arch/sparc/include/asm/oplib_32.h

   1 /*
   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 };
  25
  26 extern enum prom_major_version prom_vers;
  27 /* Revision, and firmware revision. */
  28 extern unsigned int prom_rev, prom_prev;
  29
  30 /* Root node of the prom device tree, this stays constant after
  31  * initialization is complete.
  32  */
  33 extern phandle prom_root_node;
  34
  35 /* Pointer to prom structure containing the device tree traversal
  36  * and usage utility functions.  Only prom-lib should use these,
  37  * users use the interface defined by the library only!
  38  */
  39 extern struct linux_nodeops *prom_nodeops;
  40
  41 /* The functions... */
  42
  43 /* You must call prom_init() before using any of the library services,
  44  * preferably as early as possible.  Pass it the romvec pointer.
  45  */
  46 extern void prom_init(struct linux_romvec *rom_ptr);
  47
  48 /* Boot argument acquisition, returns the boot command line string. */
  49 extern char *prom_getbootargs(void);
  50
  51 /* Device utilities. */
  52
  53 /* Map and unmap devices in IO space at virtual addresses. Note that the
  54  * virtual address you pass is a request and the prom may put your mappings
  55  * somewhere else, so check your return value as that is where your new
  56  * mappings really are!
  57  *
  58  * Another note, these are only available on V2 or higher proms!
  59  */
  60 extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes);
  61 extern void prom_unmapio(char *virt_addr, unsigned int num_bytes);
  62
  63 /* Miscellaneous routines, don't really fit in any category per se. */
  64
  65 /* Reboot the machine with the command line passed. */
  66 extern void prom_reboot(char *boot_command);
  67
  68 /* Evaluate the forth string passed. */
  69 extern void prom_feval(char *forth_string);
  70
  71 /* Enter the prom, with possibility of continuation with the 'go'
  72  * command in newer proms.
  73  */
  74 extern void prom_cmdline(void);
  75
  76 /* Enter the prom, with no chance of continuation for the stand-alone
  77  * which calls this.
  78  */
  79 extern void prom_halt(void) __attribute__ ((noreturn));
  80
  81 /* Set the PROM 'sync' callback function to the passed function pointer.
  82  * When the user gives the 'sync' command at the prom prompt while the
  83  * kernel is still active, the prom will call this routine.
  84  *
  85  * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
  86  */
  87 typedef void (*sync_func_t)(void);
  88 extern void prom_setsync(sync_func_t func_ptr);
  89
  90 /* Acquire the IDPROM of the root node in the prom device tree.  This
  91  * gets passed a buffer where you would like it stuffed.  The return value
  92  * is the format type of this idprom or 0xff on error.
  93  */
  94 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
  95
  96 /* Get the prom major version. */
  97 extern int prom_version(void);
  98
  99 /* Get the prom plugin revision. */
 100 extern int prom_getrev(void);
 101
 102 /* Get the prom firmware revision. */
 103 extern int prom_getprev(void);
 104
 105 /* Write a buffer of characters to the console. */
 106 extern void prom_console_write_buf(const char *buf, int len);
 107
 108 /* Prom's internal routines, don't use in kernel/boot code. */
 109 extern void prom_printf(const char *fmt, ...);
 110 extern void prom_write(const char *buf, unsigned int len);
 111
 112 /* Multiprocessor operations... */
 113
 114 /* Start the CPU with the given device tree node, context table, and context
 115  * at the passed program counter.
 116  */
 117 extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
 118                          int context, char *program_counter);
 119
 120 /* Stop the CPU with the passed device tree node. */
 121 extern int prom_stopcpu(int cpunode);
 122
 123 /* Idle the CPU with the passed device tree node. */
 124 extern int prom_idlecpu(int cpunode);
 125
 126 /* Re-Start the CPU with the passed device tree node. */
 127 extern int prom_restartcpu(int cpunode);
 128
 129 /* PROM memory allocation facilities... */
 130
 131 /* Allocated at possibly the given virtual address a chunk of the
 132  * indicated size.
 133  */
 134 extern char *prom_alloc(char *virt_hint, unsigned int size);
 135
 136 /* Free a previously allocated chunk. */
 137 extern void prom_free(char *virt_addr, unsigned int size);
 138
 139 /* Sun4/sun4c specific memory-management startup hook. */
 140
 141 /* Map the passed segment in the given context at the passed
 142  * virtual address.
 143  */
 144 extern void prom_putsegment(int context, unsigned long virt_addr,
 145                             int physical_segment);
 146
 147
 148 /* PROM device tree traversal functions... */
 149
 150 /* Get the child node of the given node, or zero if no child exists. */
 151 extern phandle prom_getchild(phandle parent_node);
 152
 153 /* Get the next sibling node of the given node, or zero if no further
 154  * siblings exist.
 155  */
 156 extern phandle prom_getsibling(phandle node);
 157
 158 /* Get the length, at the passed node, of the given property type.
 159  * Returns -1 on error (ie. no such property at this node).
 160  */
 161 extern int prom_getproplen(phandle thisnode, const char *property);
 162
 163 /* Fetch the requested property using the given buffer.  Returns
 164  * the number of bytes the prom put into your buffer or -1 on error.
 165  */
 166 extern int __must_check prom_getproperty(phandle thisnode, const char *property,
 167                                          char *prop_buffer, int propbuf_size);
 168
 169 /* Acquire an integer property. */
 170 extern int prom_getint(phandle node, char *property);
 171
 172 /* Acquire an integer property, with a default value. */
 173 extern int prom_getintdefault(phandle node, char *property, int defval);
 174
 175 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
 176 extern int prom_getbool(phandle node, char *prop);
 177
 178 /* Acquire a string property, null string on error. */
 179 extern void prom_getstring(phandle node, char *prop, char *buf, int bufsize);
 180
 181 /* Does the passed node have the given "name"? YES=1 NO=0 */
 182 extern int prom_nodematch(phandle thisnode, char *name);
 183
 184 /* Search all siblings starting at the passed node for "name" matching
 185  * the given string.  Returns the node on success, zero on failure.
 186  */
 187 extern phandle prom_searchsiblings(phandle node_start, char *name);
 188
 189 /* Return the first property type, as a string, for the given node.
 190  * Returns a null string on error.
 191  */
 192 extern char *prom_firstprop(phandle node, char *buffer);
 193
 194 /* Returns the next property after the passed property for the given
 195  * node.  Returns null string on failure.
 196  */
 197 extern char *prom_nextprop(phandle node, char *prev_property, char *buffer);
 198
 199 /* Returns phandle of the path specified */
 200 extern phandle prom_finddevice(char *name);
 201
 202 /* Returns 1 if the specified node has given property. */
 203 extern int prom_node_has_property(phandle node, char *property);
 204
 205 /* Set the indicated property at the given node with the passed value.
 206  * Returns the number of bytes of your value that the prom took.
 207  */
 208 extern int prom_setprop(phandle node, const char *prop_name, char *prop_value,
 209                         int value_size);
 210
 211 extern phandle prom_inst2pkg(int);
 212
 213 /* Dorking with Bus ranges... */
 214
 215 /* Apply promlib probes OBIO ranges to registers. */
 216 extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
 217
 218 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
 219 extern void prom_apply_generic_ranges(phandle node, phandle parent,
 220                                       struct linux_prom_registers *sbusregs, int nregs);
 221
 222 /* CPU probing helpers.  */
 223 int cpu_find_by_instance(int instance, phandle *prom_node, int *mid);
 224 int cpu_find_by_mid(int mid, phandle *prom_node);
 225 int cpu_get_hwmid(phandle prom_node);
 226
 227 extern spinlock_t prom_lock;
 228
 229 #endif /* !(__SPARC_OPLIB_H) */