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/* Miscellaneous routines, don't really fit in any category per se. */ 71 72/* Reboot the machine with the command line passed. */ 73extern void prom_reboot(const char *boot_command); 74 75/* Evaluate the forth string passed. */ 76extern void prom_feval(const char *forth_string); 77 78/* Enter the prom, with possibility of continuation with the 'go' 79 * command in newer proms. 80 */ 81extern void prom_cmdline(void); 82 83/* Enter the prom, with no chance of continuation for the stand-alone 84 * which calls this. 85 */ 86extern void prom_halt(void) __attribute__ ((noreturn)); 87 88/* Halt and power-off the machine. */ 89extern void prom_halt_power_off(void) __attribute__ ((noreturn)); 90 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. 94 */ 95extern unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size); 96 97/* Write a buffer of characters to the console. */ 98extern void prom_console_write_buf(const char *buf, int len); 99 100/* Prom's internal routines, don't use in kernel/boot code. */ 101extern void prom_printf(const char *fmt, ...); 102extern void prom_write(const char *buf, unsigned int len); 103 104/* Multiprocessor operations... */ 105#ifdef CONFIG_SMP 106/* Start the CPU with the given device tree node at the passed program 107 * counter with the given arg passed in via register %o0. 108 */ 109extern void prom_startcpu(int cpunode, unsigned long pc, unsigned long arg); 110 111/* Start the CPU with the given cpu ID at the passed program 112 * counter with the given arg passed in via register %o0. 113 */ 114extern void prom_startcpu_cpuid(int cpuid, unsigned long pc, unsigned long arg); 115 116/* Stop the CPU with the given cpu ID. */ 117extern void prom_stopcpu_cpuid(int cpuid); 118 119/* Stop the current CPU. */ 120extern void prom_stopself(void); 121 122/* Idle the current CPU. */ 123extern void prom_idleself(void); 124 125/* Resume the CPU with the passed device tree node. */ 126extern void prom_resumecpu(int cpunode); 127#endif 128 129/* Power management interfaces. */ 130 131/* Put the current CPU to sleep. */ 132extern void prom_sleepself(void); 133 134/* Put the entire system to sleep. */ 135extern int prom_sleepsystem(void); 136 137/* Initiate a wakeup event. */ 138extern int prom_wakeupsystem(void); 139 140/* MMU and memory related OBP interfaces. */ 141 142/* Get unique string identifying SIMM at given physical address. */ 143extern int prom_getunumber(int syndrome_code, 144 unsigned long phys_addr, 145 char *buf, int buflen); 146 147/* Retain physical memory to the caller across soft resets. */ 148extern int prom_retain(const char *name, unsigned long size, 149 unsigned long align, unsigned long *paddr); 150 151/* Load explicit I/D TLB entries into the calling processor. */ 152extern long prom_itlb_load(unsigned long index, 153 unsigned long tte_data, 154 unsigned long vaddr); 155 156extern long prom_dtlb_load(unsigned long index, 157 unsigned long tte_data, 158 unsigned long vaddr); 159 160/* Map/Unmap client program address ranges. First the format of 161 * the mapping mode argument. 162 */ 163#define PROM_MAP_WRITE 0x0001 /* Writable */ 164#define PROM_MAP_READ 0x0002 /* Readable - sw */ 165#define PROM_MAP_EXEC 0x0004 /* Executable - sw */ 166#define PROM_MAP_LOCKED 0x0010 /* Locked, use i/dtlb load calls for this instead */ 167#define PROM_MAP_CACHED 0x0020 /* Cacheable in both L1 and L2 caches */ 168#define PROM_MAP_SE 0x0040 /* Side-Effects */ 169#define PROM_MAP_GLOB 0x0080 /* Global */ 170#define PROM_MAP_IE 0x0100 /* Invert-Endianness */ 171#define PROM_MAP_DEFAULT (PROM_MAP_WRITE | PROM_MAP_READ | PROM_MAP_EXEC | PROM_MAP_CACHED) 172 173extern int prom_map(int mode, unsigned long size, 174 unsigned long vaddr, unsigned long paddr); 175extern void prom_unmap(unsigned long size, unsigned long vaddr); 176 177 178/* PROM device tree traversal functions... */ 179 180/* Get the child node of the given node, or zero if no child exists. */ 181extern int prom_getchild(int parent_node); 182 183/* Get the next sibling node of the given node, or zero if no further 184 * siblings exist. 185 */ 186extern int prom_getsibling(int node); 187 188/* Get the length, at the passed node, of the given property type. 189 * Returns -1 on error (ie. no such property at this node). 190 */ 191extern int prom_getproplen(int thisnode, const char *property); 192 193/* Fetch the requested property using the given buffer. Returns 194 * the number of bytes the prom put into your buffer or -1 on error. 195 */ 196extern int prom_getproperty(int thisnode, const char *property, 197 char *prop_buffer, int propbuf_size); 198 199/* Acquire an integer property. */ 200extern int prom_getint(int node, const char *property); 201 202/* Acquire an integer property, with a default value. */ 203extern int prom_getintdefault(int node, const char *property, int defval); 204 205/* Acquire a boolean property, 0=FALSE 1=TRUE. */ 206extern int prom_getbool(int node, const char *prop); 207 208/* Acquire a string property, null string on error. */ 209extern void prom_getstring(int node, const char *prop, char *buf, int bufsize); 210 211/* Does the passed node have the given "name"? YES=1 NO=0 */ 212extern int prom_nodematch(int thisnode, const char *name); 213 214/* Search all siblings starting at the passed node for "name" matching 215 * the given string. Returns the node on success, zero on failure. 216 */ 217extern int prom_searchsiblings(int node_start, const char *name); 218 219/* Return the first property type, as a string, for the given node. 220 * Returns a null string on error. Buffer should be at least 32B long. 221 */ 222extern char *prom_firstprop(int node, char *buffer); 223 224/* Returns the next property after the passed property for the given 225 * node. Returns null string on failure. Buffer should be at least 32B long. 226 */ 227extern char *prom_nextprop(int node, const char *prev_property, char *buffer); 228 229/* Returns 1 if the specified node has given property. */ 230extern int prom_node_has_property(int node, const char *property); 231 232/* Returns phandle of the path specified */ 233extern int prom_finddevice(const char *name); 234 235/* Set the indicated property at the given node with the passed value. 236 * Returns the number of bytes of your value that the prom took. 237 */ 238extern int prom_setprop(int node, const char *prop_name, char *prop_value, 239 int value_size); 240 241extern int prom_inst2pkg(int); 242extern void prom_sun4v_guest_soft_state(void); 243 244extern int prom_ihandle2path(int handle, char *buffer, int bufsize); 245 246/* Client interface level routines. */ 247extern void p1275_cmd_direct(unsigned long *); 248 249#endif /* !(__SPARC64_OPLIB_H) */ 250