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