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 /* Miscellaneous routines, don't really fit in any category per se. */
  52
  53 /* Reboot the machine with the command line passed. */
  54 extern void prom_reboot(char *boot_command);
  55
  56 /* Evaluate the forth string passed. */
  57 extern void prom_feval(char *forth_string);
  58
  59 /* Enter the prom, with possibility of continuation with the 'go'
  60  * command in newer proms.
  61  */
  62 extern void prom_cmdline(void);
  63
  64 /* Enter the prom, with no chance of continuation for the stand-alone
  65  * which calls this.
  66  */
  67 extern void __noreturn prom_halt(void);
  68
  69 /* Set the PROM 'sync' callback function to the passed function pointer.
  70  * When the user gives the 'sync' command at the prom prompt while the
  71  * kernel is still active, the prom will call this routine.
  72  *
  73  * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
  74  */
  75 typedef void (*sync_func_t)(void);
  76 extern void prom_setsync(sync_func_t func_ptr);
  77
  78 /* Acquire the IDPROM of the root node in the prom device tree.  This
  79  * gets passed a buffer where you would like it stuffed.  The return value
  80  * is the format type of this idprom or 0xff on error.
  81  */
  82 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
  83
  84 /* Get the prom major version. */
  85 extern int prom_version(void);
  86
  87 /* Get the prom plugin revision. */
  88 extern int prom_getrev(void);
  89
  90 /* Get the prom firmware revision. */
  91 extern int prom_getprev(void);
  92
  93 /* Write a buffer of characters to the console. */
  94 extern void prom_console_write_buf(const char *buf, int len);
  95
  96 /* Prom's internal routines, don't use in kernel/boot code. */
  97 extern void prom_printf(const char *fmt, ...);
  98 extern void prom_write(const char *buf, unsigned int len);
  99
 100 /* Multiprocessor operations... */
 101
 102 /* Start the CPU with the given device tree node, context table, and context
 103  * at the passed program counter.
 104  */
 105 extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
 106                          int context, char *program_counter);
 107
 108 /* Sun4/sun4c specific memory-management startup hook. */
 109
 110 /* Map the passed segment in the given context at the passed
 111  * virtual address.
 112  */
 113 extern void prom_putsegment(int context, unsigned long virt_addr,
 114                             int physical_segment);
 115
 116 /* Initialize the memory lists based upon the prom version. */
 117 void prom_meminit(void);
 118
 119 /* PROM device tree traversal functions... */
 120
 121 /* Get the child node of the given node, or zero if no child exists. */
 122 extern phandle prom_getchild(phandle parent_node);
 123
 124 /* Get the next sibling node of the given node, or zero if no further
 125  * siblings exist.
 126  */
 127 extern phandle prom_getsibling(phandle node);
 128
 129 /* Get the length, at the passed node, of the given property type.
 130  * Returns -1 on error (ie. no such property at this node).
 131  */
 132 extern int prom_getproplen(phandle thisnode, const char *property);
 133
 134 /* Fetch the requested property using the given buffer.  Returns
 135  * the number of bytes the prom put into your buffer or -1 on error.
 136  */
 137 extern int __must_check prom_getproperty(phandle thisnode, const char *property,
 138                                          char *prop_buffer, int propbuf_size);
 139
 140 /* Acquire an integer property. */
 141 extern int prom_getint(phandle node, char *property);
 142
 143 /* Acquire an integer property, with a default value. */
 144 extern int prom_getintdefault(phandle node, char *property, int defval);
 145
 146 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
 147 extern int prom_getbool(phandle node, char *prop);
 148
 149 /* Acquire a string property, null string on error. */
 150 extern void prom_getstring(phandle node, char *prop, char *buf, int bufsize);
 151
 152 /* Search all siblings starting at the passed node for "name" matching
 153  * the given string.  Returns the node on success, zero on failure.
 154  */
 155 extern phandle prom_searchsiblings(phandle node_start, char *name);
 156
 157 /* Returns the next property after the passed property for the given
 158  * node.  Returns null string on failure.
 159  */
 160 extern char *prom_nextprop(phandle node, char *prev_property, char *buffer);
 161
 162 /* Returns phandle of the path specified */
 163 extern phandle prom_finddevice(char *name);
 164
 165 /* Set the indicated property at the given node with the passed value.
 166  * Returns the number of bytes of your value that the prom took.
 167  */
 168 extern int prom_setprop(phandle node, const char *prop_name, char *prop_value,
 169                         int value_size);
 170
 171 extern phandle prom_inst2pkg(int);
 172
 173 /* Dorking with Bus ranges... */
 174
 175 /* Apply promlib probes OBIO ranges to registers. */
 176 extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
 177
 178 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
 179 extern void prom_apply_generic_ranges(phandle node, phandle parent,
 180                                       struct linux_prom_registers *sbusregs, int nregs);
 181
 182 void prom_ranges_init(void);
 183
 184 /* CPU probing helpers.  */
 185 int cpu_find_by_instance(int instance, phandle *prom_node, int *mid);
 186 int cpu_find_by_mid(int mid, phandle *prom_node);
 187 int cpu_get_hwmid(phandle prom_node);
 188
 189 extern spinlock_t prom_lock;
 190
 191 #endif /* !(__SPARC_OPLIB_H) */