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 <asm/openprom.h>
13 #include <linux/spinlock.h>
14 #include <linux/compiler.h>
15
16 /* The master romvec pointer... */
17 extern struct linux_romvec *romvec;
18
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 */
25 };
26
27 extern enum prom_major_version prom_vers;
28 /* Revision, and firmware revision. */
29 extern unsigned int prom_rev, prom_prev;
30
31 /* Root node of the prom device tree, this stays constant after
32 * initialization is complete.
33 */
34 extern phandle 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 */
40 extern 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 */
47 void prom_init(struct linux_romvec *rom_ptr);
48
49 /* Boot argument acquisition, returns the boot command line string. */
50 char *prom_getbootargs(void);
51
52 /* Miscellaneous routines, don't really fit in any category per se. */
53
54 /* Reboot the machine with the command line passed. */
55 void prom_reboot(char *boot_command);
56
57 /* Evaluate the forth string passed. */
58 void prom_feval(char *forth_string);
59
60 /* Enter the prom, with possibility of continuation with the 'go'
61 * command in newer proms.
62 */
63 void prom_cmdline(void);
64
65 /* Enter the prom, with no chance of continuation for the stand-alone
66 * which calls this.
67 */
68 void __noreturn prom_halt(void);
69
70 /* Set the PROM 'sync' callback function to the passed function pointer.
71 * When the user gives the 'sync' command at the prom prompt while the
72 * kernel is still active, the prom will call this routine.
73 *
74 * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX
75 */
76 typedef void (*sync_func_t)(void);
77 void prom_setsync(sync_func_t func_ptr);
78
79 /* Acquire the IDPROM of the root node in the prom device tree. This
80 * gets passed a buffer where you would like it stuffed. The return value
81 * is the format type of this idprom or 0xff on error.
82 */
83 unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size);
84
85 /* Get the prom major version. */
86 int prom_version(void);
87
88 /* Get the prom plugin revision. */
89 int prom_getrev(void);
90
91 /* Get the prom firmware revision. */
92 int prom_getprev(void);
93
94 /* Write a buffer of characters to the console. */
95 void prom_console_write_buf(const char *buf, int len);
96
97 /* Prom's internal routines, don't use in kernel/boot code. */
98 __printf(1, 2) void prom_printf(const char *fmt, ...);
99 void prom_write(const char *buf, unsigned int len);
100
101 /* Multiprocessor operations... */
102
103 /* Start the CPU with the given device tree node, context table, and context
104 * at the passed program counter.
105 */
106 int prom_startcpu(int cpunode, struct linux_prom_registers *context_table,
107 int context, char *program_counter);
108
109 /* Initialize the memory lists based upon the prom version. */
110 void prom_meminit(void);
111
112 /* PROM device tree traversal functions... */
113
114 /* Get the child node of the given node, or zero if no child exists. */
115 phandle prom_getchild(phandle parent_node);
116
117 /* Get the next sibling node of the given node, or zero if no further
118 * siblings exist.
119 */
120 phandle prom_getsibling(phandle node);
121
122 /* Get the length, at the passed node, of the given property type.
123 * Returns -1 on error (ie. no such property at this node).
124 */
125 int prom_getproplen(phandle thisnode, const char *property);
126
127 /* Fetch the requested property using the given buffer. Returns
128 * the number of bytes the prom put into your buffer or -1 on error.
129 */
130 int __must_check prom_getproperty(phandle thisnode, const char *property,
131 char *prop_buffer, int propbuf_size);
132
133 /* Acquire an integer property. */
134 int prom_getint(phandle node, char *property);
135
136 /* Acquire an integer property, with a default value. */
137 int prom_getintdefault(phandle node, char *property, int defval);
138
139 /* Acquire a boolean property, 0=FALSE 1=TRUE. */
140 int prom_getbool(phandle node, char *prop);
141
142 /* Acquire a string property, null string on error. */
143 void prom_getstring(phandle node, char *prop, char *buf, int bufsize);
144
145 /* Search all siblings starting at the passed node for "name" matching
146 * the given string. Returns the node on success, zero on failure.
147 */
148 phandle prom_searchsiblings(phandle node_start, char *name);
149
150 /* Returns the next property after the passed property for the given
151 * node. Returns null string on failure.
152 */
153 char *prom_nextprop(phandle node, char *prev_property, char *buffer);
154
155 /* Returns phandle of the path specified */
156 phandle prom_finddevice(char *name);
157
158 /* Set the indicated property at the given node with the passed value.
159 * Returns the number of bytes of your value that the prom took.
160 */
161 int prom_setprop(phandle node, const char *prop_name, char *prop_value,
162 int value_size);
163
164 phandle prom_inst2pkg(int);
165
166 /* Dorking with Bus ranges... */
167
168 /* Apply promlib probes OBIO ranges to registers. */
169 void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs);
170
171 /* Apply ranges of any prom node (and optionally parent node as well) to registers. */
172 void prom_apply_generic_ranges(phandle node, phandle parent,
173 struct linux_prom_registers *sbusregs, int nregs);
174
175 void prom_ranges_init(void);
176
177 /* CPU probing helpers. */
178 int cpu_find_by_instance(int instance, phandle *prom_node, int *mid);
179 int cpu_find_by_mid(int mid, phandle *prom_node);
180 int cpu_get_hwmid(phandle prom_node);
181
182 extern spinlock_t prom_lock;
183
184 #endif /* !(__SPARC_OPLIB_H) */