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