Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * oplib.h: Describes the interface and available routines in the
4 * Linux Prom library.
5 *
6 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
7 */
8
9#ifndef __SPARC_OPLIB_H
10#define __SPARC_OPLIB_H
11
12#include <linux/compiler.h>
13
14#include <asm/openprom.h>
15
16/* The master romvec pointer... */
17extern struct linux_romvec *romvec;
18
19/* Enumeration to describe the prom major version we have detected. */
20enum 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 */
25};
26
27extern enum prom_major_version prom_vers;
28/* Revision, and firmware revision. */
29extern unsigned int prom_rev, prom_prev;
30
31/* Root node of the prom device tree, this stays constant after
32 * initialization is complete.
33 */
34extern int prom_root_node;
35
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!
39 */
40extern struct linux_nodeops *prom_nodeops;
41
42/* The functions... */
43
44/* You must call prom_init() before using any of the library services,
45 * preferably as early as possible. Pass it the romvec pointer.
46 */
47extern void prom_init(struct linux_romvec *rom_ptr);
48
49/* Boot argument acquisition, returns the boot command line string. */
50extern char *prom_getbootargs(void);
51
52/* Device utilities. */
53
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!
58 *
59 * Another note, these are only available on V2 or higher proms!
60 */
61extern char *prom_mapio(char *virt_hint, int io_space, unsigned int phys_addr, unsigned int num_bytes);
62extern void prom_unmapio(char *virt_addr, unsigned int num_bytes);
63
64/* Device operations. */
65
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.
69 */
70extern int prom_devopen(char *device_string);
71
72/* Close a previously opened device described by the passed integer
73 * descriptor.
74 */
75extern int prom_devclose(int device_handle);
76
77/* Do a seek operation on the device described by the passed integer
78 * descriptor.
79 */
80extern void prom_seek(int device_handle, unsigned int seek_hival,
81 unsigned int seek_lowval);
82
83/* Machine memory configuration routine. */
84
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.
91 *
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.
94 */
95extern struct linux_mem_v0 *prom_meminfo(void);
96
97/* Miscellaneous routines, don't really fit in any category per se. */
98
99/* Reboot the machine with the command line passed. */
100extern void prom_reboot(char *boot_command);
101
102/* Evaluate the forth string passed. */
103extern void prom_feval(char *forth_string);
104
105/* Enter the prom, with possibility of continuation with the 'go'
106 * command in newer proms.
107 */
108extern void prom_cmdline(void);
109
110/* Enter the prom, with no chance of continuation for the stand-alone
111 * which calls this.
112 */
113extern void prom_halt(void);
114
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.
118 *
119 * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
120 */
121typedef void (*sync_func_t)(void);
122extern void prom_setsync(sync_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 */
128extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
129
130/* Get the prom major version. */
131extern int prom_version(void);
132
133/* Get the prom plugin revision. */
134extern int prom_getrev(void);
135
136/* Get the prom firmware revision. */
137extern int prom_getprev(void);
138
139/* Character operations to/from the console.... */
140
141/* Non-blocking get character from console. */
142extern int prom_nbgetchar(void);
143
144/* Non-blocking put character to console. */
145extern int prom_nbputchar(char character);
146
147/* Blocking get character from console. */
148extern char prom_getchar(void);
149
150/* Blocking put character to console. */
151extern void prom_putchar(char character);
152
153/* Prom's internal printf routine, don't use in kernel/boot code. */
154__printf(1, 2) void prom_printf(char *fmt, ...);
155
156/* Query for input device type */
157
158enum 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
165extern enum prom_input_device prom_query_input_device(void);
166
167/* Query for output device type */
168
169enum prom_output_device {
170 PROMDEV_OSCREEN, /* to screen */
171 PROMDEV_OTTYA, /* to ttya */
172 PROMDEV_OTTYB, /* to ttyb */
173 PROMDEV_O_UNK,
174};
175
176extern enum prom_output_device prom_query_output_device(void);
177
178/* Multiprocessor operations... */
179
180/* Start the CPU with the given device tree node, context table, and context
181 * at the passed program counter.
182 */
183extern int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
184 int context, char *program_counter);
185
186/* Stop the CPU with the passed device tree node. */
187extern int prom_stopcpu(int cpunode);
188
189/* Idle the CPU with the passed device tree node. */
190extern int prom_idlecpu(int cpunode);
191
192/* Re-Start the CPU with the passed device tree node. */
193extern int prom_restartcpu(int cpunode);
194
195/* PROM memory allocation facilities... */
196
197/* Allocated at possibly the given virtual address a chunk of the
198 * indicated size.
199 */
200extern char *prom_alloc(char *virt_hint, unsigned int size);
201
202/* Free a previously allocated chunk. */
203extern void prom_free(char *virt_addr, unsigned int size);
204
205/* Sun4/sun4c specific memory-management startup hook. */
206
207/* Map the passed segment in the given context at the passed
208 * virtual address.
209 */
210extern void prom_putsegment(int context, unsigned long virt_addr,
211 int physical_segment);
212
213/* PROM device tree traversal functions... */
214
215/* Get the child node of the given node, or zero if no child exists. */
216extern int prom_getchild(int parent_node);
217
218/* Get the next sibling node of the given node, or zero if no further
219 * siblings exist.
220 */
221extern int prom_getsibling(int node);
222
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).
225 */
226extern int prom_getproplen(int thisnode, char *property);
227
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.
230 */
231extern int prom_getproperty(int thisnode, char *property,
232 char *prop_buffer, int propbuf_size);
233
234/* Acquire an integer property. */
235extern int prom_getint(int node, char *property);
236
237/* Acquire an integer property, with a default value. */
238extern int prom_getintdefault(int node, char *property, int defval);
239
240/* Acquire a boolean property, 0=FALSE 1=TRUE. */
241extern int prom_getbool(int node, char *prop);
242
243/* Acquire a string property, null string on error. */
244extern void prom_getstring(int node, char *prop, char *buf, int bufsize);
245
246/* Does the passed node have the given "name"? YES=1 NO=0 */
247extern int prom_nodematch(int thisnode, char *name);
248
249/* Search all siblings starting at the passed node for "name" matching
250 * the given string. Returns the node on success, zero on failure.
251 */
252extern int prom_searchsiblings(int node_start, char *name);
253
254/* Return the first property type, as a string, for the given node.
255 * Returns a null string on error.
256 */
257extern char *prom_firstprop(int node);
258
259/* Returns the next property after the passed property for the given
260 * node. Returns null string on failure.
261 */
262extern char *prom_nextprop(int node, char *prev_property);
263
264/* Returns 1 if the specified node has given property. */
265extern int prom_node_has_property(int node, char *property);
266
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.
269 */
270extern int prom_setprop(int node, char *prop_name, char *prop_value,
271 int value_size);
272
273extern int prom_pathtoinode(char *path);
274extern int prom_inst2pkg(int);
275
276/* Dorking with Bus ranges... */
277
278/* Adjust reg values with the passed ranges. */
279extern void prom_adjust_regs(struct linux_prom_registers *regp, int nregs,
280 struct linux_prom_ranges *rangep, int nranges);
281
282/* Adjust child ranges with the passed parent ranges. */
283extern void prom_adjust_ranges(struct linux_prom_ranges *cranges, int ncranges,
284 struct linux_prom_ranges *pranges, int npranges);
285
286/* Apply promlib probed OBIO ranges to registers. */
287extern void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
288
289/* Apply ranges of any prom node (and optionally parent node as well) to registers. */
290extern void prom_apply_generic_ranges(int node, int parent,
291 struct linux_prom_registers *sbusregs, int nregs);
292
293
294#endif /* !(__SPARC_OPLIB_H) */