]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
f5e706ad SR |
2 | /* oplib.h: Describes the interface and available routines in the |
3 | * Linux Prom library. | |
4 | * | |
5 | * Copyright (C) 1995, 2007 David S. Miller (davem@davemloft.net) | |
6 | * Copyright (C) 1996 Jakub Jelinek (jj@sunsite.mff.cuni.cz) | |
7 | */ | |
8 | ||
9 | #ifndef __SPARC64_OPLIB_H | |
10 | #define __SPARC64_OPLIB_H | |
11 | ||
12 | #include <asm/openprom.h> | |
13 | ||
14 | /* OBP version string. */ | |
15 | extern char prom_version[]; | |
16 | ||
17 | /* Root node of the prom device tree, this stays constant after | |
18 | * initialization is complete. | |
19 | */ | |
8d125562 | 20 | extern phandle prom_root_node; |
f5e706ad | 21 | |
bce5feea DM |
22 | /* PROM stdout */ |
23 | extern int prom_stdout; | |
f5e706ad SR |
24 | |
25 | /* /chosen node of the prom device tree, this stays constant after | |
26 | * initialization is complete. | |
27 | */ | |
8d125562 | 28 | extern phandle prom_chosen_node; |
f5e706ad SR |
29 | |
30 | /* Helper values and strings in arch/sparc64/kernel/head.S */ | |
31 | extern const char prom_peer_name[]; | |
32 | extern const char prom_compatible_name[]; | |
33 | extern const char prom_root_compatible[]; | |
34 | extern const char prom_cpu_compatible[]; | |
35 | extern const char prom_finddev_name[]; | |
36 | extern const char prom_chosen_path[]; | |
37 | extern const char prom_cpu_path[]; | |
38 | extern const char prom_getprop_name[]; | |
39 | extern const char prom_mmu_name[]; | |
40 | extern const char prom_callmethod_name[]; | |
41 | extern const char prom_translate_name[]; | |
42 | extern const char prom_map_name[]; | |
43 | extern const char prom_unmap_name[]; | |
44 | extern int prom_mmu_ihandle_cache; | |
45 | extern unsigned int prom_boot_mapped_pc; | |
46 | extern unsigned int prom_boot_mapping_mode; | |
47 | extern unsigned long prom_boot_mapping_phys_high, prom_boot_mapping_phys_low; | |
48 | ||
49 | struct linux_mlist_p1275 { | |
50 | struct linux_mlist_p1275 *theres_more; | |
51 | unsigned long start_adr; | |
52 | unsigned long num_bytes; | |
53 | }; | |
54 | ||
55 | struct linux_mem_p1275 { | |
56 | struct linux_mlist_p1275 **p1275_totphys; | |
57 | struct linux_mlist_p1275 **p1275_prommap; | |
58 | struct linux_mlist_p1275 **p1275_available; /* What we can use */ | |
59 | }; | |
60 | ||
61 | /* The functions... */ | |
62 | ||
63 | /* You must call prom_init() before using any of the library services, | |
64 | * preferably as early as possible. Pass it the romvec pointer. | |
65 | */ | |
ef3e035c DM |
66 | void prom_init(void *cif_handler); |
67 | void prom_init_report(void); | |
f5e706ad SR |
68 | |
69 | /* Boot argument acquisition, returns the boot command line string. */ | |
f05a6865 | 70 | char *prom_getbootargs(void); |
f5e706ad | 71 | |
f5e706ad SR |
72 | /* Miscellaneous routines, don't really fit in any category per se. */ |
73 | ||
74 | /* Reboot the machine with the command line passed. */ | |
f05a6865 | 75 | void prom_reboot(const char *boot_command); |
f5e706ad SR |
76 | |
77 | /* Evaluate the forth string passed. */ | |
f05a6865 | 78 | void prom_feval(const char *forth_string); |
f5e706ad SR |
79 | |
80 | /* Enter the prom, with possibility of continuation with the 'go' | |
81 | * command in newer proms. | |
82 | */ | |
f05a6865 | 83 | void prom_cmdline(void); |
f5e706ad SR |
84 | |
85 | /* Enter the prom, with no chance of continuation for the stand-alone | |
86 | * which calls this. | |
87 | */ | |
f05a6865 | 88 | void prom_halt(void) __attribute__ ((noreturn)); |
f5e706ad SR |
89 | |
90 | /* Halt and power-off the machine. */ | |
f05a6865 | 91 | void prom_halt_power_off(void) __attribute__ ((noreturn)); |
f5e706ad | 92 | |
f5e706ad SR |
93 | /* Acquire the IDPROM of the root node in the prom device tree. This |
94 | * gets passed a buffer where you would like it stuffed. The return value | |
95 | * is the format type of this idprom or 0xff on error. | |
96 | */ | |
f05a6865 | 97 | unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size); |
f5e706ad | 98 | |
595a251c | 99 | /* Write a buffer of characters to the console. */ |
f05a6865 | 100 | void prom_console_write_buf(const char *buf, int len); |
f5e706ad SR |
101 | |
102 | /* Prom's internal routines, don't use in kernel/boot code. */ | |
f05a6865 SR |
103 | __printf(1, 2) void prom_printf(const char *fmt, ...); |
104 | void prom_write(const char *buf, unsigned int len); | |
f5e706ad SR |
105 | |
106 | /* Multiprocessor operations... */ | |
107 | #ifdef CONFIG_SMP | |
108 | /* Start the CPU with the given device tree node at the passed program | |
109 | * counter with the given arg passed in via register %o0. | |
110 | */ | |
f05a6865 | 111 | void prom_startcpu(int cpunode, unsigned long pc, unsigned long arg); |
f5e706ad SR |
112 | |
113 | /* Start the CPU with the given cpu ID at the passed program | |
114 | * counter with the given arg passed in via register %o0. | |
115 | */ | |
f05a6865 | 116 | void prom_startcpu_cpuid(int cpuid, unsigned long pc, unsigned long arg); |
f5e706ad SR |
117 | |
118 | /* Stop the CPU with the given cpu ID. */ | |
f05a6865 | 119 | void prom_stopcpu_cpuid(int cpuid); |
f5e706ad SR |
120 | |
121 | /* Stop the current CPU. */ | |
f05a6865 | 122 | void prom_stopself(void); |
f5e706ad SR |
123 | |
124 | /* Idle the current CPU. */ | |
f05a6865 | 125 | void prom_idleself(void); |
f5e706ad SR |
126 | |
127 | /* Resume the CPU with the passed device tree node. */ | |
f05a6865 | 128 | void prom_resumecpu(int cpunode); |
f5e706ad SR |
129 | #endif |
130 | ||
131 | /* Power management interfaces. */ | |
132 | ||
133 | /* Put the current CPU to sleep. */ | |
f05a6865 | 134 | void prom_sleepself(void); |
f5e706ad SR |
135 | |
136 | /* Put the entire system to sleep. */ | |
f05a6865 | 137 | int prom_sleepsystem(void); |
f5e706ad SR |
138 | |
139 | /* Initiate a wakeup event. */ | |
f05a6865 | 140 | int prom_wakeupsystem(void); |
f5e706ad SR |
141 | |
142 | /* MMU and memory related OBP interfaces. */ | |
143 | ||
144 | /* Get unique string identifying SIMM at given physical address. */ | |
f05a6865 SR |
145 | int prom_getunumber(int syndrome_code, |
146 | unsigned long phys_addr, | |
147 | char *buf, int buflen); | |
f5e706ad SR |
148 | |
149 | /* Retain physical memory to the caller across soft resets. */ | |
f05a6865 SR |
150 | int prom_retain(const char *name, unsigned long size, |
151 | unsigned long align, unsigned long *paddr); | |
f5e706ad SR |
152 | |
153 | /* Load explicit I/D TLB entries into the calling processor. */ | |
f05a6865 SR |
154 | long prom_itlb_load(unsigned long index, |
155 | unsigned long tte_data, | |
156 | unsigned long vaddr); | |
f5e706ad | 157 | |
f05a6865 SR |
158 | long prom_dtlb_load(unsigned long index, |
159 | unsigned long tte_data, | |
160 | unsigned long vaddr); | |
f5e706ad SR |
161 | |
162 | /* Map/Unmap client program address ranges. First the format of | |
163 | * the mapping mode argument. | |
164 | */ | |
165 | #define PROM_MAP_WRITE 0x0001 /* Writable */ | |
166 | #define PROM_MAP_READ 0x0002 /* Readable - sw */ | |
167 | #define PROM_MAP_EXEC 0x0004 /* Executable - sw */ | |
168 | #define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */ | |
169 | #define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */ | |
170 | #define PROM_MAP_SE 0x0040 /* Side-Effects */ | |
171 | #define PROM_MAP_GLOB 0x0080 /* Global */ | |
172 | #define PROM_MAP_IE 0x0100 /* Invert-Endianness */ | |
173 | #define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED) | |
174 | ||
f05a6865 SR |
175 | int prom_map(int mode, unsigned long size, |
176 | unsigned long vaddr, unsigned long paddr); | |
177 | void prom_unmap(unsigned long size, unsigned long vaddr); | |
f5e706ad SR |
178 | |
179 | ||
180 | /* PROM device tree traversal functions... */ | |
181 | ||
f5e706ad | 182 | /* Get the child node of the given node, or zero if no child exists. */ |
f05a6865 | 183 | phandle prom_getchild(phandle parent_node); |
f5e706ad SR |
184 | |
185 | /* Get the next sibling node of the given node, or zero if no further | |
186 | * siblings exist. | |
187 | */ | |
f05a6865 | 188 | phandle prom_getsibling(phandle node); |
f5e706ad SR |
189 | |
190 | /* Get the length, at the passed node, of the given property type. | |
191 | * Returns -1 on error (ie. no such property at this node). | |
192 | */ | |
f05a6865 | 193 | int prom_getproplen(phandle thisnode, const char *property); |
f5e706ad SR |
194 | |
195 | /* Fetch the requested property using the given buffer. Returns | |
196 | * the number of bytes the prom put into your buffer or -1 on error. | |
197 | */ | |
f05a6865 SR |
198 | int prom_getproperty(phandle thisnode, const char *property, |
199 | char *prop_buffer, int propbuf_size); | |
f5e706ad SR |
200 | |
201 | /* Acquire an integer property. */ | |
f05a6865 | 202 | int prom_getint(phandle node, const char *property); |
f5e706ad SR |
203 | |
204 | /* Acquire an integer property, with a default value. */ | |
f05a6865 | 205 | int prom_getintdefault(phandle node, const char *property, int defval); |
f5e706ad SR |
206 | |
207 | /* Acquire a boolean property, 0=FALSE 1=TRUE. */ | |
f05a6865 | 208 | int prom_getbool(phandle node, const char *prop); |
f5e706ad SR |
209 | |
210 | /* Acquire a string property, null string on error. */ | |
f05a6865 SR |
211 | void prom_getstring(phandle node, const char *prop, char *buf, |
212 | int bufsize); | |
f5e706ad SR |
213 | |
214 | /* Does the passed node have the given "name"? YES=1 NO=0 */ | |
f05a6865 | 215 | int prom_nodematch(phandle thisnode, const char *name); |
f5e706ad SR |
216 | |
217 | /* Search all siblings starting at the passed node for "name" matching | |
218 | * the given string. Returns the node on success, zero on failure. | |
219 | */ | |
f05a6865 | 220 | phandle prom_searchsiblings(phandle node_start, const char *name); |
f5e706ad SR |
221 | |
222 | /* Return the first property type, as a string, for the given node. | |
223 | * Returns a null string on error. Buffer should be at least 32B long. | |
224 | */ | |
f05a6865 | 225 | char *prom_firstprop(phandle node, char *buffer); |
f5e706ad SR |
226 | |
227 | /* Returns the next property after the passed property for the given | |
228 | * node. Returns null string on failure. Buffer should be at least 32B long. | |
229 | */ | |
f05a6865 | 230 | char *prom_nextprop(phandle node, const char *prev_property, char *buf); |
f5e706ad SR |
231 | |
232 | /* Returns 1 if the specified node has given property. */ | |
f05a6865 | 233 | int prom_node_has_property(phandle node, const char *property); |
f5e706ad SR |
234 | |
235 | /* Returns phandle of the path specified */ | |
f05a6865 | 236 | phandle prom_finddevice(const char *name); |
f5e706ad SR |
237 | |
238 | /* Set the indicated property at the given node with the passed value. | |
239 | * Returns the number of bytes of your value that the prom took. | |
240 | */ | |
f05a6865 SR |
241 | int prom_setprop(phandle node, const char *prop_name, char *prop_value, |
242 | int value_size); | |
f5e706ad | 243 | |
f05a6865 SR |
244 | phandle prom_inst2pkg(int); |
245 | void prom_sun4v_guest_soft_state(void); | |
f5e706ad | 246 | |
f05a6865 | 247 | int prom_ihandle2path(int handle, char *buffer, int bufsize); |
f5e706ad SR |
248 | |
249 | /* Client interface level routines. */ | |
f05a6865 | 250 | void p1275_cmd_direct(unsigned long *); |
f5e706ad SR |
251 | |
252 | #endif /* !(__SPARC64_OPLIB_H) */ |