xref: /netbsd-src/sys/dev/pcmcia/wdc_pcmcia.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: wdc_pcmcia.c,v 1.109 2007/10/19 12:01:06 ad Exp $ */
2 
3 /*-
4  * Copyright (c) 1998, 2003, 2004 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum, by Onno van der Linden and by Manuel Bouyer.
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 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: wdc_pcmcia.c,v 1.109 2007/10/19 12:01:06 ad Exp $");
41 
42 #include <sys/param.h>
43 #include <sys/device.h>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/systm.h>
47 #include <sys/proc.h>
48 
49 #include <sys/bus.h>
50 #include <sys/intr.h>
51 
52 #include <dev/pcmcia/pcmciareg.h>
53 #include <dev/pcmcia/pcmciavar.h>
54 #include <dev/pcmcia/pcmciadevs.h>
55 
56 #include <dev/ic/wdcreg.h>
57 #include <dev/ata/atavar.h>
58 #include <dev/ic/wdcvar.h>
59 
60 #ifndef __BUS_SPACE_HAS_STREAM_METHODS
61 #define	bus_space_write_multi_stream_2	bus_space_write_multi_2
62 #define	bus_space_write_multi_stream_4	bus_space_write_multi_4
63 #define	bus_space_read_multi_stream_2	bus_space_read_multi_2
64 #define	bus_space_read_multi_stream_4	bus_space_read_multi_4
65 #endif /* __BUS_SPACE_HAS_STREAM_METHODS */
66 
67 #define WDC_PCMCIA_REG_NPORTS      8
68 #define WDC_PCMCIA_AUXREG_OFFSET   (WDC_PCMCIA_REG_NPORTS + 6)
69 #define WDC_PCMCIA_AUXREG_NPORTS   2
70 
71 struct wdc_pcmcia_softc {
72 	struct wdc_softc sc_wdcdev;
73 	struct ata_channel *wdc_chanlist[1];
74 	struct ata_channel ata_channel;
75 	struct ata_queue wdc_chqueue;
76 	struct wdc_regs wdc_regs;
77 
78 	struct pcmcia_function *sc_pf;
79 	void *sc_ih;
80 
81 	int sc_state;
82 #define WDC_PCMCIA_ATTACHED	3
83 };
84 
85 #ifndef __BUS_SPACE_HAS_STREAM_METHODS
86 #define bus_space_read_region_stream_2 bus_space_read_region_2
87 #define bus_space_read_region_stream_4 bus_space_read_region_4
88 #define bus_space_write_region_stream_2 bus_space_write_region_2
89 #define bus_space_write_region_stream_4 bus_space_write_region_4
90 #endif /* __BUS_SPACE_HAS_STREAM_METHODS */
91 
92 static int wdc_pcmcia_match(struct device *, struct cfdata *, void *);
93 static int wdc_pcmcia_validate_config_io(struct pcmcia_config_entry *);
94 static int wdc_pcmcia_validate_config_memory(struct pcmcia_config_entry *);
95 static void wdc_pcmcia_attach(struct device *, struct device *, void *);
96 static int wdc_pcmcia_detach(struct device *, int);
97 
98 CFATTACH_DECL(wdc_pcmcia, sizeof(struct wdc_pcmcia_softc),
99     wdc_pcmcia_match, wdc_pcmcia_attach, wdc_pcmcia_detach, wdcactivate);
100 
101 static const struct wdc_pcmcia_product {
102 	struct pcmcia_product wdc_product;
103 	int wdc_ndrive;
104 } wdc_pcmcia_products[] = {
105 	{ { PCMCIA_VENDOR_DIGITAL,
106 	  PCMCIA_PRODUCT_DIGITAL_MOBILE_MEDIA_CDROM,
107 	  {NULL, "Digital Mobile Media CD-ROM", NULL, NULL} }, 2 },
108 
109 	{ { PCMCIA_VENDOR_IBM,
110 	  PCMCIA_PRODUCT_IBM_PORTABLE_CDROM,
111 	  {NULL, "PCMCIA Portable CD-ROM Drive", NULL, NULL} }, 2 },
112 
113 	/* The TEAC IDE/Card II is used on the Sony Vaio */
114 	{ { PCMCIA_VENDOR_TEAC,
115 	  PCMCIA_PRODUCT_TEAC_IDECARDII,
116 	  PCMCIA_CIS_TEAC_IDECARDII }, 2 },
117 
118 	/*
119 	 * A fujitsu rebranded panasonic drive that reports
120 	 * itself as function "scsi", disk interface 0
121 	 */
122 	{ { PCMCIA_VENDOR_PANASONIC,
123 	  PCMCIA_PRODUCT_PANASONIC_KXLC005,
124 	  PCMCIA_CIS_PANASONIC_KXLC005 }, 2 },
125 
126 	{ { PCMCIA_VENDOR_SANDISK,
127 	  PCMCIA_PRODUCT_SANDISK_SDCFB,
128 	  PCMCIA_CIS_SANDISK_SDCFB }, 1 },
129 
130 	/*
131 	 * EXP IDE/ATAPI DVD Card use with some DVD players.
132 	 * Does not have a vendor ID or product ID.
133 	 */
134 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
135 	  PCMCIA_CIS_EXP_EXPMULTIMEDIA }, 2 },
136 
137 	/* Mobile Dock 2, neither vendor ID nor product ID */
138 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
139 	  {"SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", NULL, NULL} }, 2 },
140 
141 	/* Toshiba Portege 3110 CD, neither vendor ID nor product ID */
142 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
143 	  {"FREECOM", "PCCARD-IDE", NULL, NULL} }, 2 },
144 
145 	/* Random CD-ROM, (badged AMACOM), neither vendor ID nor product ID */
146 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
147 	  {"PCMCIA", "CD-ROM", NULL, NULL} }, 2 },
148 
149 	/* IO DATA CBIDE2, with neither vendor ID nor product ID */
150 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
151 	  PCMCIA_CIS_IODATA_CBIDE2 }, 2 },
152 
153 	/* TOSHIBA PA2673U(IODATA_CBIDE2 OEM), */
154 	/*  with neither vendor ID nor product ID */
155 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
156 	  PCMCIA_CIS_TOSHIBA_CBIDE2 }, 2 },
157 
158 	/*
159 	 * Novac PCMCIA-IDE Card for HD530P IDE Box,
160 	 * with neither vendor ID nor product ID
161 	 */
162 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
163 	  {"PCMCIA", "PnPIDE", NULL, NULL} }, 2 },
164 
165 	{ { PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
166 	  {"PCMCIA", "IDE CARD", NULL, NULL} }, 2 },
167 
168 };
169 static const size_t wdc_pcmcia_nproducts =
170     sizeof(wdc_pcmcia_products) / sizeof(wdc_pcmcia_products[0]);
171 
172 static int	wdc_pcmcia_enable(struct device *, int);
173 static void	wdc_pcmcia_datain_memory(struct ata_channel *, int, void *,
174 					 size_t);
175 static void	wdc_pcmcia_dataout_memory(struct ata_channel *, int, void *,
176 					  size_t);
177 
178 static int
179 wdc_pcmcia_match(struct device *parent, struct cfdata *match,
180     void *aux)
181 {
182 	struct pcmcia_attach_args *pa = aux;
183 
184 	if (pa->pf->function == PCMCIA_FUNCTION_DISK &&
185 	    pa->pf->pf_funce_disk_interface == PCMCIA_TPLFE_DDI_PCCARD_ATA)
186 		return (1);
187 	if (pcmcia_product_lookup(pa, wdc_pcmcia_products, wdc_pcmcia_nproducts,
188 	    sizeof(wdc_pcmcia_products[0]), NULL))
189 		return (2);
190 	return (0);
191 }
192 
193 static int
194 wdc_pcmcia_validate_config_io(struct pcmcia_config_entry *cfe)
195 {
196 	if (cfe->iftype != PCMCIA_IFTYPE_IO ||
197 	    cfe->num_iospace < 1 || cfe->num_iospace > 2)
198 		return (EINVAL);
199 	cfe->num_memspace = 0;
200 	return (0);
201 }
202 
203 static int
204 wdc_pcmcia_validate_config_memory(struct pcmcia_config_entry *cfe)
205 {
206 	if (cfe->iftype != PCMCIA_IFTYPE_MEMORY ||
207 	    cfe->num_memspace > 1 ||
208 	    cfe->memspace[0].length < 2048)
209 		return (EINVAL);
210 	cfe->num_iospace = 0;
211 	return (0);
212 }
213 
214 static void
215 wdc_pcmcia_attach(struct device *parent, struct device *self,
216     void *aux)
217 {
218 	struct wdc_pcmcia_softc *sc = (void *)self;
219 	struct pcmcia_attach_args *pa = aux;
220 	struct pcmcia_config_entry *cfe;
221 	struct wdc_regs *wdr;
222 	const struct wdc_pcmcia_product *wdcp;
223 	bus_size_t offset;
224 	int i;
225 	int error;
226 
227 	sc->sc_pf = pa->pf;
228 
229 	error = pcmcia_function_configure(pa->pf,
230 	    wdc_pcmcia_validate_config_io);
231 	if (error)
232 		/*XXXmem16|common*/
233 		error = pcmcia_function_configure(pa->pf,
234 		    wdc_pcmcia_validate_config_memory);
235 	if (error) {
236 		aprint_error("%s: configure failed, error=%d\n", self->dv_xname,
237 		    error);
238 		return;
239 	}
240 
241 	cfe = pa->pf->cfe;
242 	sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA16;
243 
244 	sc->sc_wdcdev.regs = wdr = &sc->wdc_regs;
245 
246 	if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
247 		wdr->cmd_iot = cfe->memspace[0].handle.memt;
248 		wdr->cmd_baseioh = cfe->memspace[0].handle.memh;
249 		offset = cfe->memspace[0].offset;
250 		wdr->ctl_iot = cfe->memspace[0].handle.memt;
251 		if (bus_space_subregion(cfe->memspace[0].handle.memt,
252 		    cfe->memspace[0].handle.memh,
253 		    offset + WDC_PCMCIA_AUXREG_OFFSET, WDC_PCMCIA_AUXREG_NPORTS,
254 		    &wdr->ctl_ioh))
255 			goto fail;
256 	} else {
257 		wdr->cmd_iot = cfe->iospace[0].handle.iot;
258 		wdr->cmd_baseioh = cfe->iospace[0].handle.ioh;
259 		offset = 0;
260 		if (cfe->num_iospace == 1) {
261 			wdr->ctl_iot = cfe->iospace[0].handle.iot;
262 			if (bus_space_subregion(cfe->iospace[0].handle.iot,
263 			    cfe->iospace[0].handle.ioh,
264 			    WDC_PCMCIA_AUXREG_OFFSET, WDC_PCMCIA_AUXREG_NPORTS,
265 			    &wdr->ctl_ioh))
266 				goto fail;
267 		} else {
268 			wdr->ctl_iot = cfe->iospace[1].handle.iot;
269 			wdr->ctl_ioh = cfe->iospace[1].handle.ioh;
270 		}
271 	}
272 
273 	for (i = 0; i < WDC_PCMCIA_REG_NPORTS; i++) {
274 		if (bus_space_subregion(wdr->cmd_iot,
275 		    wdr->cmd_baseioh,
276 		    offset + i, i == 0 ? 4 : 1,
277 		    &wdr->cmd_iohs[i]) != 0) {
278 			aprint_error("%s: can't subregion I/O space\n",
279 			    self->dv_xname);
280 			goto fail;
281 		}
282 	}
283 
284 	if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
285 		aprint_normal("%s: memory mapped mode\n", self->dv_xname);
286 		wdr->data32iot = cfe->memspace[0].handle.memt;
287 		if (bus_space_subregion(cfe->memspace[0].handle.memt,
288 		    cfe->memspace[0].handle.memh, offset + 1024, 1024,
289 		    &wdr->data32ioh))
290 			goto fail;
291 		sc->sc_wdcdev.datain_pio = wdc_pcmcia_datain_memory;
292 		sc->sc_wdcdev.dataout_pio = wdc_pcmcia_dataout_memory;
293 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_NOIRQ;
294 	} else {
295 		aprint_normal("%s: i/o mapped mode\n", self->dv_xname);
296 		wdr->data32iot = wdr->cmd_iot;
297 		wdr->data32ioh = wdr->cmd_iohs[wd_data];
298 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA32;
299 	}
300 
301 	sc->sc_wdcdev.sc_atac.atac_pio_cap = 0;
302 	sc->wdc_chanlist[0] = &sc->ata_channel;
303 	sc->sc_wdcdev.sc_atac.atac_channels = sc->wdc_chanlist;
304 	sc->sc_wdcdev.sc_atac.atac_nchannels = 1;
305 	sc->ata_channel.ch_channel = 0;
306 	sc->ata_channel.ch_atac = &sc->sc_wdcdev.sc_atac;
307 	sc->ata_channel.ch_queue = &sc->wdc_chqueue;
308 	wdcp = pcmcia_product_lookup(pa, wdc_pcmcia_products,
309 	    wdc_pcmcia_nproducts, sizeof(wdc_pcmcia_products[0]), NULL);
310 	sc->ata_channel.ch_ndrive = wdcp ? wdcp->wdc_ndrive : 2;
311 	wdc_init_shadow_regs(&sc->ata_channel);
312 
313 	error = wdc_pcmcia_enable(self, 1);
314 	if (error)
315 		goto fail;
316 
317 	/* We can enable and disable the controller. */
318 	sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_enable =
319 	    wdc_pcmcia_enable;
320 	sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_refcnt = 1;
321 
322 	/*
323 	 * Some devices needs some more delay after power up to stabilize
324 	 * and probe properly, so give them half a second.
325 	 * See PR 25659 for details.
326 	 */
327 	config_pending_incr();
328 	tsleep(wdc_pcmcia_attach, PWAIT, "wdcattach", hz / 2);
329 
330 	wdcattach(&sc->ata_channel);
331 	config_pending_decr();
332 	ata_delref(&sc->ata_channel);
333 	sc->sc_state = WDC_PCMCIA_ATTACHED;
334 	return;
335 
336 fail:
337 	pcmcia_function_unconfigure(pa->pf);
338 }
339 
340 static int
341 wdc_pcmcia_detach(struct device *self, int flags)
342 {
343 	struct wdc_pcmcia_softc *sc = (struct wdc_pcmcia_softc *)self;
344 	int error;
345 
346 	if (sc->sc_state != WDC_PCMCIA_ATTACHED)
347 		return (0);
348 
349 	if ((error = wdcdetach(self, flags)) != 0)
350 		return (error);
351 
352 	pcmcia_function_unconfigure(sc->sc_pf);
353 
354 	return (0);
355 }
356 
357 static int
358 wdc_pcmcia_enable(struct device *self, int onoff)
359 {
360 	struct wdc_pcmcia_softc *sc = (void *)self;
361 	int error;
362 
363 	if (onoff) {
364 		/* Establish the interrupt handler. */
365 		sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_BIO,
366 		    wdcintr, &sc->ata_channel);
367 		if (!sc->sc_ih)
368 			return (EIO);
369 
370 		error = pcmcia_function_enable(sc->sc_pf);
371 		if (error) {
372 			pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
373 			sc->sc_ih = 0;
374 			return (error);
375 		}
376 	} else {
377 		pcmcia_function_disable(sc->sc_pf);
378 		pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
379 		sc->sc_ih = 0;
380 	}
381 
382 	return (0);
383 }
384 
385 static void
386 wdc_pcmcia_datain_memory(struct ata_channel *chp, int flags, void *buf,
387     size_t len)
388 {
389 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
390 
391 	while (len > 0) {
392 		size_t n;
393 
394 		n = min(len, 1024);
395 		if ((flags & DRIVE_CAP32) && (n & 3) == 0)
396 			bus_space_read_region_stream_4(wdr->data32iot,
397 			    wdr->data32ioh, 0, buf, n >> 2);
398 		else
399 			bus_space_read_region_stream_2(wdr->data32iot,
400 			    wdr->data32ioh, 0, buf, n >> 1);
401 		buf = (char *)buf + n;
402 		len -= n;
403 	}
404 }
405 
406 static void
407 wdc_pcmcia_dataout_memory(struct ata_channel *chp, int flags, void *buf,
408     size_t len)
409 {
410 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
411 
412 	while (len > 0) {
413 		size_t n;
414 
415 		n = min(len, 1024);
416 		if ((flags & DRIVE_CAP32) && (n & 3) == 0)
417 			bus_space_write_region_stream_4(wdr->data32iot,
418 			    wdr->data32ioh, 0, buf, n >> 2);
419 		else
420 			bus_space_write_region_stream_2(wdr->data32iot,
421 			    wdr->data32ioh, 0, buf, n >> 1);
422 		buf = (char *)buf + n;
423 		len -= n;
424 	}
425 }
426