1 /* $Id: oplib.h,v 1.13 2000/05/09 17:40:15 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
9 #ifndef __SPARC64_OPLIB_H
10 #define __SPARC64_OPLIB_H
11
12 #include <linux/config.h>
13 #include <asm/openprom.h>
14
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 */
22 };
23
24 extern enum prom_major_version prom_vers;
25 /* Revision, and firmware revision. */
26 extern unsigned int prom_rev, prom_prev;
27
28 /* Root node of the prom device tree, this stays constant after
29 * initialization is complete.
30 */
31 extern int prom_root_node;
32
33 /* PROM stdin and stdout */
34 extern int prom_stdin, prom_stdout;
35
36 /* /chosen node of the prom device tree, this stays constant after
37 * initialization is complete.
38 */
39 extern int prom_chosen_node;
40
41 struct linux_mlist_p1275 {
42 struct linux_mlist_p1275 *theres_more;
43 unsigned long start_adr;
44 unsigned long num_bytes;
45 };
46
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 */
51 };
52
53 /* The functions... */
54
55 /* You must call prom_init() before using any of the library services,
56 * preferably as early as possible. Pass it the romvec pointer.
57 */
58 extern void prom_init(void *cif_handler, void *cif_stack);
59
60 /* Boot argument acquisition, returns the boot command line string. */
61 extern char *prom_getbootargs(void);
62
63 /* Device utilities. */
64
65 /* Device operations. */
66
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.
70 */
71 extern int prom_devopen(char *device_string);
72
73 /* Close a previously opened device described by the passed integer
74 * descriptor.
75 */
76 extern int prom_devclose(int device_handle);
77
78 /* Do a seek operation on the device described by the passed integer
79 * descriptor.
80 */
81 extern void prom_seek(int device_handle, unsigned int seek_hival,
82 unsigned int seek_lowval);
83
84 /* Machine memory configuration routine. */
85
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.
92 *
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.
95 */
96 extern struct linux_mem_p1275 *prom_meminfo(void);
97
98 /* Miscellaneous routines, don't really fit in any category per se. */
99
100 /* Reboot the machine with the command line passed. */
101 extern void prom_reboot(char *boot_command);
102
103 /* Evaluate the forth string passed. */
104 extern void prom_feval(char *forth_string);
105
106 /* Enter the prom, with possibility of continuation with the 'go'
107 * command in newer proms.
108 */
109 extern void prom_cmdline(void);
110
111 /* Enter the prom, with no chance of continuation for the stand-alone
112 * which calls this.
113 */
114 extern void prom_halt(void) __attribute__ ((noreturn));
115
116 /* Set the PROM 'sync' callback function to the passed function pointer.
117 * When the user gives the 'sync' command at the prom prompt while the
118 * kernel is still active, the prom will call this routine.
119 *
120 */
121 typedef int (*callback_func_t)(long *cmd);
122 extern void prom_setcallback(callback_func_t func_ptr);
123
124 /* Acquire the IDPROM of the root node in the prom device tree. This
125 * gets passed a buffer where you would like it stuffed. The return value
126 * is the format type of this idprom or 0xff on error.
127 */
128 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
129
130 /* Get the prom major version. */
131 extern int prom_version(void);
132
133 /* Get the prom plugin revision. */
134 extern int prom_getrev(void);
135
136 /* Get the prom firmware revision. */
137 extern int prom_getprev(void);
138
139 /* Character operations to/from the console.... */
140
141 /* Non-blocking get character from console. */
142 extern int prom_nbgetchar(void);
143
144 /* Non-blocking put character to console. */
145 extern int prom_nbputchar(char character);
146
147 /* Blocking get character from console. */
148 extern char prom_getchar(void);
149
150 /* Blocking put character to console. */
151 extern void prom_putchar(char character);
152
153 /* Prom's internal printf routine, don't use in kernel/boot code. */
154 void prom_printf(char *fmt, ...);
155
156 /* Query for input device type */
157
158 enum prom_input_device {
159 PROMDEV_IKBD, /* input from keyboard */
160 PROMDEV_ITTYA, /* input from ttya */
161 PROMDEV_ITTYB, /* input from ttyb */
162 PROMDEV_I_UNK,
163 };
164
165 extern enum prom_input_device prom_query_input_device(void);
166
167 /* Query for output device type */
168
169 enum prom_output_device {
170 PROMDEV_OSCREEN, /* to screen */
171 PROMDEV_OTTYA, /* to ttya */
172 PROMDEV_OTTYB, /* to ttyb */
173 PROMDEV_O_UNK,
174 };
175
176 extern enum prom_output_device prom_query_output_device(void);
177
178 /* Multiprocessor operations... */
179 #ifdef CONFIG_SMP
180 /* Start the CPU with the given device tree node, context table, and context
181 * at the passed program counter.
182 */
183 extern void prom_startcpu(int cpunode, unsigned long pc, unsigned long o0);
184
185 /* Stop the current CPU. */
186 extern void prom_stopself(void);
187
188 /* Idle the current CPU. */
189 extern void prom_idleself(void);
190
191 /* Resume the CPU with the passed device tree node. */
192 extern void prom_resumecpu(int cpunode);
193 #endif
194
195 /* Power management interfaces. */
196
197 /* Put the current CPU to sleep. */
198 extern void prom_sleepself(void);
199
200 /* Put the entire system to sleep. */
201 extern int prom_sleepsystem(void);
202
203 /* Initiate a wakeup event. */
204 extern int prom_wakeupsystem(void);
205
206 /* MMU and memory related OBP interfaces. */
207
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);
212
213 /* Retain physical memory to the caller across soft resets. */
214 extern unsigned long prom_retain(char *name,
215 unsigned long pa_low, unsigned long pa_high,
216 long size, long align);
217
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);
222
223 extern long prom_dtlb_load(unsigned long index,
224 unsigned long tte_data,
225 unsigned long vaddr);
226
227 /* Map/Unmap client program address ranges. First the format of
228 * the mapping mode argument.
229 */
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)
239
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);
243
244
245 /* PROM device tree traversal functions... */
246
247 #ifdef PROMLIB_INTERNAL
248
249 /* Internal version of prom_getchild. */
250 extern int __prom_getchild(int parent_node);
251
252 /* Internal version of prom_getsibling. */
253 extern int __prom_getsibling(int node);
254
255 #endif
256
257 /* Get the child node of the given node, or zero if no child exists. */
258 extern int prom_getchild(int parent_node);
259
260 /* Get the next sibling node of the given node, or zero if no further
261 * siblings exist.
262 */
263 extern int prom_getsibling(int node);
264
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).
267 */
268 extern int prom_getproplen(int thisnode, char *property);
269
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.
272 */
273 extern int prom_getproperty(int thisnode, char *property,
274 char *prop_buffer, int propbuf_size);
275
276 /* Acquire an integer property. */
277 extern int prom_getint(int node, char *property);
278
279 /* Acquire an integer property, with a default value. */
280 extern int prom_getintdefault(int node, char *property, int defval);
281
282 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
283 extern int prom_getbool(int node, char *prop);
284
285 /* Acquire a string property, null string on error. */
286 extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
287
288 /* Does the passed node have the given "name"? YES=1 NO=0 */
289 extern int prom_nodematch(int thisnode, char *name);
290
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
293 */
294 extern int prom_getname(int node, char *buf, int buflen);
295
296 /* Search all siblings starting at the passed node for "name" matching
297 * the given string. Returns the node on success, zero on failure.
298 */
299 extern int prom_searchsiblings(int node_start, char *name);
300
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.
303 */
304 extern char *prom_firstprop(int node, char *buffer);
305
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.
308 */
309 extern char *prom_nextprop(int node, char *prev_property, char *buffer);
310
311 /* Returns 1 if the specified node has given property. */
312 extern int prom_node_has_property(int node, char *property);
313
314 /* Returns phandle of the path specified */
315 extern int prom_finddevice(char *name);
316
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.
319 */
320 extern int prom_setprop(int node, char *prop_name, char *prop_value,
321 int value_size);
322
323 extern int prom_pathtoinode(char *path);
324 extern int prom_inst2pkg(int);
325
326 /* Client interface level routines. */
327 extern void prom_set_trap_table(unsigned long tba);
328
329 /* Dorking with Bus ranges... */
330
331 /* Adjust reg values with the passed ranges. */
332 extern void prom_adjust_regs(struct linux_prom_registers *regp, int nregs,
333 struct linux_prom_ranges *rangep, int nranges);
334
335 /* Adjust child ranges with the passed parent ranges. */
336 extern void prom_adjust_ranges(struct linux_prom_ranges *cranges, int ncranges,
337 struct linux_prom_ranges *pranges, int npranges);
338
339 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
340 extern void prom_apply_generic_ranges(int node, int parent,
341 struct linux_prom_registers *sbusregs, int nregs);
342
343 extern long p1275_cmd (char *, long, ...);
344
345
346 #if 0
347 #define P1275_SIZE(x) ((((long)((x) / 32)) << 32) | (x))
348 #else
349 #define P1275_SIZE(x) x
350 #endif
351
352 /* We support at most 16 input and 1 output argument */
353 #define P1275_ARG_NUMBER 0
354 #define P1275_ARG_IN_STRING 1
355 #define P1275_ARG_OUT_BUF 2
356 #define P1275_ARG_OUT_32B 3
357 #define P1275_ARG_IN_FUNCTION 4
358 #define P1275_ARG_IN_BUF 5
359 #define P1275_ARG_IN_64B 6
360
361 #define P1275_IN(x) ((x) & 0xf)
362 #define P1275_OUT(x) (((x) << 4) & 0xf0)
363 #define P1275_INOUT(i,o) (P1275_IN(i)|P1275_OUT(o))
364 #define P1275_ARG(n,x) ((x) << ((n)*3 + 8))
365
366 #endif /* !(__SPARC64_OPLIB_H) */
367
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.