projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 1da177e4 LT |
1 | /* $Id: oplib.h,v 1.23 2001/12/21 00:54:31 davem Exp $ |
| 2 | * oplib.h: Describes the interface and available routines in the | |
| 3 | * Linux Prom library. | |
| 4 | * | |
| 5 | * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu) | |
| 6 | */ | |
| 7 | ||
| 8 | #ifndef __SPARC_OPLIB_H | |
| 9 | #define __SPARC_OPLIB_H | |
| 10 | ||
| 11 | #include <asm/openprom.h> | |
| 12 | #include <linux/spinlock.h> | |
| 13 | #include <linux/compiler.h> | |
| 14 | ||
| 15 | /* The master romvec pointer... */ | |
| 16 | extern struct linux_romvec *romvec; | |
| 17 | ||
| 18 | /* Enumeration to describe the prom major version we have detected. */ | |
| 19 | enum prom_major_version { | |
| 20 | PROM_V0, /* Original sun4c V0 prom */ | |
| 21 | PROM_V2, /* sun4c and early sun4m V2 prom */ | |
| 22 | PROM_V3, /* sun4m and later, up to sun4d/sun4e machines V3 */ | |
| 23 | PROM_P1275, /* IEEE compliant ISA based Sun PROM, only sun4u */ | |
| 24 | PROM_AP1000, /* actually no prom at all */ | |
| 25 | PROM_SUN4, /* Old sun4 proms are totally different, but we'll shoehorn it to make it fit */ | |
| 26 | }; | |
| 27 | ||
| 28 | extern enum prom_major_version prom_vers; | |
| 29 | /* Revision, and firmware revision. */ | |
| 30 | extern unsigned int prom_rev, prom_prev; | |
| 31 | ||
| 32 | /* Root node of the prom device tree, this stays constant after | |
| 33 | * initialization is complete. | |
| 34 | */ | |
| 35 | extern int prom_root_node; | |
| 36 | ||
| 37 | /* PROM stdin and stdout */ | |
| 38 | extern int prom_stdin, prom_stdout; | |
| 39 | ||
| 40 | /* Pointer to prom structure containing the device tree traversal | |
| 41 | * and usage utility functions. Only prom-lib should use these, | |
| 42 | * users use the interface defined by the library only! | |
| 43 | */ | |
| 44 | extern struct linux_nodeops *prom_nodeops; | |
| 45 | ||
| 46 | /* The functions... */ | |
| 47 | ||
| 48 | /* You must call prom_init() before using any of the library services, | |
| 49 | * preferably as early as possible. Pass it the romvec pointer. | |
| 50 | */ | |
| 51 | extern void prom_init(struct linux_romvec *rom_ptr); | |
| 52 | ||
| 53 | /* Boot argument acquisition, returns the boot command line string. */ | |
| 54 | extern char *prom_getbootargs(void); | |
| 55 | ||
| 56 | /* Device utilities. */ | |
| 57 | ||
| 58 | /* Map and unmap devices in IO space at virtual addresses. Note that the | |
| 59 | * virtual address you pass is a request and the prom may put your mappings | |
| 60 | * somewhere else, so check your return value as that is where your new | |
| 61 | * mappings really are! | |
| 62 | * | |
| 63 | * Another note, these are only available on V2 or higher proms! | |
| 64 | */ | |
| 65 | extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes); | |
| 66 | extern void prom_unmapio(char *virt_addr, unsigned int num_bytes); | |
| 67 | ||
| 68 | /* Device operations. */ | |
| 69 | ||
| 70 | /* Open the device described by the passed string. Note, that the format | |
| 71 | * of the string is different on V0 vs. V2->higher proms. The caller must | |
| 72 | * know what he/she is doing! Returns the device descriptor, an int. | |
| 73 | */ | |
| 74 | extern int prom_devopen(char *device_string); | |
| 75 | ||
| 76 | /* Close a previously opened device described by the passed integer | |
| 77 | * descriptor. | |
| 78 | */ | |
| 79 | extern int prom_devclose(int device_handle); | |
| 80 | ||
| 81 | /* Do a seek operation on the device described by the passed integer | |
| 82 | * descriptor. | |
| 83 | */ | |
| 84 | extern void prom_seek(int device_handle, unsigned int seek_hival, | |
| 85 | unsigned int seek_lowval); | |
| 86 | ||
| 87 | /* Machine memory configuration routine. */ | |
| 88 | ||
| 89 | /* This function returns a V0 format memory descriptor table, it has three | |
| 90 | * entries. One for the total amount of physical ram on the machine, one | |
| 91 | * for the amount of physical ram available, and one describing the virtual | |
| 92 | * areas which are allocated by the prom. So, in a sense the physical | |
| 93 | * available is a calculation of the total physical minus the physical mapped | |
| 94 | * by the prom with virtual mappings. | |
| 95 | * | |
| 96 | * These lists are returned pre-sorted, this should make your life easier | |
| 97 | * since the prom itself is way too lazy to do such nice things. | |
| 98 | */ | |
| 99 | extern struct linux_mem_v0 *prom_meminfo(void); | |
| 100 | ||
| 101 | /* Miscellaneous routines, don't really fit in any category per se. */ | |
| 102 | ||
| 103 | /* Reboot the machine with the command line passed. */ | |
| 104 | extern void prom_reboot(char *boot_command); | |
| 105 | ||
| 106 | /* Evaluate the forth string passed. */ | |
| 107 | extern void prom_feval(char *forth_string); | |
| 108 | ||
| 109 | /* Enter the prom, with possibility of continuation with the 'go' | |
| 110 | * command in newer proms. | |
| 111 | */ | |
| 112 | extern void prom_cmdline(void); | |
| 113 | ||
| 114 | /* Enter the prom, with no chance of continuation for the stand-alone | |
| 115 | * which calls this. | |
| 116 | */ | |
| 117 | extern void prom_halt(void) __attribute__ ((noreturn)); | |
| 118 | ||
| 119 | /* Set the PROM 'sync' callback function to the passed function pointer. | |
| 120 | * When the user gives the 'sync' command at the prom prompt while the | |
| 121 | * kernel is still active, the prom will call this routine. | |
| 122 | * | |
| 123 | * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX | |
| 124 | */ | |
| 125 | typedef void (*sync_func_t)(void); | |
| 126 | extern void prom_setsync(sync_func_t func_ptr); | |
| 127 | ||
| 128 | /* Acquire the IDPROM of the root node in the prom device tree. This | |
| 129 | * gets passed a buffer where you would like it stuffed. The return value | |
| 130 | * is the format type of this idprom or 0xff on error. | |
| 131 | */ | |
| 132 | extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size); | |
| 133 | ||
| 134 | /* Get the prom major version. */ | |
| 135 | extern int prom_version(void); | |
| 136 | ||
| 137 | /* Get the prom plugin revision. */ | |
| 138 | extern int prom_getrev(void); | |
| 139 | ||
| 140 | /* Get the prom firmware revision. */ | |
| 141 | extern int prom_getprev(void); | |
| 142 | ||
| 143 | /* Character operations to/from the console.... */ | |
| 144 | ||
| 145 | /* Non-blocking get character from console. */ | |
| 146 | extern int prom_nbgetchar(void); | |
| 147 | ||
| 148 | /* Non-blocking put character to console. */ | |
| 149 | extern int prom_nbputchar(char character); | |
| 150 | ||
| 151 | /* Blocking get character from console. */ | |
| 152 | extern char prom_getchar(void); | |
| 153 | ||
| 154 | /* Blocking put character to console. */ | |
| 155 | extern void prom_putchar(char character); | |
| 156 | ||
| 157 | /* Prom's internal routines, don't use in kernel/boot code. */ | |
| 158 | extern void prom_printf(char *fmt, ...); | |
| 159 | extern void prom_write(const char *buf, unsigned int len); | |
| 160 | ||
| 1da177e4 LT |
161 | /* Multiprocessor operations... */ |
| 162 | ||
| 163 | /* Start the CPU with the given device tree node, context table, and context | |
| 164 | * at the passed program counter. | |
| 165 | */ | |
| 166 | extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table, | |
| 167 | int context, char *program_counter); | |
| 168 | ||
| 169 | /* Stop the CPU with the passed device tree node. */ | |
| 170 | extern int prom_stopcpu(int cpunode); | |
| 171 | ||
| 172 | /* Idle the CPU with the passed device tree node. */ | |
| 173 | extern int prom_idlecpu(int cpunode); | |
| 174 | ||
| 175 | /* Re-Start the CPU with the passed device tree node. */ | |
| 176 | extern int prom_restartcpu(int cpunode); | |
| 177 | ||
| 178 | /* PROM memory allocation facilities... */ | |
| 179 | ||
| 180 | /* Allocated at possibly the given virtual address a chunk of the | |
| 181 | * indicated size. | |
| 182 | */ | |
| 183 | extern char *prom_alloc(char *virt_hint, unsigned int size); | |
| 184 | ||
| 185 | /* Free a previously allocated chunk. */ | |
| 186 | extern void prom_free(char *virt_addr, unsigned int size); | |
| 187 | ||
| 188 | /* Sun4/sun4c specific memory-management startup hook. */ | |
| 189 | ||
| 190 | /* Map the passed segment in the given context at the passed | |
| 191 | * virtual address. | |
| 192 | */ | |
| 193 | extern void prom_putsegment(int context, unsigned long virt_addr, | |
| 194 | int physical_segment); | |
| 195 | ||
| 196 | ||
| 197 | /* PROM device tree traversal functions... */ | |
| 198 | ||
| 199 | #ifdef PROMLIB_INTERNAL | |
| 200 | ||
| 201 | /* Internal version of prom_getchild. */ | |
| 202 | extern int __prom_getchild(int parent_node); | |
| 203 | ||
| 204 | /* Internal version of prom_getsibling. */ | |
| 205 | extern int __prom_getsibling(int node); | |
| 206 | ||
| 207 | #endif | |
| 208 | ||
| 209 | ||
| 210 | /* Get the child node of the given node, or zero if no child exists. */ | |
| 211 | extern int prom_getchild(int parent_node); | |
| 212 | ||
| 213 | /* Get the next sibling node of the given node, or zero if no further | |
| 214 | * siblings exist. | |
| 215 | */ | |
| 216 | extern int prom_getsibling(int node); | |
| 217 | ||
| 218 | /* Get the length, at the passed node, of the given property type. | |
| 219 | * Returns -1 on error (ie. no such property at this node). | |
| 220 | */ | |
| 221 | extern int prom_getproplen(int thisnode, char *property); | |
| 222 | ||
| 223 | /* Fetch the requested property using the given buffer. Returns | |
| 224 | * the number of bytes the prom put into your buffer or -1 on error. | |
| 225 | */ | |
| 226 | extern int __must_check prom_getproperty(int thisnode, char *property, | |
| 227 | char *prop_buffer, int propbuf_size); | |
| 228 | ||
| 229 | /* Acquire an integer property. */ | |
| 230 | extern int prom_getint(int node, char *property); | |
| 231 | ||
| 232 | /* Acquire an integer property, with a default value. */ | |
| 233 | extern int prom_getintdefault(int node, char *property, int defval); | |
| 234 | ||
| 235 | /* Acquire a boolean property, 0=FALSE 1=TRUE. */ | |
| 236 | extern int prom_getbool(int node, char *prop); | |
| 237 | ||
| 238 | /* Acquire a string property, null string on error. */ | |
| 239 | extern void prom_getstring(int node, char *prop, char *buf, int bufsize); | |
| 240 | ||
| 241 | /* Does the passed node have the given "name"? YES=1 NO=0 */ | |
| 242 | extern int prom_nodematch(int thisnode, char *name); | |
| 243 | ||
| 1da177e4 LT |
244 | /* Search all siblings starting at the passed node for "name" matching |
| 245 | * the given string. Returns the node on success, zero on failure. | |
| 246 | */ | |
| 247 | extern int prom_searchsiblings(int node_start, char *name); | |
| 248 | ||
| 249 | /* Return the first property type, as a string, for the given node. | |
| 250 | * Returns a null string on error. | |
| 251 | */ | |
| 252 | extern char *prom_firstprop(int node, char *buffer); | |
| 253 | ||
| 254 | /* Returns the next property after the passed property for the given | |
| 255 | * node. Returns null string on failure. | |
| 256 | */ | |
| 257 | extern char *prom_nextprop(int node, char *prev_property, char *buffer); | |
| 258 | ||
| 259 | /* Returns phandle of the path specified */ | |
| 260 | extern int prom_finddevice(char *name); | |
| 261 | ||
| 262 | /* Returns 1 if the specified node has given property. */ | |
| 263 | extern int prom_node_has_property(int node, char *property); | |
| 264 | ||
| 265 | /* Set the indicated property at the given node with the passed value. | |
| 266 | * Returns the number of bytes of your value that the prom took. | |
| 267 | */ | |
| 268 | extern int prom_setprop(int node, char *prop_name, char *prop_value, | |
| 269 | int value_size); | |
| 270 | ||
| 271 | extern int prom_pathtoinode(char *path); | |
| 272 | extern int prom_inst2pkg(int); | |
| 273 | ||
| 274 | /* Dorking with Bus ranges... */ | |
| 275 | ||
| 276 | /* Apply promlib probes OBIO ranges to registers. */ | |
| 277 | extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs); | |
| 278 | ||
| 279 | /* Apply ranges of any prom node (and optionally parent node as well) to registers. */ | |
| 280 | extern void prom_apply_generic_ranges(int node, int parent, | |
| 281 | struct linux_prom_registers *sbusregs, int nregs); | |
| 282 | ||
| 283 | /* CPU probing helpers. */ | |
| 284 | int cpu_find_by_instance(int instance, int *prom_node, int *mid); | |
| 285 | int cpu_find_by_mid(int mid, int *prom_node); | |
| 286 | int cpu_get_hwmid(int prom_node); | |
| 287 | ||
| 288 | extern spinlock_t prom_lock; | |
| 289 | ||
| 290 | #endif /* !(__SPARC_OPLIB_H) */ |