include/asm-sparc64/oplib.h

   1 /* $Id: oplib.h,v 1.11 1999/08/31 19:25:49 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 <asm/openprom.h>
  13
  14 /* Enumeration to describe the prom major version we have detected. */
  15 enum prom_major_version {
  16         PROM_V0,      /* Original sun4c V0 prom */
  17         PROM_V2,      /* sun4c and early sun4m V2 prom */
  18         PROM_V3,      /* sun4m and later, up to sun4d/sun4e machines V3 */
  19         PROM_P1275,   /* IEEE compliant ISA based Sun PROM, only sun4u */
  20         PROM_AP1000,  /* actually no prom at all */
  21 };
  22
  23 extern enum prom_major_version prom_vers;
  24 /* Revision, and firmware revision. */
  25 extern unsigned int prom_rev, prom_prev;
  26
  27 /* Root node of the prom device tree, this stays constant after
  28  * initialization is complete.
  29  */
  30 extern int prom_root_node;
  31
  32 /* PROM stdin and stdout */
  33 extern int prom_stdin, prom_stdout;
  34
  35 /* /chosen node of the prom device tree, this stays constant after
  36  * initialization is complete.
  37  */
  38 extern int prom_chosen_node;
  39
  40 struct linux_mlist_p1275 {
  41         struct linux_mlist_p1275 *theres_more;
  42         unsigned long start_adr;
  43         unsigned long num_bytes;
  44 };
  45
  46 struct linux_mem_p1275 {
  47         struct linux_mlist_p1275 **p1275_totphys;
  48         struct linux_mlist_p1275 **p1275_prommap;
  49         struct linux_mlist_p1275 **p1275_available; /* What we can use */
  50 };
  51
  52 /* The functions... */
  53
  54 /* You must call prom_init() before using any of the library services,
  55  * preferably as early as possible.  Pass it the romvec pointer.
  56  */
  57 extern void prom_init(void *cif_handler, void *cif_stack);
  58
  59 /* Boot argument acquisition, returns the boot command line string. */
  60 extern char *prom_getbootargs(void);
  61
  62 /* Device utilities. */
  63
  64 /* Device operations. */
  65
  66 /* Open the device described by the passed string.  Note, that the format
  67  * of the string is different on V0 vs. V2->higher proms.  The caller must
  68  * know what he/she is doing!  Returns the device descriptor, an int.
  69  */
  70 extern int prom_devopen(char *device_string);
  71
  72 /* Close a previously opened device described by the passed integer
  73  * descriptor.
  74  */
  75 extern int prom_devclose(int device_handle);
  76
  77 /* Do a seek operation on the device described by the passed integer
  78  * descriptor.
  79  */
  80 extern void prom_seek(int device_handle, unsigned int seek_hival,
  81                       unsigned int seek_lowval);
  82
  83 /* Machine memory configuration routine. */
  84
  85 /* This function returns a V0 format memory descriptor table, it has three
  86  * entries.  One for the total amount of physical ram on the machine, one
  87  * for the amount of physical ram available, and one describing the virtual
  88  * areas which are allocated by the prom.  So, in a sense the physical
  89  * available is a calculation of the total physical minus the physical mapped
  90  * by the prom with virtual mappings.
  91  *
  92  * These lists are returned pre-sorted, this should make your life easier
  93  * since the prom itself is way too lazy to do such nice things.
  94  */
  95 extern struct linux_mem_p1275 *prom_meminfo(void);
  96
  97 /* Miscellaneous routines, don't really fit in any category per se. */
  98
  99 /* Reboot the machine with the command line passed. */
 100 extern void prom_reboot(char *boot_command);
 101
 102 /* Evaluate the forth string passed. */
 103 extern void prom_feval(char *forth_string);
 104
 105 /* Enter the prom, with possibility of continuation with the 'go'
 106  * command in newer proms.
 107  */
 108 extern void prom_cmdline(void);
 109
 110 /* Enter the prom, with no chance of continuation for the stand-alone
 111  * which calls this.
 112  */
 113 extern void prom_halt(void) __attribute__ ((noreturn));
 114
 115 /* Set the PROM 'sync' callback function to the passed function pointer.
 116  * When the user gives the 'sync' command at the prom prompt while the
 117  * kernel is still active, the prom will call this routine.
 118  *
 119  */
 120 typedef int (*callback_func_t)(long *cmd);
 121 extern void prom_setcallback(callback_func_t func_ptr);
 122
 123 /* Acquire the IDPROM of the root node in the prom device tree.  This
 124  * gets passed a buffer where you would like it stuffed.  The return value
 125  * is the format type of this idprom or 0xff on error.
 126  */
 127 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
 128
 129 /* Get the prom major version. */
 130 extern int prom_version(void);
 131
 132 /* Get the prom plugin revision. */
 133 extern int prom_getrev(void);
 134
 135 /* Get the prom firmware revision. */
 136 extern int prom_getprev(void);
 137
 138 /* Character operations to/from the console.... */
 139
 140 /* Non-blocking get character from console. */
 141 extern int prom_nbgetchar(void);
 142
 143 /* Non-blocking put character to console. */
 144 extern int prom_nbputchar(char character);
 145
 146 /* Blocking get character from console. */
 147 extern char prom_getchar(void);
 148
 149 /* Blocking put character to console. */
 150 extern void prom_putchar(char character);
 151
 152 /* Prom's internal printf routine, don't use in kernel/boot code. */
 153 void prom_printf(char *fmt, ...);
 154
 155 /* Query for input device type */
 156
 157 enum prom_input_device {
 158         PROMDEV_IKBD,                   /* input from keyboard */
 159         PROMDEV_ITTYA,                  /* input from ttya */
 160         PROMDEV_ITTYB,                  /* input from ttyb */
 161         PROMDEV_I_UNK,
 162 };
 163
 164 extern enum prom_input_device prom_query_input_device(void);
 165
 166 /* Query for output device type */
 167
 168 enum prom_output_device {
 169         PROMDEV_OSCREEN,                /* to screen */
 170         PROMDEV_OTTYA,                  /* to ttya */
 171         PROMDEV_OTTYB,                  /* to ttyb */
 172         PROMDEV_O_UNK,
 173 };
 174
 175 extern enum prom_output_device prom_query_output_device(void);
 176
 177 /* Multiprocessor operations... */
 178 #ifdef __SMP__
 179 /* Start the CPU with the given device tree node, context table, and context
 180  * at the passed program counter.
 181  */
 182 extern void prom_startcpu(int cpunode, unsigned long pc, unsigned long o0);
 183
 184 /* Stop the current CPU. */
 185 extern void prom_stopself(void);
 186
 187 /* Idle the current CPU. */
 188 extern void prom_idleself(void);
 189
 190 /* Resume the CPU with the passed device tree node. */
 191 extern void prom_resumecpu(int cpunode);
 192 #endif
 193
 194 /* Power management interfaces. */
 195
 196 /* Put the current CPU to sleep. */
 197 extern void prom_sleepself(void);
 198
 199 /* Put the entire system to sleep. */
 200 extern int prom_sleepsystem(void);
 201
 202 /* Initiate a wakeup event. */
 203 extern int prom_wakeupsystem(void);
 204
 205 /* MMU and memory related OBP interfaces. */
 206
 207 /* Get unique string identifying SIMM at given physical address. */
 208 extern int prom_getunumber(int syndrome_code,
 209                            unsigned long phys_addr,
 210                            char *buf, int buflen);
 211
 212 /* Retain physical memory to the caller across soft resets. */
 213 extern unsigned long prom_retain(char *name,
 214                                  unsigned long pa_low, unsigned long pa_high,
 215                                  long size, long align);
 216
 217 /* Load explicit I/D TLB entries into the calling processor. */
 218 extern long prom_itlb_load(unsigned long index,
 219                            unsigned long tte_data,
 220                            unsigned long vaddr);
 221
 222 extern long prom_dtlb_load(unsigned long index,
 223                            unsigned long tte_data,
 224                            unsigned long vaddr);
 225
 226 /* PROM device tree traversal functions... */
 227
 228 #ifdef PROMLIB_INTERNAL
 229
 230 /* Internal version of prom_getchild. */
 231 extern int __prom_getchild(int parent_node);
 232
 233 /* Internal version of prom_getsibling. */
 234 extern int __prom_getsibling(int node);
 235
 236 #endif
 237
 238 /* Get the child node of the given node, or zero if no child exists. */
 239 extern int prom_getchild(int parent_node);
 240
 241 /* Get the next sibling node of the given node, or zero if no further
 242  * siblings exist.
 243  */
 244 extern int prom_getsibling(int node);
 245
 246 /* Get the length, at the passed node, of the given property type.
 247  * Returns -1 on error (ie. no such property at this node).
 248  */
 249 extern int prom_getproplen(int thisnode, char *property);
 250
 251 /* Fetch the requested property using the given buffer.  Returns
 252  * the number of bytes the prom put into your buffer or -1 on error.
 253  */
 254 extern int prom_getproperty(int thisnode, char *property,
 255                             char *prop_buffer, int propbuf_size);
 256
 257 /* Acquire an integer property. */
 258 extern int prom_getint(int node, char *property);
 259
 260 /* Acquire an integer property, with a default value. */
 261 extern int prom_getintdefault(int node, char *property, int defval);
 262
 263 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
 264 extern int prom_getbool(int node, char *prop);
 265
 266 /* Acquire a string property, null string on error. */
 267 extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
 268
 269 /* Does the passed node have the given "name"? YES=1 NO=0 */
 270 extern int prom_nodematch(int thisnode, char *name);
 271
 272 /* Puts in buffer a prom name in the form name@x,y or name (x for which_io
 273  * and y for first regs phys address
 274  */
 275 extern int prom_getname(int node, char *buf, int buflen);
 276
 277 /* Search all siblings starting at the passed node for "name" matching
 278  * the given string.  Returns the node on success, zero on failure.
 279  */
 280 extern int prom_searchsiblings(int node_start, char *name);
 281
 282 /* Return the first property type, as a string, for the given node.
 283  * Returns a null string on error. Buffer should be at least 32B long.
 284  */
 285 extern char *prom_firstprop(int node, char *buffer);
 286
 287 /* Returns the next property after the passed property for the given
 288  * node.  Returns null string on failure. Buffer should be at least 32B long.
 289  */
 290 extern char *prom_nextprop(int node, char *prev_property, char *buffer);
 291
 292 /* Returns 1 if the specified node has given property. */
 293 extern int prom_node_has_property(int node, char *property);
 294
 295 /* Returns phandle of the path specified */
 296 extern int prom_finddevice(char *name);
 297
 298 /* Set the indicated property at the given node with the passed value.
 299  * Returns the number of bytes of your value that the prom took.
 300  */
 301 extern int prom_setprop(int node, char *prop_name, char *prop_value,
 302                         int value_size);
 303
 304 extern int prom_pathtoinode(char *path);
 305 extern int prom_inst2pkg(int);
 306
 307 /* Client interface level routines. */
 308 extern void prom_set_trap_table(unsigned long tba);
 309
 310 /* Dorking with Bus ranges... */
 311
 312 /* Adjust reg values with the passed ranges. */
 313 extern void prom_adjust_regs(struct linux_prom_registers *regp, int nregs,
 314                              struct linux_prom_ranges *rangep, int nranges);
 315
 316 /* Adjust child ranges with the passed parent ranges. */
 317 extern void prom_adjust_ranges(struct linux_prom_ranges *cranges, int ncranges,
 318                                struct linux_prom_ranges *pranges, int npranges);
 319
 320 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
 321 extern void prom_apply_generic_ranges(int node, int parent,
 322                                       struct linux_prom_registers *sbusregs, int nregs);
 323
 324 extern long p1275_cmd (char *, long, ...);
 325
 326
 327 #if 0
 328 #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x))
 329 #else
 330 #define P1275_SIZE(x) x
 331 #endif
 332
 333 /* We support at most 16 input and 1 output argument */
 334 #define P1275_ARG_NUMBER                0
 335 #define P1275_ARG_IN_STRING             1
 336 #define P1275_ARG_OUT_BUF               2
 337 #define P1275_ARG_OUT_32B               3
 338 #define P1275_ARG_IN_FUNCTION           4
 339 #define P1275_ARG_IN_BUF                5
 340 #define P1275_ARG_IN_64B                6
 341
 342 #define P1275_IN(x) ((x) & 0xf)
 343 #define P1275_OUT(x) (((x) << 4) & 0xf0)
 344 #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o))
 345 #define P1275_ARG(n,x) ((x) << ((n)*3 + 8))
 346
 347 #endif /* !(__SPARC64_OPLIB_H) */