Home | History | Annotate | Line # | Download | only in pcmcia
wdc_pcmcia.c revision 1.27
      1 /*	$NetBSD: wdc_pcmcia.c,v 1.27 2000/01/24 23:14:23 enami Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 1998 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/param.h>
     40 #include <sys/systm.h>
     41 #include <sys/kernel.h>
     42 #include <sys/conf.h>
     43 #include <sys/file.h>
     44 #include <sys/stat.h>
     45 #include <sys/ioctl.h>
     46 #include <sys/buf.h>
     47 #include <sys/uio.h>
     48 #include <sys/malloc.h>
     49 #include <sys/device.h>
     50 #include <sys/disklabel.h>
     51 #include <sys/disk.h>
     52 #include <sys/syslog.h>
     53 #include <sys/proc.h>
     54 
     55 #include <vm/vm.h>
     56 
     57 #include <machine/cpu.h>
     58 #include <machine/intr.h>
     59 #include <machine/bus.h>
     60 
     61 #include <dev/pcmcia/pcmciareg.h>
     62 #include <dev/pcmcia/pcmciavar.h>
     63 #include <dev/pcmcia/pcmciadevs.h>
     64 
     65 #include <dev/ata/atavar.h>
     66 #include <dev/ic/wdcvar.h>
     67 
     68 #define WDC_PCMCIA_REG_NPORTS      8
     69 #define WDC_PCMCIA_AUXREG_OFFSET   (WDC_PCMCIA_REG_NPORTS + 6)
     70 #define WDC_PCMCIA_AUXREG_NPORTS   2
     71 
     72 struct wdc_pcmcia_softc {
     73 	struct wdc_softc sc_wdcdev;
     74 	struct channel_softc *wdc_chanptr;
     75 	struct channel_softc wdc_channel;
     76 	struct pcmcia_io_handle sc_pioh;
     77 	struct pcmcia_io_handle sc_auxpioh;
     78 	int sc_iowindow;
     79 	int sc_auxiowindow;
     80 	void *sc_ih;
     81 	struct pcmcia_function *sc_pf;
     82 	int sc_flags;
     83 #define	WDC_PCMCIA_ATTACH	0x0001
     84 };
     85 
     86 static int wdc_pcmcia_match	__P((struct device *, struct cfdata *, void *));
     87 static void wdc_pcmcia_attach	__P((struct device *, struct device *, void *));
     88 static int wdc_pcmcia_detach	__P((struct device *, int));
     89 
     90 struct cfattach wdc_pcmcia_ca = {
     91 	sizeof(struct wdc_pcmcia_softc), wdc_pcmcia_match, wdc_pcmcia_attach,
     92 	wdc_pcmcia_detach, wdcactivate
     93 };
     94 
     95 struct wdc_pcmcia_product {
     96 	u_int32_t	wpp_vendor;	/* vendor ID */
     97 	u_int32_t	wpp_product;	/* product ID */
     98 	int		wpp_quirk_flag;	/* Quirk flags */
     99 #define WDC_PCMCIA_FORCE_16BIT_IO	0x01 /* Don't use PCMCIA_WIDTH_AUTO */
    100 #define WDC_PCMCIA_NO_EXTRA_RESETS	0x02 /* Only reset ctrl once */
    101 	const char	*wpp_cis_info[4];	/* XXX necessary? */
    102 	const char	*wpp_name;	/* product name */
    103 } wdc_pcmcia_products[] = {
    104 
    105 	{ /* PCMCIA_VENDOR_DIGITAL XXX */ 0x0100,
    106 	  PCMCIA_PRODUCT_DIGITAL_MOBILE_MEDIA_CDROM,
    107 	  0, { NULL, "Digital Mobile Media CD-ROM", NULL, NULL },
    108 	  PCMCIA_STR_DIGITAL_MOBILE_MEDIA_CDROM },
    109 
    110 	{ PCMCIA_VENDOR_IBM,
    111 	  PCMCIA_PRODUCT_IBM_PORTABLE_CDROM,
    112 	  0, { NULL, "PCMCIA Portable CD-ROM Drive", NULL, NULL },
    113 	  PCMCIA_STR_IBM_PORTABLE_CDROM },
    114 
    115 	{ PCMCIA_VENDOR_HAGIWARASYSCOM,
    116 	  -1,			/* XXX */
    117 	  WDC_PCMCIA_FORCE_16BIT_IO,
    118 	  { NULL, NULL, NULL, NULL },
    119 	  "Hagiwara SYS-COM CompactFlash Card" },
    120 
    121 	/* The TEAC IDE/Card II is used on the Sony Vaio */
    122 	{ PCMCIA_VENDOR_TEAC,
    123 	  PCMCIA_PRODUCT_TEAC_IDECARDII,
    124 	  WDC_PCMCIA_NO_EXTRA_RESETS,
    125 	  PCMCIA_CIS_TEAC_IDECARDII,
    126 	  PCMCIA_STR_TEAC_IDECARDII },
    127 
    128 	/*
    129 	 * EXP IDE/ATAPI DVD Card use with some DVD players.
    130 	 * Does not have a vendor ID or product ID.
    131 	 */
    132 	{ -1,
    133 	  -1,
    134 	  0,
    135 	  PCMCIA_CIS_EXP_EXPMULTIMEDIA,
    136 	  PCMCIA_STR_EXP_EXPMULTIMEDIA },
    137 
    138 	/* Mobile Dock 2, which doesn't have vendor ID nor product ID */
    139 	{ -1, -1, 0,
    140 	  { "SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", NULL, NULL},
    141 	  "SHUTTLE TECHNOLOGY IDE/ATAPI Adapter"
    142 	},
    143 
    144 	{ 0, 0, 0, { NULL, NULL, NULL, NULL}, NULL }
    145 };
    146 
    147 struct wdc_pcmcia_disk_device_interface_args {
    148 	int ddi_type;		/* interface type */
    149 	int ddi_reqfn;		/* function we are requesting iftype */
    150 	int ddi_curfn;		/* function we are currently parsing in CIS */
    151 };
    152 
    153 int	wdc_pcmcia_disk_device_interface_callback __P((struct pcmcia_tuple *,
    154 	    void *));
    155 int	wdc_pcmcia_disk_device_interface __P((struct pcmcia_function *));
    156 struct wdc_pcmcia_product *
    157 	wdc_pcmcia_lookup __P((struct pcmcia_attach_args *));
    158 
    159 int	wdc_pcmcia_enable __P((void *, int));
    160 
    161 int
    162 wdc_pcmcia_disk_device_interface_callback(tuple, arg)
    163 	struct pcmcia_tuple *tuple;
    164 	void *arg;
    165 {
    166 	struct wdc_pcmcia_disk_device_interface_args *ddi = arg;
    167 
    168 	switch (tuple->code) {
    169 	case PCMCIA_CISTPL_FUNCID:
    170 		ddi->ddi_curfn++;
    171 		break;
    172 
    173 	case PCMCIA_CISTPL_FUNCE:
    174 		if (ddi->ddi_reqfn != ddi->ddi_curfn)
    175 			break;
    176 
    177 		/* subcode (disk device interface), data (interface type) */
    178 		if (tuple->length < 2)
    179 			break;
    180 
    181 		/* check type */
    182 		if (pcmcia_tuple_read_1(tuple, 0) !=
    183 		    PCMCIA_TPLFE_TYPE_DISK_DEVICE_INTERFACE)
    184 			break;
    185 
    186 		ddi->ddi_type = pcmcia_tuple_read_1(tuple, 1);
    187 		return (1);
    188 	}
    189 	return (0);
    190 }
    191 
    192 int
    193 wdc_pcmcia_disk_device_interface(pf)
    194 	struct pcmcia_function *pf;
    195 {
    196 	struct wdc_pcmcia_disk_device_interface_args ddi;
    197 
    198 	ddi.ddi_reqfn = pf->number;
    199 	ddi.ddi_curfn = -1;
    200 	if (pcmcia_scan_cis((struct device *)pf->sc,
    201 	    wdc_pcmcia_disk_device_interface_callback, &ddi) > 0)
    202 		return (ddi.ddi_type);
    203 	else
    204 		return (-1);
    205 }
    206 
    207 struct wdc_pcmcia_product *
    208 wdc_pcmcia_lookup(pa)
    209 	struct pcmcia_attach_args *pa;
    210 {
    211 	struct wdc_pcmcia_product *wpp;
    212 	int i, cis_match;
    213 
    214 	for (wpp = wdc_pcmcia_products; wpp->wpp_name != NULL; wpp++)
    215 		if ((wpp->wpp_vendor == -1 ||
    216 		     pa->manufacturer == wpp->wpp_vendor) &&
    217 		    (wpp->wpp_product == -1 ||
    218 		     pa->product == wpp->wpp_product)) {
    219 			cis_match = 1;
    220 			for (i = 0; i < 4; i++) {
    221 				if (!(wpp->wpp_cis_info[i] == NULL ||
    222 				      (pa->card->cis1_info[i] != NULL &&
    223 				       strcmp(pa->card->cis1_info[i],
    224 					      wpp->wpp_cis_info[i]) == 0)))
    225 					cis_match = 0;
    226 			}
    227 			if (cis_match)
    228 				return (wpp);
    229 		}
    230 
    231 	return (NULL);
    232 }
    233 
    234 static int
    235 wdc_pcmcia_match(parent, match, aux)
    236 	struct device *parent;
    237 	struct cfdata *match;
    238 	void *aux;
    239 {
    240 	struct pcmcia_attach_args *pa = aux;
    241 	struct pcmcia_softc *sc;
    242 	int iftype;
    243 
    244 	if (wdc_pcmcia_lookup(pa) != NULL)
    245 		return (1);
    246 
    247 	if (pa->pf->function == PCMCIA_FUNCTION_DISK) {
    248 		sc = pa->pf->sc;
    249 
    250 		pcmcia_chip_socket_enable(sc->pct, sc->pch);
    251 		iftype = wdc_pcmcia_disk_device_interface(pa->pf);
    252 		pcmcia_chip_socket_disable(sc->pct, sc->pch);
    253 
    254 		if (iftype == PCMCIA_TPLFE_DDI_PCCARD_ATA)
    255 			return (1);
    256 	}
    257 
    258 	return (0);
    259 }
    260 
    261 static void
    262 wdc_pcmcia_attach(parent, self, aux)
    263 	struct device *parent;
    264 	struct device *self;
    265 	void *aux;
    266 {
    267 	struct wdc_pcmcia_softc *sc = (void *)self;
    268 	struct pcmcia_attach_args *pa = aux;
    269 	struct pcmcia_config_entry *cfe;
    270 	struct wdc_pcmcia_product *wpp;
    271 	int quirks;
    272 
    273 	sc->sc_pf = pa->pf;
    274 
    275 	for (cfe = SIMPLEQ_FIRST(&pa->pf->cfe_head); cfe != NULL;
    276 	    cfe = SIMPLEQ_NEXT(cfe, cfe_list)) {
    277 		if (cfe->num_iospace != 1 && cfe->num_iospace != 2)
    278 			continue;
    279 
    280 		if (pcmcia_io_alloc(pa->pf, cfe->iospace[0].start,
    281 		    cfe->iospace[0].length,
    282 		    cfe->iospace[0].start == 0 ? cfe->iospace[0].length : 0,
    283 		    &sc->sc_pioh))
    284 			continue;
    285 
    286 		if (cfe->num_iospace == 2) {
    287 			if (!pcmcia_io_alloc(pa->pf, cfe->iospace[1].start,
    288 			    cfe->iospace[1].length, 0, &sc->sc_auxpioh))
    289 				break;
    290 		} else /* num_iospace == 1 */ {
    291 			sc->sc_auxpioh.iot = sc->sc_pioh.iot;
    292 			if (!bus_space_subregion(sc->sc_pioh.iot,
    293 			    sc->sc_pioh.ioh, WDC_PCMCIA_AUXREG_OFFSET,
    294 			    WDC_PCMCIA_AUXREG_NPORTS, &sc->sc_auxpioh.ioh))
    295 				break;
    296 		}
    297 		pcmcia_io_free(pa->pf, &sc->sc_pioh);
    298 	}
    299 
    300 	if (cfe == NULL) {
    301 		printf(": can't handle card info\n");
    302 		return;
    303 	}
    304 
    305 	/* Enable the card. */
    306 	pcmcia_function_init(pa->pf, cfe);
    307 	if (pcmcia_function_enable(pa->pf)) {
    308 		printf(": function enable failed\n");
    309 		return;
    310 	}
    311 
    312 	/*
    313 	 * XXX  DEC Mobile Media CDROM is not yet tested whether it works
    314 	 * XXX  with PCMCIA_WIDTH_IO16.  HAGIWARA SYS-COM HPC-CF32 doesn't
    315 	 * XXX  work with PCMCIA_WIDTH_AUTO.
    316 	 * XXX  CANON FC-8M (SANDISK SDCFB 8M) works for both _AUTO and IO16.
    317 	 * XXX  So, here is temporary work around.
    318 	 */
    319 	wpp = wdc_pcmcia_lookup(pa);
    320 	if (wpp != NULL)
    321 		quirks = wpp->wpp_quirk_flag;
    322 	else
    323 		quirks = 0;
    324 
    325 	if (pcmcia_io_map(pa->pf, quirks & WDC_PCMCIA_FORCE_16BIT_IO ?
    326 	    PCMCIA_WIDTH_IO16 : PCMCIA_WIDTH_AUTO, 0,
    327 	    sc->sc_pioh.size, &sc->sc_pioh, &sc->sc_iowindow)) {
    328 		printf(": can't map first I/O space\n");
    329 		return;
    330 	}
    331 
    332 	/*
    333 	 * Currently, # of iospace is 1 except DIGITAL Mobile Media CD-ROM.
    334 	 * So whether the work around like above is necessary or not
    335 	 * is unknown.  XXX.
    336 	 */
    337 	if (cfe->num_iospace <= 1)
    338 		sc->sc_auxiowindow = -1;
    339 	else if (pcmcia_io_map(pa->pf, PCMCIA_WIDTH_AUTO, 0,
    340 	    sc->sc_auxpioh.size, &sc->sc_auxpioh, &sc->sc_auxiowindow)) {
    341 		printf(": can't map second I/O space\n");
    342 		return;
    343 	}
    344 
    345 	if ((wpp != NULL) && (wpp->wpp_name != NULL))
    346 		printf(": %s", wpp->wpp_name);
    347 
    348 	printf("\n");
    349 
    350 	sc->wdc_channel.cmd_iot = sc->sc_pioh.iot;
    351 	sc->wdc_channel.cmd_ioh = sc->sc_pioh.ioh;
    352 	sc->wdc_channel.ctl_iot = sc->sc_auxpioh.iot;
    353 	sc->wdc_channel.ctl_ioh = sc->sc_auxpioh.ioh;
    354 	sc->wdc_channel.data32iot = sc->wdc_channel.cmd_iot;
    355 	sc->wdc_channel.data32ioh = sc->wdc_channel.cmd_ioh;
    356 	sc->sc_wdcdev.cap |= WDC_CAPABILITY_DATA16 | WDC_CAPABILITY_DATA32;
    357 	sc->sc_wdcdev.PIO_cap = 0;
    358 	sc->wdc_chanptr = &sc->wdc_channel;
    359 	sc->sc_wdcdev.channels = &sc->wdc_chanptr;
    360 	sc->sc_wdcdev.nchannels = 1;
    361 	sc->wdc_channel.channel = 0;
    362 	sc->wdc_channel.wdc = &sc->sc_wdcdev;
    363 	sc->wdc_channel.ch_queue = malloc(sizeof(struct channel_queue),
    364 	    M_DEVBUF, M_NOWAIT);
    365 	if (sc->wdc_channel.ch_queue == NULL) {
    366 		printf("%s: can't allocate memory for command queue\n",
    367 		    sc->sc_wdcdev.sc_dev.dv_xname);
    368 		return;
    369 	}
    370 	if (quirks & WDC_PCMCIA_NO_EXTRA_RESETS)
    371 		sc->sc_wdcdev.cap |= WDC_CAPABILITY_NO_EXTRA_RESETS;
    372 
    373 	/* We can enable and disable the controller. */
    374 	sc->sc_wdcdev.sc_atapi_adapter.scsipi_enable = wdc_pcmcia_enable;
    375 
    376 	sc->sc_flags |= WDC_PCMCIA_ATTACH;
    377 	wdcattach(&sc->wdc_channel);
    378 	sc->sc_flags &= ~WDC_PCMCIA_ATTACH;
    379 }
    380 
    381 int
    382 wdc_pcmcia_detach(self, flags)
    383 	struct device *self;
    384 	int flags;
    385 {
    386 	struct wdc_pcmcia_softc *sc = (struct wdc_pcmcia_softc *)self;
    387 	int error;
    388 
    389 	if ((error = wdcdetach(self, flags)) != 0)
    390 		return (error);
    391 
    392 	if (sc->wdc_channel.ch_queue != NULL)
    393 		free(sc->wdc_channel.ch_queue, M_DEVBUF);
    394 
    395 	/* Unmap our i/o window and i/o space. */
    396 	pcmcia_io_unmap(sc->sc_pf, sc->sc_iowindow);
    397 	pcmcia_io_free(sc->sc_pf, &sc->sc_pioh);
    398 	if (sc->sc_auxiowindow != -1) {
    399 		pcmcia_io_unmap(sc->sc_pf, sc->sc_auxiowindow);
    400 		pcmcia_io_free(sc->sc_pf, &sc->sc_auxpioh);
    401 	}
    402 
    403 	return (0);
    404 }
    405 
    406 int
    407 wdc_pcmcia_enable(arg, onoff)
    408 	void *arg;
    409 	int onoff;
    410 {
    411 	struct wdc_pcmcia_softc *sc = arg;
    412 
    413 	if (onoff) {
    414 		/* Establish the interrupt handler. */
    415 		sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_BIO, wdcintr,
    416 		    &sc->wdc_channel);
    417 		if (sc->sc_ih == NULL) {
    418 			printf("%s: couldn't establish interrupt handler\n",
    419 			    sc->sc_wdcdev.sc_dev.dv_xname);
    420 			return (EIO);
    421 		}
    422 
    423 		/* See the comment in aic_pcmcia_enable */
    424 		if ((sc->sc_flags & WDC_PCMCIA_ATTACH) == 0) {
    425 			if (pcmcia_function_enable(sc->sc_pf)) {
    426 				printf("%s: couldn't enable PCMCIA function\n",
    427 				    sc->sc_wdcdev.sc_dev.dv_xname);
    428 				pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
    429 				return (EIO);
    430 			}
    431 			wdcreset(&sc->wdc_channel, VERBOSE);
    432 		}
    433 	} else {
    434 		pcmcia_function_disable(sc->sc_pf);
    435 		pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
    436 	}
    437 
    438 	return (0);
    439 }
    440