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 /* Enumeration to describe the prom major version we have detected. */
16 enum prom_major_version {
17 PROM_V0, /* Original sun4c V0 prom */
18 PROM_V2, /* sun4c and early sun4m V2 prom */
19 PROM_V3, /* sun4m and later, up to sun4d/sun4e machines V3 */
20 PROM_P1275, /* IEEE compliant ISA based Sun PROM, only sun4u */
21 PROM_AP1000, /* actually no prom at all */
24 extern enum prom_major_version prom_vers;
25 /* Revision, and firmware revision. */
26 extern unsigned int prom_rev, prom_prev;
28 /* Root node of the prom device tree, this stays constant after
29 * initialization is complete.
31 extern int prom_root_node;
33 /* PROM stdin and stdout */
34 extern int prom_stdin, prom_stdout;
36 /* /chosen node of the prom device tree, this stays constant after
37 * initialization is complete.
39 extern int prom_chosen_node;
41 /* Helper values and strings in arch/sparc64/kernel/head.S */
42 extern const char prom_finddev_name[];
43 extern const char prom_chosen_path[];
44 extern const char prom_getprop_name[];
45 extern const char prom_mmu_name[];
46 extern const char prom_callmethod_name[];
47 extern const char prom_translate_name[];
48 extern const char prom_map_name[];
49 extern const char prom_unmap_name[];
50 extern int prom_mmu_ihandle_cache;
51 extern unsigned int prom_boot_mapped_pc;
52 extern unsigned int prom_boot_mapping_mode;
53 extern unsigned long prom_boot_mapping_phys_high, prom_boot_mapping_phys_low;
55 struct linux_mlist_p1275 {
56 struct linux_mlist_p1275 *theres_more;
57 unsigned long start_adr;
58 unsigned long num_bytes;
61 struct linux_mem_p1275 {
62 struct linux_mlist_p1275 **p1275_totphys;
63 struct linux_mlist_p1275 **p1275_prommap;
64 struct linux_mlist_p1275 **p1275_available; /* What we can use */
67 /* The functions... */
69 /* You must call prom_init() before using any of the library services,
70 * preferably as early as possible. Pass it the romvec pointer.
72 extern void prom_init(void *cif_handler, void *cif_stack);
74 /* Boot argument acquisition, returns the boot command line string. */
75 extern char *prom_getbootargs(void);
77 /* Device utilities. */
79 /* Device operations. */
81 /* Open the device described by the passed string. Note, that the format
82 * of the string is different on V0 vs. V2->higher proms. The caller must
83 * know what he/she is doing! Returns the device descriptor, an int.
85 extern int prom_devopen(const char *device_string);
87 /* Close a previously opened device described by the passed integer
90 extern int prom_devclose(int device_handle);
92 /* Do a seek operation on the device described by the passed integer
95 extern void prom_seek(int device_handle, unsigned int seek_hival,
96 unsigned int seek_lowval);
98 /* Machine memory configuration routine. */
100 /* This function returns a V0 format memory descriptor table, it has three
101 * entries. One for the total amount of physical ram on the machine, one
102 * for the amount of physical ram available, and one describing the virtual
103 * areas which are allocated by the prom. So, in a sense the physical
104 * available is a calculation of the total physical minus the physical mapped
105 * by the prom with virtual mappings.
107 * These lists are returned pre-sorted, this should make your life easier
108 * since the prom itself is way too lazy to do such nice things.
110 extern struct linux_mem_p1275 *prom_meminfo(void);
112 /* Miscellaneous routines, don't really fit in any category per se. */
114 /* Reboot the machine with the command line passed. */
115 extern void prom_reboot(const char *boot_command);
117 /* Evaluate the forth string passed. */
118 extern void prom_feval(const char *forth_string);
120 /* Enter the prom, with possibility of continuation with the 'go'
121 * command in newer proms.
123 extern void prom_cmdline(void);
125 /* Enter the prom, with no chance of continuation for the stand-alone
128 extern void prom_halt(void) __attribute__ ((noreturn));
130 /* Halt and power-off the machine. */
131 extern void prom_halt_power_off(void) __attribute__ ((noreturn));
133 /* Set the PROM 'sync' callback function to the passed function pointer.
134 * When the user gives the 'sync' command at the prom prompt while the
135 * kernel is still active, the prom will call this routine.
138 typedef int (*callback_func_t)(long *cmd);
139 extern void prom_setcallback(callback_func_t func_ptr);
141 /* Acquire the IDPROM of the root node in the prom device tree. This
142 * gets passed a buffer where you would like it stuffed. The return value
143 * is the format type of this idprom or 0xff on error.
145 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
147 /* Get the prom major version. */
148 extern int prom_version(void);
150 /* Get the prom plugin revision. */
151 extern int prom_getrev(void);
153 /* Get the prom firmware revision. */
154 extern int prom_getprev(void);
156 /* Character operations to/from the console.... */
158 /* Non-blocking get character from console. */
159 extern int prom_nbgetchar(void);
161 /* Non-blocking put character to console. */
162 extern int prom_nbputchar(char character);
164 /* Blocking get character from console. */
165 extern char prom_getchar(void);
167 /* Blocking put character to console. */
168 extern void prom_putchar(char character);
170 /* Prom's internal routines, don't use in kernel/boot code. */
171 extern void prom_printf(const char *fmt, ...);
172 extern void prom_write(const char *buf, unsigned int len);
174 /* Query for input device type */
176 enum prom_input_device {
177 PROMDEV_IKBD, /* input from keyboard */
178 PROMDEV_ITTYA, /* input from ttya */
179 PROMDEV_ITTYB, /* input from ttyb */
183 extern enum prom_input_device prom_query_input_device(void);
185 /* Query for output device type */
187 enum prom_output_device {
188 PROMDEV_OSCREEN, /* to screen */
189 PROMDEV_OTTYA, /* to ttya */
190 PROMDEV_OTTYB, /* to ttyb */
194 extern enum prom_output_device prom_query_output_device(void);
196 /* Multiprocessor operations... */
198 /* Start the CPU with the given device tree node, context table, and context
199 * at the passed program counter.
201 extern void prom_startcpu(int cpunode, unsigned long pc, unsigned long o0);
203 /* Stop the current CPU. */
204 extern void prom_stopself(void);
206 /* Idle the current CPU. */
207 extern void prom_idleself(void);
209 /* Resume the CPU with the passed device tree node. */
210 extern void prom_resumecpu(int cpunode);
213 /* Power management interfaces. */
215 /* Put the current CPU to sleep. */
216 extern void prom_sleepself(void);
218 /* Put the entire system to sleep. */
219 extern int prom_sleepsystem(void);
221 /* Initiate a wakeup event. */
222 extern int prom_wakeupsystem(void);
224 /* MMU and memory related OBP interfaces. */
226 /* Get unique string identifying SIMM at given physical address. */
227 extern int prom_getunumber(int syndrome_code,
228 unsigned long phys_addr,
229 char *buf, int buflen);
231 /* Retain physical memory to the caller across soft resets. */
232 extern unsigned long prom_retain(const char *name,
233 unsigned long pa_low, unsigned long pa_high,
234 long size, long align);
236 /* Load explicit I/D TLB entries into the calling processor. */
237 extern long prom_itlb_load(unsigned long index,
238 unsigned long tte_data,
239 unsigned long vaddr);
241 extern long prom_dtlb_load(unsigned long index,
242 unsigned long tte_data,
243 unsigned long vaddr);
245 /* Map/Unmap client program address ranges. First the format of
246 * the mapping mode argument.
248 #define PROM_MAP_WRITE 0x0001 /* Writable */
249 #define PROM_MAP_READ 0x0002 /* Readable - sw */
250 #define PROM_MAP_EXEC 0x0004 /* Executable - sw */
251 #define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */
252 #define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */
253 #define PROM_MAP_SE 0x0040 /* Side-Effects */
254 #define PROM_MAP_GLOB 0x0080 /* Global */
255 #define PROM_MAP_IE 0x0100 /* Invert-Endianness */
256 #define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED)
258 extern int prom_map(int mode, unsigned long size,
259 unsigned long vaddr, unsigned long paddr);
260 extern void prom_unmap(unsigned long size, unsigned long vaddr);
263 /* PROM device tree traversal functions... */
265 #ifdef PROMLIB_INTERNAL
267 /* Internal version of prom_getchild. */
268 extern int __prom_getchild(int parent_node);
270 /* Internal version of prom_getsibling. */
271 extern int __prom_getsibling(int node);
275 /* Get the child node of the given node, or zero if no child exists. */
276 extern int prom_getchild(int parent_node);
278 /* Get the next sibling node of the given node, or zero if no further
281 extern int prom_getsibling(int node);
283 /* Get the length, at the passed node, of the given property type.
284 * Returns -1 on error (ie. no such property at this node).
286 extern int prom_getproplen(int thisnode, const char *property);
288 /* Fetch the requested property using the given buffer. Returns
289 * the number of bytes the prom put into your buffer or -1 on error.
291 extern int prom_getproperty(int thisnode, const char *property,
292 char *prop_buffer, int propbuf_size);
294 /* Acquire an integer property. */
295 extern int prom_getint(int node, const char *property);
297 /* Acquire an integer property, with a default value. */
298 extern int prom_getintdefault(int node, const char *property, int defval);
300 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
301 extern int prom_getbool(int node, const char *prop);
303 /* Acquire a string property, null string on error. */
304 extern void prom_getstring(int node, const char *prop, char *buf, int bufsize);
306 /* Does the passed node have the given "name"? YES=1 NO=0 */
307 extern int prom_nodematch(int thisnode, const char *name);
309 /* Puts in buffer a prom name in the form name@x,y or name (x for which_io
310 * and y for first regs phys address
312 extern int prom_getname(int node, char *buf, int buflen);
314 /* Search all siblings starting at the passed node for "name" matching
315 * the given string. Returns the node on success, zero on failure.
317 extern int prom_searchsiblings(int node_start, const char *name);
319 /* Return the first property type, as a string, for the given node.
320 * Returns a null string on error. Buffer should be at least 32B long.
322 extern char *prom_firstprop(int node, char *buffer);
324 /* Returns the next property after the passed property for the given
325 * node. Returns null string on failure. Buffer should be at least 32B long.
327 extern char *prom_nextprop(int node, const char *prev_property, char *buffer);
329 /* Returns 1 if the specified node has given property. */
330 extern int prom_node_has_property(int node, const char *property);
332 /* Returns phandle of the path specified */
333 extern int prom_finddevice(const char *name);
335 /* Set the indicated property at the given node with the passed value.
336 * Returns the number of bytes of your value that the prom took.
338 extern int prom_setprop(int node, const char *prop_name, char *prop_value,
341 extern int prom_pathtoinode(const char *path);
342 extern int prom_inst2pkg(int);
344 /* CPU probing helpers. */
345 int cpu_find_by_instance(int instance, int *prom_node, int *mid);
346 int cpu_find_by_mid(int mid, int *prom_node);
348 /* Client interface level routines. */
349 extern void prom_set_trap_table(unsigned long tba);
351 extern long p1275_cmd(const char *, long, ...);
355 #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x))
357 #define P1275_SIZE(x) x
360 /* We support at most 16 input and 1 output argument */
361 #define P1275_ARG_NUMBER 0
362 #define P1275_ARG_IN_STRING 1
363 #define P1275_ARG_OUT_BUF 2
364 #define P1275_ARG_OUT_32B 3
365 #define P1275_ARG_IN_FUNCTION 4
366 #define P1275_ARG_IN_BUF 5
367 #define P1275_ARG_IN_64B 6
369 #define P1275_IN(x) ((x) & 0xf)
370 #define P1275_OUT(x) (((x) << 4) & 0xf0)
371 #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o))
372 #define P1275_ARG(n,x) ((x) << ((n)*3 + 8))
374 #endif /* !(__SPARC64_OPLIB_H) */