oplib.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:10k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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