Commit | Line | Data |
---|---|---|
f5e706ad SR |
1 | /* |
2 | * oplib.h: Describes the interface and available routines in the | |
3 | * Linux Prom library. | |
4 | * | |
5 | * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu) | |
6 | */ | |
7 | ||
8 | #ifndef __SPARC_OPLIB_H | |
9 | #define __SPARC_OPLIB_H | |
10 | ||
11 | #include <asm/openprom.h> | |
12 | #include <linux/spinlock.h> | |
13 | #include <linux/compiler.h> | |
14 | ||
15 | /* The master romvec pointer... */ | |
16 | extern struct linux_romvec *romvec; | |
17 | ||
18 | /* Enumeration to describe the prom major version we have detected. */ | |
19 | enum prom_major_version { | |
20 | PROM_V0, /* Original sun4c V0 prom */ | |
21 | PROM_V2, /* sun4c and early sun4m V2 prom */ | |
22 | PROM_V3, /* sun4m and later, up to sun4d/sun4e machines V3 */ | |
23 | PROM_P1275, /* IEEE compliant ISA based Sun PROM, only sun4u */ | |
f5e706ad SR |
24 | }; |
25 | ||
26 | extern enum prom_major_version prom_vers; | |
27 | /* Revision, and firmware revision. */ | |
28 | extern unsigned int prom_rev, prom_prev; | |
29 | ||
30 | /* Root node of the prom device tree, this stays constant after | |
31 | * initialization is complete. | |
32 | */ | |
8d125562 | 33 | extern phandle prom_root_node; |
f5e706ad SR |
34 | |
35 | /* Pointer to prom structure containing the device tree traversal | |
36 | * and usage utility functions. Only prom-lib should use these, | |
37 | * users use the interface defined by the library only! | |
38 | */ | |
39 | extern struct linux_nodeops *prom_nodeops; | |
40 | ||
41 | /* The functions... */ | |
42 | ||
43 | /* You must call prom_init() before using any of the library services, | |
44 | * preferably as early as possible. Pass it the romvec pointer. | |
45 | */ | |
f05a6865 | 46 | void prom_init(struct linux_romvec *rom_ptr); |
f5e706ad SR |
47 | |
48 | /* Boot argument acquisition, returns the boot command line string. */ | |
f05a6865 | 49 | char *prom_getbootargs(void); |
f5e706ad | 50 | |
f5e706ad SR |
51 | /* Miscellaneous routines, don't really fit in any category per se. */ |
52 | ||
53 | /* Reboot the machine with the command line passed. */ | |
f05a6865 | 54 | void prom_reboot(char *boot_command); |
f5e706ad SR |
55 | |
56 | /* Evaluate the forth string passed. */ | |
f05a6865 | 57 | void prom_feval(char *forth_string); |
f5e706ad SR |
58 | |
59 | /* Enter the prom, with possibility of continuation with the 'go' | |
60 | * command in newer proms. | |
61 | */ | |
f05a6865 | 62 | void prom_cmdline(void); |
f5e706ad SR |
63 | |
64 | /* Enter the prom, with no chance of continuation for the stand-alone | |
65 | * which calls this. | |
66 | */ | |
f05a6865 | 67 | void __noreturn prom_halt(void); |
f5e706ad SR |
68 | |
69 | /* Set the PROM 'sync' callback function to the passed function pointer. | |
70 | * When the user gives the 'sync' command at the prom prompt while the | |
71 | * kernel is still active, the prom will call this routine. | |
72 | * | |
73 | * XXX The arguments are different on V0 vs. V2->higher proms, grrr! XXX | |
74 | */ | |
75 | typedef void (*sync_func_t)(void); | |
f05a6865 | 76 | void prom_setsync(sync_func_t func_ptr); |
f5e706ad SR |
77 | |
78 | /* Acquire the IDPROM of the root node in the prom device tree. This | |
79 | * gets passed a buffer where you would like it stuffed. The return value | |
80 | * is the format type of this idprom or 0xff on error. | |
81 | */ | |
f05a6865 | 82 | unsigned char prom_get_idprom(char *idp_buffer, int idpbuf_size); |
f5e706ad SR |
83 | |
84 | /* Get the prom major version. */ | |
f05a6865 | 85 | int prom_version(void); |
f5e706ad SR |
86 | |
87 | /* Get the prom plugin revision. */ | |
f05a6865 | 88 | int prom_getrev(void); |
f5e706ad SR |
89 | |
90 | /* Get the prom firmware revision. */ | |
f05a6865 | 91 | int prom_getprev(void); |
f5e706ad | 92 | |
595a251c | 93 | /* Write a buffer of characters to the console. */ |
f05a6865 | 94 | void prom_console_write_buf(const char *buf, int len); |
f5e706ad SR |
95 | |
96 | /* Prom's internal routines, don't use in kernel/boot code. */ | |
f05a6865 SR |
97 | __printf(1, 2) void prom_printf(const char *fmt, ...); |
98 | void prom_write(const char *buf, unsigned int len); | |
f5e706ad SR |
99 | |
100 | /* Multiprocessor operations... */ | |
101 | ||
102 | /* Start the CPU with the given device tree node, context table, and context | |
103 | * at the passed program counter. | |
104 | */ | |
f05a6865 SR |
105 | int prom_startcpu(int cpunode, struct linux_prom_registers *context_table, |
106 | int context, char *program_counter); | |
f5e706ad | 107 | |
5f66dd35 SR |
108 | /* Initialize the memory lists based upon the prom version. */ |
109 | void prom_meminit(void); | |
f5e706ad SR |
110 | |
111 | /* PROM device tree traversal functions... */ | |
112 | ||
f5e706ad | 113 | /* Get the child node of the given node, or zero if no child exists. */ |
f05a6865 | 114 | phandle prom_getchild(phandle parent_node); |
f5e706ad SR |
115 | |
116 | /* Get the next sibling node of the given node, or zero if no further | |
117 | * siblings exist. | |
118 | */ | |
f05a6865 | 119 | phandle prom_getsibling(phandle node); |
f5e706ad SR |
120 | |
121 | /* Get the length, at the passed node, of the given property type. | |
122 | * Returns -1 on error (ie. no such property at this node). | |
123 | */ | |
f05a6865 | 124 | int prom_getproplen(phandle thisnode, const char *property); |
f5e706ad SR |
125 | |
126 | /* Fetch the requested property using the given buffer. Returns | |
127 | * the number of bytes the prom put into your buffer or -1 on error. | |
128 | */ | |
f05a6865 SR |
129 | int __must_check prom_getproperty(phandle thisnode, const char *property, |
130 | char *prop_buffer, int propbuf_size); | |
f5e706ad SR |
131 | |
132 | /* Acquire an integer property. */ | |
f05a6865 | 133 | int prom_getint(phandle node, char *property); |
f5e706ad SR |
134 | |
135 | /* Acquire an integer property, with a default value. */ | |
f05a6865 | 136 | int prom_getintdefault(phandle node, char *property, int defval); |
f5e706ad SR |
137 | |
138 | /* Acquire a boolean property, 0=FALSE 1=TRUE. */ | |
f05a6865 | 139 | int prom_getbool(phandle node, char *prop); |
f5e706ad SR |
140 | |
141 | /* Acquire a string property, null string on error. */ | |
f05a6865 | 142 | void prom_getstring(phandle node, char *prop, char *buf, int bufsize); |
f5e706ad | 143 | |
f5e706ad SR |
144 | /* Search all siblings starting at the passed node for "name" matching |
145 | * the given string. Returns the node on success, zero on failure. | |
146 | */ | |
f05a6865 | 147 | phandle prom_searchsiblings(phandle node_start, char *name); |
f5e706ad | 148 | |
f5e706ad SR |
149 | /* Returns the next property after the passed property for the given |
150 | * node. Returns null string on failure. | |
151 | */ | |
f05a6865 | 152 | char *prom_nextprop(phandle node, char *prev_property, char *buffer); |
f5e706ad SR |
153 | |
154 | /* Returns phandle of the path specified */ | |
f05a6865 | 155 | phandle prom_finddevice(char *name); |
f5e706ad | 156 | |
f5e706ad SR |
157 | /* Set the indicated property at the given node with the passed value. |
158 | * Returns the number of bytes of your value that the prom took. | |
159 | */ | |
f05a6865 SR |
160 | int prom_setprop(phandle node, const char *prop_name, char *prop_value, |
161 | int value_size); | |
f5e706ad | 162 | |
f05a6865 | 163 | phandle prom_inst2pkg(int); |
f5e706ad SR |
164 | |
165 | /* Dorking with Bus ranges... */ | |
166 | ||
167 | /* Apply promlib probes OBIO ranges to registers. */ | |
f05a6865 | 168 | void prom_apply_obio_ranges(struct linux_prom_registers *obioregs, int nregs); |
f5e706ad SR |
169 | |
170 | /* Apply ranges of any prom node (and optionally parent node as well) to registers. */ | |
f05a6865 SR |
171 | void prom_apply_generic_ranges(phandle node, phandle parent, |
172 | struct linux_prom_registers *sbusregs, int nregs); | |
f5e706ad | 173 | |
5f66dd35 SR |
174 | void prom_ranges_init(void); |
175 | ||
f5e706ad | 176 | /* CPU probing helpers. */ |
8d125562 AS |
177 | int cpu_find_by_instance(int instance, phandle *prom_node, int *mid); |
178 | int cpu_find_by_mid(int mid, phandle *prom_node); | |
179 | int cpu_get_hwmid(phandle prom_node); | |
f5e706ad SR |
180 | |
181 | extern spinlock_t prom_lock; | |
182 | ||
183 | #endif /* !(__SPARC_OPLIB_H) */ |