Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* $Id: oplib.h,v 1.14 2001/12/19 00:29:51 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 | * Copyright (C) 1996 Jakub Jelinek (jj@sunsite.mff.cuni.cz) |
| 7 | */ |
| 8 | |
| 9 | #ifndef __SPARC64_OPLIB_H |
| 10 | #define __SPARC64_OPLIB_H |
| 11 | |
| 12 | #include <linux/config.h> |
| 13 | #include <asm/openprom.h> |
| 14 | |
| 15 | /* Enumeration to describe the prom major version we have detected. */ |
| 16 | enum prom_major_version { |
| 17 | PROM_V0, /* Original sun4c V0 prom */ |
| 18 | PROM_V2, /* sun4c and early sun4m V2 prom */ |
| 19 | PROM_V3, /* sun4m and later, up to sun4d/sun4e machines V3 */ |
| 20 | PROM_P1275, /* IEEE compliant ISA based Sun PROM, only sun4u */ |
| 21 | PROM_AP1000, /* actually no prom at all */ |
| 22 | }; |
| 23 | |
| 24 | extern enum prom_major_version prom_vers; |
| 25 | /* Revision, and firmware revision. */ |
| 26 | extern unsigned int prom_rev, prom_prev; |
| 27 | |
| 28 | /* Root node of the prom device tree, this stays constant after |
| 29 | * initialization is complete. |
| 30 | */ |
| 31 | extern int prom_root_node; |
| 32 | |
| 33 | /* PROM stdin and stdout */ |
| 34 | extern int prom_stdin, prom_stdout; |
| 35 | |
| 36 | /* /chosen node of the prom device tree, this stays constant after |
| 37 | * initialization is complete. |
| 38 | */ |
| 39 | extern int prom_chosen_node; |
| 40 | |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 41 | /* Helper values and strings in arch/sparc64/kernel/head.S */ |
David S. Miller | d82ace7 | 2006-02-09 02:52:44 -0800 | [diff] [blame] | 42 | extern const char prom_peer_name[]; |
| 43 | extern const char prom_compatible_name[]; |
| 44 | extern const char prom_root_compatible[]; |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 45 | extern const char prom_finddev_name[]; |
| 46 | extern const char prom_chosen_path[]; |
| 47 | extern const char prom_getprop_name[]; |
| 48 | extern const char prom_mmu_name[]; |
| 49 | extern const char prom_callmethod_name[]; |
| 50 | extern const char prom_translate_name[]; |
| 51 | extern const char prom_map_name[]; |
| 52 | extern const char prom_unmap_name[]; |
| 53 | extern int prom_mmu_ihandle_cache; |
| 54 | extern unsigned int prom_boot_mapped_pc; |
| 55 | extern unsigned int prom_boot_mapping_mode; |
| 56 | extern unsigned long prom_boot_mapping_phys_high, prom_boot_mapping_phys_low; |
| 57 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | struct linux_mlist_p1275 { |
| 59 | struct linux_mlist_p1275 *theres_more; |
| 60 | unsigned long start_adr; |
| 61 | unsigned long num_bytes; |
| 62 | }; |
| 63 | |
| 64 | struct linux_mem_p1275 { |
| 65 | struct linux_mlist_p1275 **p1275_totphys; |
| 66 | struct linux_mlist_p1275 **p1275_prommap; |
| 67 | struct linux_mlist_p1275 **p1275_available; /* What we can use */ |
| 68 | }; |
| 69 | |
| 70 | /* The functions... */ |
| 71 | |
| 72 | /* You must call prom_init() before using any of the library services, |
| 73 | * preferably as early as possible. Pass it the romvec pointer. |
| 74 | */ |
| 75 | extern void prom_init(void *cif_handler, void *cif_stack); |
| 76 | |
| 77 | /* Boot argument acquisition, returns the boot command line string. */ |
| 78 | extern char *prom_getbootargs(void); |
| 79 | |
| 80 | /* Device utilities. */ |
| 81 | |
| 82 | /* Device operations. */ |
| 83 | |
| 84 | /* Open the device described by the passed string. Note, that the format |
| 85 | * of the string is different on V0 vs. V2->higher proms. The caller must |
| 86 | * know what he/she is doing! Returns the device descriptor, an int. |
| 87 | */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 88 | extern int prom_devopen(const char *device_string); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | |
| 90 | /* Close a previously opened device described by the passed integer |
| 91 | * descriptor. |
| 92 | */ |
| 93 | extern int prom_devclose(int device_handle); |
| 94 | |
| 95 | /* Do a seek operation on the device described by the passed integer |
| 96 | * descriptor. |
| 97 | */ |
| 98 | extern void prom_seek(int device_handle, unsigned int seek_hival, |
| 99 | unsigned int seek_lowval); |
| 100 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | /* Miscellaneous routines, don't really fit in any category per se. */ |
| 102 | |
| 103 | /* Reboot the machine with the command line passed. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 104 | extern void prom_reboot(const char *boot_command); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | |
| 106 | /* Evaluate the forth string passed. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 107 | extern void prom_feval(const char *forth_string); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | /* Halt and power-off the machine. */ |
| 120 | extern void prom_halt_power_off(void) __attribute__ ((noreturn)); |
| 121 | |
| 122 | /* Set the PROM 'sync' callback function to the passed function pointer. |
| 123 | * When the user gives the 'sync' command at the prom prompt while the |
| 124 | * kernel is still active, the prom will call this routine. |
| 125 | * |
| 126 | */ |
| 127 | typedef int (*callback_func_t)(long *cmd); |
| 128 | extern void prom_setcallback(callback_func_t func_ptr); |
| 129 | |
| 130 | /* Acquire the IDPROM of the root node in the prom device tree. This |
| 131 | * gets passed a buffer where you would like it stuffed. The return value |
| 132 | * is the format type of this idprom or 0xff on error. |
| 133 | */ |
| 134 | extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size); |
| 135 | |
| 136 | /* Get the prom major version. */ |
| 137 | extern int prom_version(void); |
| 138 | |
| 139 | /* Get the prom plugin revision. */ |
| 140 | extern int prom_getrev(void); |
| 141 | |
| 142 | /* Get the prom firmware revision. */ |
| 143 | extern int prom_getprev(void); |
| 144 | |
| 145 | /* Character operations to/from the console.... */ |
| 146 | |
| 147 | /* Non-blocking get character from console. */ |
| 148 | extern int prom_nbgetchar(void); |
| 149 | |
| 150 | /* Non-blocking put character to console. */ |
| 151 | extern int prom_nbputchar(char character); |
| 152 | |
| 153 | /* Blocking get character from console. */ |
| 154 | extern char prom_getchar(void); |
| 155 | |
| 156 | /* Blocking put character to console. */ |
| 157 | extern void prom_putchar(char character); |
| 158 | |
| 159 | /* Prom's internal routines, don't use in kernel/boot code. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 160 | extern void prom_printf(const char *fmt, ...); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | extern void prom_write(const char *buf, unsigned int len); |
| 162 | |
| 163 | /* Query for input device type */ |
| 164 | |
| 165 | enum prom_input_device { |
| 166 | PROMDEV_IKBD, /* input from keyboard */ |
| 167 | PROMDEV_ITTYA, /* input from ttya */ |
| 168 | PROMDEV_ITTYB, /* input from ttyb */ |
Eddie C. Dost | c126cf8 | 2006-01-18 14:54:31 -0800 | [diff] [blame] | 169 | PROMDEV_IRSC, /* input from rsc */ |
David S. Miller | 1a7a242 | 2006-02-11 23:24:30 -0800 | [diff] [blame^] | 170 | PROMDEV_IVCONS, /* input from virtual-console */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | PROMDEV_I_UNK, |
| 172 | }; |
| 173 | |
| 174 | extern enum prom_input_device prom_query_input_device(void); |
| 175 | |
| 176 | /* Query for output device type */ |
| 177 | |
| 178 | enum prom_output_device { |
| 179 | PROMDEV_OSCREEN, /* to screen */ |
| 180 | PROMDEV_OTTYA, /* to ttya */ |
| 181 | PROMDEV_OTTYB, /* to ttyb */ |
Eddie C. Dost | c126cf8 | 2006-01-18 14:54:31 -0800 | [diff] [blame] | 182 | PROMDEV_ORSC, /* to rsc */ |
David S. Miller | 1a7a242 | 2006-02-11 23:24:30 -0800 | [diff] [blame^] | 183 | PROMDEV_OVCONS, /* to virtual-console */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | PROMDEV_O_UNK, |
| 185 | }; |
| 186 | |
| 187 | extern enum prom_output_device prom_query_output_device(void); |
| 188 | |
| 189 | /* Multiprocessor operations... */ |
| 190 | #ifdef CONFIG_SMP |
| 191 | /* Start the CPU with the given device tree node, context table, and context |
| 192 | * at the passed program counter. |
| 193 | */ |
| 194 | extern void prom_startcpu(int cpunode, unsigned long pc, unsigned long o0); |
| 195 | |
| 196 | /* Stop the current CPU. */ |
| 197 | extern void prom_stopself(void); |
| 198 | |
| 199 | /* Idle the current CPU. */ |
| 200 | extern void prom_idleself(void); |
| 201 | |
| 202 | /* Resume the CPU with the passed device tree node. */ |
| 203 | extern void prom_resumecpu(int cpunode); |
| 204 | #endif |
| 205 | |
| 206 | /* Power management interfaces. */ |
| 207 | |
| 208 | /* Put the current CPU to sleep. */ |
| 209 | extern void prom_sleepself(void); |
| 210 | |
| 211 | /* Put the entire system to sleep. */ |
| 212 | extern int prom_sleepsystem(void); |
| 213 | |
| 214 | /* Initiate a wakeup event. */ |
| 215 | extern int prom_wakeupsystem(void); |
| 216 | |
| 217 | /* MMU and memory related OBP interfaces. */ |
| 218 | |
| 219 | /* Get unique string identifying SIMM at given physical address. */ |
| 220 | extern int prom_getunumber(int syndrome_code, |
| 221 | unsigned long phys_addr, |
| 222 | char *buf, int buflen); |
| 223 | |
| 224 | /* Retain physical memory to the caller across soft resets. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 225 | extern unsigned long prom_retain(const char *name, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 226 | unsigned long pa_low, unsigned long pa_high, |
| 227 | long size, long align); |
| 228 | |
| 229 | /* Load explicit I/D TLB entries into the calling processor. */ |
| 230 | extern long prom_itlb_load(unsigned long index, |
| 231 | unsigned long tte_data, |
| 232 | unsigned long vaddr); |
| 233 | |
| 234 | extern long prom_dtlb_load(unsigned long index, |
| 235 | unsigned long tte_data, |
| 236 | unsigned long vaddr); |
| 237 | |
| 238 | /* Map/Unmap client program address ranges. First the format of |
| 239 | * the mapping mode argument. |
| 240 | */ |
| 241 | #define PROM_MAP_WRITE 0x0001 /* Writable */ |
| 242 | #define PROM_MAP_READ 0x0002 /* Readable - sw */ |
| 243 | #define PROM_MAP_EXEC 0x0004 /* Executable - sw */ |
| 244 | #define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */ |
| 245 | #define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */ |
| 246 | #define PROM_MAP_SE 0x0040 /* Side-Effects */ |
| 247 | #define PROM_MAP_GLOB 0x0080 /* Global */ |
| 248 | #define PROM_MAP_IE 0x0100 /* Invert-Endianness */ |
| 249 | #define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED) |
| 250 | |
| 251 | extern int prom_map(int mode, unsigned long size, |
| 252 | unsigned long vaddr, unsigned long paddr); |
| 253 | extern void prom_unmap(unsigned long size, unsigned long vaddr); |
| 254 | |
| 255 | |
| 256 | /* PROM device tree traversal functions... */ |
| 257 | |
| 258 | #ifdef PROMLIB_INTERNAL |
| 259 | |
| 260 | /* Internal version of prom_getchild. */ |
| 261 | extern int __prom_getchild(int parent_node); |
| 262 | |
| 263 | /* Internal version of prom_getsibling. */ |
| 264 | extern int __prom_getsibling(int node); |
| 265 | |
| 266 | #endif |
| 267 | |
| 268 | /* Get the child node of the given node, or zero if no child exists. */ |
| 269 | extern int prom_getchild(int parent_node); |
| 270 | |
| 271 | /* Get the next sibling node of the given node, or zero if no further |
| 272 | * siblings exist. |
| 273 | */ |
| 274 | extern int prom_getsibling(int node); |
| 275 | |
| 276 | /* Get the length, at the passed node, of the given property type. |
| 277 | * Returns -1 on error (ie. no such property at this node). |
| 278 | */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 279 | extern int prom_getproplen(int thisnode, const char *property); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 280 | |
| 281 | /* Fetch the requested property using the given buffer. Returns |
| 282 | * the number of bytes the prom put into your buffer or -1 on error. |
| 283 | */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 284 | extern int prom_getproperty(int thisnode, const char *property, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 285 | char *prop_buffer, int propbuf_size); |
| 286 | |
| 287 | /* Acquire an integer property. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 288 | extern int prom_getint(int node, const char *property); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 289 | |
| 290 | /* Acquire an integer property, with a default value. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 291 | extern int prom_getintdefault(int node, const char *property, int defval); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 292 | |
| 293 | /* Acquire a boolean property, 0=FALSE 1=TRUE. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 294 | extern int prom_getbool(int node, const char *prop); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 295 | |
| 296 | /* Acquire a string property, null string on error. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 297 | extern void prom_getstring(int node, const char *prop, char *buf, int bufsize); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 298 | |
| 299 | /* Does the passed node have the given "name"? YES=1 NO=0 */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 300 | extern int prom_nodematch(int thisnode, const char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 301 | |
| 302 | /* Puts in buffer a prom name in the form name@x,y or name (x for which_io |
| 303 | * and y for first regs phys address |
| 304 | */ |
| 305 | extern int prom_getname(int node, char *buf, int buflen); |
| 306 | |
| 307 | /* Search all siblings starting at the passed node for "name" matching |
| 308 | * the given string. Returns the node on success, zero on failure. |
| 309 | */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 310 | extern int prom_searchsiblings(int node_start, const char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 311 | |
| 312 | /* Return the first property type, as a string, for the given node. |
| 313 | * Returns a null string on error. Buffer should be at least 32B long. |
| 314 | */ |
| 315 | extern char *prom_firstprop(int node, char *buffer); |
| 316 | |
| 317 | /* Returns the next property after the passed property for the given |
| 318 | * node. Returns null string on failure. Buffer should be at least 32B long. |
| 319 | */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 320 | extern char *prom_nextprop(int node, const char *prev_property, char *buffer); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 321 | |
| 322 | /* Returns 1 if the specified node has given property. */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 323 | extern int prom_node_has_property(int node, const char *property); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 324 | |
| 325 | /* Returns phandle of the path specified */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 326 | extern int prom_finddevice(const char *name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 327 | |
| 328 | /* Set the indicated property at the given node with the passed value. |
| 329 | * Returns the number of bytes of your value that the prom took. |
| 330 | */ |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 331 | extern int prom_setprop(int node, const char *prop_name, char *prop_value, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 332 | int value_size); |
| 333 | |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 334 | extern int prom_pathtoinode(const char *path); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 335 | extern int prom_inst2pkg(int); |
| 336 | |
| 337 | /* CPU probing helpers. */ |
| 338 | int cpu_find_by_instance(int instance, int *prom_node, int *mid); |
| 339 | int cpu_find_by_mid(int mid, int *prom_node); |
| 340 | |
| 341 | /* Client interface level routines. */ |
| 342 | extern void prom_set_trap_table(unsigned long tba); |
David S. Miller | 12eaa32 | 2006-02-10 15:39:51 -0800 | [diff] [blame] | 343 | extern void prom_set_trap_table_sun4v(unsigned long tba, unsigned long mmfsa); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 344 | |
David S. Miller | bff06d5 | 2005-09-22 20:11:33 -0700 | [diff] [blame] | 345 | extern long p1275_cmd(const char *, long, ...); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 346 | |
| 347 | |
| 348 | #if 0 |
| 349 | #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x)) |
| 350 | #else |
| 351 | #define P1275_SIZE(x) x |
| 352 | #endif |
| 353 | |
| 354 | /* We support at most 16 input and 1 output argument */ |
| 355 | #define P1275_ARG_NUMBER 0 |
| 356 | #define P1275_ARG_IN_STRING 1 |
| 357 | #define P1275_ARG_OUT_BUF 2 |
| 358 | #define P1275_ARG_OUT_32B 3 |
| 359 | #define P1275_ARG_IN_FUNCTION 4 |
| 360 | #define P1275_ARG_IN_BUF 5 |
| 361 | #define P1275_ARG_IN_64B 6 |
| 362 | |
| 363 | #define P1275_IN(x) ((x) & 0xf) |
| 364 | #define P1275_OUT(x) (((x) << 4) & 0xf0) |
| 365 | #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o)) |
| 366 | #define P1275_ARG(n,x) ((x) << ((n)*3 + 8)) |
| 367 | |
| 368 | #endif /* !(__SPARC64_OPLIB_H) */ |