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
5 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
6 * Copyright (C) 1996 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
9 #ifndef __SPARC64_OPLIB_H
10 #define __SPARC64_OPLIB_H
12 #include <linux/config.h>
13 #include <asm/openprom.h>
15 /* OBP version string. */
16 extern char prom_version[];
18 /* Root node of the prom device tree, this stays constant after
19 * initialization is complete.
21 extern int prom_root_node;
23 /* PROM stdin and stdout */
24 extern int prom_stdin, prom_stdout;
26 /* /chosen node of the prom device tree, this stays constant after
27 * initialization is complete.
29 extern int prom_chosen_node;
31 /* Helper values and strings in arch/sparc64/kernel/head.S */
32 extern const char prom_peer_name[];
33 extern const char prom_compatible_name[];
34 extern const char prom_root_compatible[];
35 extern const char prom_finddev_name[];
36 extern const char prom_chosen_path[];
37 extern const char prom_getprop_name[];
38 extern const char prom_mmu_name[];
39 extern const char prom_callmethod_name[];
40 extern const char prom_translate_name[];
41 extern const char prom_map_name[];
42 extern const char prom_unmap_name[];
43 extern int prom_mmu_ihandle_cache;
44 extern unsigned int prom_boot_mapped_pc;
45 extern unsigned int prom_boot_mapping_mode;
46 extern unsigned long prom_boot_mapping_phys_high, prom_boot_mapping_phys_low;
48 struct linux_mlist_p1275 {
49 struct linux_mlist_p1275 *theres_more;
50 unsigned long start_adr;
51 unsigned long num_bytes;
54 struct linux_mem_p1275 {
55 struct linux_mlist_p1275 **p1275_totphys;
56 struct linux_mlist_p1275 **p1275_prommap;
57 struct linux_mlist_p1275 **p1275_available; /* What we can use */
60 /* The functions... */
62 /* You must call prom_init() before using any of the library services,
63 * preferably as early as possible. Pass it the romvec pointer.
65 extern void prom_init(void *cif_handler, void *cif_stack);
67 /* Boot argument acquisition, returns the boot command line string. */
68 extern char *prom_getbootargs(void);
70 /* Device utilities. */
72 /* Device operations. */
74 /* Open the device described by the passed string. Note, that the format
75 * of the string is different on V0 vs. V2->higher proms. The caller must
76 * know what he/she is doing! Returns the device descriptor, an int.
78 extern int prom_devopen(const char *device_string);
80 /* Close a previously opened device described by the passed integer
83 extern int prom_devclose(int device_handle);
85 /* Do a seek operation on the device described by the passed integer
88 extern void prom_seek(int device_handle, unsigned int seek_hival,
89 unsigned int seek_lowval);
91 /* Miscellaneous routines, don't really fit in any category per se. */
93 /* Reboot the machine with the command line passed. */
94 extern void prom_reboot(const char *boot_command);
96 /* Evaluate the forth string passed. */
97 extern void prom_feval(const char *forth_string);
99 /* Enter the prom, with possibility of continuation with the 'go'
100 * command in newer proms.
102 extern void prom_cmdline(void);
104 /* Enter the prom, with no chance of continuation for the stand-alone
107 extern void prom_halt(void) __attribute__ ((noreturn));
109 /* Halt and power-off the machine. */
110 extern void prom_halt_power_off(void) __attribute__ ((noreturn));
112 /* Set the PROM 'sync' callback function to the passed function pointer.
113 * When the user gives the 'sync' command at the prom prompt while the
114 * kernel is still active, the prom will call this routine.
117 typedef int (*callback_func_t)(long *cmd);
118 extern void prom_setcallback(callback_func_t func_ptr);
120 /* Acquire the IDPROM of the root node in the prom device tree. This
121 * gets passed a buffer where you would like it stuffed. The return value
122 * is the format type of this idprom or 0xff on error.
124 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
126 /* Character operations to/from the console.... */
128 /* Non-blocking get character from console. */
129 extern int prom_nbgetchar(void);
131 /* Non-blocking put character to console. */
132 extern int prom_nbputchar(char character);
134 /* Blocking get character from console. */
135 extern char prom_getchar(void);
137 /* Blocking put character to console. */
138 extern void prom_putchar(char character);
140 /* Prom's internal routines, don't use in kernel/boot code. */
141 extern void prom_printf(const char *fmt, ...);
142 extern void prom_write(const char *buf, unsigned int len);
144 /* Query for input device type */
146 enum prom_input_device {
147 PROMDEV_IKBD, /* input from keyboard */
148 PROMDEV_ITTYA, /* input from ttya */
149 PROMDEV_ITTYB, /* input from ttyb */
150 PROMDEV_IRSC, /* input from rsc */
151 PROMDEV_IVCONS, /* input from virtual-console */
155 extern enum prom_input_device prom_query_input_device(void);
157 /* Query for output device type */
159 enum prom_output_device {
160 PROMDEV_OSCREEN, /* to screen */
161 PROMDEV_OTTYA, /* to ttya */
162 PROMDEV_OTTYB, /* to ttyb */
163 PROMDEV_ORSC, /* to rsc */
164 PROMDEV_OVCONS, /* to virtual-console */
168 extern enum prom_output_device prom_query_output_device(void);
170 /* Multiprocessor operations... */
172 /* Start the CPU with the given device tree node at the passed program
173 * counter with the given arg passed in via register %o0.
175 extern void prom_startcpu(int cpunode, unsigned long pc, unsigned long arg);
177 /* Start the CPU with the given cpu ID at the passed program
178 * counter with the given arg passed in via register %o0.
180 extern void prom_startcpu_cpuid(int cpuid, unsigned long pc, unsigned long arg);
182 /* Stop the CPU with the given cpu ID. */
183 extern void prom_stopcpu_cpuid(int cpuid);
185 /* Stop the current CPU. */
186 extern void prom_stopself(void);
188 /* Idle the current CPU. */
189 extern void prom_idleself(void);
191 /* Resume the CPU with the passed device tree node. */
192 extern void prom_resumecpu(int cpunode);
195 /* Power management interfaces. */
197 /* Put the current CPU to sleep. */
198 extern void prom_sleepself(void);
200 /* Put the entire system to sleep. */
201 extern int prom_sleepsystem(void);
203 /* Initiate a wakeup event. */
204 extern int prom_wakeupsystem(void);
206 /* MMU and memory related OBP interfaces. */
208 /* Get unique string identifying SIMM at given physical address. */
209 extern int prom_getunumber(int syndrome_code,
210 unsigned long phys_addr,
211 char *buf, int buflen);
213 /* Retain physical memory to the caller across soft resets. */
214 extern unsigned long prom_retain(const char *name,
215 unsigned long pa_low, unsigned long pa_high,
216 long size, long align);
218 /* Load explicit I/D TLB entries into the calling processor. */
219 extern long prom_itlb_load(unsigned long index,
220 unsigned long tte_data,
221 unsigned long vaddr);
223 extern long prom_dtlb_load(unsigned long index,
224 unsigned long tte_data,
225 unsigned long vaddr);
227 /* Map/Unmap client program address ranges. First the format of
228 * the mapping mode argument.
230 #define PROM_MAP_WRITE 0x0001 /* Writable */
231 #define PROM_MAP_READ 0x0002 /* Readable - sw */
232 #define PROM_MAP_EXEC 0x0004 /* Executable - sw */
233 #define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */
234 #define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */
235 #define PROM_MAP_SE 0x0040 /* Side-Effects */
236 #define PROM_MAP_GLOB 0x0080 /* Global */
237 #define PROM_MAP_IE 0x0100 /* Invert-Endianness */
238 #define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED)
240 extern int prom_map(int mode, unsigned long size,
241 unsigned long vaddr, unsigned long paddr);
242 extern void prom_unmap(unsigned long size, unsigned long vaddr);
245 /* PROM device tree traversal functions... */
247 #ifdef PROMLIB_INTERNAL
249 /* Internal version of prom_getchild. */
250 extern int __prom_getchild(int parent_node);
252 /* Internal version of prom_getsibling. */
253 extern int __prom_getsibling(int node);
257 /* Get the child node of the given node, or zero if no child exists. */
258 extern int prom_getchild(int parent_node);
260 /* Get the next sibling node of the given node, or zero if no further
263 extern int prom_getsibling(int node);
265 /* Get the length, at the passed node, of the given property type.
266 * Returns -1 on error (ie. no such property at this node).
268 extern int prom_getproplen(int thisnode, const char *property);
270 /* Fetch the requested property using the given buffer. Returns
271 * the number of bytes the prom put into your buffer or -1 on error.
273 extern int prom_getproperty(int thisnode, const char *property,
274 char *prop_buffer, int propbuf_size);
276 /* Acquire an integer property. */
277 extern int prom_getint(int node, const char *property);
279 /* Acquire an integer property, with a default value. */
280 extern int prom_getintdefault(int node, const char *property, int defval);
282 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
283 extern int prom_getbool(int node, const char *prop);
285 /* Acquire a string property, null string on error. */
286 extern void prom_getstring(int node, const char *prop, char *buf, int bufsize);
288 /* Does the passed node have the given "name"? YES=1 NO=0 */
289 extern int prom_nodematch(int thisnode, const char *name);
291 /* Puts in buffer a prom name in the form name@x,y or name (x for which_io
292 * and y for first regs phys address
294 extern int prom_getname(int node, char *buf, int buflen);
296 /* Search all siblings starting at the passed node for "name" matching
297 * the given string. Returns the node on success, zero on failure.
299 extern int prom_searchsiblings(int node_start, const char *name);
301 /* Return the first property type, as a string, for the given node.
302 * Returns a null string on error. Buffer should be at least 32B long.
304 extern char *prom_firstprop(int node, char *buffer);
306 /* Returns the next property after the passed property for the given
307 * node. Returns null string on failure. Buffer should be at least 32B long.
309 extern char *prom_nextprop(int node, const char *prev_property, char *buffer);
311 /* Returns 1 if the specified node has given property. */
312 extern int prom_node_has_property(int node, const char *property);
314 /* Returns phandle of the path specified */
315 extern int prom_finddevice(const char *name);
317 /* Set the indicated property at the given node with the passed value.
318 * Returns the number of bytes of your value that the prom took.
320 extern int prom_setprop(int node, const char *prop_name, char *prop_value,
323 extern int prom_pathtoinode(const char *path);
324 extern int prom_inst2pkg(int);
326 /* CPU probing helpers. */
327 int cpu_find_by_instance(int instance, int *prom_node, int *mid);
328 int cpu_find_by_mid(int mid, int *prom_node);
330 /* Client interface level routines. */
331 extern void prom_set_trap_table(unsigned long tba);
332 extern void prom_set_trap_table_sun4v(unsigned long tba, unsigned long mmfsa);
334 extern long p1275_cmd(const char *, long, ...);
338 #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x))
340 #define P1275_SIZE(x) x
343 /* We support at most 16 input and 1 output argument */
344 #define P1275_ARG_NUMBER 0
345 #define P1275_ARG_IN_STRING 1
346 #define P1275_ARG_OUT_BUF 2
347 #define P1275_ARG_OUT_32B 3
348 #define P1275_ARG_IN_FUNCTION 4
349 #define P1275_ARG_IN_BUF 5
350 #define P1275_ARG_IN_64B 6
352 #define P1275_IN(x) ((x) & 0xf)
353 #define P1275_OUT(x) (((x) << 4) & 0xf0)
354 #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o))
355 #define P1275_ARG(n,x) ((x) << ((n)*3 + 8))
357 #endif /* !(__SPARC64_OPLIB_H) */