oplib.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:11k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

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