ubavar.h revision 1.32 1 /* $NetBSD: ubavar.h,v 1.32 2001/05/13 15:23:37 ragge Exp $ */
2
3 /*
4 * Copyright (c) 1982, 1986 Regents of the University of California.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by the University of
18 * California, Berkeley and its contributors.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)ubavar.h 7.7 (Berkeley) 6/28/90
36 */
37 #ifndef _QBUS_UBAVAR_H
38 #define _QBUS_UBAVAR_H
39
40 /*
41 * This file contains definitions related to the kernel structures
42 * for dealing with the unibus adapters.
43 *
44 * Each uba has a uba_softc structure.
45 * Each unibus controller which is not a device has a uba_ctlr structure.
46 * Each unibus device has a uba_device structure.
47 */
48
49 /*
50 * Per-uba structure.
51 *
52 * This structure holds the interrupt vector for the uba,
53 * and its address in physical and virtual space. At boot time
54 * we determine the devices attached to the uba's and their
55 * interrupt vectors, filling in uh_vec. We free the map
56 * register and bdp resources of the uba into the structures
57 * defined here.
58 *
59 * During normal operation, resources are allocated and returned
60 * to the structures here. We watch the number of passive releases
61 * on each uba, and if the number is excessive may reset the uba.
62 *
63 * When uba resources are needed and not available, or if a device
64 * which can tolerate no other uba activity (rk07) gets on the bus,
65 * then device drivers may have to wait to get to the bus and are
66 * queued here. It is also possible for processes to block in
67 * the unibus driver in resource wait (mrwant, bdpwant); these
68 * wait states are also recorded here.
69 */
70 struct uba_softc {
71 struct device uh_dev; /* Device struct, autoconfig */
72 struct evcnt uh_intrcnt; /* interrupt counting */
73 SIMPLEQ_HEAD(, uba_unit) uh_resq; /* resource wait chain */
74 SIMPLEQ_HEAD(, uba_reset) uh_resetq; /* ubareset queue */
75 int uh_lastiv; /* last free interrupt vector */
76 int (*uh_errchk) __P((struct uba_softc *));
77 void (*uh_beforescan) __P((struct uba_softc *));
78 void (*uh_afterscan) __P((struct uba_softc *));
79 void (*uh_ubainit) __P((struct uba_softc *));
80 void (*uh_ubapurge) __P((struct uba_softc *, int));
81 short uh_nr; /* Unibus sequential number */
82 short uh_type; /* Type of bus */
83 bus_space_tag_t uh_iot; /* Tag for this Unibus */
84 bus_space_handle_t uh_ioh; /* Handle for I/O space */
85 bus_dma_tag_t uh_dmat;
86 };
87
88 /*
89 * Per-controller structure.
90 * The unit struct is common to both the adapter and the controller
91 * to which it belongs. It is only used on controllers that handles
92 * BDP's, and calls the adapter queueing subroutines.
93 */
94 struct uba_unit {
95 SIMPLEQ_ENTRY(uba_unit) uu_resq;/* Queue while waiting for resources */
96 void *uu_softc; /* Pointer to units softc */
97 int uu_bdp; /* for controllers that hang on to bdp's */
98 int (*uu_ready) __P((struct uba_unit *));
99 void *uu_ref; /* Buffer this is related to */
100 short uu_xclu; /* want exclusive use of bdp's */
101 short uu_keepbdp; /* hang on to bdp's once allocated */
102 };
103
104 /*
105 * Reset structure. All devices that needs to be reinitialized
106 * after an ubareset registers with this struct.
107 */
108 struct uba_reset {
109 SIMPLEQ_ENTRY(uba_reset) ur_resetq;
110 void (*ur_reset)(struct device *);
111 struct device *ur_dev;
112 };
113
114 /*
115 * uba_attach_args is used during autoconfiguration. It is sent
116 * from ubascan() to each (possible) device.
117 */
118 struct uba_attach_args {
119 bus_space_tag_t ua_iot; /* Tag for this bus I/O-space */
120 bus_addr_t ua_ioh; /* I/O regs addr */
121 bus_dma_tag_t ua_dmat; /* DMA tag for this bus'es dma */
122 struct evcnt *ua_evcnt;
123 void *ua_icookie; /* Cookie for interrupt establish */
124 int ua_iaddr; /* Full CSR address of device */
125 int ua_br; /* IPL this dev interrupted on */
126 int ua_cvec; /* Vector for this device */
127 };
128
129 /*
130 * Flags to UBA map/bdp allocation routines
131 */
132 #define UBA_NEEDBDP 0x01 /* transfer needs a bdp */
133 #define UBA_CANTWAIT 0x02 /* don't block me */
134 #define UBA_NEED16 0x04 /* need 16 bit addresses only */
135 #define UBA_HAVEBDP 0x08 /* use bdp specified in high bits */
136 #define UBA_DONTQUE 0x10 /* Do not enqueue xfer */
137
138 /*
139 * Type of adapter.
140 */
141 #define UBA_UBA 0 /* Traditional unibus adapter */
142 #define UBA_MVI 1 /* MVI direct-mapped unibus */
143 #define UBA_QBUS 2 /* Qbus with map registers */
144 /*
145 * Struct for unibus allocation.
146 */
147 struct ubinfo {
148 bus_dmamap_t ui_dmam;
149 bus_dma_segment_t ui_seg;
150 int ui_rseg;
151 caddr_t ui_vaddr;
152 bus_addr_t ui_baddr;
153 bus_size_t ui_size;
154 };
155
156 /*
157 * Some common defines for all subtypes of U/Q-buses/adapters.
158 */
159 #define MAXUBAXFER (63*1024) /* Max transfer size in bytes */
160 #define ubdevreg(addr) ((addr) & 017777)
161
162 #ifdef _KERNEL
163 void uba_intr_establish(void *, int, void (*)(void *), void *, struct evcnt *);
164 void uba_reset_establish(void (*)(struct device *), struct device *);
165 void uba_attach(struct uba_softc *, unsigned long);
166 void uba_enqueue(struct uba_unit *);
167 void uba_done(struct uba_softc *);
168 void ubareset(struct uba_softc *);
169 int uballoc(struct uba_softc *, struct ubinfo *, int);
170 int ubmemalloc(struct uba_softc *, struct ubinfo *, int);
171 void ubfree(struct uba_softc *, struct ubinfo *);
172 void ubmemfree(struct uba_softc *, struct ubinfo *);
173 #endif /* _KERNEL */
174
175 #endif /* _QBUS_UBAVAR_H */
176