xref: /netbsd-src/sys/dev/pcmcia/wdc_pcmcia.c (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1 /*	$NetBSD: wdc_pcmcia.c,v 1.101 2005/12/11 12:23:23 christos 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.101 2005/12/11 12:23:23 christos 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 <machine/bus.h>
50 #include <machine/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 pcmcia_product wdc_pcmcia_products[] = {
102 	{ PCMCIA_VENDOR_DIGITAL,
103 	  PCMCIA_PRODUCT_DIGITAL_MOBILE_MEDIA_CDROM,
104 	  {NULL, "Digital Mobile Media CD-ROM", NULL, NULL} },
105 
106 	{ PCMCIA_VENDOR_IBM,
107 	  PCMCIA_PRODUCT_IBM_PORTABLE_CDROM,
108 	  {NULL, "PCMCIA Portable CD-ROM Drive", NULL, NULL} },
109 
110 	/* The TEAC IDE/Card II is used on the Sony Vaio */
111 	{ PCMCIA_VENDOR_TEAC,
112 	  PCMCIA_PRODUCT_TEAC_IDECARDII,
113 	  PCMCIA_CIS_TEAC_IDECARDII },
114 
115 	/*
116 	 * A fujitsu rebranded panasonic drive that reports
117 	 * itself as function "scsi", disk interface 0
118 	 */
119 	{ PCMCIA_VENDOR_PANASONIC,
120 	  PCMCIA_PRODUCT_PANASONIC_KXLC005,
121 	  PCMCIA_CIS_PANASONIC_KXLC005 },
122 
123 	/*
124 	 * EXP IDE/ATAPI DVD Card use with some DVD players.
125 	 * Does not have a vendor ID or product ID.
126 	 */
127 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
128 	  PCMCIA_CIS_EXP_EXPMULTIMEDIA },
129 
130 	/* Mobile Dock 2, neither vendor ID nor product ID */
131 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
132 	  {"SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", NULL, NULL} },
133 
134 	/* Toshiba Portege 3110 CD, neither vendor ID nor product ID */
135 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
136 	  {"FREECOM", "PCCARD-IDE", NULL, NULL} },
137 
138 	/* Random CD-ROM, (badged AMACOM), neither vendor ID nor product ID */
139 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
140 	  {"PCMCIA", "CD-ROM", NULL, NULL} },
141 
142 	/* IO DATA CBIDE2, with neither vendor ID nor product ID */
143 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
144 	  PCMCIA_CIS_IODATA_CBIDE2 },
145 
146 	/* TOSHIBA PA2673U(IODATA_CBIDE2 OEM), */
147 	/*  with neither vendor ID nor product ID */
148 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
149 	  PCMCIA_CIS_TOSHIBA_CBIDE2 },
150 
151 	/*
152 	 * Novac PCMCIA-IDE Card for HD530P IDE Box,
153 	 * with neither vendor ID nor product ID
154 	 */
155 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
156 	  {"PCMCIA", "PnPIDE", NULL, NULL} },
157 };
158 static const size_t wdc_pcmcia_nproducts =
159     sizeof(wdc_pcmcia_products) / sizeof(wdc_pcmcia_products[0]);
160 
161 static int	wdc_pcmcia_enable(struct device *, int);
162 static void	wdc_pcmcia_datain_memory(struct ata_channel *, int, void *,
163 					 size_t);
164 static void	wdc_pcmcia_dataout_memory(struct ata_channel *, int, void *,
165 					  size_t);
166 
167 static int
168 wdc_pcmcia_match(struct device *parent, struct cfdata *match, void *aux)
169 {
170 	struct pcmcia_attach_args *pa = aux;
171 
172 	if (pa->pf->function == PCMCIA_FUNCTION_DISK &&
173 	    pa->pf->pf_funce_disk_interface == PCMCIA_TPLFE_DDI_PCCARD_ATA)
174 		return (1);
175 	if (pcmcia_product_lookup(pa, wdc_pcmcia_products, wdc_pcmcia_nproducts,
176 	    sizeof(wdc_pcmcia_products[0]), NULL))
177 		return (2);
178 	return (0);
179 }
180 
181 static int
182 wdc_pcmcia_validate_config_io(struct pcmcia_config_entry *cfe)
183 {
184 	if (cfe->iftype != PCMCIA_IFTYPE_IO ||
185 	    cfe->num_iospace < 1 || cfe->num_iospace > 2)
186 		return (EINVAL);
187 	cfe->num_memspace = 0;
188 	return (0);
189 }
190 
191 static int
192 wdc_pcmcia_validate_config_memory(struct pcmcia_config_entry *cfe)
193 {
194 	if (cfe->iftype != PCMCIA_IFTYPE_MEMORY ||
195 	    cfe->num_memspace > 1 ||
196 	    cfe->memspace[0].length < 2048)
197 		return (EINVAL);
198 	cfe->num_iospace = 0;
199 	return (0);
200 }
201 
202 static void
203 wdc_pcmcia_attach(struct device *parent, struct device *self, void *aux)
204 {
205 	struct wdc_pcmcia_softc *sc = (void *)self;
206 	struct pcmcia_attach_args *pa = aux;
207 	struct pcmcia_config_entry *cfe;
208 	struct wdc_regs *wdr;
209 	bus_size_t offset;
210 	int i;
211 	int error;
212 
213 	sc->sc_pf = pa->pf;
214 
215 	error = pcmcia_function_configure(pa->pf,
216 	    wdc_pcmcia_validate_config_io);
217 	if (error)
218 		/*XXXmem16|common*/
219 		error = pcmcia_function_configure(pa->pf,
220 		    wdc_pcmcia_validate_config_memory);
221 	if (error) {
222 		aprint_error("%s: configure failed, error=%d\n", self->dv_xname,
223 		    error);
224 		return;
225 	}
226 
227 	cfe = pa->pf->cfe;
228 	sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA16;
229 
230 	sc->sc_wdcdev.regs = wdr = &sc->wdc_regs;
231 
232 	if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
233 		wdr->cmd_iot = cfe->memspace[0].handle.memt;
234 		wdr->cmd_baseioh = cfe->memspace[0].handle.memh;
235 		offset = cfe->memspace[0].offset;
236 		wdr->ctl_iot = cfe->memspace[0].handle.memt;
237 		if (bus_space_subregion(cfe->memspace[0].handle.memt,
238 		    cfe->memspace[0].handle.memh,
239 		    offset + WDC_PCMCIA_AUXREG_OFFSET, WDC_PCMCIA_AUXREG_NPORTS,
240 		    &wdr->ctl_ioh))
241 			goto fail;
242 	} else {
243 		wdr->cmd_iot = cfe->iospace[0].handle.iot;
244 		wdr->cmd_baseioh = cfe->iospace[0].handle.ioh;
245 		offset = 0;
246 		if (cfe->num_iospace == 1) {
247 			wdr->ctl_iot = cfe->iospace[0].handle.iot;
248 			if (bus_space_subregion(cfe->iospace[0].handle.iot,
249 			    cfe->iospace[0].handle.ioh,
250 			    WDC_PCMCIA_AUXREG_OFFSET, WDC_PCMCIA_AUXREG_NPORTS,
251 			    &wdr->ctl_ioh))
252 				goto fail;
253 		} else {
254 			wdr->ctl_iot = cfe->iospace[1].handle.iot;
255 			wdr->ctl_ioh = cfe->iospace[1].handle.ioh;
256 		}
257 	}
258 
259 	for (i = 0; i < WDC_PCMCIA_REG_NPORTS; i++) {
260 		if (bus_space_subregion(wdr->cmd_iot,
261 		    wdr->cmd_baseioh,
262 		    offset + i, i == 0 ? 4 : 1,
263 		    &wdr->cmd_iohs[i]) != 0) {
264 			aprint_error("%s: can't subregion I/O space\n",
265 			    self->dv_xname);
266 			goto fail;
267 		}
268 	}
269 
270 	if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
271 		aprint_normal("%s: memory mapped mode\n", self->dv_xname);
272 		wdr->data32iot = cfe->memspace[0].handle.memt;
273 		if (bus_space_subregion(cfe->memspace[0].handle.memt,
274 		    cfe->memspace[0].handle.memh, offset + 1024, 1024,
275 		    &wdr->data32ioh))
276 			goto fail;
277 		sc->sc_wdcdev.datain_pio = wdc_pcmcia_datain_memory;
278 		sc->sc_wdcdev.dataout_pio = wdc_pcmcia_dataout_memory;
279 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_NOIRQ;
280 	} else {
281 		aprint_normal("%s: i/o mapped mode\n", self->dv_xname);
282 		wdr->data32iot = wdr->cmd_iot;
283 		wdr->data32ioh = wdr->cmd_iohs[wd_data];
284 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA32;
285 	}
286 
287 	sc->sc_wdcdev.sc_atac.atac_pio_cap = 0;
288 	sc->wdc_chanlist[0] = &sc->ata_channel;
289 	sc->sc_wdcdev.sc_atac.atac_channels = sc->wdc_chanlist;
290 	sc->sc_wdcdev.sc_atac.atac_nchannels = 1;
291 	sc->ata_channel.ch_channel = 0;
292 	sc->ata_channel.ch_atac = &sc->sc_wdcdev.sc_atac;
293 	sc->ata_channel.ch_queue = &sc->wdc_chqueue;
294 	wdc_init_shadow_regs(&sc->ata_channel);
295 
296 	error = wdc_pcmcia_enable(self, 1);
297 	if (error)
298 		goto fail;
299 
300 	/* We can enable and disable the controller. */
301 	sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_enable =
302 	    wdc_pcmcia_enable;
303 	sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_refcnt = 1;
304 
305 	/*
306 	 * Some devices needs some more delay after power up to stabilize
307 	 * and probe properly, so give them half a second.
308 	 * See PR 25659 for details.
309 	 */
310 	tsleep(wdc_pcmcia_attach, PWAIT, "wdcattach", hz / 2);
311 
312 	wdcattach(&sc->ata_channel);
313 	ata_delref(&sc->ata_channel);
314 	sc->sc_state = WDC_PCMCIA_ATTACHED;
315 	return;
316 
317 fail:
318 	pcmcia_function_unconfigure(pa->pf);
319 }
320 
321 static int
322 wdc_pcmcia_detach(struct device *self, int flags)
323 {
324 	struct wdc_pcmcia_softc *sc = (struct wdc_pcmcia_softc *)self;
325 	int error;
326 
327 	if (sc->sc_state != WDC_PCMCIA_ATTACHED)
328 		return (0);
329 
330 	if ((error = wdcdetach(self, flags)) != 0)
331 		return (error);
332 
333 	pcmcia_function_unconfigure(sc->sc_pf);
334 
335 	return (0);
336 }
337 
338 static int
339 wdc_pcmcia_enable(struct device *self, int onoff)
340 {
341 	struct wdc_pcmcia_softc *sc = (void *)self;
342 	int error;
343 
344 	if (onoff) {
345 		/* Establish the interrupt handler. */
346 		sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_BIO,
347 		    wdcintr, &sc->ata_channel);
348 		if (!sc->sc_ih)
349 			return (EIO);
350 
351 		error = pcmcia_function_enable(sc->sc_pf);
352 		if (error) {
353 			pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
354 			sc->sc_ih = 0;
355 			return (error);
356 		}
357 	} else {
358 		pcmcia_function_disable(sc->sc_pf);
359 		pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
360 		sc->sc_ih = 0;
361 	}
362 
363 	return (0);
364 }
365 
366 static void
367 wdc_pcmcia_datain_memory(struct ata_channel *chp, int flags, void *buf,
368     size_t len)
369 {
370 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
371 
372 	while (len > 0) {
373 		size_t n;
374 
375 		n = min(len, 1024);
376 		if ((flags & DRIVE_CAP32) && (n & 3) == 0)
377 			bus_space_read_region_stream_4(wdr->data32iot,
378 			    wdr->data32ioh, 0, buf, n >> 2);
379 		else
380 			bus_space_read_region_stream_2(wdr->data32iot,
381 			    wdr->data32ioh, 0, buf, n >> 1);
382 		buf = (char *)buf + n;
383 		len -= n;
384 	}
385 }
386 
387 static void
388 wdc_pcmcia_dataout_memory(struct ata_channel *chp, int flags, void *buf,
389     size_t len)
390 {
391 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
392 
393 	while (len > 0) {
394 		size_t n;
395 
396 		n = min(len, 1024);
397 		if ((flags & DRIVE_CAP32) && (n & 3) == 0)
398 			bus_space_write_region_stream_4(wdr->data32iot,
399 			    wdr->data32ioh, 0, buf, n >> 2);
400 		else
401 			bus_space_write_region_stream_2(wdr->data32iot,
402 			    wdr->data32ioh, 0, buf, n >> 1);
403 		buf = (char *)buf + n;
404 		len -= n;
405 	}
406 }
407