/arch/sparc/include/asm/oplib_64.h

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