xref: /netbsd/sys/dev/sbus/sbusvar.h (revision bf9ec67e)
1 /*	$NetBSD: sbusvar.h,v 1.17 2002/03/20 19:32:42 eeh Exp $ */
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Paul Kranenburg.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef _SBUS_VAR_H
40 #define _SBUS_VAR_H
41 
42 #if defined(_KERNEL_OPT) && (defined(__sparc__) || defined(__sparc64__))
43 #include "opt_sparc_arch.h"
44 #endif
45 
46 struct sbus_softc;
47 
48 /*
49  * S-bus variables.
50  */
51 struct sbusdev {
52 	struct	device *sd_dev;		/* backpointer to generic */
53 	struct	sbusdev *sd_bchain;	/* forward link in bus chain */
54 	void	(*sd_reset) __P((struct device *));
55 };
56 
57 typedef u_int32_t sbus_slot_t;
58 typedef u_int32_t sbus_offset_t;
59 
60 /* Device register space description */
61 struct sbus_reg {
62 	u_int32_t	sbr_slot;
63 	u_int32_t	sbr_offset;
64 	u_int32_t	sbr_size;
65 };
66 
67 /* Interrupt information */
68 struct sbus_intr {
69 	u_int32_t	sbi_pri;	/* priority (IPL) */
70 	u_int32_t	sbi_vec;	/* vector (always 0?) */
71 };
72 
73 /* Address translation accross busses */
74 struct sbus_range {
75 	u_int32_t	cspace;		/* Client space */
76 	u_int32_t	coffset;	/* Client offset */
77 	u_int32_t	pspace;		/* Parent space */
78 	u_int32_t	poffset;	/* Parent offset */
79 	u_int32_t	size;		/* Size in bytes of this range */
80 };
81 
82 /*
83  * Sbus driver attach arguments.
84  */
85 struct sbus_attach_args {
86 	int		sa_placeholder;	/* for obio attach args sharing */
87 	bus_space_tag_t	sa_bustag;
88 	bus_dma_tag_t	sa_dmatag;
89 	char		*sa_name;	/* PROM node name */
90 	int		sa_node;	/* PROM handle */
91 	struct sbus_reg	*sa_reg;	/* Sbus register space for device */
92 	int		sa_nreg;	/* Number of Sbus register spaces */
93 #define sa_slot		sa_reg[0].sbr_slot
94 #define sa_offset	sa_reg[0].sbr_offset
95 #define sa_size		sa_reg[0].sbr_size
96 
97 	struct sbus_intr *sa_intr;	/* Sbus interrupts for device */
98 	int		sa_nintr;	/* Number of interrupts */
99 #define sa_pri		sa_intr[0].sbi_pri
100 
101 	u_int32_t	*sa_promvaddrs;/* PROM-supplied virtual addresses -- 32-bit */
102 	int		sa_npromvaddrs;	/* Number of PROM VAs */
103 #define sa_promvaddr	sa_promvaddrs[0]
104 	int		sa_frequency;	/* SBus clockrate */
105 };
106 
107 /* sbus_attach_internal() is also used from obio.c */
108 void	sbus_attach_common __P((struct sbus_softc *, char *, int,
109 				const char * const *));
110 int	sbus_print __P((void *, const char *));
111 
112 void	sbus_establish __P((struct sbusdev *, struct device *));
113 
114 int	sbus_setup_attach_args __P((
115 		struct sbus_softc *,
116 		bus_space_tag_t,
117 		bus_dma_tag_t,
118 		int,			/*node*/
119 		struct sbus_attach_args *));
120 
121 void	sbus_destroy_attach_args __P((struct sbus_attach_args *));
122 
123 #define sbus_bus_map(tag, slot, offset, sz, flags, hp) \
124 	bus_space_map(tag, BUS_ADDR(slot,offset), sz, flags, hp)
125 bus_addr_t	sbus_bus_addr __P((bus_space_tag_t, u_int, u_int));
126 void	sbus_promaddr_to_handle __P((bus_space_tag_t, u_int,
127 	bus_space_handle_t *));
128 
129 #if notyet
130 /* variables per Sbus */
131 struct sbus_softc {
132 	struct	device sc_dev;		/* base device */
133 	bus_space_tag_t	sc_bustag;
134 	bus_dma_tag_t	sc_dmatag;
135 	int	sc_clockfreq;		/* clock frequency (in Hz) */
136 	struct	sbusdev *sc_sbdev;	/* list of all children */
137 	struct	sbus_range *sc_range;
138 	int	sc_nrange;
139 	int	sc_burst;		/* burst transfer sizes supported */
140 	/* machdep stuff follows here */
141 	int	*sc_intr2ipl;		/* Interrupt level translation */
142 	int	*sc_intr_compat;	/* `intr' property to sbus compat */
143 };
144 #endif
145 
146 
147 /*
148  * PROM-reported DMA burst sizes for the SBus
149  */
150 #define SBUS_BURST_1	0x1
151 #define SBUS_BURST_2	0x2
152 #define SBUS_BURST_4	0x4
153 #define SBUS_BURST_8	0x8
154 #define SBUS_BURST_16	0x10
155 #define SBUS_BURST_32	0x20
156 #define SBUS_BURST_64	0x40
157 
158 /* We use #defined(SUN4*) here while the ports are in flux */
159 #if defined(SUN4) || defined(SUN4C) || defined(SUN4M)
160 #include <sparc/dev/sbusvar.h>
161 #elif defined(SUN4U)
162 #include <sparc64/dev/sbusvar.h>
163 #endif
164 
165 #endif /* _SBUS_VAR_H */
166