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 /* 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(const char *boot_command
);
103 /* Evaluate the forth string passed. */
104 extern void prom_feval(const 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(const 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 */
166 PROMDEV_IRSC
, /* input from rsc */
170 extern enum prom_input_device
prom_query_input_device(void);
172 /* Query for output device type */
174 enum prom_output_device
{
175 PROMDEV_OSCREEN
, /* to screen */
176 PROMDEV_OTTYA
, /* to ttya */
177 PROMDEV_OTTYB
, /* to ttyb */
178 PROMDEV_ORSC
, /* to rsc */
182 extern enum prom_output_device
prom_query_output_device(void);
184 /* Multiprocessor operations... */
186 /* Start the CPU with the given device tree node, context table, and context
187 * at the passed program counter.
189 extern void prom_startcpu(int cpunode
, unsigned long pc
, unsigned long o0
);
191 /* Stop the current CPU. */
192 extern void prom_stopself(void);
194 /* Idle the current CPU. */
195 extern void prom_idleself(void);
197 /* Resume the CPU with the passed device tree node. */
198 extern void prom_resumecpu(int cpunode
);
201 /* Power management interfaces. */
203 /* Put the current CPU to sleep. */
204 extern void prom_sleepself(void);
206 /* Put the entire system to sleep. */
207 extern int prom_sleepsystem(void);
209 /* Initiate a wakeup event. */
210 extern int prom_wakeupsystem(void);
212 /* MMU and memory related OBP interfaces. */
214 /* Get unique string identifying SIMM at given physical address. */
215 extern int prom_getunumber(int syndrome_code
,
216 unsigned long phys_addr
,
217 char *buf
, int buflen
);
219 /* Retain physical memory to the caller across soft resets. */
220 extern unsigned long prom_retain(const char *name
,
221 unsigned long pa_low
, unsigned long pa_high
,
222 long size
, long align
);
224 /* Load explicit I/D TLB entries into the calling processor. */
225 extern long prom_itlb_load(unsigned long index
,
226 unsigned long tte_data
,
227 unsigned long vaddr
);
229 extern long prom_dtlb_load(unsigned long index
,
230 unsigned long tte_data
,
231 unsigned long vaddr
);
233 /* Map/Unmap client program address ranges. First the format of
234 * the mapping mode argument.
236 #define PROM_MAP_WRITE 0x0001 /* Writable */
237 #define PROM_MAP_READ 0x0002 /* Readable - sw */
238 #define PROM_MAP_EXEC 0x0004 /* Executable - sw */
239 #define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */
240 #define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */
241 #define PROM_MAP_SE 0x0040 /* Side-Effects */
242 #define PROM_MAP_GLOB 0x0080 /* Global */
243 #define PROM_MAP_IE 0x0100 /* Invert-Endianness */
244 #define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED)
246 extern int prom_map(int mode
, unsigned long size
,
247 unsigned long vaddr
, unsigned long paddr
);
248 extern void prom_unmap(unsigned long size
, unsigned long vaddr
);
251 /* PROM device tree traversal functions... */
253 #ifdef PROMLIB_INTERNAL
255 /* Internal version of prom_getchild. */
256 extern int __prom_getchild(int parent_node
);
258 /* Internal version of prom_getsibling. */
259 extern int __prom_getsibling(int node
);
263 /* Get the child node of the given node, or zero if no child exists. */
264 extern int prom_getchild(int parent_node
);
266 /* Get the next sibling node of the given node, or zero if no further
269 extern int prom_getsibling(int node
);
271 /* Get the length, at the passed node, of the given property type.
272 * Returns -1 on error (ie. no such property at this node).
274 extern int prom_getproplen(int thisnode
, const char *property
);
276 /* Fetch the requested property using the given buffer. Returns
277 * the number of bytes the prom put into your buffer or -1 on error.
279 extern int prom_getproperty(int thisnode
, const char *property
,
280 char *prop_buffer
, int propbuf_size
);
282 /* Acquire an integer property. */
283 extern int prom_getint(int node
, const char *property
);
285 /* Acquire an integer property, with a default value. */
286 extern int prom_getintdefault(int node
, const char *property
, int defval
);
288 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
289 extern int prom_getbool(int node
, const char *prop
);
291 /* Acquire a string property, null string on error. */
292 extern void prom_getstring(int node
, const char *prop
, char *buf
, int bufsize
);
294 /* Does the passed node have the given "name"? YES=1 NO=0 */
295 extern int prom_nodematch(int thisnode
, const char *name
);
297 /* Puts in buffer a prom name in the form name@x,y or name (x for which_io
298 * and y for first regs phys address
300 extern int prom_getname(int node
, char *buf
, int buflen
);
302 /* Search all siblings starting at the passed node for "name" matching
303 * the given string. Returns the node on success, zero on failure.
305 extern int prom_searchsiblings(int node_start
, const char *name
);
307 /* Return the first property type, as a string, for the given node.
308 * Returns a null string on error. Buffer should be at least 32B long.
310 extern char *prom_firstprop(int node
, char *buffer
);
312 /* Returns the next property after the passed property for the given
313 * node. Returns null string on failure. Buffer should be at least 32B long.
315 extern char *prom_nextprop(int node
, const char *prev_property
, char *buffer
);
317 /* Returns 1 if the specified node has given property. */
318 extern int prom_node_has_property(int node
, const char *property
);
320 /* Returns phandle of the path specified */
321 extern int prom_finddevice(const char *name
);
323 /* Set the indicated property at the given node with the passed value.
324 * Returns the number of bytes of your value that the prom took.
326 extern int prom_setprop(int node
, const char *prop_name
, char *prop_value
,
329 extern int prom_pathtoinode(const char *path
);
330 extern int prom_inst2pkg(int);
332 /* CPU probing helpers. */
333 int cpu_find_by_instance(int instance
, int *prom_node
, int *mid
);
334 int cpu_find_by_mid(int mid
, int *prom_node
);
336 /* Client interface level routines. */
337 extern void prom_set_trap_table(unsigned long tba
);
339 extern long p1275_cmd(const char *, long, ...);
343 #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x))
345 #define P1275_SIZE(x) x
348 /* We support at most 16 input and 1 output argument */
349 #define P1275_ARG_NUMBER 0
350 #define P1275_ARG_IN_STRING 1
351 #define P1275_ARG_OUT_BUF 2
352 #define P1275_ARG_OUT_32B 3
353 #define P1275_ARG_IN_FUNCTION 4
354 #define P1275_ARG_IN_BUF 5
355 #define P1275_ARG_IN_64B 6
357 #define P1275_IN(x) ((x) & 0xf)
358 #define P1275_OUT(x) (((x) << 4) & 0xf0)
359 #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o))
360 #define P1275_ARG(n,x) ((x) << ((n)*3 + 8))
362 #endif /* !(__SPARC64_OPLIB_H) */