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