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