[mirror_ubuntu-kernels.git] / include / asm-sparc / openprom_64.h

#ifndef __SPARC64_OPENPROM_H
#define __SPARC64_OPENPROM_H

/* openprom.h:  Prom structures and defines for access to the OPENBOOT
 *              prom routines and data areas.
 *
 * Copyright (C) 1996 David S. Miller (davem@caip.rutgers.edu)
 */

#ifndef __ASSEMBLY__
/* V0 prom device operations. */
struct linux_dev_v0_funcs {
	int (*v0_devopen)(char *device_str);
	int (*v0_devclose)(int dev_desc);
	int (*v0_rdblkdev)(int dev_desc, int num_blks, int blk_st, char *buf);
	int (*v0_wrblkdev)(int dev_desc, int num_blks, int blk_st, char *buf);
	int (*v0_wrnetdev)(int dev_desc, int num_bytes, char *buf);
	int (*v0_rdnetdev)(int dev_desc, int num_bytes, char *buf);
	int (*v0_rdchardev)(int dev_desc, int num_bytes, int dummy, char *buf);
	int (*v0_wrchardev)(int dev_desc, int num_bytes, int dummy, char *buf);
	int (*v0_seekdev)(int dev_desc, long logical_offst, int from);
};

/* V2 and later prom device operations. */
struct linux_dev_v2_funcs {
	int (*v2_inst2pkg)(int d);	/* Convert ihandle to phandle */
	char * (*v2_dumb_mem_alloc)(char *va, unsigned sz);
	void (*v2_dumb_mem_free)(char *va, unsigned sz);

	/* To map devices into virtual I/O space. */
	char * (*v2_dumb_mmap)(char *virta, int which_io, unsigned paddr, unsigned sz);
	void (*v2_dumb_munmap)(char *virta, unsigned size);

	int (*v2_dev_open)(char *devpath);
	void (*v2_dev_close)(int d);
	int (*v2_dev_read)(int d, char *buf, int nbytes);
	int (*v2_dev_write)(int d, char *buf, int nbytes);
	int (*v2_dev_seek)(int d, int hi, int lo);

	/* Never issued (multistage load support) */
	void (*v2_wheee2)(void);
	void (*v2_wheee3)(void);
};

struct linux_mlist_v0 {
	struct linux_mlist_v0 *theres_more;
	unsigned start_adr;
	unsigned num_bytes;
};

struct linux_mem_v0 {
	struct linux_mlist_v0 **v0_totphys;
	struct linux_mlist_v0 **v0_prommap;
	struct linux_mlist_v0 **v0_available; /* What we can use */
};

/* Arguments sent to the kernel from the boot prompt. */
struct linux_arguments_v0 {
	char *argv[8];
	char args[100];
	char boot_dev[2];
	int boot_dev_ctrl;
	int boot_dev_unit;
	int dev_partition;
	char *kernel_file_name;
	void *aieee1;           /* XXX */
};

/* V2 and up boot things. */
struct linux_bootargs_v2 {
	char **bootpath;
	char **bootargs;
	int *fd_stdin;
	int *fd_stdout;
};

/* The top level PROM vector. */
struct linux_romvec {
	/* Version numbers. */
	unsigned int pv_magic_cookie;
	unsigned int pv_romvers;
	unsigned int pv_plugin_revision;
	unsigned int pv_printrev;

	/* Version 0 memory descriptors. */
	struct linux_mem_v0 pv_v0mem;

	/* Node operations. */
	struct linux_nodeops *pv_nodeops;

	char **pv_bootstr;
	struct linux_dev_v0_funcs pv_v0devops;

	char *pv_stdin;
	char *pv_stdout;
#define	PROMDEV_KBD	0		/* input from keyboard */
#define	PROMDEV_SCREEN	0		/* output to screen */
#define	PROMDEV_TTYA	1		/* in/out to ttya */
#define	PROMDEV_TTYB	2		/* in/out to ttyb */

	/* Blocking getchar/putchar.  NOT REENTRANT! (grr) */
	int (*pv_getchar)(void);
	void (*pv_putchar)(int ch);

	/* Non-blocking variants. */
	int (*pv_nbgetchar)(void);
	int (*pv_nbputchar)(int ch);

	void (*pv_putstr)(char *str, int len);

	/* Miscellany. */
	void (*pv_reboot)(char *bootstr);
	void (*pv_printf)(__const__ char *fmt, ...);
	void (*pv_abort)(void);
	__volatile__ int *pv_ticks;
	void (*pv_halt)(void);
	void (**pv_synchook)(void);

	/* Evaluate a forth string, not different proto for V0 and V2->up. */
	union {
		void (*v0_eval)(int len, char *str);
		void (*v2_eval)(char *str);
	} pv_fortheval;

	struct linux_arguments_v0 **pv_v0bootargs;

	/* Get ether address. */
	unsigned int (*pv_enaddr)(int d, char *enaddr);

	struct linux_bootargs_v2 pv_v2bootargs;
	struct linux_dev_v2_funcs pv_v2devops;

	int filler[15];

	/* This one is sun4c/sun4 only. */
	void (*pv_setctxt)(int ctxt, char *va, int pmeg);

	/* Prom version 3 Multiprocessor routines. This stuff is crazy.
	 * No joke. Calling these when there is only one cpu probably
	 * crashes the machine, have to test this. :-)
	 */

	/* v3_cpustart() will start the cpu 'whichcpu' in mmu-context
	 * 'thiscontext' executing at address 'prog_counter'
	 */
	int (*v3_cpustart)(unsigned int whichcpu, int ctxtbl_ptr,
			   int thiscontext, char *prog_counter);

	/* v3_cpustop() will cause cpu 'whichcpu' to stop executing
	 * until a resume cpu call is made.
	 */
	int (*v3_cpustop)(unsigned int whichcpu);

	/* v3_cpuidle() will idle cpu 'whichcpu' until a stop or
	 * resume cpu call is made.
	 */
	int (*v3_cpuidle)(unsigned int whichcpu);

	/* v3_cpuresume() will resume processor 'whichcpu' executing
	 * starting with whatever 'pc' and 'npc' were left at the
	 * last 'idle' or 'stop' call.
	 */
	int (*v3_cpuresume)(unsigned int whichcpu);
};

/* Routines for traversing the prom device tree. */
struct linux_nodeops {
	int (*no_nextnode)(int node);
	int (*no_child)(int node);
	int (*no_proplen)(int node, char *name);
	int (*no_getprop)(int node, char *name, char *val);
	int (*no_setprop)(int node, char *name, char *val, int len);
	char * (*no_nextprop)(int node, char *name);
};

/* More fun PROM structures for device probing. */
#define PROMREG_MAX     24
#define PROMVADDR_MAX   16
#define PROMINTR_MAX    32

struct linux_prom_registers {
	unsigned which_io;	/* hi part of physical address			*/
	unsigned phys_addr;	/* The physical address of this register	*/
	int reg_size;		/* How many bytes does this register take up?	*/
};

struct linux_prom64_registers {
	unsigned long phys_addr;
	unsigned long reg_size;
};

struct linux_prom_irqs {
	int pri;    /* IRQ priority */
	int vector; /* This is foobar, what does it do? */
};

/* Element of the "ranges" vector */
struct linux_prom_ranges {
	unsigned int ot_child_space;
	unsigned int ot_child_base;		/* Bus feels this */
	unsigned int ot_parent_space;
	unsigned int ot_parent_base;		/* CPU looks from here */
	unsigned int or_size;
};

struct linux_prom64_ranges {
	unsigned long ot_child_base;		/* Bus feels this */
	unsigned long ot_parent_base;		/* CPU looks from here */
	unsigned long or_size;
};

/* Ranges and reg properties are a bit different for PCI. */
struct linux_prom_pci_registers {
	unsigned int phys_hi;
	unsigned int phys_mid;
	unsigned int phys_lo;

	unsigned int size_hi;
	unsigned int size_lo;
};

struct linux_prom_pci_ranges {
	unsigned int child_phys_hi;	/* Only certain bits are encoded here. */
	unsigned int child_phys_mid;
	unsigned int child_phys_lo;

	unsigned int parent_phys_hi;
	unsigned int parent_phys_lo;

	unsigned int size_hi;
	unsigned int size_lo;
};

struct linux_prom_pci_intmap {
	unsigned int phys_hi;
	unsigned int phys_mid;
	unsigned int phys_lo;

	unsigned int interrupt;

	int          cnode;
	unsigned int cinterrupt;
};

struct linux_prom_pci_intmask {
	unsigned int phys_hi;
	unsigned int phys_mid;
	unsigned int phys_lo;
	unsigned int interrupt;
};

struct linux_prom_ebus_ranges {
	unsigned int child_phys_hi;
	unsigned int child_phys_lo;

	unsigned int parent_phys_hi;
	unsigned int parent_phys_mid;
	unsigned int parent_phys_lo;

	unsigned int size;
};

struct linux_prom_ebus_intmap {
	unsigned int phys_hi;
	unsigned int phys_lo;

	unsigned int interrupt;

	int          cnode;
	unsigned int cinterrupt;
};

struct linux_prom_ebus_intmask {
	unsigned int phys_hi;
	unsigned int phys_lo;
	unsigned int interrupt;
};
#endif /* !(__ASSEMBLY__) */

#endif /* !(__SPARC64_OPENPROM_H) */
Commit	Line	Data
f5e706ad SR	1	#ifndef __SPARC64_OPENPROM_H
	2	#define __SPARC64_OPENPROM_H
	3
	4	/* openprom.h: Prom structures and defines for access to the OPENBOOT
	5	* prom routines and data areas.
	6	*
	7	* Copyright (C) 1996 David S. Miller (davem@caip.rutgers.edu)
	8	*/
	9
	10	#ifndef __ASSEMBLY__
	11	/* V0 prom device operations. */
	12	struct linux_dev_v0_funcs {
	13	int (v0_devopen)(char device_str);
	14	int (*v0_devclose)(int dev_desc);
	15	int (v0_rdblkdev)(int dev_desc, int num_blks, int blk_st, char buf);
	16	int (v0_wrblkdev)(int dev_desc, int num_blks, int blk_st, char buf);
	17	int (v0_wrnetdev)(int dev_desc, int num_bytes, char buf);
	18	int (v0_rdnetdev)(int dev_desc, int num_bytes, char buf);
	19	int (v0_rdchardev)(int dev_desc, int num_bytes, int dummy, char buf);
	20	int (v0_wrchardev)(int dev_desc, int num_bytes, int dummy, char buf);
	21	int (*v0_seekdev)(int dev_desc, long logical_offst, int from);
	22	};
	23
	24	/* V2 and later prom device operations. */
	25	struct linux_dev_v2_funcs {
	26	int (v2_inst2pkg)(int d); / Convert ihandle to phandle */
	27	char * (v2_dumb_mem_alloc)(char va, unsigned sz);
	28	void (v2_dumb_mem_free)(char va, unsigned sz);
	29
	30	/* To map devices into virtual I/O space. */
	31	char * (v2_dumb_mmap)(char virta, int which_io, unsigned paddr, unsigned sz);
	32	void (v2_dumb_munmap)(char virta, unsigned size);
	33
	34	int (v2_dev_open)(char devpath);
	35	void (*v2_dev_close)(int d);
	36	int (v2_dev_read)(int d, char buf, int nbytes);
	37	int (v2_dev_write)(int d, char buf, int nbytes);
	38	int (*v2_dev_seek)(int d, int hi, int lo);
	39
	40	/* Never issued (multistage load support) */
	41	void (*v2_wheee2)(void);
	42	void (*v2_wheee3)(void);
	43	};
	44
	45	struct linux_mlist_v0 {
	46	struct linux_mlist_v0 *theres_more;
	47	unsigned start_adr;
	48	unsigned num_bytes;
	49	};
	50
	51	struct linux_mem_v0 {
	52	struct linux_mlist_v0 **v0_totphys;
	53	struct linux_mlist_v0 **v0_prommap;
	54	struct linux_mlist_v0 *v0_available; / What we can use */
	55	};
	56
	57	/* Arguments sent to the kernel from the boot prompt. */
	58	struct linux_arguments_v0 {
	59	char *argv[8];
	60	char args[100];
	61	char boot_dev[2];
	62	int boot_dev_ctrl;
	63	int boot_dev_unit;
	64	int dev_partition;
65	char *kernel_file_name;
66	void aieee1; / XXX */
67	};
68
69	/* V2 and up boot things. */
70	struct linux_bootargs_v2 {
71	char **bootpath;
72	char **bootargs;
73	int *fd_stdin;
74	int *fd_stdout;
75	};
76
77	/* The top level PROM vector. */
78	struct linux_romvec {
79	/* Version numbers. */
80	unsigned int pv_magic_cookie;
81	unsigned int pv_romvers;
82	unsigned int pv_plugin_revision;
83	unsigned int pv_printrev;
84
85	/* Version 0 memory descriptors. */
86	struct linux_mem_v0 pv_v0mem;
87
88	/* Node operations. */
89	struct linux_nodeops *pv_nodeops;
90
91	char **pv_bootstr;
92	struct linux_dev_v0_funcs pv_v0devops;
93
94	char *pv_stdin;
95	char *pv_stdout;
96	#define PROMDEV_KBD 0 /* input from keyboard */
97	#define PROMDEV_SCREEN 0 /* output to screen */
98	#define PROMDEV_TTYA 1 /* in/out to ttya */
99	#define PROMDEV_TTYB 2 /* in/out to ttyb */
100
101	/* Blocking getchar/putchar. NOT REENTRANT! (grr) */
102	int (*pv_getchar)(void);
103	void (*pv_putchar)(int ch);
104
105	/* Non-blocking variants. */
106	int (*pv_nbgetchar)(void);
107	int (*pv_nbputchar)(int ch);
108
109	void (pv_putstr)(char str, int len);
110
111	/* Miscellany. */
112	void (pv_reboot)(char bootstr);
113	void (pv_printf)(__const__ char fmt, ...);
114	void (*pv_abort)(void);
115	__volatile__ int *pv_ticks;
116	void (*pv_halt)(void);
117	void (**pv_synchook)(void);
118
119	/* Evaluate a forth string, not different proto for V0 and V2->up. */
120	union {
121	void (v0_eval)(int len, char str);
122	void (v2_eval)(char str);
123	} pv_fortheval;
124
125	struct linux_arguments_v0 **pv_v0bootargs;
126
127	/* Get ether address. */
128	unsigned int (pv_enaddr)(int d, char enaddr);
129
130	struct linux_bootargs_v2 pv_v2bootargs;
131	struct linux_dev_v2_funcs pv_v2devops;
132
133	int filler[15];
134
135	/* This one is sun4c/sun4 only. */
136	void (pv_setctxt)(int ctxt, char va, int pmeg);
137
138	/* Prom version 3 Multiprocessor routines. This stuff is crazy.
139	* No joke. Calling these when there is only one cpu probably
140	* crashes the machine, have to test this. :-)
141	*/
142
143	/* v3_cpustart() will start the cpu 'whichcpu' in mmu-context
144	* 'thiscontext' executing at address 'prog_counter'
145	*/
146	int (*v3_cpustart)(unsigned int whichcpu, int ctxtbl_ptr,
147	int thiscontext, char *prog_counter);
148
149	/* v3_cpustop() will cause cpu 'whichcpu' to stop executing
150	* until a resume cpu call is made.
151	*/
152	int (*v3_cpustop)(unsigned int whichcpu);
153
154	/* v3_cpuidle() will idle cpu 'whichcpu' until a stop or
155	* resume cpu call is made.
156	*/
157	int (*v3_cpuidle)(unsigned int whichcpu);
158
159	/* v3_cpuresume() will resume processor 'whichcpu' executing
160	* starting with whatever 'pc' and 'npc' were left at the
161	* last 'idle' or 'stop' call.
162	*/
163	int (*v3_cpuresume)(unsigned int whichcpu);
164	};
165
166	/* Routines for traversing the prom device tree. */
167	struct linux_nodeops {
168	int (*no_nextnode)(int node);
169	int (*no_child)(int node);
170	int (no_proplen)(int node, char name);
171	int (no_getprop)(int node, char name, char *val);
172	int (no_setprop)(int node, char name, char *val, int len);
173	char * (no_nextprop)(int node, char name);
174	};
175
176	/* More fun PROM structures for device probing. */
177	#define PROMREG_MAX 24
178	#define PROMVADDR_MAX 16
179	#define PROMINTR_MAX 32
180
181	struct linux_prom_registers {
182	unsigned which_io; /* hi part of physical address */
183	unsigned phys_addr; /* The physical address of this register */
184	int reg_size; /* How many bytes does this register take up? */
185	};
186
187	struct linux_prom64_registers {
188	unsigned long phys_addr;
189	unsigned long reg_size;
190	};
191
192	struct linux_prom_irqs {
193	int pri; /* IRQ priority */
194	int vector; /* This is foobar, what does it do? */
195	};
196
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;
204	};
205
206	struct linux_prom64_ranges {
207	unsigned long ot_child_base; /* Bus feels this */
208	unsigned long ot_parent_base; /* CPU looks from here */
209	unsigned long or_size;
210	};
211
212	/* Ranges and reg properties are a bit different for PCI. */
213	struct linux_prom_pci_registers {
214	unsigned int phys_hi;
215	unsigned int phys_mid;
216	unsigned int phys_lo;
217
218	unsigned int size_hi;
219	unsigned int size_lo;
220	};
221
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;
226
227	unsigned int parent_phys_hi;
228	unsigned int parent_phys_lo;
229
230	unsigned int size_hi;
231	unsigned int size_lo;
232	};
233
234	struct linux_prom_pci_intmap {
235	unsigned int phys_hi;
236	unsigned int phys_mid;
237	unsigned int phys_lo;
238
239	unsigned int interrupt;
240
241	int cnode;
242	unsigned int cinterrupt;
243	};
244
245	struct linux_prom_pci_intmask {
246	unsigned int phys_hi;
247	unsigned int phys_mid;
248	unsigned int phys_lo;
249	unsigned int interrupt;
250	};
251
252	struct linux_prom_ebus_ranges {
253	unsigned int child_phys_hi;
254	unsigned int child_phys_lo;
255
256	unsigned int parent_phys_hi;
257	unsigned int parent_phys_mid;
258	unsigned int parent_phys_lo;
259
260	unsigned int size;
261	};
262
263	struct linux_prom_ebus_intmap {
264	unsigned int phys_hi;
265	unsigned int phys_lo;
266
267	unsigned int interrupt;
268
269	int cnode;
270	unsigned int cinterrupt;
271	};
272
273	struct linux_prom_ebus_intmask {
274	unsigned int phys_hi;
275	unsigned int phys_lo;
276	unsigned int interrupt;
277	};
278	#endif /* !(__ASSEMBLY__) */
279
280	#endif /* !(__SPARC64_OPENPROM_H) */