22dc39d97b4e124bf3bf2a4bac81c5fb613793bb
[linux-2.6.git] / include / asm-sparc / oplib.h
1 /* $Id: oplib.h,v 1.23 2001/12/21 00:54:31 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  */
7
8 #ifndef __SPARC_OPLIB_H
9 #define __SPARC_OPLIB_H
10
11 #include <asm/openprom.h>
12 #include <linux/spinlock.h>
13 #include <linux/compiler.h>
14
15 /* The master romvec pointer... */
16 extern struct linux_romvec *romvec;
17
18 /* Enumeration to describe the prom major version we have detected. */
19 enum prom_major_version {
20         PROM_V0,      /* Original sun4c V0 prom */
21         PROM_V2,      /* sun4c and early sun4m V2 prom */
22         PROM_V3,      /* sun4m and later, up to sun4d/sun4e machines V3 */
23         PROM_P1275,   /* IEEE compliant ISA based Sun PROM, only sun4u */
24         PROM_AP1000,  /* actually no prom at all */
25         PROM_SUN4,    /* Old sun4 proms are totally different, but we'll shoehorn it to make it fit */
26 };
27
28 extern enum prom_major_version prom_vers;
29 /* Revision, and firmware revision. */
30 extern unsigned int prom_rev, prom_prev;
31
32 /* Root node of the prom device tree, this stays constant after
33  * initialization is complete.
34  */
35 extern int prom_root_node;
36
37 /* PROM stdin and stdout */
38 extern int prom_stdin, prom_stdout;
39
40 /* Pointer to prom structure containing the device tree traversal
41  * and usage utility functions.  Only prom-lib should use these,
42  * users use the interface defined by the library only!
43  */
44 extern struct linux_nodeops *prom_nodeops;
45
46 /* The functions... */
47
48 /* You must call prom_init() before using any of the library services,
49  * preferably as early as possible.  Pass it the romvec pointer.
50  */
51 extern void prom_init(struct linux_romvec *rom_ptr);
52
53 /* Boot argument acquisition, returns the boot command line string. */
54 extern char *prom_getbootargs(void);
55
56 /* Device utilities. */
57
58 /* Map and unmap devices in IO space at virtual addresses. Note that the
59  * virtual address you pass is a request and the prom may put your mappings
60  * somewhere else, so check your return value as that is where your new
61  * mappings really are!
62  *
63  * Another note, these are only available on V2 or higher proms!
64  */
65 extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes);
66 extern void prom_unmapio(char *virt_addr, unsigned int num_bytes);
67
68 /* Device operations. */
69
70 /* Open the device described by the passed string.  Note, that the format
71  * of the string is different on V0 vs. V2->higher proms.  The caller must
72  * know what he/she is doing!  Returns the device descriptor, an int.
73  */
74 extern int prom_devopen(char *device_string);
75
76 /* Close a previously opened device described by the passed integer
77  * descriptor.
78  */
79 extern int prom_devclose(int device_handle);
80
81 /* Do a seek operation on the device described by the passed integer
82  * descriptor.
83  */
84 extern void prom_seek(int device_handle, unsigned int seek_hival,
85                       unsigned int seek_lowval);
86
87 /* Miscellaneous routines, don't really fit in any category per se. */
88
89 /* Reboot the machine with the command line passed. */
90 extern void prom_reboot(char *boot_command);
91
92 /* Evaluate the forth string passed. */
93 extern void prom_feval(char *forth_string);
94
95 /* Enter the prom, with possibility of continuation with the 'go'
96  * command in newer proms.
97  */
98 extern void prom_cmdline(void);
99
100 /* Enter the prom, with no chance of continuation for the stand-alone
101  * which calls this.
102  */
103 extern void prom_halt(void) __attribute__ ((noreturn));
104
105 /* Set the PROM 'sync' callback function to the passed function pointer.
106  * When the user gives the 'sync' command at the prom prompt while the
107  * kernel is still active, the prom will call this routine.
108  *
109  * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
110  */
111 typedef void (*sync_func_t)(void);
112 extern void prom_setsync(sync_func_t func_ptr);
113
114 /* Acquire the IDPROM of the root node in the prom device tree.  This
115  * gets passed a buffer where you would like it stuffed.  The return value
116  * is the format type of this idprom or 0xff on error.
117  */
118 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
119
120 /* Get the prom major version. */
121 extern int prom_version(void);
122
123 /* Get the prom plugin revision. */
124 extern int prom_getrev(void);
125
126 /* Get the prom firmware revision. */
127 extern int prom_getprev(void);
128
129 /* Character operations to/from the console.... */
130
131 /* Non-blocking get character from console. */
132 extern int prom_nbgetchar(void);
133
134 /* Non-blocking put character to console. */
135 extern int prom_nbputchar(char character);
136
137 /* Blocking get character from console. */
138 extern char prom_getchar(void);
139
140 /* Blocking put character to console. */
141 extern void prom_putchar(char character);
142
143 /* Prom's internal routines, don't use in kernel/boot code. */
144 extern void prom_printf(char *fmt, ...);
145 extern void prom_write(const char *buf, unsigned int len);
146
147 /* Multiprocessor operations... */
148
149 /* Start the CPU with the given device tree node, context table, and context
150  * at the passed program counter.
151  */
152 extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
153                          int context, char *program_counter);
154
155 /* Stop the CPU with the passed device tree node. */
156 extern int prom_stopcpu(int cpunode);
157
158 /* Idle the CPU with the passed device tree node. */
159 extern int prom_idlecpu(int cpunode);
160
161 /* Re-Start the CPU with the passed device tree node. */
162 extern int prom_restartcpu(int cpunode);
163
164 /* PROM memory allocation facilities... */
165
166 /* Allocated at possibly the given virtual address a chunk of the
167  * indicated size.
168  */
169 extern char *prom_alloc(char *virt_hint, unsigned int size);
170
171 /* Free a previously allocated chunk. */
172 extern void prom_free(char *virt_addr, unsigned int size);
173
174 /* Sun4/sun4c specific memory-management startup hook. */
175
176 /* Map the passed segment in the given context at the passed
177  * virtual address.
178  */
179 extern void prom_putsegment(int context, unsigned long virt_addr,
180                             int physical_segment);
181
182
183 /* PROM device tree traversal functions... */
184
185 #ifdef PROMLIB_INTERNAL
186
187 /* Internal version of prom_getchild. */
188 extern int __prom_getchild(int parent_node);
189
190 /* Internal version of prom_getsibling. */
191 extern int __prom_getsibling(int node);
192
193 #endif
194
195
196 /* Get the child node of the given node, or zero if no child exists. */
197 extern int prom_getchild(int parent_node);
198
199 /* Get the next sibling node of the given node, or zero if no further
200  * siblings exist.
201  */
202 extern int prom_getsibling(int node);
203
204 /* Get the length, at the passed node, of the given property type.
205  * Returns -1 on error (ie. no such property at this node).
206  */
207 extern int prom_getproplen(int thisnode, char *property);
208
209 /* Fetch the requested property using the given buffer.  Returns
210  * the number of bytes the prom put into your buffer or -1 on error.
211  */
212 extern int __must_check prom_getproperty(int thisnode, char *property,
213                                          char *prop_buffer, int propbuf_size);
214
215 /* Acquire an integer property. */
216 extern int prom_getint(int node, char *property);
217
218 /* Acquire an integer property, with a default value. */
219 extern int prom_getintdefault(int node, char *property, int defval);
220
221 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
222 extern int prom_getbool(int node, char *prop);
223
224 /* Acquire a string property, null string on error. */
225 extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
226
227 /* Does the passed node have the given "name"? YES=1 NO=0 */
228 extern int prom_nodematch(int thisnode, char *name);
229
230 /* Search all siblings starting at the passed node for "name" matching
231  * the given string.  Returns the node on success, zero on failure.
232  */
233 extern int prom_searchsiblings(int node_start, char *name);
234
235 /* Return the first property type, as a string, for the given node.
236  * Returns a null string on error.
237  */
238 extern char *prom_firstprop(int node, char *buffer);
239
240 /* Returns the next property after the passed property for the given
241  * node.  Returns null string on failure.
242  */
243 extern char *prom_nextprop(int node, char *prev_property, char *buffer);
244
245 /* Returns phandle of the path specified */
246 extern int prom_finddevice(char *name);
247
248 /* Returns 1 if the specified node has given property. */
249 extern int prom_node_has_property(int node, char *property);
250
251 /* Set the indicated property at the given node with the passed value.
252  * Returns the number of bytes of your value that the prom took.
253  */
254 extern int prom_setprop(int node, char *prop_name, char *prop_value,
255                         int value_size);
256                         
257 extern int prom_pathtoinode(char *path);
258 extern int prom_inst2pkg(int);
259
260 /* Dorking with Bus ranges... */
261
262 /* Apply promlib probes OBIO ranges to registers. */
263 extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
264
265 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
266 extern void prom_apply_generic_ranges(int node, int parent, 
267                                       struct linux_prom_registers *sbusregs, int nregs);
268
269 /* CPU probing helpers.  */
270 int cpu_find_by_instance(int instance, int *prom_node, int *mid);
271 int cpu_find_by_mid(int mid, int *prom_node);
272 int cpu_get_hwmid(int prom_node);
273
274 extern spinlock_t prom_lock;
275
276 #endif /* !(__SPARC_OPLIB_H) */