/* $Id: oplib.h,v 1.23 2001/12/21 00:54:31 davem Exp $ * oplib.h: Describes the interface and available routines in the * Linux Prom library. * * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu) */ #ifndef __SPARC_OPLIB_H #define __SPARC_OPLIB_H #include <asm/openprom.h> #include <linux/spinlock.h> #include <linux/compiler.h> /* The master romvec pointer... */ extern struct linux_romvec *romvec; /* Enumeration to describe the prom major version we have detected. */ enum prom_major_version { PROM_V0, /* Original sun4c V0 prom */ PROM_V2, /* sun4c and early sun4m V2 prom */ PROM_V3, /* sun4m and later, up to sun4d/sun4e machines V3 */ PROM_P1275, /* IEEE compliant ISA based Sun PROM, only sun4u */ PROM_AP1000, /* actually no prom at all */ PROM_SUN4, /* Old sun4 proms are totally different, but we'll shoehorn it to make it fit */ }; extern enum prom_major_version prom_vers; /* Revision, and firmware revision. */ extern unsigned int prom_rev, prom_prev; /* Root node of the prom device tree, this stays constant after * initialization is complete. */ extern int prom_root_node; /* PROM stdin and stdout */ extern int prom_stdin, prom_stdout; /* Pointer to prom structure containing the device tree traversal * and usage utility functions. Only prom-lib should use these, * users use the interface defined by the library only! */ extern struct linux_nodeops *prom_nodeops; /* The functions... */ /* You must call prom_init() before using any of the library services, * preferably as early as possible. Pass it the romvec pointer. */ extern void prom_init(struct linux_romvec *rom_ptr); /* Boot argument acquisition, returns the boot command line string. */ extern char *prom_getbootargs(void); /* Device utilities. */ /* Map and unmap devices in IO space at virtual addresses. Note that the * virtual address you pass is a request and the prom may put your mappings * somewhere else, so check your return value as that is where your new * mappings really are! * * Another note, these are only available on V2 or higher proms! */ extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes); extern void prom_unmapio(char *virt_addr, unsigned int num_bytes); /* Device operations. */ /* Open the device described by the passed string. Note, that the format * of the string is different on V0 vs. V2->higher proms. The caller must * know what he/she is doing! Returns the device descriptor, an int. */ extern int prom_devopen(char *device_string); /* Close a previously opened device described by the passed integer * descriptor. */ extern int prom_devclose(int device_handle); /* Do a seek operation on the device described by the passed integer * descriptor. */ extern void prom_seek(int device_handle, unsigned int seek_hival, unsigned int seek_lowval); /* Machine memory configuration routine. */ /* This function returns a V0 format memory descriptor table, it has three * entries. One for the total amount of physical ram on the machine, one * for the amount of physical ram available, and one describing the virtual * areas which are allocated by the prom. So, in a sense the physical * available is a calculation of the total physical minus the physical mapped * by the prom with virtual mappings. * * These lists are returned pre-sorted, this should make your life easier * since the prom itself is way too lazy to do such nice things. */ extern struct linux_mem_v0 *prom_meminfo(void); /* Miscellaneous routines, don't really fit in any category per se. */ /* Reboot the machine with the command line passed. */ extern void prom_reboot(char *boot_command); /* Evaluate the forth string passed. */ extern void prom_feval(char *forth_string); /* Enter the prom, with possibility of continuation with the 'go' * command in newer proms. */ extern void prom_cmdline(void); /* Enter the prom, with no chance of continuation for the stand-alone * which calls this. */ extern void prom_halt(void) __attribute__ ((noreturn)); /* Set the PROM 'sync' callback function to the passed function pointer. * When the user gives the 'sync' command at the prom prompt while the * kernel is still active, the prom will call this routine. * * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX */ typedef void (*sync_func_t)(void); extern void prom_setsync(sync_func_t func_ptr); /* Acquire the IDPROM of the root node in the prom device tree. This * gets passed a buffer where you would like it stuffed. The return value * is the format type of this idprom or 0xff on error. */ extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size); /* Get the prom major version. */ extern int prom_version(void); /* Get the prom plugin revision. */ extern int prom_getrev(void); /* Get the prom firmware revision. */ extern int prom_getprev(void); /* Character operations to/from the console.... */ /* Non-blocking get character from console. */ extern int prom_nbgetchar(void); /* Non-blocking put character to console. */ extern int prom_nbputchar(char character); /* Blocking get character from console. */ extern char prom_getchar(void); /* Blocking put character to console. */ extern void prom_putchar(char character); /* Prom's internal routines, don't use in kernel/boot code. */ extern void prom_printf(char *fmt, ...); extern void prom_write(const char *buf, unsigned int len); /* Multiprocessor operations... */ /* Start the CPU with the given device tree node, context table, and context * at the passed program counter. */ extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table, int context, char *program_counter); /* Stop the CPU with the passed device tree node. */ extern int prom_stopcpu(int cpunode); /* Idle the CPU with the passed device tree node. */ extern int prom_idlecpu(int cpunode); /* Re-Start the CPU with the passed device tree node. */ extern int prom_restartcpu(int cpunode); /* PROM memory allocation facilities... */ /* Allocated at possibly the given virtual address a chunk of the * indicated size. */ extern char *prom_alloc(char *virt_hint, unsigned int size); /* Free a previously allocated chunk. */ extern void prom_free(char *virt_addr, unsigned int size); /* Sun4/sun4c specific memory-management startup hook. */ /* Map the passed segment in the given context at the passed * virtual address. */ extern void prom_putsegment(int context, unsigned long virt_addr, int physical_segment); /* PROM device tree traversal functions... */ #ifdef PROMLIB_INTERNAL /* Internal version of prom_getchild. */ extern int __prom_getchild(int parent_node); /* Internal version of prom_getsibling. */ extern int __prom_getsibling(int node); #endif /* Get the child node of the given node, or zero if no child exists. */ extern int prom_getchild(int parent_node); /* Get the next sibling node of the given node, or zero if no further * siblings exist. */ extern int prom_getsibling(int node); /* Get the length, at the passed node, of the given property type. * Returns -1 on error (ie. no such property at this node). */ extern int prom_getproplen(int thisnode, char *property); /* Fetch the requested property using the given buffer. Returns * the number of bytes the prom put into your buffer or -1 on error. */ extern int __must_check prom_getproperty(int thisnode, char *property, char *prop_buffer, int propbuf_size); /* Acquire an integer property. */ extern int prom_getint(int node, char *property); /* Acquire an integer property, with a default value. */ extern int prom_getintdefault(int node, char *property, int defval); /* Acquire a boolean property, 0=FALSE 1=TRUE. */ extern int prom_getbool(int node, char *prop); /* Acquire a string property, null string on error. */ extern void prom_getstring(int node, char *prop, char *buf, int bufsize); /* Does the passed node have the given "name"? YES=1 NO=0 */ extern int prom_nodematch(int thisnode, char *name); /* Search all siblings starting at the passed node for "name" matching * the given string. Returns the node on success, zero on failure. */ extern int prom_searchsiblings(int node_start, char *name); /* Return the first property type, as a string, for the given node. * Returns a null string on error. */ extern char *prom_firstprop(int node, char *buffer); /* Returns the next property after the passed property for the given * node. Returns null string on failure. */ extern char *prom_nextprop(int node, char *prev_property, char *buffer); /* Returns phandle of the path specified */ extern int prom_finddevice(char *name); /* Returns 1 if the specified node has given property. */ extern int prom_node_has_property(int node, char *property); /* Set the indicated property at the given node with the passed value. * Returns the number of bytes of your value that the prom took. */ extern int prom_setprop(int node, char *prop_name, char *prop_value, int value_size); extern int prom_pathtoinode(char *path); extern int prom_inst2pkg(int); /* Dorking with Bus ranges... */ /* Apply promlib probes OBIO ranges to registers. */ extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs); /* Apply ranges of any prom node (and optionally parent node as well) to registers. */ extern void prom_apply_generic_ranges(int node, int parent, struct linux_prom_registers *sbusregs, int nregs); /* CPU probing helpers. */ int cpu_find_by_instance(int instance, int *prom_node, int *mid); int cpu_find_by_mid(int mid, int *prom_node); int cpu_get_hwmid(int prom_node); extern spinlock_t prom_lock; #endif /* !(__SPARC_OPLIB_H) */