home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / src / linux-headers-2.6.17-6 / include / asm-sparc / oplib.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-08-11  |  10.4 KB  |  322 lines
  1. /* $Id: oplib.h,v 1.23 2001/12/21 00:54:31 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.  */
  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.         PROM_AP1000,  /* actually no prom at all */
  25.     PROM_SUN4,    /* Old sun4 proms are totally different, but we'll shoehorn it to make it fit */
  26. };
  27.  
  28. extern enum prom_major_version prom_vers;
  29. /* Revision, and firmware revision. */
  30. extern unsigned int prom_rev, prom_prev;
  31.  
  32. /* Root node of the prom device tree, this stays constant after
  33.  * initialization is complete.
  34.  */
  35. extern int prom_root_node;
  36.  
  37. /* PROM stdin and stdout */
  38. extern int prom_stdin, prom_stdout;
  39.  
  40. /* Pointer to prom structure containing the device tree traversal
  41.  * and usage utility functions.  Only prom-lib should use these,
  42.  * users use the interface defined by the library only!
  43.  */
  44. extern struct linux_nodeops *prom_nodeops;
  45.  
  46. /* The functions... */
  47.  
  48. /* You must call prom_init() before using any of the library services,
  49.  * preferably as early as possible.  Pass it the romvec pointer.
  50.  */
  51. extern void prom_init(struct linux_romvec *rom_ptr);
  52.  
  53. /* Boot argument acquisition, returns the boot command line string. */
  54. extern char *prom_getbootargs(void);
  55.  
  56. /* Device utilities. */
  57.  
  58. /* Map and unmap devices in IO space at virtual addresses. Note that the
  59.  * virtual address you pass is a request and the prom may put your mappings
  60.  * somewhere else, so check your return value as that is where your new
  61.  * mappings really are!
  62.  *
  63.  * Another note, these are only available on V2 or higher proms!
  64.  */
  65. extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes);
  66. extern void prom_unmapio(char *virt_addr, unsigned int num_bytes);
  67.  
  68. /* Device operations. */
  69.  
  70. /* Open the device described by the passed string.  Note, that the format
  71.  * of the string is different on V0 vs. V2->higher proms.  The caller must
  72.  * know what he/she is doing!  Returns the device descriptor, an int.
  73.  */
  74. extern int prom_devopen(char *device_string);
  75.  
  76. /* Close a previously opened device described by the passed integer
  77.  * descriptor.
  78.  */
  79. extern int prom_devclose(int device_handle);
  80.  
  81. /* Do a seek operation on the device described by the passed integer
  82.  * descriptor.
  83.  */
  84. extern void prom_seek(int device_handle, unsigned int seek_hival,
  85.               unsigned int seek_lowval);
  86.  
  87. /* Machine memory configuration routine. */
  88.  
  89. /* This function returns a V0 format memory descriptor table, it has three
  90.  * entries.  One for the total amount of physical ram on the machine, one
  91.  * for the amount of physical ram available, and one describing the virtual
  92.  * areas which are allocated by the prom.  So, in a sense the physical
  93.  * available is a calculation of the total physical minus the physical mapped
  94.  * by the prom with virtual mappings.
  95.  *
  96.  * These lists are returned pre-sorted, this should make your life easier
  97.  * since the prom itself is way too lazy to do such nice things.
  98.  */
  99. extern struct linux_mem_v0 *prom_meminfo(void);
  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(char *boot_command);
  105.  
  106. /* Evaluate the forth string passed. */
  107. extern void prom_feval(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. /* Set the PROM 'sync' callback function to the passed function pointer.
  120.  * When the user gives the 'sync' command at the prom prompt while the
  121.  * kernel is still active, the prom will call this routine.
  122.  *
  123.  * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
  124.  */
  125. typedef void (*sync_func_t)(void);
  126. extern void prom_setsync(sync_func_t func_ptr);
  127.  
  128. /* Acquire the IDPROM of the root node in the prom device tree.  This
  129.  * gets passed a buffer where you would like it stuffed.  The return value
  130.  * is the format type of this idprom or 0xff on error.
  131.  */
  132. extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
  133.  
  134. /* Get the prom major version. */
  135. extern int prom_version(void);
  136.  
  137. /* Get the prom plugin revision. */
  138. extern int prom_getrev(void);
  139.  
  140. /* Get the prom firmware revision. */
  141. extern int prom_getprev(void);
  142.  
  143. /* Character operations to/from the console.... */
  144.  
  145. /* Non-blocking get character from console. */
  146. extern int prom_nbgetchar(void);
  147.  
  148. /* Non-blocking put character to console. */
  149. extern int prom_nbputchar(char character);
  150.  
  151. /* Blocking get character from console. */
  152. extern char prom_getchar(void);
  153.  
  154. /* Blocking put character to console. */
  155. extern void prom_putchar(char character);
  156.  
  157. /* Prom's internal routines, don't use in kernel/boot code. */
  158. extern void prom_printf(char *fmt, ...);
  159. extern void prom_write(const char *buf, unsigned int len);
  160.  
  161. /* Query for input device type */
  162.  
  163. enum prom_input_device {
  164.     PROMDEV_IKBD,            /* input from keyboard */
  165.     PROMDEV_ITTYA,            /* input from ttya */
  166.     PROMDEV_ITTYB,            /* input from ttyb */
  167.     PROMDEV_IRSC,            /* input from rsc */
  168.     PROMDEV_IVCONS,            /* input from virtual-console */
  169.     PROMDEV_I_UNK,
  170. };
  171.  
  172. extern enum prom_input_device prom_query_input_device(void);
  173.  
  174. /* Query for output device type */
  175.  
  176. enum prom_output_device {
  177.     PROMDEV_OSCREEN,        /* to screen */
  178.     PROMDEV_OTTYA,            /* to ttya */
  179.     PROMDEV_OTTYB,            /* to ttyb */
  180.     PROMDEV_ORSC,            /* to rsc */
  181.     PROMDEV_OVCONS,            /* to virtual-console */
  182.     PROMDEV_O_UNK,
  183. };
  184.  
  185. extern enum prom_output_device prom_query_output_device(void);
  186.  
  187. /* Multiprocessor operations... */
  188.  
  189. /* Start the CPU with the given device tree node, context table, and context
  190.  * at the passed program counter.
  191.  */
  192. extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
  193.              int context, char *program_counter);
  194.  
  195. /* Stop the CPU with the passed device tree node. */
  196. extern int prom_stopcpu(int cpunode);
  197.  
  198. /* Idle the CPU with the passed device tree node. */
  199. extern int prom_idlecpu(int cpunode);
  200.  
  201. /* Re-Start the CPU with the passed device tree node. */
  202. extern int prom_restartcpu(int cpunode);
  203.  
  204. /* PROM memory allocation facilities... */
  205.  
  206. /* Allocated at possibly the given virtual address a chunk of the
  207.  * indicated size.
  208.  */
  209. extern char *prom_alloc(char *virt_hint, unsigned int size);
  210.  
  211. /* Free a previously allocated chunk. */
  212. extern void prom_free(char *virt_addr, unsigned int size);
  213.  
  214. /* Sun4/sun4c specific memory-management startup hook. */
  215.  
  216. /* Map the passed segment in the given context at the passed
  217.  * virtual address.
  218.  */
  219. extern void prom_putsegment(int context, unsigned long virt_addr,
  220.                 int physical_segment);
  221.  
  222.  
  223. /* PROM device tree traversal functions... */
  224.  
  225. #ifdef PROMLIB_INTERNAL
  226.  
  227. /* Internal version of prom_getchild. */
  228. extern int __prom_getchild(int parent_node);
  229.  
  230. /* Internal version of prom_getsibling. */
  231. extern int __prom_getsibling(int node);
  232.  
  233. #endif
  234.  
  235.  
  236. /* Get the child node of the given node, or zero if no child exists. */
  237. extern int prom_getchild(int parent_node);
  238.  
  239. /* Get the next sibling node of the given node, or zero if no further
  240.  * siblings exist.
  241.  */
  242. extern int prom_getsibling(int node);
  243.  
  244. /* Get the length, at the passed node, of the given property type.
  245.  * Returns -1 on error (ie. no such property at this node).
  246.  */
  247. extern int prom_getproplen(int thisnode, char *property);
  248.  
  249. /* Fetch the requested property using the given buffer.  Returns
  250.  * the number of bytes the prom put into your buffer or -1 on error.
  251.  */
  252. extern int __must_check prom_getproperty(int thisnode, char *property,
  253.                      char *prop_buffer, int propbuf_size);
  254.  
  255. /* Acquire an integer property. */
  256. extern int prom_getint(int node, char *property);
  257.  
  258. /* Acquire an integer property, with a default value. */
  259. extern int prom_getintdefault(int node, char *property, int defval);
  260.  
  261. /* Acquire a boolean property, 0=FALSE 1=TRUE. */
  262. extern int prom_getbool(int node, char *prop);
  263.  
  264. /* Acquire a string property, null string on error. */
  265. extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
  266.  
  267. /* Does the passed node have the given "name"? YES=1 NO=0 */
  268. extern int prom_nodematch(int thisnode, char *name);
  269.  
  270. /* Puts in buffer a prom name in the form name@x,y or name (x for which_io 
  271.  * and y for first regs phys address
  272.  */
  273. extern int prom_getname(int node, char *buf, int buflen);
  274.  
  275. /* Search all siblings starting at the passed node for "name" matching
  276.  * the given string.  Returns the node on success, zero on failure.
  277.  */
  278. extern int prom_searchsiblings(int node_start, char *name);
  279.  
  280. /* Return the first property type, as a string, for the given node.
  281.  * Returns a null string on error.
  282.  */
  283. extern char *prom_firstprop(int node, char *buffer);
  284.  
  285. /* Returns the next property after the passed property for the given
  286.  * node.  Returns null string on failure.
  287.  */
  288. extern char *prom_nextprop(int node, char *prev_property, char *buffer);
  289.  
  290. /* Returns phandle of the path specified */
  291. extern int prom_finddevice(char *name);
  292.  
  293. /* Returns 1 if the specified node has given property. */
  294. extern int prom_node_has_property(int node, char *property);
  295.  
  296. /* Set the indicated property at the given node with the passed value.
  297.  * Returns the number of bytes of your value that the prom took.
  298.  */
  299. extern int prom_setprop(int node, char *prop_name, char *prop_value,
  300.             int value_size);
  301.             
  302. extern int prom_pathtoinode(char *path);
  303. extern int prom_inst2pkg(int);
  304.  
  305. /* Dorking with Bus ranges... */
  306.  
  307. /* Apply promlib probes OBIO ranges to registers. */
  308. extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
  309.  
  310. /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
  311. extern void prom_apply_generic_ranges(int node, int parent, 
  312.                       struct linux_prom_registers *sbusregs, int nregs);
  313.  
  314. /* CPU probing helpers.  */
  315. int cpu_find_by_instance(int instance, int *prom_node, int *mid);
  316. int cpu_find_by_mid(int mid, int *prom_node);
  317. int cpu_get_hwmid(int prom_node);
  318.  
  319. extern spinlock_t prom_lock;
  320.  
  321. #endif /* !(__SPARC_OPLIB_H) */
  322.