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 struct linux_mlist_p1275
{
42 struct linux_mlist_p1275
*theres_more
;
43 unsigned long start_adr
;
44 unsigned long num_bytes
;
47 struct linux_mem_p1275
{
48 struct linux_mlist_p1275
**p1275_totphys
;
49 struct linux_mlist_p1275
**p1275_prommap
;
50 struct linux_mlist_p1275
**p1275_available
; /* What we can use */
53 /* The functions... */
55 /* You must call prom_init() before using any of the library services,
56 * preferably as early as possible. Pass it the romvec pointer.
58 extern void prom_init(void *cif_handler
, void *cif_stack
);
60 /* Boot argument acquisition, returns the boot command line string. */
61 extern char *prom_getbootargs(void);
63 /* Device utilities. */
65 /* Device operations. */
67 /* Open the device described by the passed string. Note, that the format
68 * of the string is different on V0 vs. V2->higher proms. The caller must
69 * know what he/she is doing! Returns the device descriptor, an int.
71 extern int prom_devopen(char *device_string
);
73 /* Close a previously opened device described by the passed integer
76 extern int prom_devclose(int device_handle
);
78 /* Do a seek operation on the device described by the passed integer
81 extern void prom_seek(int device_handle
, unsigned int seek_hival
,
82 unsigned int seek_lowval
);
84 /* Machine memory configuration routine. */
86 /* This function returns a V0 format memory descriptor table, it has three
87 * entries. One for the total amount of physical ram on the machine, one
88 * for the amount of physical ram available, and one describing the virtual
89 * areas which are allocated by the prom. So, in a sense the physical
90 * available is a calculation of the total physical minus the physical mapped
91 * by the prom with virtual mappings.
93 * These lists are returned pre-sorted, this should make your life easier
94 * since the prom itself is way too lazy to do such nice things.
96 extern struct linux_mem_p1275
*prom_meminfo(void);
98 /* Miscellaneous routines, don't really fit in any category per se. */
100 /* Reboot the machine with the command line passed. */
101 extern void prom_reboot(char *boot_command
);
103 /* Evaluate the forth string passed. */
104 extern void prom_feval(char *forth_string
);
106 /* Enter the prom, with possibility of continuation with the 'go'
107 * command in newer proms.
109 extern void prom_cmdline(void);
111 /* Enter the prom, with no chance of continuation for the stand-alone
114 extern void prom_halt(void) __attribute__ ((noreturn
));
116 /* Halt and power-off the machine. */
117 extern void prom_halt_power_off(void) __attribute__ ((noreturn
));
119 /* Set the PROM 'sync' callback function to the passed function pointer.
120 * When the user gives the 'sync' command at the prom prompt while the
121 * kernel is still active, the prom will call this routine.
124 typedef int (*callback_func_t
)(long *cmd
);
125 extern void prom_setcallback(callback_func_t func_ptr
);
127 /* Acquire the IDPROM of the root node in the prom device tree. This
128 * gets passed a buffer where you would like it stuffed. The return value
129 * is the format type of this idprom or 0xff on error.
131 extern unsigned char prom_get_idprom(char *idp_buffer
, int idpbuf_size
);
133 /* Get the prom major version. */
134 extern int prom_version(void);
136 /* Get the prom plugin revision. */
137 extern int prom_getrev(void);
139 /* Get the prom firmware revision. */
140 extern int prom_getprev(void);
142 /* Character operations to/from the console.... */
144 /* Non-blocking get character from console. */
145 extern int prom_nbgetchar(void);
147 /* Non-blocking put character to console. */
148 extern int prom_nbputchar(char character
);
150 /* Blocking get character from console. */
151 extern char prom_getchar(void);
153 /* Blocking put character to console. */
154 extern void prom_putchar(char character
);
156 /* Prom's internal routines, don't use in kernel/boot code. */
157 extern void prom_printf(char *fmt
, ...);
158 extern void prom_write(const char *buf
, unsigned int len
);
160 /* Query for input device type */
162 enum prom_input_device
{
163 PROMDEV_IKBD
, /* input from keyboard */
164 PROMDEV_ITTYA
, /* input from ttya */
165 PROMDEV_ITTYB
, /* input from ttyb */
169 extern enum prom_input_device
prom_query_input_device(void);
171 /* Query for output device type */
173 enum prom_output_device
{
174 PROMDEV_OSCREEN
, /* to screen */
175 PROMDEV_OTTYA
, /* to ttya */
176 PROMDEV_OTTYB
, /* to ttyb */
180 extern enum prom_output_device
prom_query_output_device(void);
182 /* Multiprocessor operations... */
184 /* Start the CPU with the given device tree node, context table, and context
185 * at the passed program counter.
187 extern void prom_startcpu(int cpunode
, unsigned long pc
, unsigned long o0
);
189 /* Stop the current CPU. */
190 extern void prom_stopself(void);
192 /* Idle the current CPU. */
193 extern void prom_idleself(void);
195 /* Resume the CPU with the passed device tree node. */
196 extern void prom_resumecpu(int cpunode
);
199 /* Power management interfaces. */
201 /* Put the current CPU to sleep. */
202 extern void prom_sleepself(void);
204 /* Put the entire system to sleep. */
205 extern int prom_sleepsystem(void);
207 /* Initiate a wakeup event. */
208 extern int prom_wakeupsystem(void);
210 /* MMU and memory related OBP interfaces. */
212 /* Get unique string identifying SIMM at given physical address. */
213 extern int prom_getunumber(int syndrome_code
,
214 unsigned long phys_addr
,
215 char *buf
, int buflen
);
217 /* Retain physical memory to the caller across soft resets. */
218 extern unsigned long prom_retain(char *name
,
219 unsigned long pa_low
, unsigned long pa_high
,
220 long size
, long align
);
222 /* Load explicit I/D TLB entries into the calling processor. */
223 extern long prom_itlb_load(unsigned long index
,
224 unsigned long tte_data
,
225 unsigned long vaddr
);
227 extern long prom_dtlb_load(unsigned long index
,
228 unsigned long tte_data
,
229 unsigned long vaddr
);
231 /* Map/Unmap client program address ranges. First the format of
232 * the mapping mode argument.
234 #define PROM_MAP_WRITE 0x0001 /* Writable */
235 #define PROM_MAP_READ 0x0002 /* Readable - sw */
236 #define PROM_MAP_EXEC 0x0004 /* Executable - sw */
237 #define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */
238 #define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */
239 #define PROM_MAP_SE 0x0040 /* Side-Effects */
240 #define PROM_MAP_GLOB 0x0080 /* Global */
241 #define PROM_MAP_IE 0x0100 /* Invert-Endianness */
242 #define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED)
244 extern int prom_map(int mode
, unsigned long size
,
245 unsigned long vaddr
, unsigned long paddr
);
246 extern void prom_unmap(unsigned long size
, unsigned long vaddr
);
249 /* PROM device tree traversal functions... */
251 #ifdef PROMLIB_INTERNAL
253 /* Internal version of prom_getchild. */
254 extern int __prom_getchild(int parent_node
);
256 /* Internal version of prom_getsibling. */
257 extern int __prom_getsibling(int node
);
261 /* Get the child node of the given node, or zero if no child exists. */
262 extern int prom_getchild(int parent_node
);
264 /* Get the next sibling node of the given node, or zero if no further
267 extern int prom_getsibling(int node
);
269 /* Get the length, at the passed node, of the given property type.
270 * Returns -1 on error (ie. no such property at this node).
272 extern int prom_getproplen(int thisnode
, char *property
);
274 /* Fetch the requested property using the given buffer. Returns
275 * the number of bytes the prom put into your buffer or -1 on error.
277 extern int prom_getproperty(int thisnode
, char *property
,
278 char *prop_buffer
, int propbuf_size
);
280 /* Acquire an integer property. */
281 extern int prom_getint(int node
, char *property
);
283 /* Acquire an integer property, with a default value. */
284 extern int prom_getintdefault(int node
, char *property
, int defval
);
286 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
287 extern int prom_getbool(int node
, char *prop
);
289 /* Acquire a string property, null string on error. */
290 extern void prom_getstring(int node
, char *prop
, char *buf
, int bufsize
);
292 /* Does the passed node have the given "name"? YES=1 NO=0 */
293 extern int prom_nodematch(int thisnode
, char *name
);
295 /* Puts in buffer a prom name in the form name@x,y or name (x for which_io
296 * and y for first regs phys address
298 extern int prom_getname(int node
, char *buf
, int buflen
);
300 /* Search all siblings starting at the passed node for "name" matching
301 * the given string. Returns the node on success, zero on failure.
303 extern int prom_searchsiblings(int node_start
, char *name
);
305 /* Return the first property type, as a string, for the given node.
306 * Returns a null string on error. Buffer should be at least 32B long.
308 extern char *prom_firstprop(int node
, char *buffer
);
310 /* Returns the next property after the passed property for the given
311 * node. Returns null string on failure. Buffer should be at least 32B long.
313 extern char *prom_nextprop(int node
, char *prev_property
, char *buffer
);
315 /* Returns 1 if the specified node has given property. */
316 extern int prom_node_has_property(int node
, char *property
);
318 /* Returns phandle of the path specified */
319 extern int prom_finddevice(char *name
);
321 /* Set the indicated property at the given node with the passed value.
322 * Returns the number of bytes of your value that the prom took.
324 extern int prom_setprop(int node
, char *prop_name
, char *prop_value
,
327 extern int prom_pathtoinode(char *path
);
328 extern int prom_inst2pkg(int);
330 /* CPU probing helpers. */
331 int cpu_find_by_instance(int instance
, int *prom_node
, int *mid
);
332 int cpu_find_by_mid(int mid
, int *prom_node
);
334 /* Client interface level routines. */
335 extern void prom_set_trap_table(unsigned long tba
);
337 extern long p1275_cmd (char *, long, ...);
341 #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x))
343 #define P1275_SIZE(x) x
346 /* We support at most 16 input and 1 output argument */
347 #define P1275_ARG_NUMBER 0
348 #define P1275_ARG_IN_STRING 1
349 #define P1275_ARG_OUT_BUF 2
350 #define P1275_ARG_OUT_32B 3
351 #define P1275_ARG_IN_FUNCTION 4
352 #define P1275_ARG_IN_BUF 5
353 #define P1275_ARG_IN_64B 6
355 #define P1275_IN(x) ((x) & 0xf)
356 #define P1275_OUT(x) (((x) << 4) & 0xf0)
357 #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o))
358 #define P1275_ARG(n,x) ((x) << ((n)*3 + 8))
360 #endif /* !(__SPARC64_OPLIB_H) */