include/asm-sparc64/oplib.h

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