Home | History | Annotate | Line # | Download | only in pcmcia
wdc_pcmcia.c revision 1.110
      1 /*	$NetBSD: wdc_pcmcia.c,v 1.110 2008/03/18 20:46:37 cube 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.110 2008/03/18 20:46:37 cube 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(device_t, cfdata_t, 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(device_t, device_t, void *);
     96 static int wdc_pcmcia_detach(device_t, int);
     97 
     98 CFATTACH_DECL_NEW(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(device_t, 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(device_t parent, cfdata_t 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(device_t parent, device_t self, void *aux)
    215 {
    216 	struct wdc_pcmcia_softc *sc = device_private(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_wdcdev.sc_atac.atac_dev = self;
    226 	sc->sc_pf = pa->pf;
    227 
    228 	error = pcmcia_function_configure(pa->pf,
    229 	    wdc_pcmcia_validate_config_io);
    230 	if (error)
    231 		/*XXXmem16|common*/
    232 		error = pcmcia_function_configure(pa->pf,
    233 		    wdc_pcmcia_validate_config_memory);
    234 	if (error) {
    235 		aprint_error_dev(self, "configure failed, error=%d\n", 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_dev(self, "can't subregion I/O space\n");
    277 			goto fail;
    278 		}
    279 	}
    280 
    281 	if (cfe->iftype == PCMCIA_IFTYPE_MEMORY) {
    282 		aprint_normal_dev(self, "memory mapped mode\n");
    283 		wdr->data32iot = cfe->memspace[0].handle.memt;
    284 		if (bus_space_subregion(cfe->memspace[0].handle.memt,
    285 		    cfe->memspace[0].handle.memh, offset + 1024, 1024,
    286 		    &wdr->data32ioh))
    287 			goto fail;
    288 		sc->sc_wdcdev.datain_pio = wdc_pcmcia_datain_memory;
    289 		sc->sc_wdcdev.dataout_pio = wdc_pcmcia_dataout_memory;
    290 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_NOIRQ;
    291 	} else {
    292 		aprint_normal_dev(self, "i/o mapped mode\n");
    293 		wdr->data32iot = wdr->cmd_iot;
    294 		wdr->data32ioh = wdr->cmd_iohs[wd_data];
    295 		sc->sc_wdcdev.sc_atac.atac_cap |= ATAC_CAP_DATA32;
    296 	}
    297 
    298 	sc->sc_wdcdev.sc_atac.atac_pio_cap = 0;
    299 	sc->wdc_chanlist[0] = &sc->ata_channel;
    300 	sc->sc_wdcdev.sc_atac.atac_channels = sc->wdc_chanlist;
    301 	sc->sc_wdcdev.sc_atac.atac_nchannels = 1;
    302 	sc->ata_channel.ch_channel = 0;
    303 	sc->ata_channel.ch_atac = &sc->sc_wdcdev.sc_atac;
    304 	sc->ata_channel.ch_queue = &sc->wdc_chqueue;
    305 	wdcp = pcmcia_product_lookup(pa, wdc_pcmcia_products,
    306 	    wdc_pcmcia_nproducts, sizeof(wdc_pcmcia_products[0]), NULL);
    307 	sc->ata_channel.ch_ndrive = wdcp ? wdcp->wdc_ndrive : 2;
    308 	wdc_init_shadow_regs(&sc->ata_channel);
    309 
    310 	error = wdc_pcmcia_enable(self, 1);
    311 	if (error)
    312 		goto fail;
    313 
    314 	/* We can enable and disable the controller. */
    315 	sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_enable =
    316 	    wdc_pcmcia_enable;
    317 	sc->sc_wdcdev.sc_atac.atac_atapi_adapter._generic.adapt_refcnt = 1;
    318 
    319 	/*
    320 	 * Some devices needs some more delay after power up to stabilize
    321 	 * and probe properly, so give them half a second.
    322 	 * See PR 25659 for details.
    323 	 */
    324 	config_pending_incr();
    325 	tsleep(wdc_pcmcia_attach, PWAIT, "wdcattach", hz / 2);
    326 
    327 	wdcattach(&sc->ata_channel);
    328 	config_pending_decr();
    329 	ata_delref(&sc->ata_channel);
    330 	sc->sc_state = WDC_PCMCIA_ATTACHED;
    331 	return;
    332 
    333 fail:
    334 	pcmcia_function_unconfigure(pa->pf);
    335 }
    336 
    337 static int
    338 wdc_pcmcia_detach(device_t self, int flags)
    339 {
    340 	struct wdc_pcmcia_softc *sc = device_private(self);
    341 	int error;
    342 
    343 	if (sc->sc_state != WDC_PCMCIA_ATTACHED)
    344 		return (0);
    345 
    346 	if ((error = wdcdetach(self, flags)) != 0)
    347 		return (error);
    348 
    349 	pcmcia_function_unconfigure(sc->sc_pf);
    350 
    351 	return (0);
    352 }
    353 
    354 static int
    355 wdc_pcmcia_enable(struct device *self, int onoff)
    356 {
    357 	struct wdc_pcmcia_softc *sc = device_private(self);
    358 	int error;
    359 
    360 	if (onoff) {
    361 		/* Establish the interrupt handler. */
    362 		sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_BIO,
    363 		    wdcintr, &sc->ata_channel);
    364 		if (!sc->sc_ih)
    365 			return (EIO);
    366 
    367 		error = pcmcia_function_enable(sc->sc_pf);
    368 		if (error) {
    369 			pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
    370 			sc->sc_ih = 0;
    371 			return (error);
    372 		}
    373 	} else {
    374 		pcmcia_function_disable(sc->sc_pf);
    375 		pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
    376 		sc->sc_ih = 0;
    377 	}
    378 
    379 	return (0);
    380 }
    381 
    382 static void
    383 wdc_pcmcia_datain_memory(struct ata_channel *chp, int flags, void *buf,
    384     size_t len)
    385 {
    386 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
    387 
    388 	while (len > 0) {
    389 		size_t n;
    390 
    391 		n = min(len, 1024);
    392 		if ((flags & DRIVE_CAP32) && (n & 3) == 0)
    393 			bus_space_read_region_stream_4(wdr->data32iot,
    394 			    wdr->data32ioh, 0, buf, n >> 2);
    395 		else
    396 			bus_space_read_region_stream_2(wdr->data32iot,
    397 			    wdr->data32ioh, 0, buf, n >> 1);
    398 		buf = (char *)buf + n;
    399 		len -= n;
    400 	}
    401 }
    402 
    403 static void
    404 wdc_pcmcia_dataout_memory(struct ata_channel *chp, int flags, void *buf,
    405     size_t len)
    406 {
    407 	struct wdc_regs *wdr = CHAN_TO_WDC_REGS(chp);
    408 
    409 	while (len > 0) {
    410 		size_t n;
    411 
    412 		n = min(len, 1024);
    413 		if ((flags & DRIVE_CAP32) && (n & 3) == 0)
    414 			bus_space_write_region_stream_4(wdr->data32iot,
    415 			    wdr->data32ioh, 0, buf, n >> 2);
    416 		else
    417 			bus_space_write_region_stream_2(wdr->data32iot,
    418 			    wdr->data32ioh, 0, buf, n >> 1);
    419 		buf = (char *)buf + n;
    420 		len -= n;
    421 	}
    422 }
    423