xref: /netbsd-src/sys/dev/eisa/cac_eisa.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: cac_eisa.c,v 1.25 2016/09/27 03:33:32 pgoyette Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran.
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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 2000 Jonathan Lemon
34  * Copyright (c) 1999 by Matthew N. Dodd <winter@jurai.net>
35  * All Rights Reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions, and the following disclaimer,
42  *    without modification, immediately at the beginning of the file.
43  * 2. The name of the author may not be used to endorse or promote products
44  *    derived from this software without specific prior written permission.
45  *
46  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
50  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56  * SUCH DAMAGE.
57  */
58 
59 /*
60  * EISA front-end for cac(4) driver.
61  */
62 
63 #include <sys/cdefs.h>
64 __KERNEL_RCSID(0, "$NetBSD: cac_eisa.c,v 1.25 2016/09/27 03:33:32 pgoyette Exp $");
65 
66 #include <sys/param.h>
67 #include <sys/systm.h>
68 #include <sys/device.h>
69 #include <sys/module.h>
70 #include <sys/bus.h>
71 #include <sys/intr.h>
72 
73 #include <dev/eisa/eisavar.h>
74 #include <dev/eisa/eisadevs.h>
75 
76 #include <dev/ic/cacreg.h>
77 #include <dev/ic/cacvar.h>
78 
79 #include "ioconf.h"
80 
81 #define CAC_EISA_SLOT_OFFSET		0x0c88
82 #define CAC_EISA_IOSIZE			0x0017
83 #define CAC_EISA_IOCONF			0x38
84 
85 static void	cac_eisa_attach(device_t, device_t, void *);
86 static int	cac_eisa_match(device_t, cfdata_t, void *);
87 
88 static struct	cac_ccb *cac_eisa_l0_completed(struct cac_softc *);
89 static int	cac_eisa_l0_fifo_full(struct cac_softc *);
90 static void	cac_eisa_l0_intr_enable(struct cac_softc *, int);
91 static int	cac_eisa_l0_intr_pending(struct cac_softc *);
92 static void	cac_eisa_l0_submit(struct cac_softc *, struct cac_ccb *);
93 
94 CFATTACH_DECL3_NEW(cac_eisa, sizeof(struct cac_softc),
95     cac_eisa_match, cac_eisa_attach, NULL, NULL, cac_rescan, NULL, 0);
96 
97 static const struct cac_linkage cac_eisa_l0 = {
98 	cac_eisa_l0_completed,
99 	cac_eisa_l0_fifo_full,
100 	cac_eisa_l0_intr_enable,
101 	cac_eisa_l0_intr_pending,
102 	cac_eisa_l0_submit
103 };
104 
105 static struct cac_eisa_type {
106 	const char	*ct_prodstr;
107 	const char	*ct_typestr;
108 	const struct	cac_linkage *ct_linkage;
109 } cac_eisa_type[] = {
110 	{ "CPQ4001",	"IDA",		&cac_eisa_l0 },
111 	{ "CPQ4002",	"IDA-2",	&cac_eisa_l0 },
112 	{ "CPQ4010",	"IEAS",		&cac_eisa_l0 },
113 	{ "CPQ4020",	"SMART",	&cac_eisa_l0 },
114 	{ "CPQ4030",	"SMART-2/E",	&cac_l0 },
115 };
116 
117 static int
118 cac_eisa_match(device_t parent, cfdata_t match, void *aux)
119 {
120 	struct eisa_attach_args *ea;
121 	int i;
122 
123 	ea = aux;
124 
125 	for (i = 0; i < sizeof(cac_eisa_type) / sizeof(cac_eisa_type[0]); i++)
126 		if (strcmp(ea->ea_idstring, cac_eisa_type[i].ct_prodstr) == 0)
127 			return (1);
128 
129 	return (0);
130 }
131 
132 static void
133 cac_eisa_attach(device_t parent, device_t self, void *aux)
134 {
135 	struct eisa_attach_args *ea;
136 	bus_space_handle_t ioh;
137 	eisa_chipset_tag_t ec;
138 	eisa_intr_handle_t ih;
139 	struct cac_softc *sc;
140 	bus_space_tag_t iot;
141 	const char *intrstr;
142 	int irq, i;
143 	char intrbuf[EISA_INTRSTR_LEN];
144 
145 	ea = aux;
146 	sc = device_private(self);
147 	iot = ea->ea_iot;
148 	ec = ea->ea_ec;
149 
150 	if (bus_space_map(iot, EISA_SLOT_ADDR(ea->ea_slot) +
151 	    CAC_EISA_SLOT_OFFSET, CAC_EISA_IOSIZE, 0, &ioh)) {
152 		aprint_error(": can't map i/o space\n");
153 		return;
154 	}
155 
156 	sc->sc_dev = self;
157 	sc->sc_iot = iot;
158 	sc->sc_ioh = ioh;
159 	sc->sc_dmat = ea->ea_dmat;
160 
161 	/*
162 	 * Map and establish the interrupt.
163 	 */
164 	switch (bus_space_read_1(iot, ioh, CAC_EISA_IOCONF) & 0xf0) {
165 	case 0x20:
166 		irq = 10;
167 		break;
168 	case 0x10:
169 		irq = 11;
170 		break;
171 	case 0x40:
172 		irq = 14;
173 		break;
174 	case 0x80:
175 		irq = 15;
176 		break;
177 	default:
178 		aprint_error(": controller on invalid IRQ\n");
179 		return;
180 	}
181 
182 	if (eisa_intr_map(ec, irq, &ih)) {
183 		aprint_error(": can't map interrupt (%d)\n", irq);
184 		return;
185 	}
186 
187 	intrstr = eisa_intr_string(ec, ih, intrbuf, sizeof(intrbuf));
188 	if ((sc->sc_ih = eisa_intr_establish(ec, ih, IST_LEVEL, IPL_BIO,
189 	    cac_intr, sc)) == NULL) {
190 		aprint_error(": can't establish interrupt");
191 		if (intrstr != NULL)
192 			aprint_normal(" at %s", intrstr);
193 		aprint_normal("\n");
194 		return;
195 	}
196 
197 	/*
198 	 * Print board type and attach to the bus-independent code.
199 	 */
200 	for (i = 0; i < sizeof(cac_eisa_type) / sizeof(cac_eisa_type[0]); i++)
201 		if (strcmp(ea->ea_idstring, cac_eisa_type[i].ct_prodstr) == 0)
202 			break;
203 
204 	aprint_normal(": Compaq %s\n", cac_eisa_type[i].ct_typestr);
205 	memcpy(&sc->sc_cl, cac_eisa_type[i].ct_linkage, sizeof(sc->sc_cl));
206 	cac_init(sc, intrstr, 0);
207 }
208 
209 /*
210  * Linkage specific to EISA boards.
211  */
212 
213 static int
214 cac_eisa_l0_fifo_full(struct cac_softc *sc)
215 {
216 
217 	return ((cac_inb(sc, CAC_EISAREG_SYSTEM_DOORBELL) &
218 	    CAC_EISA_CHANNEL_CLEAR) == 0);
219 }
220 
221 static void
222 cac_eisa_l0_submit(struct cac_softc *sc, struct cac_ccb *ccb)
223 {
224 	u_int16_t size;
225 
226 	/*
227 	 * On these boards, `ccb_hdr.size' is actually for control flags.
228 	 * Set it to zero and pass the value by means of an I/O port.
229 	 */
230 	size = le16toh(ccb->ccb_hdr.size) << 2;
231 	ccb->ccb_hdr.size = 0;
232 
233 	bus_dmamap_sync(sc->sc_dmat, sc->sc_dmamap,
234 	    (char *)ccb - (char *)sc->sc_ccbs,
235 	    sizeof(struct cac_ccb), BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
236 
237 	cac_outb(sc, CAC_EISAREG_SYSTEM_DOORBELL, CAC_EISA_CHANNEL_CLEAR);
238 	cac_outl(sc, CAC_EISAREG_LIST_ADDR, ccb->ccb_paddr);
239 	cac_outw(sc, CAC_EISAREG_LIST_LEN, size);
240 	cac_outb(sc, CAC_EISAREG_LOCAL_DOORBELL, CAC_EISA_CHANNEL_BUSY);
241 }
242 
243 static struct cac_ccb *
244 cac_eisa_l0_completed(struct cac_softc *sc)
245 {
246 	struct cac_ccb *ccb;
247 	u_int32_t off;
248 	u_int8_t status;
249 
250 	if ((cac_inb(sc, CAC_EISAREG_SYSTEM_DOORBELL) &
251 	    CAC_EISA_CHANNEL_BUSY) == 0)
252 		return (NULL);
253 
254 	cac_outb(sc, CAC_EISAREG_SYSTEM_DOORBELL, CAC_EISA_CHANNEL_BUSY);
255 	off = cac_inl(sc, CAC_EISAREG_COMPLETE_ADDR);
256 	status = cac_inb(sc, CAC_EISAREG_LIST_STATUS);
257 	cac_outb(sc, CAC_EISAREG_LOCAL_DOORBELL, CAC_EISA_CHANNEL_CLEAR);
258 
259 	if (off == 0)
260 		return (NULL);
261 
262 	off = (off & ~3) - sc->sc_ccbs_paddr;
263 	ccb = (struct cac_ccb *)((char *)sc->sc_ccbs + off);
264 
265 	bus_dmamap_sync(sc->sc_dmat, sc->sc_dmamap, off, sizeof(struct cac_ccb),
266 	    BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
267 
268 	ccb->ccb_req.error = status;
269 
270 	if ((off & 3) != 0 && ccb->ccb_req.error == 0)
271 		ccb->ccb_req.error = CAC_RET_CMD_REJECTED;
272 
273 	return (ccb);
274 }
275 
276 static int
277 cac_eisa_l0_intr_pending(struct cac_softc *sc)
278 {
279 
280 	return (cac_inb(sc, CAC_EISAREG_SYSTEM_DOORBELL) &
281 	    CAC_EISA_CHANNEL_BUSY);
282 }
283 
284 static void
285 cac_eisa_l0_intr_enable(struct cac_softc *sc, int state)
286 {
287 
288 	if (state) {
289 		cac_outb(sc, CAC_EISAREG_SYSTEM_DOORBELL,
290 		    ~CAC_EISA_CHANNEL_CLEAR);
291 		cac_outb(sc, CAC_EISAREG_LOCAL_DOORBELL,
292 		    CAC_EISA_CHANNEL_BUSY);
293 		cac_outb(sc, CAC_EISAREG_INTR_MASK, CAC_INTR_ENABLE);
294 		cac_outb(sc, CAC_EISAREG_SYSTEM_MASK, CAC_INTR_ENABLE);
295 	} else
296 		cac_outb(sc, CAC_EISAREG_SYSTEM_MASK, CAC_INTR_DISABLE);
297 }
298 
299 MODULE(MODULE_CLASS_DRIVER, cac_eisa, "cac");	/* No eisa module yet! */
300 
301 #ifdef _MODULE
302 /*
303  * XXX Don't allow ioconf.c to redefine the "struct cfdriver cac_cd"
304  * XXX it will be defined in the common-code module
305  */
306 #undef  CFDRIVER_DECL
307 #define CFDRIVER_DECL(name, class, attr)
308 #include "ioconf.c"
309 #endif
310 
311 static int
312 cac_eisa_modcmd(modcmd_t cmd, void *opaque)
313 {
314 	int error = 0;
315 
316 #ifdef _MODULE
317 	switch (cmd) {
318 	case MODULE_CMD_INIT:
319 		/*
320 		 * We skip over the first entry in cfdriver[] array
321 		 * since the cfdriver is attached by the common
322 		 * (non-attachment-specific) code.
323 		 */
324 		error = config_init_component(&cfdriver_ioconf_cac_eisa[1],
325 		    cfattach_ioconf_cac_eisa, cfdata_ioconf_cac_eisa);
326 		break;
327 	case MODULE_CMD_FINI:
328 		error = config_fini_component(&cfdriver_ioconf_cac_eisa[1],
329 		    cfattach_ioconf_cac_eisa, cfdata_ioconf_cac_eisa);
330 		break;
331 	default:
332 		error = ENOTTY;
333 		break;
334 	}
335 #endif
336 
337 	return error;
338 }
339