1 #ifndef __SPARC_OPENPROM_H
2 #define __SPARC_OPENPROM_H
4 /* openprom.h: Prom structures and defines for access to the OPENBOOT
5 * prom routines and data areas.
7 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
10 #include <asm/vaddrs.h>
12 /* Empirical constants... */
13 #define LINUX_OPPROM_MAGIC 0x10010407
16 /* V0 prom device operations. */
17 struct linux_dev_v0_funcs {
18 int (*v0_devopen)(char *device_str);
19 int (*v0_devclose)(int dev_desc);
20 int (*v0_rdblkdev)(int dev_desc, int num_blks, int blk_st, char *buf);
21 int (*v0_wrblkdev)(int dev_desc, int num_blks, int blk_st, char *buf);
22 int (*v0_wrnetdev)(int dev_desc, int num_bytes, char *buf);
23 int (*v0_rdnetdev)(int dev_desc, int num_bytes, char *buf);
24 int (*v0_rdchardev)(int dev_desc, int num_bytes, int dummy, char *buf);
25 int (*v0_wrchardev)(int dev_desc, int num_bytes, int dummy, char *buf);
26 int (*v0_seekdev)(int dev_desc, long logical_offst, int from);
29 /* V2 and later prom device operations. */
30 struct linux_dev_v2_funcs {
31 int (*v2_inst2pkg)(int d); /* Convert ihandle to phandle */
32 char * (*v2_dumb_mem_alloc)(char *va, unsigned sz);
33 void (*v2_dumb_mem_free)(char *va, unsigned sz);
35 /* To map devices into virtual I/O space. */
36 char * (*v2_dumb_mmap)(char *virta, int which_io, unsigned paddr, unsigned sz);
37 void (*v2_dumb_munmap)(char *virta, unsigned size);
39 int (*v2_dev_open)(char *devpath);
40 void (*v2_dev_close)(int d);
41 int (*v2_dev_read)(int d, char *buf, int nbytes);
42 int (*v2_dev_write)(int d, char *buf, int nbytes);
43 int (*v2_dev_seek)(int d, int hi, int lo);
45 /* Never issued (multistage load support) */
46 void (*v2_wheee2)(void);
47 void (*v2_wheee3)(void);
50 struct linux_mlist_v0 {
51 struct linux_mlist_v0 *theres_more;
57 struct linux_mlist_v0 **v0_totphys;
58 struct linux_mlist_v0 **v0_prommap;
59 struct linux_mlist_v0 **v0_available; /* What we can use */
62 /* Arguments sent to the kernel from the boot prompt. */
63 struct linux_arguments_v0 {
70 char *kernel_file_name;
71 void *aieee1; /* XXX */
74 /* V2 and up boot things. */
75 struct linux_bootargs_v2 {
82 /* The top level PROM vector. */
84 /* Version numbers. */
85 unsigned int pv_magic_cookie;
86 unsigned int pv_romvers;
87 unsigned int pv_plugin_revision;
88 unsigned int pv_printrev;
90 /* Version 0 memory descriptors. */
91 struct linux_mem_v0 pv_v0mem;
93 /* Node operations. */
94 struct linux_nodeops *pv_nodeops;
97 struct linux_dev_v0_funcs pv_v0devops;
101 #define PROMDEV_KBD 0 /* input from keyboard */
102 #define PROMDEV_SCREEN 0 /* output to screen */
103 #define PROMDEV_TTYA 1 /* in/out to ttya */
104 #define PROMDEV_TTYB 2 /* in/out to ttyb */
106 /* Blocking getchar/putchar. NOT REENTRANT! (grr) */
107 int (*pv_getchar)(void);
108 void (*pv_putchar)(int ch);
110 /* Non-blocking variants. */
111 int (*pv_nbgetchar)(void);
112 int (*pv_nbputchar)(int ch);
114 void (*pv_putstr)(char *str, int len);
117 void (*pv_reboot)(char *bootstr);
118 void (*pv_printf)(__const__ char *fmt, ...);
119 void (*pv_abort)(void);
120 __volatile__ int *pv_ticks;
121 void (*pv_halt)(void);
122 void (**pv_synchook)(void);
124 /* Evaluate a forth string, not different proto for V0 and V2->up. */
126 void (*v0_eval)(int len, char *str);
127 void (*v2_eval)(char *str);
130 struct linux_arguments_v0 **pv_v0bootargs;
132 /* Get ether address. */
133 unsigned int (*pv_enaddr)(int d, char *enaddr);
135 struct linux_bootargs_v2 pv_v2bootargs;
136 struct linux_dev_v2_funcs pv_v2devops;
140 /* This one is sun4c/sun4 only. */
141 void (*pv_setctxt)(int ctxt, char *va, int pmeg);
143 /* Prom version 3 Multiprocessor routines. This stuff is crazy.
144 * No joke. Calling these when there is only one cpu probably
145 * crashes the machine, have to test this. :-)
148 /* v3_cpustart() will start the cpu 'whichcpu' in mmu-context
149 * 'thiscontext' executing at address 'prog_counter'
151 int (*v3_cpustart)(unsigned int whichcpu, int ctxtbl_ptr,
152 int thiscontext, char *prog_counter);
154 /* v3_cpustop() will cause cpu 'whichcpu' to stop executing
155 * until a resume cpu call is made.
157 int (*v3_cpustop)(unsigned int whichcpu);
159 /* v3_cpuidle() will idle cpu 'whichcpu' until a stop or
160 * resume cpu call is made.
162 int (*v3_cpuidle)(unsigned int whichcpu);
164 /* v3_cpuresume() will resume processor 'whichcpu' executing
165 * starting with whatever 'pc' and 'npc' were left at the
166 * last 'idle' or 'stop' call.
168 int (*v3_cpuresume)(unsigned int whichcpu);
171 /* Routines for traversing the prom device tree. */
172 struct linux_nodeops {
173 int (*no_nextnode)(int node);
174 int (*no_child)(int node);
175 int (*no_proplen)(int node, char *name);
176 int (*no_getprop)(int node, char *name, char *val);
177 int (*no_setprop)(int node, char *name, char *val, int len);
178 char * (*no_nextprop)(int node, char *name);
181 /* More fun PROM structures for device probing. */
182 #define PROMREG_MAX 16
183 #define PROMVADDR_MAX 16
184 #define PROMINTR_MAX 15
186 struct linux_prom_registers {
187 unsigned int which_io; /* is this in OBIO space? */
188 unsigned int phys_addr; /* The physical address of this register */
189 unsigned int reg_size; /* How many bytes does this register take up? */
192 struct linux_prom_irqs {
193 int pri; /* IRQ priority */
194 int vector; /* This is foobar, what does it do? */
197 /* Element of the "ranges" vector */
198 struct linux_prom_ranges {
199 unsigned int ot_child_space;
200 unsigned int ot_child_base; /* Bus feels this */
201 unsigned int ot_parent_space;
202 unsigned int ot_parent_base; /* CPU looks from here */
203 unsigned int or_size;
206 /* Ranges and reg properties are a bit different for PCI. */
207 struct linux_prom_pci_registers {
209 * We don't know what information this field contain.
210 * We guess, PCI device function is in bits 15:8
213 unsigned int which_io; /* Let it be which_io */
215 unsigned int phys_hi;
216 unsigned int phys_lo;
218 unsigned int size_hi;
219 unsigned int size_lo;
222 struct linux_prom_pci_ranges {
223 unsigned int child_phys_hi; /* Only certain bits are encoded here. */
224 unsigned int child_phys_mid;
225 unsigned int child_phys_lo;
227 unsigned int parent_phys_hi;
228 unsigned int parent_phys_lo;
230 unsigned int size_hi;
231 unsigned int size_lo;
234 struct linux_prom_pci_assigned_addresses {
235 unsigned int which_io;
237 unsigned int phys_hi;
238 unsigned int phys_lo;
240 unsigned int size_hi;
241 unsigned int size_lo;
244 struct linux_prom_ebus_ranges {
245 unsigned int child_phys_hi;
246 unsigned int child_phys_lo;
248 unsigned int parent_phys_hi;
249 unsigned int parent_phys_mid;
250 unsigned int parent_phys_lo;
255 #endif /* !(__ASSEMBLY__) */
257 #endif /* !(__SPARC_OPENPROM_H) */