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
5 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
8 #ifndef __SPARC_OPLIB_H
9 #define __SPARC_OPLIB_H
11 #include <asm/openprom.h>
12 #include <linux/spinlock.h>
13 #include <linux/compiler.h>
15 /* The master romvec pointer... */
16 extern struct linux_romvec *romvec;
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 */
28 extern enum prom_major_version prom_vers;
29 /* Revision, and firmware revision. */
30 extern unsigned int prom_rev, prom_prev;
32 /* Root node of the prom device tree, this stays constant after
33 * initialization is complete.
35 extern int prom_root_node;
37 /* PROM stdin and stdout */
38 extern int prom_stdin, prom_stdout;
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!
44 extern struct linux_nodeops *prom_nodeops;
46 /* The functions... */
48 /* You must call prom_init() before using any of the library services,
49 * preferably as early as possible. Pass it the romvec pointer.
51 extern void prom_init(struct linux_romvec *rom_ptr);
53 /* Boot argument acquisition, returns the boot command line string. */
54 extern char *prom_getbootargs(void);
56 /* Device utilities. */
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!
63 * Another note, these are only available on V2 or higher proms!
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);
68 /* Device operations. */
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.
74 extern int prom_devopen(char *device_string);
76 /* Close a previously opened device described by the passed integer
79 extern int prom_devclose(int device_handle);
81 /* Do a seek operation on the device described by the passed integer
84 extern void prom_seek(int device_handle, unsigned int seek_hival,
85 unsigned int seek_lowval);
87 /* Machine memory configuration routine. */
89 /* This function returns a V0 format available memory descriptor entry.
90 * This list is pre-sorted,
92 extern struct linux_mlist_v0 *prom_meminfo(void);
94 /* Miscellaneous routines, don't really fit in any category per se. */
96 /* Reboot the machine with the command line passed. */
97 extern void prom_reboot(char *boot_command);
99 /* Evaluate the forth string passed. */
100 extern void prom_feval(char *forth_string);
102 /* Enter the prom, with possibility of continuation with the 'go'
103 * command in newer proms.
105 extern void prom_cmdline(void);
107 /* Enter the prom, with no chance of continuation for the stand-alone
110 extern void prom_halt(void) __attribute__ ((noreturn));
112 /* Set the PROM 'sync' callback function to the passed function pointer.
113 * When the user gives the 'sync' command at the prom prompt while the
114 * kernel is still active, the prom will call this routine.
116 * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
118 typedef void (*sync_func_t)(void);
119 extern void prom_setsync(sync_func_t func_ptr);
121 /* Acquire the IDPROM of the root node in the prom device tree. This
122 * gets passed a buffer where you would like it stuffed. The return value
123 * is the format type of this idprom or 0xff on error.
125 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
127 /* Get the prom major version. */
128 extern int prom_version(void);
130 /* Get the prom plugin revision. */
131 extern int prom_getrev(void);
133 /* Get the prom firmware revision. */
134 extern int prom_getprev(void);
136 /* Character operations to/from the console.... */
138 /* Non-blocking get character from console. */
139 extern int prom_nbgetchar(void);
141 /* Non-blocking put character to console. */
142 extern int prom_nbputchar(char character);
144 /* Blocking get character from console. */
145 extern char prom_getchar(void);
147 /* Blocking put character to console. */
148 extern void prom_putchar(char character);
150 /* Prom's internal routines, don't use in kernel/boot code. */
151 extern void prom_printf(char *fmt, ...);
152 extern void prom_write(const char *buf, unsigned int len);
154 /* Multiprocessor operations... */
156 /* Start the CPU with the given device tree node, context table, and context
157 * at the passed program counter.
159 extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
160 int context, char *program_counter);
162 /* Stop the CPU with the passed device tree node. */
163 extern int prom_stopcpu(int cpunode);
165 /* Idle the CPU with the passed device tree node. */
166 extern int prom_idlecpu(int cpunode);
168 /* Re-Start the CPU with the passed device tree node. */
169 extern int prom_restartcpu(int cpunode);
171 /* PROM memory allocation facilities... */
173 /* Allocated at possibly the given virtual address a chunk of the
176 extern char *prom_alloc(char *virt_hint, unsigned int size);
178 /* Free a previously allocated chunk. */
179 extern void prom_free(char *virt_addr, unsigned int size);
181 /* Sun4/sun4c specific memory-management startup hook. */
183 /* Map the passed segment in the given context at the passed
186 extern void prom_putsegment(int context, unsigned long virt_addr,
187 int physical_segment);
190 /* PROM device tree traversal functions... */
192 #ifdef PROMLIB_INTERNAL
194 /* Internal version of prom_getchild. */
195 extern int __prom_getchild(int parent_node);
197 /* Internal version of prom_getsibling. */
198 extern int __prom_getsibling(int node);
203 /* Get the child node of the given node, or zero if no child exists. */
204 extern int prom_getchild(int parent_node);
206 /* Get the next sibling node of the given node, or zero if no further
209 extern int prom_getsibling(int node);
211 /* Get the length, at the passed node, of the given property type.
212 * Returns -1 on error (ie. no such property at this node).
214 extern int prom_getproplen(int thisnode, char *property);
216 /* Fetch the requested property using the given buffer. Returns
217 * the number of bytes the prom put into your buffer or -1 on error.
219 extern int __must_check prom_getproperty(int thisnode, char *property,
220 char *prop_buffer, int propbuf_size);
222 /* Acquire an integer property. */
223 extern int prom_getint(int node, char *property);
225 /* Acquire an integer property, with a default value. */
226 extern int prom_getintdefault(int node, char *property, int defval);
228 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
229 extern int prom_getbool(int node, char *prop);
231 /* Acquire a string property, null string on error. */
232 extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
234 /* Does the passed node have the given "name"? YES=1 NO=0 */
235 extern int prom_nodematch(int thisnode, char *name);
237 /* Search all siblings starting at the passed node for "name" matching
238 * the given string. Returns the node on success, zero on failure.
240 extern int prom_searchsiblings(int node_start, char *name);
242 /* Return the first property type, as a string, for the given node.
243 * Returns a null string on error.
245 extern char *prom_firstprop(int node, char *buffer);
247 /* Returns the next property after the passed property for the given
248 * node. Returns null string on failure.
250 extern char *prom_nextprop(int node, char *prev_property, char *buffer);
252 /* Returns phandle of the path specified */
253 extern int prom_finddevice(char *name);
255 /* Returns 1 if the specified node has given property. */
256 extern int prom_node_has_property(int node, char *property);
258 /* Set the indicated property at the given node with the passed value.
259 * Returns the number of bytes of your value that the prom took.
261 extern int prom_setprop(int node, char *prop_name, char *prop_value,
264 extern int prom_pathtoinode(char *path);
265 extern int prom_inst2pkg(int);
267 /* Dorking with Bus ranges... */
269 /* Apply promlib probes OBIO ranges to registers. */
270 extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
272 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
273 extern void prom_apply_generic_ranges(int node, int parent,
274 struct linux_prom_registers *sbusregs, int nregs);
276 /* CPU probing helpers. */
277 int cpu_find_by_instance(int instance, int *prom_node, int *mid);
278 int cpu_find_by_mid(int mid, int *prom_node);
279 int cpu_get_hwmid(int prom_node);
281 extern spinlock_t prom_lock;
283 #endif /* !(__SPARC_OPLIB_H) */