LXR linux/arch/sparc/include/asm/oplib

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