Home | History | Annotate | Line # | Download | only in usb
umass_quirks.c revision 1.34
      1 /*	$NetBSD: umass_quirks.c,v 1.34 2003/02/24 13:11:55 nakayama Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by MAEKAWA Masahide (gehenna (at) NetBSD.org).
      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/device.h>
     42 #include <sys/buf.h>
     43 
     44 #include <dev/scsipi/scsipi_all.h> /* for scsiconf.h below */
     45 #include <dev/scsipi/scsiconf.h> /* for quirks defines */
     46 
     47 #include <dev/usb/usb.h>
     48 #include <dev/usb/usbdi.h>
     49 #include <dev/usb/usbdevs.h>
     50 
     51 #include <dev/usb/umassvar.h>
     52 #include <dev/usb/umass_quirks.h>
     53 
     54 Static usbd_status umass_init_insystem(struct umass_softc *);
     55 Static usbd_status umass_init_shuttle(struct umass_softc *);
     56 
     57 Static void umass_fixup_sony(struct umass_softc *);
     58 Static void umass_fixup_yedata(struct umass_softc *);
     59 
     60 Static const struct umass_quirk umass_quirks[] = {
     61 	{ { USB_VENDOR_ATI, USB_PRODUCT_ATI2_205 },
     62 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
     63 	  0,
     64 	  0,
     65 	  UMATCH_VENDOR_PRODUCT,
     66 	  NULL, NULL
     67 	},
     68 
     69 	{ { USB_VENDOR_DMI, USB_PRODUCT_DMI_SA2_0 },
     70 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
     71 	  0,
     72 	  PQUIRK_NOMODESENSE,
     73 	  UMATCH_VENDOR_PRODUCT,
     74 	  NULL, NULL
     75 	},
     76 
     77 	{ { USB_VENDOR_EASYDISK, USB_PRODUCT_EASYDISK_EASYDISK },
     78 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
     79 	  0,
     80 	  PQUIRK_NOMODESENSE,
     81 	  UMATCH_VENDOR_PRODUCT,
     82 	  NULL, NULL
     83 	},
     84 
     85 	{ { USB_VENDOR_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100 },
     86 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
     87 	  UMASS_QUIRK_NO_START_STOP,
     88 	  PQUIRK_NOTUR | PQUIRK_NOSENSE,
     89 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
     90 	  NULL, NULL
     91 	},
     92 
     93 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ADAPTERV2 },
     94 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
     95 	  0,
     96 	  0,
     97 	  UMATCH_VENDOR_PRODUCT,
     98 	  NULL, NULL
     99 	},
    100 
    101 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI },
    102 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
    103 	  0,
    104 	  0,
    105 	  UMATCH_VENDOR_PRODUCT,
    106 	  NULL, NULL
    107 	},
    108 
    109 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_DRIVEV2_5 },
    110 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
    111 	  0,
    112 	  0,
    113 	  UMATCH_VENDOR_PRODUCT,
    114 	  NULL, NULL
    115 	},
    116 
    117 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_IDEUSB2 },
    118 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    119 	  0,
    120 	  PQUIRK_NOMODESENSE,
    121 	  UMATCH_VENDOR_PRODUCT,
    122 	  NULL, NULL
    123 	},
    124 
    125 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE },
    126 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
    127 	  UMASS_QUIRK_NO_START_STOP,
    128 	  PQUIRK_NOTUR,
    129 	  UMATCH_VENDOR_PRODUCT,
    130 	  umass_init_insystem, NULL
    131 	},
    132 
    133 	{ { USB_VENDOR_IODATA2, USB_PRODUCT_IODATA2_USB2SC },
    134 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    135 	  0,
    136 	  0,
    137 	  UMATCH_VENDOR_PRODUCT,
    138 	  NULL, NULL
    139 	},
    140 
    141 	{ { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100 },
    142 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    143 	  0,
    144 	  PQUIRK_NOTUR,
    145 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    146 	  NULL, NULL
    147 	},
    148 
    149 	{ { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP250 },
    150 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    151 	  0,
    152 	  PQUIRK_NOTUR,
    153 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    154 	  NULL, NULL
    155 	},
    156 
    157 
    158 	{ { USB_VENDOR_MELCO, USB_PRODUCT_MELCO_DUBPXXG },
    159 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    160 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY | UMASS_QUIRK_NO_START_STOP,
    161 	  PQUIRK_NOMODESENSE,
    162 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    163 	  NULL, NULL
    164 	},
    165 
    166 	{ { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_DPCM },
    167 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
    168 	  0,
    169 	  0,
    170 	  UMATCH_VENDOR_PRODUCT,
    171 	  NULL, NULL
    172 	},
    173 
    174 	{ { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_S304 },
    175 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    176 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
    177 	  0,
    178 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    179 	  NULL, NULL
    180 	},
    181 
    182 	{ { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_X },
    183 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    184 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
    185 	  0,
    186 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    187 	  NULL, NULL
    188 	},
    189 
    190 	{ { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY },
    191 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    192 	  UMASS_QUIRK_NO_MAX_LUN,
    193 	  PQUIRK_NOMODESENSE | PQUIRK_NODOORLOCK | PQUIRK_NOBIGMODESENSE,
    194 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    195 	  NULL, NULL
    196 	},
    197 
    198 	{ { USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND3050 },
    199 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    200 	  0,
    201 	  PQUIRK_NOMODESENSE | PQUIRK_FORCELUNS,
    202 	  UMATCH_VENDOR_PRODUCT,
    203 	  NULL, NULL
    204 	},
    205 
    206 	{ { USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND5010 },
    207 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    208 	  0,
    209 	  PQUIRK_NOMODESENSE | PQUIRK_FORCELUNS,
    210 	  UMATCH_VENDOR_PRODUCT,
    211 	  NULL, NULL
    212 	},
    213 
    214 	{ { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1 },
    215 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    216 	  UMASS_QUIRK_WRONG_CSWSIG,
    217 	  0,
    218 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    219 	  NULL, NULL
    220 	},
    221 
    222 	{ { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD1II },
    223 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    224 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
    225 	  PQUIRK_NOMODESENSE,
    226 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    227 	  NULL, NULL
    228 	},
    229 
    230 	{ { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD2 },
    231 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    232 	  0,
    233 	  PQUIRK_NOMODESENSE,
    234 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    235 	  NULL, NULL
    236 	},
    237 
    238 	{ { USB_VENDOR_OTI, USB_PRODUCT_OTI_SOLID },
    239 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    240 	  0,
    241 	  PQUIRK_NOMODESENSE | PQUIRK_NOBIGMODESENSE,
    242 	  UMATCH_VENDOR_PRODUCT,
    243 	  NULL, NULL
    244 	},
    245 
    246 	{ { USB_VENDOR_PEN, USB_PRODUCT_PEN_USBDISK },
    247 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    248 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
    249 	  0,
    250 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    251 	  NULL, NULL
    252 	},
    253 
    254 	{ { USB_VENDOR_PQI, USB_PRODUCT_PQI_TRAVELFLASH },
    255 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    256 	  0,
    257 	  PQUIRK_NOMODESENSE | PQUIRK_NODOORLOCK,
    258 	  UMATCH_VENDOR_PRODUCT,
    259 	  NULL, NULL
    260 	},
    261 
    262 	{ { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R },
    263 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
    264 	  UMASS_QUIRK_WRONG_CSWTAG,
    265 	  0,
    266 	  UMATCH_VENDOR_PRODUCT,
    267 	  NULL, NULL
    268 	},
    269 
    270 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB },
    271 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
    272 	  UMASS_QUIRK_NO_START_STOP,
    273 	  PQUIRK_NOTUR,
    274 	  UMATCH_VENDOR_PRODUCT,
    275 	  umass_init_shuttle, NULL
    276 	},
    277 
    278 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ZIOMMC },
    279 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
    280 	  UMASS_QUIRK_NO_START_STOP,
    281 	  PQUIRK_NOTUR,
    282 	  UMATCH_VENDOR_PRODUCT,
    283 	  NULL, NULL
    284 	},
    285 
    286 	{ { USB_VENDOR_SIIG, USB_PRODUCT_SIIG_MULTICARDREADER },
    287 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    288 	  UMASS_QUIRK_NO_START_STOP,
    289 	  0,
    290 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    291 	  NULL,NULL
    292 	},
    293 
    294 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_DRIVEV2 },
    295 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
    296 	  0,
    297 	  0,
    298 	  UMATCH_VENDOR_PRODUCT,
    299 	  NULL, NULL
    300 	},
    301 
    302 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC },
    303 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    304 	  0,
    305 	  0,
    306 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    307 	  NULL, umass_fixup_sony
    308 	},
    309 
    310 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC },
    311 	  UMASS_WPROTO_CBI, UMASS_CPROTO_UFI,
    312 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY | UMASS_QUIRK_RS_NO_CLEAR_UA,
    313 	  PQUIRK_NOMODESENSE,
    314 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    315 	  NULL, NULL
    316 	},
    317 
    318 	{ { USB_VENDOR_TEAC, USB_PRODUCT_TEAC_FD05PUB },
    319 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    320 	  0,
    321 	  PQUIRK_NOMODESENSE,
    322 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    323 	  NULL, NULL
    324 	},
    325 
    326 	{ { USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_XXX1100 },
    327 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
    328 	  0,
    329 	  0,
    330 	  UMATCH_VENDOR_PRODUCT,
    331 	  NULL, NULL
    332 	},
    333 
    334 	{ { USB_VENDOR_YANO, USB_PRODUCT_YANO_U640MO },
    335 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
    336 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY,
    337 	  0,
    338 	  UMATCH_VENDOR_PRODUCT,
    339 	  NULL, NULL
    340 	},
    341 
    342 	{ { USB_VENDOR_YEDATA, USB_PRODUCT_YEDATA_FLASHBUSTERU },
    343 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
    344 	  UMASS_QUIRK_RS_NO_CLEAR_UA,
    345 	  PQUIRK_NOMODESENSE,
    346 	  UMATCH_VENDOR_PRODUCT_REV,
    347 	  NULL, umass_fixup_yedata
    348 	},
    349 };
    350 
    351 const struct umass_quirk *
    352 umass_lookup(u_int16_t vendor, u_int16_t product)
    353 {
    354 	return ((const struct umass_quirk *)
    355 		usb_lookup(umass_quirks, vendor, product));
    356 }
    357 
    358 Static usbd_status
    359 umass_init_insystem(struct umass_softc *sc)
    360 {
    361 	usbd_status err;
    362 
    363 	err = usbd_set_interface(sc->sc_iface, 1);
    364 	if (err) {
    365 		DPRINTF(UDMASS_USB,
    366 			("%s: could not switch to Alt Interface 1\n",
    367 			USBDEVNAME(sc->sc_dev)));
    368 		return (err);
    369 	}
    370 
    371 	return (USBD_NORMAL_COMPLETION);
    372 }
    373 
    374 Static usbd_status
    375 umass_init_shuttle(struct umass_softc *sc)
    376 {
    377 	usb_device_request_t req;
    378 	u_int8_t status[2];
    379 
    380 	/* The Linux driver does this */
    381 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
    382 	req.bRequest = 1;
    383 	USETW(req.wValue, 0);
    384 	USETW(req.wIndex, sc->sc_ifaceno);
    385 	USETW(req.wLength, sizeof(status));
    386 
    387 	return (usbd_do_request(sc->sc_udev, &req, &status));
    388 }
    389 
    390 Static void
    391 umass_fixup_sony(struct umass_softc *sc)
    392 {
    393 	usb_interface_descriptor_t *id;
    394 
    395 	id = usbd_get_interface_descriptor(sc->sc_iface);
    396 	if (id->bInterfaceSubClass == 0xff) {
    397 		sc->sc_cmd = UMASS_CPROTO_RBC;
    398 	}
    399 }
    400 
    401 Static void
    402 umass_fixup_yedata(struct umass_softc *sc)
    403 {
    404 	usb_device_descriptor_t *dd;
    405 
    406 	dd = usbd_get_device_descriptor(sc->sc_udev);
    407 
    408 	/*
    409 	 * Revisions < 1.28 do not handle the interrupt endpoint very well.
    410 	 */
    411 	if (UGETW(dd->bcdDevice) < 0x128)
    412 		sc->sc_wire = UMASS_WPROTO_CBI;
    413 	else
    414 		sc->sc_wire = UMASS_WPROTO_CBI_I;
    415 
    416 	/*
    417 	 * Revisions < 1.28 do not have the TEST UNIT READY command
    418 	 * Revisions == 1.28 have a broken TEST UNIT READY
    419 	 */
    420 	if (UGETW(dd->bcdDevice) <= 0x128)
    421 		sc->sc_busquirks |= PQUIRK_NOTUR;
    422 }
    423