1 /* SPDX-License-Identifier: GPL-2.0 */
3 * oplib.h: Describes the interface and available routines in the
6 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
9 #ifndef __SPARC_OPLIB_H
10 #define __SPARC_OPLIB_H
12 #include <linux/compiler.h>
14 #include <asm/openprom.h>
16 /* The master romvec pointer... */
17 extern struct linux_romvec *romvec;
19 /* Enumeration to describe the prom major version we have detected. */
20 enum prom_major_version {
21 PROM_V0, /* Original sun4c V0 prom */
22 PROM_V2, /* sun4c and early sun4m V2 prom */
23 PROM_V3, /* sun4m and later, up to sun4d/sun4e machines V3 */
24 PROM_P1275, /* IEEE compliant ISA based Sun PROM, only sun4u */
27 extern enum prom_major_version prom_vers;
28 /* Revision, and firmware revision. */
29 extern unsigned int prom_rev, prom_prev;
31 /* Root node of the prom device tree, this stays constant after
32 * initialization is complete.
34 extern int prom_root_node;
36 /* Pointer to prom structure containing the device tree traversal
37 * and usage utility functions. Only prom-lib should use these,
38 * users use the interface defined by the library only!
40 extern struct linux_nodeops *prom_nodeops;
42 /* The functions... */
44 /* You must call prom_init() before using any of the library services,
45 * preferably as early as possible. Pass it the romvec pointer.
47 extern void prom_init(struct linux_romvec *rom_ptr);
49 /* Boot argument acquisition, returns the boot command line string. */
50 extern char *prom_getbootargs(void);
52 /* Device utilities. */
54 /* Map and unmap devices in IO space at virtual addresses. Note that the
55 * virtual address you pass is a request and the prom may put your mappings
56 * somewhere else, so check your return value as that is where your new
57 * mappings really are!
59 * Another note, these are only available on V2 or higher proms!
61 extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes);
62 extern void prom_unmapio(char *virt_addr, unsigned int num_bytes);
64 /* Device operations. */
66 /* Open the device described by the passed string. Note, that the format
67 * of the string is different on V0 vs. V2->higher proms. The caller must
68 * know what he/she is doing! Returns the device descriptor, an int.
70 extern int prom_devopen(char *device_string);
72 /* Close a previously opened device described by the passed integer
75 extern int prom_devclose(int device_handle);
77 /* Do a seek operation on the device described by the passed integer
80 extern void prom_seek(int device_handle, unsigned int seek_hival,
81 unsigned int seek_lowval);
83 /* Machine memory configuration routine. */
85 /* This function returns a V0 format memory descriptor table, it has three
86 * entries. One for the total amount of physical ram on the machine, one
87 * for the amount of physical ram available, and one describing the virtual
88 * areas which are allocated by the prom. So, in a sense the physical
89 * available is a calculation of the total physical minus the physical mapped
90 * by the prom with virtual mappings.
92 * These lists are returned pre-sorted, this should make your life easier
93 * since the prom itself is way too lazy to do such nice things.
95 extern struct linux_mem_v0 *prom_meminfo(void);
97 /* Miscellaneous routines, don't really fit in any category per se. */
99 /* Reboot the machine with the command line passed. */
100 extern void prom_reboot(char *boot_command);
102 /* Evaluate the forth string passed. */
103 extern void prom_feval(char *forth_string);
105 /* Enter the prom, with possibility of continuation with the 'go'
106 * command in newer proms.
108 extern void prom_cmdline(void);
110 /* Enter the prom, with no chance of continuation for the stand-alone
113 extern void prom_halt(void);
115 /* Set the PROM 'sync' callback function to the passed function pointer.
116 * When the user gives the 'sync' command at the prom prompt while the
117 * kernel is still active, the prom will call this routine.
119 * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
121 typedef void (*sync_func_t)(void);
122 extern void prom_setsync(sync_func_t func_ptr);
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.
128 extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
130 /* Get the prom major version. */
131 extern int prom_version(void);
133 /* Get the prom plugin revision. */
134 extern int prom_getrev(void);
136 /* Get the prom firmware revision. */
137 extern int prom_getprev(void);
139 /* Character operations to/from the console.... */
141 /* Non-blocking get character from console. */
142 extern int prom_nbgetchar(void);
144 /* Non-blocking put character to console. */
145 extern int prom_nbputchar(char character);
147 /* Blocking get character from console. */
148 extern char prom_getchar(void);
150 /* Blocking put character to console. */
151 extern void prom_putchar(char character);
153 /* Prom's internal printf routine, don't use in kernel/boot code. */
154 __printf(1, 2) void prom_printf(char *fmt, ...);
156 /* Query for input device type */
158 enum prom_input_device {
159 PROMDEV_IKBD, /* input from keyboard */
160 PROMDEV_ITTYA, /* input from ttya */
161 PROMDEV_ITTYB, /* input from ttyb */
165 extern enum prom_input_device prom_query_input_device(void);
167 /* Query for output device type */
169 enum prom_output_device {
170 PROMDEV_OSCREEN, /* to screen */
171 PROMDEV_OTTYA, /* to ttya */
172 PROMDEV_OTTYB, /* to ttyb */
176 extern enum prom_output_device prom_query_output_device(void);
178 /* Multiprocessor operations... */
180 /* Start the CPU with the given device tree node, context table, and context
181 * at the passed program counter.
183 extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
184 int context, char *program_counter);
186 /* Stop the CPU with the passed device tree node. */
187 extern int prom_stopcpu(int cpunode);
189 /* Idle the CPU with the passed device tree node. */
190 extern int prom_idlecpu(int cpunode);
192 /* Re-Start the CPU with the passed device tree node. */
193 extern int prom_restartcpu(int cpunode);
195 /* PROM memory allocation facilities... */
197 /* Allocated at possibly the given virtual address a chunk of the
200 extern char *prom_alloc(char *virt_hint, unsigned int size);
202 /* Free a previously allocated chunk. */
203 extern void prom_free(char *virt_addr, unsigned int size);
205 /* Sun4/sun4c specific memory-management startup hook. */
207 /* Map the passed segment in the given context at the passed
210 extern void prom_putsegment(int context, unsigned long virt_addr,
211 int physical_segment);
213 /* PROM device tree traversal functions... */
215 /* Get the child node of the given node, or zero if no child exists. */
216 extern int prom_getchild(int parent_node);
218 /* Get the next sibling node of the given node, or zero if no further
221 extern int prom_getsibling(int node);
223 /* Get the length, at the passed node, of the given property type.
224 * Returns -1 on error (ie. no such property at this node).
226 extern int prom_getproplen(int thisnode, char *property);
228 /* Fetch the requested property using the given buffer. Returns
229 * the number of bytes the prom put into your buffer or -1 on error.
231 extern int prom_getproperty(int thisnode, char *property,
232 char *prop_buffer, int propbuf_size);
234 /* Acquire an integer property. */
235 extern int prom_getint(int node, char *property);
237 /* Acquire an integer property, with a default value. */
238 extern int prom_getintdefault(int node, char *property, int defval);
240 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
241 extern int prom_getbool(int node, char *prop);
243 /* Acquire a string property, null string on error. */
244 extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
246 /* Does the passed node have the given "name"? YES=1 NO=0 */
247 extern int prom_nodematch(int thisnode, char *name);
249 /* Search all siblings starting at the passed node for "name" matching
250 * the given string. Returns the node on success, zero on failure.
252 extern int prom_searchsiblings(int node_start, char *name);
254 /* Return the first property type, as a string, for the given node.
255 * Returns a null string on error.
257 extern char *prom_firstprop(int node);
259 /* Returns the next property after the passed property for the given
260 * node. Returns null string on failure.
262 extern char *prom_nextprop(int node, char *prev_property);
264 /* Returns 1 if the specified node has given property. */
265 extern int prom_node_has_property(int node, char *property);
267 /* Set the indicated property at the given node with the passed value.
268 * Returns the number of bytes of your value that the prom took.
270 extern int prom_setprop(int node, char *prop_name, char *prop_value,
273 extern int prom_pathtoinode(char *path);
274 extern int prom_inst2pkg(int);
276 /* Dorking with Bus ranges... */
278 /* Adjust reg values with the passed ranges. */
279 extern void prom_adjust_regs(struct linux_prom_registers *regp, int nregs,
280 struct linux_prom_ranges *rangep, int nranges);
282 /* Adjust child ranges with the passed parent ranges. */
283 extern void prom_adjust_ranges(struct linux_prom_ranges *cranges, int ncranges,
284 struct linux_prom_ranges *pranges, int npranges);
286 /* Apply promlib probed OBIO ranges to registers. */
287 extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
289 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
290 extern void prom_apply_generic_ranges(int node, int parent,
291 struct linux_prom_registers *sbusregs, int nregs);
294 #endif /* !(__SPARC_OPLIB_H) */