wdc_pcmcia.c revision 1.106 1 /* $NetBSD: wdc_pcmcia.c,v 1.106 2006/06/19 21:53:57 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.106 2006/06/19 21:53:57 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 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, void *aux)
180 {
181 struct pcmcia_attach_args *pa = aux;
182
183 if (pa->pf->function == PCMCIA_FUNCTION_DISK &&
184 pa->pf->pf_funce_disk_interface == PCMCIA_TPLFE_DDI_PCCARD_ATA)
185 return (1);
186 if (pcmcia_product_lookup(pa, wdc_pcmcia_products, wdc_pcmcia_nproducts,
187 sizeof(wdc_pcmcia_products[0]), NULL))
188 return (2);
189 return (0);
190 }
191
192 static int
193 wdc_pcmcia_validate_config_io(struct pcmcia_config_entry *cfe)
194 {
195 if (cfe->iftype != PCMCIA_IFTYPE_IO ||
196 cfe->num_iospace < 1 || cfe->num_iospace > 2)
197 return (EINVAL);
198 cfe->num_memspace = 0;
199 return (0);
200 }
201
202 static int
203 wdc_pcmcia_validate_config_memory(struct pcmcia_config_entry *cfe)
204 {
205 if (cfe->iftype != PCMCIA_IFTYPE_MEMORY ||
206 cfe->num_memspace > 1 ||
207 cfe->memspace[0].length < 2048)
208 return (EINVAL);
209 cfe->num_iospace = 0;
210 return (0);
211 }
212
213 static void
214 wdc_pcmcia_attach(struct device *parent, struct device *self, void *aux)
215 {
216 struct wdc_pcmcia_softc *sc = (void *)self;
217 struct pcmcia_attach_args *pa = aux;
218 struct pcmcia_config_entry *cfe;
219 struct wdc_regs *wdr;
220 const struct wdc_pcmcia_product *wdcp;
221 bus_size_t offset;
222 int i;
223 int error;
224
225 sc->sc_pf = pa->pf;
226
227 error = pcmcia_function_configure(pa->pf,
228 wdc_pcmcia_validate_config_io);
229 if (error)
230 /*XXXmem16|common*/
231 error = pcmcia_function_configure(pa->pf,
232 wdc_pcmcia_validate_config_memory);
233 if (error) {
234 aprint_error("%s: configure failed, error=%d\n", self->dv_xname,
235 error);
236 return;
237 }
238
239 cfe = pa->pf->cfe;
240 sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA16;
241
242 sc->sc_wdcdev.regs = wdr = &sc->wdc_regs;
243
244 if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
245 wdr->cmd_iot = cfe->memspace[0].handle.memt;
246 wdr->cmd_baseioh = cfe->memspace[0].handle.memh;
247 offset = cfe->memspace[0].offset;
248 wdr->ctl_iot = cfe->memspace[0].handle.memt;
249 if (bus_space_subregion(cfe->memspace[0].handle.memt,
250 cfe->memspace[0].handle.memh,
251 offset + WDC_PCMCIA_AUXREG_OFFSET, WDC_PCMCIA_AUXREG_NPORTS,
252 &wdr->ctl_ioh))
253 goto fail;
254 } else {
255 wdr->cmd_iot = cfe->iospace[0].handle.iot;
256 wdr->cmd_baseioh = cfe->iospace[0].handle.ioh;
257 offset = 0;
258 if (cfe->num_iospace == 1) {
259 wdr->ctl_iot = cfe->iospace[0].handle.iot;
260 if (bus_space_subregion(cfe->iospace[0].handle.iot,
261 cfe->iospace[0].handle.ioh,
262 WDC_PCMCIA_AUXREG_OFFSET, WDC_PCMCIA_AUXREG_NPORTS,
263 &wdr->ctl_ioh))
264 goto fail;
265 } else {
266 wdr->ctl_iot = cfe->iospace[1].handle.iot;
267 wdr->ctl_ioh = cfe->iospace[1].handle.ioh;
268 }
269 }
270
271 for (i = 0; i < WDC_PCMCIA_REG_NPORTS; i++) {
272 if (bus_space_subregion(wdr->cmd_iot,
273 wdr->cmd_baseioh,
274 offset + i, i == 0 ? 4 : 1,
275 &wdr->cmd_iohs[i]) != 0) {
276 aprint_error("%s: can't subregion I/O space\n",
277 self->dv_xname);
278 goto fail;
279 }
280 }
281
282 if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
283 aprint_normal("%s: memory mapped mode\n", self->dv_xname);
284 wdr->data32iot = cfe->memspace[0].handle.memt;
285 if (bus_space_subregion(cfe->memspace[0].handle.memt,
286 cfe->memspace[0].handle.memh, offset + 1024, 1024,
287 &wdr->data32ioh))
288 goto fail;
289 sc->sc_wdcdev.datain_pio = wdc_pcmcia_datain_memory;
290 sc->sc_wdcdev.dataout_pio = wdc_pcmcia_dataout_memory;
291 sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_NOIRQ;
292 } else {
293 aprint_normal("%s: i/o mapped mode\n", self->dv_xname);
294 wdr->data32iot = wdr->cmd_iot;
295 wdr->data32ioh = wdr->cmd_iohs[wd_data];
296 sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA32;
297 }
298
299 sc->sc_wdcdev.sc_atac.atac_pio_cap = 0;
300 sc->wdc_chanlist[0] = &sc->ata_channel;
301 sc->sc_wdcdev.sc_atac.atac_channels = sc->wdc_chanlist;
302 sc->sc_wdcdev.sc_atac.atac_nchannels = 1;
303 sc->ata_channel.ch_channel = 0;
304 sc->ata_channel.ch_atac = &sc->sc_wdcdev.sc_atac;
305 sc->ata_channel.ch_queue = &sc->wdc_chqueue;
306 wdcp = pcmcia_product_lookup(pa, wdc_pcmcia_products,
307 wdc_pcmcia_nproducts, sizeof(wdc_pcmcia_products[0]), NULL);
308 sc->ata_channel.ch_ndrive = wdcp ? wdcp->wdc_ndrive : 2;
309 wdc_init_shadow_regs(&sc->ata_channel);
310
311 error = wdc_pcmcia_enable(self, 1);
312 if (error)
313 goto fail;
314
315 /* We can enable and disable the controller. */
316 sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_enable =
317 wdc_pcmcia_enable;
318 sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_refcnt = 1;
319
320 /*
321 * Some devices needs some more delay after power up to stabilize
322 * and probe properly, so give them half a second.
323 * See PR 25659 for details.
324 */
325 config_pending_incr();
326 tsleep(wdc_pcmcia_attach, PWAIT, "wdcattach", hz / 2);
327
328 wdcattach(&sc->ata_channel);
329 config_pending_decr();
330 ata_delref(&sc->ata_channel);
331 sc->sc_state = WDC_PCMCIA_ATTACHED;
332 return;
333
334 fail:
335 pcmcia_function_unconfigure(pa->pf);
336 }
337
338 static int
339 wdc_pcmcia_detach(struct device *self, int flags)
340 {
341 struct wdc_pcmcia_softc *sc = (struct wdc_pcmcia_softc *)self;
342 int error;
343
344 if (sc->sc_state != WDC_PCMCIA_ATTACHED)
345 return (0);
346
347 if ((error = wdcdetach(self, flags)) != 0)
348 return (error);
349
350 pcmcia_function_unconfigure(sc->sc_pf);
351
352 return (0);
353 }
354
355 static int
356 wdc_pcmcia_enable(struct device *self, int onoff)
357 {
358 struct wdc_pcmcia_softc *sc = (void *)self;
359 int error;
360
361 if (onoff) {
362 /* Establish the interrupt handler. */
363 sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_BIO,
364 wdcintr, &sc->ata_channel);
365 if (!sc->sc_ih)
366 return (EIO);
367
368 error = pcmcia_function_enable(sc->sc_pf);
369 if (error) {
370 pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
371 sc->sc_ih = 0;
372 return (error);
373 }
374 } else {
375 pcmcia_function_disable(sc->sc_pf);
376 pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
377 sc->sc_ih = 0;
378 }
379
380 return (0);
381 }
382
383 static void
384 wdc_pcmcia_datain_memory(struct ata_channel *chp, int flags, void *buf,
385 size_t len)
386 {
387 struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
388
389 while (len > 0) {
390 size_t n;
391
392 n = min(len, 1024);
393 if ((flags & DRIVE_CAP32) && (n & 3) == 0)
394 bus_space_read_region_stream_4(wdr->data32iot,
395 wdr->data32ioh, 0, buf, n >> 2);
396 else
397 bus_space_read_region_stream_2(wdr->data32iot,
398 wdr->data32ioh, 0, buf, n >> 1);
399 buf = (char *)buf + n;
400 len -= n;
401 }
402 }
403
404 static void
405 wdc_pcmcia_dataout_memory(struct ata_channel *chp, int flags, void *buf,
406 size_t len)
407 {
408 struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
409
410 while (len > 0) {
411 size_t n;
412
413 n = min(len, 1024);
414 if ((flags & DRIVE_CAP32) && (n & 3) == 0)
415 bus_space_write_region_stream_4(wdr->data32iot,
416 wdr->data32ioh, 0, buf, n >> 2);
417 else
418 bus_space_write_region_stream_2(wdr->data32iot,
419 wdr->data32ioh, 0, buf, n >> 1);
420 buf = (char *)buf + n;
421 len -= n;
422 }
423 }
424