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