Home | History | Annotate | Line # | Download | only in usb
umass_quirks.c revision 1.86
      1 /*	$NetBSD: umass_quirks.c,v 1.86 2011/08/23 16:16:43 christos Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2001, 2004 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  * This code is derived from software contributed to The NetBSD Foundation
     10  * by Charles M. Hannum.
     11  *
     12  * Redistribution and use in source and binary forms, with or without
     13  * modification, are permitted provided that the following conditions
     14  * are met:
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice, this list of conditions and the following disclaimer.
     17  * 2. Redistributions in binary form must reproduce the above copyright
     18  *    notice, this list of conditions and the following disclaimer in the
     19  *    documentation and/or other materials provided with the distribution.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     31  * POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 
     34 #include <sys/cdefs.h>
     35 __KERNEL_RCSID(0, "$NetBSD: umass_quirks.c,v 1.86 2011/08/23 16:16:43 christos Exp $");
     36 
     37 #include "opt_umass.h"
     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 
     59 /*
     60  * XXX
     61  * PLEASE NOTE that if you want quirk entries added to this table, you MUST
     62  * compile a kernel with USB_DEBUG, and submit a full log of the output from
     63  * whatever operation is "failing" with ?hcidebug=20 or higher and
     64  * umassdebug=0xffffff.  (It's usually helpful to also set MSGBUFSIZE to
     65  * something "large" unless you're using a serial console.)  Without this
     66  * information, the source of the problem cannot be properly analyzed, and
     67  * the quirk entry WILL NOT be accepted.
     68  * Also, when an entry is committed to this table, a concise but clear
     69  * description of the problem MUST accompany it.
     70  * - mycroft
     71  */
     72 Static const struct umass_quirk umass_quirks[] = {
     73 	/*
     74 	 * The following 3 In-System Design adapters use a non-standard ATA
     75 	 * over BBB protocol.  Force this protocol by quirk entries.
     76 	 */
     77 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ADAPTERV2 },
     78 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
     79 	  0,
     80 	  0,
     81 	  UMATCH_VENDOR_PRODUCT,
     82 	  NULL, NULL
     83 	},
     84 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI },
     85 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
     86 	  0,
     87 	  0,
     88 	  UMATCH_VENDOR_PRODUCT,
     89 	  NULL, NULL
     90 	},
     91 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_DRIVEV2_5 },
     92 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
     93 	  0,
     94 	  0,
     95 	  UMATCH_VENDOR_PRODUCT,
     96 	  NULL, NULL
     97 	},
     98 
     99 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE },
    100 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
    101 	  0,
    102 	  0,
    103 	  UMATCH_VENDOR_PRODUCT,
    104 	  umass_init_insystem, NULL
    105 	},
    106 
    107 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB },
    108 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
    109 	  0,
    110 	  0,
    111 	  UMATCH_VENDOR_PRODUCT,
    112 	  umass_init_shuttle, NULL
    113 	},
    114 
    115 	/*
    116 	 * These work around genuine device bugs -- returning the wrong info in
    117 	 * the CSW block.
    118 	 */
    119 	{ { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1 },
    120 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    121 	  UMASS_QUIRK_WRONG_CSWSIG,
    122 	  0,
    123 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    124 	  NULL, NULL
    125 	},
    126 	{ { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R },
    127 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    128 	  UMASS_QUIRK_WRONG_CSWTAG,
    129 	  0,
    130 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    131 	  NULL, NULL
    132 	},
    133 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ORCA },
    134 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    135 	  UMASS_QUIRK_WRONG_CSWTAG,
    136 	  0,
    137 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    138 	  NULL, NULL
    139 	},
    140 
    141 	/*
    142 	 * Some Sony cameras advertise a subclass code of 0xff, so we force it
    143 	 * to the correct value iff necessary.
    144 	 */
    145 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_DSC },
    146 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    147 	  UMASS_QUIRK_RBC_PAD_TO_12,
    148 	  0,
    149 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    150 	  NULL, umass_fixup_sony
    151 	},
    152 
    153 	/*
    154 	 * Stupid device reports itself as SFF-8070, but actually returns a UFI
    155 	 * interrupt descriptor.  - mycroft, 2004/06/28
    156 	 */
    157 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_40_MS },
    158 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
    159 	  0,
    160 	  0,
    161 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    162 	  NULL, NULL
    163 	},
    164 
    165 	/*
    166 	 * The SONY Portable GPS strage device almost hangs up when request
    167 	 * UR_BBB_GET_MAX_LUN - disable the query logic.
    168 	 */
    169 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_GPS_CS1 },
    170 	  UMASS_WPROTO_BBB, UMASS_CPROTO_UNSPEC,
    171 	  UMASS_QUIRK_NOGETMAXLUN,
    172 	  0,
    173 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    174 	  NULL, NULL
    175 	},
    176 
    177 	/*
    178 	 * The DiskOnKey does not reject commands it doesn't recognize in a
    179 	 * sane way -- rather than STALLing the bulk pipe, it continually NAKs
    180 	 * until we time out.  To prevent being screwed by this, for now we
    181 	 * disable 10-byte MODE SENSE the klugy way.  - mycroft, 2003/10/16
    182 	 */
    183 	{ { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY },
    184 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    185 	  0,
    186 	  PQUIRK_NOBIGMODESENSE,
    187 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    188 	  NULL, NULL
    189 	},
    190 	{ { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY2 },
    191 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    192 	  0,
    193 	  PQUIRK_NOBIGMODESENSE,
    194 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    195 	  NULL, NULL
    196 	},
    197 	{ { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY3 },
    198 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    199 	  0,
    200 	  PQUIRK_NOBIGMODESENSE,
    201 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
    202 	  NULL, NULL
    203 	},
    204 	/* Some Sigmatel-based devices don't like all SCSI commands */
    205 	{ { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_MUSICSTICK },
    206 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    207 	  0,
    208 	  PQUIRK_NODOORLOCK | PQUIRK_NOSYNCCACHE,
    209 	  UMATCH_VENDOR_PRODUCT,
    210 	  NULL, NULL
    211 	},
    212 	{ { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_I_BEAD100 },
    213 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    214 	  0,
    215 	  PQUIRK_NODOORLOCK | PQUIRK_NOSYNCCACHE,
    216 	  UMATCH_VENDOR_PRODUCT,
    217 	  NULL, NULL
    218 	},
    219 	{ { USB_VENDOR_SIGMATEL, USB_PRODUCT_SIGMATEL_I_BEAD150 },
    220 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    221 	  0,
    222 	  PQUIRK_NODOORLOCK | PQUIRK_NOSYNCCACHE,
    223 	  UMATCH_VENDOR_PRODUCT,
    224 	  NULL, NULL
    225 	},
    226 	{ { USB_VENDOR_PHILIPS, USB_PRODUCT_PHILIPS_SA235 },
    227 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    228 	  0,
    229 	  PQUIRK_NODOORLOCK | PQUIRK_NOSYNCCACHE,
    230 	  UMATCH_VENDOR_PRODUCT,
    231 	  NULL, NULL
    232 	},
    233 	/* Creative Nomad MuVo, NetBSD PR 30389, FreeBSD PR 53094 */
    234 	{ { USB_VENDOR_CREATIVE, USB_PRODUCT_CREATIVE_NOMAD },
    235 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    236 	  0,
    237 	  PQUIRK_NODOORLOCK | PQUIRK_NOSYNCCACHE,
    238 	  UMATCH_VENDOR_PRODUCT,
    239 	  NULL, NULL
    240 	},
    241 
    242 	/* iRiver iFP-[135]xx players fail on PREVENT/ALLOW, see PR 25440 */
    243 	{ { USB_VENDOR_IRIVER, USB_PRODUCT_IRIVER_IFP_1XX },
    244 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    245 	  0,
    246 	  PQUIRK_NODOORLOCK,
    247 	  UMATCH_VENDOR_PRODUCT,
    248 	  NULL, NULL
    249 	},
    250 	{ { USB_VENDOR_IRIVER, USB_PRODUCT_IRIVER_IFP_3XX },
    251 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    252 	  0,
    253 	  PQUIRK_NODOORLOCK,
    254 	  UMATCH_VENDOR_PRODUCT,
    255 	  NULL, NULL
    256 	},
    257 	{ { USB_VENDOR_IRIVER, USB_PRODUCT_IRIVER_IFP_5XX },
    258 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    259 	  0,
    260 	  PQUIRK_NODOORLOCK,
    261 	  UMATCH_VENDOR_PRODUCT,
    262 	  NULL, NULL
    263 	},
    264 
    265 	/* Meizu M6 doesn't like synchronize-cache, see PR 40442 */
    266 	{ { USB_VENDOR_MEIZU, USB_PRODUCT_MEIZU_M6_SL },
    267 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    268 	  0,
    269 	  PQUIRK_NOSYNCCACHE,
    270 	  UMATCH_VENDOR_PRODUCT,
    271 	  NULL, NULL
    272 	},
    273 
    274 	/* Kingston USB pendrives don't like being told to lock the door */
    275 	{ { USB_VENDOR_KINGSTON, USB_PRODUCT_KINGSTON_DTMINI10 },
    276 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    277 	  0,
    278 	  PQUIRK_NODOORLOCK,
    279 	  UMATCH_VENDOR_PRODUCT,
    280 	  NULL, NULL
    281 	},
    282 
    283 	/* HP USB pendrives don't like being told to lock the door */
    284 	{ { USB_VENDOR_HP, USB_PRODUCT_HP_V125W },
    285 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    286 	  0,
    287 	  PQUIRK_NODOORLOCK,
    288 	  UMATCH_VENDOR_PRODUCT,
    289 	  NULL, NULL
    290 	},
    291 
    292 	/* Devices with bad residue. */
    293 	{ { USB_VENDOR_SUPERTOP, USB_PRODUCT_SUPERTOP_IDEBRIDGE },
    294 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
    295 	  UMASS_QUIRK_IGNORE_RESIDUE,
    296 	  0,
    297 	  UMATCH_VENDOR_PRODUCT,
    298 	  NULL, NULL
    299 	},
    300 };
    301 
    302 const struct umass_quirk *
    303 umass_lookup(u_int16_t vendor, u_int16_t product)
    304 {
    305 	return ((const struct umass_quirk *)
    306 		usb_lookup(umass_quirks, vendor, product));
    307 }
    308 
    309 Static usbd_status
    310 umass_init_insystem(struct umass_softc *sc)
    311 {
    312 	usbd_status err;
    313 
    314 	err = usbd_set_interface(sc->sc_iface, 1);
    315 	if (err) {
    316 		DPRINTF(UDMASS_USB,
    317 			("%s: could not switch to Alt Interface 1\n",
    318 			device_xname(sc->sc_dev)));
    319 		return (err);
    320 	}
    321 
    322 	return (USBD_NORMAL_COMPLETION);
    323 }
    324 
    325 Static usbd_status
    326 umass_init_shuttle(struct umass_softc *sc)
    327 {
    328 	usb_device_request_t req;
    329 	u_int8_t status[2];
    330 
    331 	/* The Linux driver does this */
    332 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
    333 	req.bRequest = 1;
    334 	USETW(req.wValue, 0);
    335 	USETW(req.wIndex, sc->sc_ifaceno);
    336 	USETW(req.wLength, sizeof(status));
    337 
    338 	return (usbd_do_request(sc->sc_udev, &req, &status));
    339 }
    340 
    341 Static void
    342 umass_fixup_sony(struct umass_softc *sc)
    343 {
    344 	usb_interface_descriptor_t *id;
    345 
    346 	id = usbd_get_interface_descriptor(sc->sc_iface);
    347 	if (id->bInterfaceSubClass == 0xff)
    348 		sc->sc_cmd = UMASS_CPROTO_RBC;
    349 }
    350