xref: /netbsd-src/sys/dev/isa/tcic2_isa.c (revision 220b5c059a84c51ea44107ea8951a57ffaecdc8c)
1 /*	$NetBSD: tcic2_isa.c,v 1.5 2001/11/15 09:48:10 lukem Exp $	*/
2 
3 /*
4  *
5  * Copyright (c) 1998, 1999 Christoph Badura. All rights reserved.
6  * Copyright (c) 1997 Marc Horowitz.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by Marc Horowitz.
19  * 4. The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: tcic2_isa.c,v 1.5 2001/11/15 09:48:10 lukem Exp $");
36 
37 #undef	TCICISADEBUG
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/device.h>
42 #include <sys/extent.h>
43 #include <sys/malloc.h>
44 
45 #include <machine/bus.h>
46 #include <machine/intr.h>
47 
48 #include <dev/isa/isareg.h>
49 #include <dev/isa/isavar.h>
50 
51 #include <dev/pcmcia/pcmciareg.h>
52 #include <dev/pcmcia/pcmciavar.h>
53 #include <dev/pcmcia/pcmciachip.h>
54 
55 #include <dev/ic/tcic2reg.h>
56 #include <dev/ic/tcic2var.h>
57 
58 /*****************************************************************************
59  * Configurable parameters.
60  *****************************************************************************/
61 
62 #include "opt_tcic_isa_alloc_iobase.h"
63 #include "opt_tcic_isa_alloc_iosize.h"
64 #include "opt_tcic_isa_intr_alloc_mask.h"
65 
66 /*
67  * Default I/O allocation range.  If both are set to non-zero, these
68  * values will be used instead.  Otherwise, the code attempts to probe
69  * the bus width.  Systems with 10 address bits should use 0x300 and 0xff.
70  * Systems with 12 address bits (most) should use 0x400 and 0xbff.
71  */
72 
73 #ifndef TCIC_ISA_ALLOC_IOBASE
74 #define	TCIC_ISA_ALLOC_IOBASE		0
75 #endif
76 
77 #ifndef TCIC_ISA_ALLOC_IOSIZE
78 #define	TCIC_ISA_ALLOC_IOSIZE		0
79 #endif
80 
81 int	tcic_isa_alloc_iobase = TCIC_ISA_ALLOC_IOBASE;
82 int	tcic_isa_alloc_iosize = TCIC_ISA_ALLOC_IOSIZE;
83 
84 /*
85  * Default IRQ allocation bitmask.  This defines the range of allowable
86  * IRQs for PCMCIA slots.  Useful if order of probing would screw up other
87  * devices, or if TCIC hardware/cards have trouble with certain interrupt
88  * lines.
89  *
90  * We disable IRQ 10 by default, since some common laptops (namely, the
91  * NEC Versa series) reserve IRQ 10 for the docking station SCSI interface.
92  *
93  * XXX Do we care about this?  the Versa doesn't use a tcic. -chb
94  */
95 
96 #ifndef TCIC_ISA_INTR_ALLOC_MASK
97 #define	TCIC_ISA_INTR_ALLOC_MASK	0xffff
98 #endif
99 
100 int	tcic_isa_intr_alloc_mask = TCIC_ISA_INTR_ALLOC_MASK;
101 
102 /*****************************************************************************
103  * End of configurable parameters.
104  *****************************************************************************/
105 
106 #ifdef TCICISADEBUG
107 int	tcic_isa_debug = 1;
108 #define	DPRINTF(arg) if (tcic_isa_debug) printf arg;
109 #else
110 #define	DPRINTF(arg)
111 #endif
112 
113 int	tcic_isa_probe __P((struct device *, struct cfdata *, void *));
114 void	tcic_isa_attach __P((struct device *, struct device *, void *));
115 
116 void	*tcic_isa_chip_intr_establish __P((pcmcia_chipset_handle_t,
117 	    struct pcmcia_function *, int, int (*) (void *), void *));
118 void	tcic_isa_chip_intr_disestablish __P((pcmcia_chipset_handle_t, void *));
119 
120 struct cfattach tcic_isa_ca = {
121 	sizeof(struct tcic_softc), tcic_isa_probe, tcic_isa_attach
122 };
123 
124 static struct pcmcia_chip_functions tcic_isa_functions = {
125 	tcic_chip_mem_alloc,
126 	tcic_chip_mem_free,
127 	tcic_chip_mem_map,
128 	tcic_chip_mem_unmap,
129 
130 	tcic_chip_io_alloc,
131 	tcic_chip_io_free,
132 	tcic_chip_io_map,
133 	tcic_chip_io_unmap,
134 
135 	tcic_isa_chip_intr_establish,
136 	tcic_isa_chip_intr_disestablish,
137 
138 	tcic_chip_socket_enable,
139 	tcic_chip_socket_disable,
140 };
141 
142 int
143 tcic_isa_probe(parent, match, aux)
144 	struct device *parent;
145 	struct cfdata *match;
146 	void *aux;
147 {
148 	struct isa_attach_args *ia = aux;
149 	bus_space_tag_t iot = ia->ia_iot;
150 	bus_space_handle_t ioh, memh;
151 	int val, found;
152 
153 	/* Disallow wildcarded i/o address. */
154 	if (ia->ia_iobase == ISACF_PORT_DEFAULT)
155 		return (0);
156 
157 	if (bus_space_map(iot, ia->ia_iobase, TCIC_IOSIZE, 0, &ioh))
158 		return (0);
159 
160 	if (ia->ia_msize == -1)
161 		ia->ia_msize = TCIC_MEMSIZE;
162 
163 	if (bus_space_map(ia->ia_memt, ia->ia_maddr, ia->ia_msize, 0, &memh))
164 		return (0);
165 
166 	DPRINTF(("tcic probing 0x%03x\n", ia->ia_iobase));
167 	found = 0;
168 
169 	/*
170 	 * First, check for the reserved bits to be zero.
171 	 */
172 	if (tcic_check_reserved_bits(iot, ioh)) {
173 		DPRINTF(("tcic: reserved bits checked OK\n"));
174 		/* Second, check whether the we know how to handle the chip. */
175 		if ((val = tcic_chipid(iot, ioh))) {
176 			DPRINTF(("tcic id: 0x%02x\n", val));
177 			if (tcic_chipid_known(val))
178 				found++;
179 		}
180 	}
181 	else
182 		DPRINTF(("tcic: reserved bits didn't check OK\n"));
183 
184 	bus_space_unmap(iot, ioh, TCIC_IOSIZE);
185 	bus_space_unmap(ia->ia_memt, memh, ia->ia_msize);
186 
187 	if (!found)
188 		return (0);
189 
190 	ia->ia_iosize = TCIC_IOSIZE;
191 
192 	return (1);
193 }
194 
195 void
196 tcic_isa_attach(parent, self, aux)
197 	struct device *parent, *self;
198 	void *aux;
199 {
200 	struct tcic_softc *sc = (void *) self;
201 	struct isa_attach_args *ia = aux;
202 	isa_chipset_tag_t ic = ia->ia_ic;
203 	bus_space_tag_t iot = ia->ia_iot;
204 	bus_space_tag_t memt = ia->ia_memt;
205 	bus_space_handle_t ioh;
206 	bus_space_handle_t memh;
207 
208 	/* Map i/o space. */
209 	if (bus_space_map(iot, ia->ia_iobase, ia->ia_iosize, 0, &ioh)) {
210 		printf(": can't map i/o space\n");
211 		return;
212 	}
213 
214 	/* Map mem space. */
215 	if (bus_space_map(memt, ia->ia_maddr, ia->ia_msize, 0, &memh)) {
216 		printf(": can't map mem space\n");
217 		return;
218 	}
219 
220 	sc->membase = ia->ia_maddr;
221 	sc->subregionmask = (1 << (ia->ia_msize / TCIC_MEM_PAGESIZE)) - 1;
222 	sc->memsize2 = tcic_log2((u_int)ia->ia_msize);
223 
224 	sc->intr_est = ic;
225 	sc->pct = (pcmcia_chipset_tag_t) & tcic_isa_functions;
226 
227 	sc->iot = iot;
228 	sc->ioh = ioh;
229 	sc->memt = memt;
230 	sc->memh = memh;
231 
232 	/*
233 	 * determine chip type and initialise some chip type dependend
234 	 * parameters in softc.
235 	 */
236 	sc->chipid = tcic_chipid(iot, ioh);
237 	sc->validirqs = tcic_validirqs(sc->chipid);
238 
239 	/*
240 	 * allocate an irq.  interrupts are relatively
241 	 * scarce but for TCIC controllers very infrequent.
242 	 */
243 
244 	if ((sc->irq = ia->ia_irq) == IRQUNK) {
245 		if (isa_intr_alloc(ic,
246 		    sc->validirqs & (tcic_isa_intr_alloc_mask & 0xff00),
247 		    IST_EDGE, &sc->irq)) {
248 			printf("\n%s: can't allocate interrupt\n",
249 			    sc->dev.dv_xname);
250 			return;
251 		}
252 		printf(": using irq %d", sc->irq);
253 	}
254 	printf("\n");
255 
256 	tcic_attach(sc);
257 
258 
259 	/*
260 	 * XXX mycroft recommends I/O space range 0x400-0xfff.
261 	 */
262 
263 	/*
264 	 * XXX some hardware doesn't seem to grok addresses in 0x400 range--
265 	 * apparently missing a bit or more of address lines. (e.g.
266 	 * CIRRUS_PD672X with Linksys EthernetCard ne2000 clone in TI
267 	 * TravelMate 5000--not clear which is at fault)
268 	 *
269 	 * Add a kludge to detect 10 bit wide buses and deal with them,
270 	 * and also a config file option to override the probe.
271 	 */
272 
273 #if 0
274 	/*
275 	 * This is what we'd like to use, but...
276 	 */
277 	sc->iobase = 0x400;
278 	sc->iosize = 0xbff;
279 #else
280 	/*
281 	 * ...the above bus width probe doesn't always work.
282 	 * So, experimentation has shown the following range
283 	 * to not lose on systems that 0x300-0x3ff loses on
284 	 * (e.g. the NEC Versa 6030X).
285 	 */
286 	sc->iobase = 0x330;
287 	sc->iosize = 0x0cf;
288 #endif
289 
290 	DPRINTF(("%s: bus_space_alloc range 0x%04lx-0x%04lx)\n",
291 	    sc->dev.dv_xname, (long) sc->iobase,
292 	    (long) sc->iobase + sc->iosize));
293 
294 	if (tcic_isa_alloc_iobase && tcic_isa_alloc_iosize) {
295 		sc->iobase = tcic_isa_alloc_iobase;
296 		sc->iosize = tcic_isa_alloc_iosize;
297 
298 		DPRINTF(("%s: bus_space_alloc range 0x%04lx-0x%04lx "
299 		    "(config override)\n", sc->dev.dv_xname, (long) sc->iobase,
300 		    (long) sc->iobase + sc->iosize));
301 	}
302 	sc->ih = isa_intr_establish(ic, sc->irq, IST_EDGE, IPL_TTY,
303 	    tcic_intr, sc);
304 	if (sc->ih == NULL) {
305 		printf("%s: can't establish interrupt\n", sc->dev.dv_xname);
306 		return;
307 	}
308 
309 	tcic_attach_sockets(sc);
310 }
311 
312 void *
313 tcic_isa_chip_intr_establish(pch, pf, ipl, fct, arg)
314 	pcmcia_chipset_handle_t pch;
315 	struct pcmcia_function *pf;
316 	int ipl;
317 	int (*fct) __P((void *));
318 	void *arg;
319 {
320 	struct tcic_handle *h = (struct tcic_handle *) pch;
321 	int irq, ist;
322 	void *ih;
323 
324 	DPRINTF(("%s: tcic_isa_chip_intr_establish\n", h->sc->dev.dv_xname));
325 
326 	/* XXX should we convert level to pulse? -chb  */
327 	if (pf->cfe->flags & PCMCIA_CFE_IRQLEVEL)
328 		ist = IST_LEVEL;
329 	else if (pf->cfe->flags & PCMCIA_CFE_IRQPULSE)
330 		ist = IST_PULSE;
331 	else
332 		ist = IST_LEVEL;
333 
334 	if (isa_intr_alloc(h->sc->intr_est,
335 	    h->sc->validirqs & tcic_isa_intr_alloc_mask, ist, &irq))
336 		return (NULL);
337 	if ((ih = isa_intr_establish(h->sc->intr_est, irq, ist, ipl,
338 	    fct, arg)) == NULL)
339 		return (NULL);
340 
341 	DPRINTF(("%s: intr estrablished\n", h->sc->dev.dv_xname));
342 
343 	h->ih_irq = irq;
344 
345 	printf("%s: card irq %d\n", h->pcmcia->dv_xname, irq);
346 
347 	return (ih);
348 }
349 
350 void
351 tcic_isa_chip_intr_disestablish(pch, ih)
352 	pcmcia_chipset_handle_t pch;
353 	void *ih;
354 {
355 	struct tcic_handle *h = (struct tcic_handle *) pch;
356 	int val, reg;
357 
358 	DPRINTF(("%s: tcic_isa_chip_intr_disestablish\n", h->sc->dev.dv_xname));
359 
360 	h->ih_irq = 0;
361 
362 	reg = TCIC_IR_SCF1_N(h->sock);
363 	val = tcic_read_ind_2(h, reg);
364 	val &= ~TCIC_SCF1_IRQ_MASK;
365 	tcic_write_ind_2(h, reg, val);
366 
367 	isa_intr_disestablish(h->sc->intr_est, ih);
368 }
369