xref: /freebsd-11-stable/sys/dev/usb/quirk/usb_quirk.c (revision 0da0fedafa6a48bbc18efcad1258aa67cb900818)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
4  * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
5  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/stdint.h>
30 #include <sys/stddef.h>
31 #include <sys/param.h>
32 #include <sys/queue.h>
33 #include <sys/types.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/bus.h>
37 #include <sys/module.h>
38 #include <sys/lock.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/sysctl.h>
42 #include <sys/sx.h>
43 #include <sys/unistd.h>
44 #include <sys/callout.h>
45 #include <sys/malloc.h>
46 #include <sys/priv.h>
47 
48 #include <dev/usb/usb.h>
49 #include <dev/usb/usb_ioctl.h>
50 #include <dev/usb/usbdi.h>
51 #include "usbdevs.h"
52 
53 #define	USB_DEBUG_VAR usb_debug
54 #include <dev/usb/usb_debug.h>
55 #include <dev/usb/usb_dynamic.h>
56 
57 #include <dev/usb/quirk/usb_quirk.h>
58 
59 MODULE_DEPEND(usb_quirk, usb, 1, 1, 1);
60 MODULE_VERSION(usb_quirk, 1);
61 
62 #define	USB_DEV_QUIRKS_MAX 384
63 #define	USB_SUB_QUIRKS_MAX 8
64 #define	USB_QUIRK_ENVROOT "hw.usb.quirk."
65 
66 struct usb_quirk_entry {
67 	uint16_t vid;
68 	uint16_t pid;
69 	uint16_t lo_rev;
70 	uint16_t hi_rev;
71 	uint16_t quirks[USB_SUB_QUIRKS_MAX];
72 };
73 
74 static struct mtx usb_quirk_mtx;
75 
76 #define	USB_QUIRK_VP(v,p,l,h,...) \
77   { .vid = (v), .pid = (p), .lo_rev = (l), .hi_rev = (h), \
78     .quirks = { __VA_ARGS__ } }
79 #define	USB_QUIRK(v,p,l,h,...) \
80   USB_QUIRK_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, l, h, __VA_ARGS__)
81 
82 static struct usb_quirk_entry usb_quirks[USB_DEV_QUIRKS_MAX] = {
83 	USB_QUIRK(ASUS, LCM, 0x0000, 0xffff, UQ_HID_IGNORE),
84 	USB_QUIRK(INSIDEOUT, EDGEPORT4, 0x094, 0x094, UQ_SWAP_UNICODE),
85 	USB_QUIRK(DALLAS, J6502, 0x0a2, 0x0a2, UQ_BAD_ADC),
86 	USB_QUIRK(DALLAS, J6502, 0x0a2, 0x0a2, UQ_AU_NO_XU),
87 	USB_QUIRK(ALTEC, ADA70, 0x103, 0x103, UQ_BAD_ADC),
88 	USB_QUIRK(ALTEC, ASC495, 0x000, 0x000, UQ_BAD_AUDIO),
89 	USB_QUIRK(QTRONIX, 980N, 0x110, 0x110, UQ_SPUR_BUT_UP),
90 	USB_QUIRK(ALCOR2, KBD_HUB, 0x001, 0x001, UQ_SPUR_BUT_UP),
91 	USB_QUIRK(MCT, HUB0100, 0x102, 0x102, UQ_BUS_POWERED),
92 	USB_QUIRK(MCT, USB232, 0x102, 0x102, UQ_BUS_POWERED),
93 	USB_QUIRK(TI, UTUSB41, 0x110, 0x110, UQ_POWER_CLAIM),
94 	USB_QUIRK(TELEX, MIC1, 0x009, 0x009, UQ_AU_NO_FRAC),
95 	USB_QUIRK(SILICONPORTALS, YAPPHONE, 0x100, 0x100, UQ_AU_INP_ASYNC),
96 	USB_QUIRK(LOGITECH, UN53B, 0x0000, 0xffff, UQ_NO_STRINGS),
97 	USB_QUIRK(LOGITECH, G510S, 0x0000, 0xFFFF, UQ_KBD_BOOTPROTO),
98 	USB_QUIRK(REALTEK, RTL8196EU, 0x0000, 0xffff, UQ_CFG_INDEX_1),
99 	USB_QUIRK(REALTEK, RTL8153, 0x0000, 0xffff, UQ_CFG_INDEX_1),
100 	USB_QUIRK(ELSA, MODEM1, 0x0000, 0xffff, UQ_CFG_INDEX_1),
101 	USB_QUIRK(PLANEX2, MZKUE150N, 0x0000, 0xffff, UQ_CFG_INDEX_1),
102 	USB_QUIRK(CISCOLINKSYS, USB3GIGV1, 0x0000, 0xffff, UQ_CFG_INDEX_1),
103 	/* Quirks for printer devices */
104 	USB_QUIRK(HP, 895C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
105 	USB_QUIRK(HP, 880C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
106 	USB_QUIRK(HP, 815C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
107 	USB_QUIRK(HP, 810C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
108 	USB_QUIRK(HP, 830C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
109 	USB_QUIRK(HP, 1220C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
110 	USB_QUIRK(XEROX, WCM15, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
111 	/* Devices which should be ignored by uhid */
112 	USB_QUIRK(APC, UPS, 0x0000, 0xffff, UQ_HID_IGNORE),
113 	USB_QUIRK(BELKIN, F6C550AVR, 0x0000, 0xffff, UQ_HID_IGNORE),
114 	USB_QUIRK(CYBERPOWER, 1500CAVRLCD, 0x0000, 0xffff, UQ_HID_IGNORE),
115 	USB_QUIRK(CYPRESS, SILVERSHIELD, 0x0000, 0xffff, UQ_HID_IGNORE),
116 	USB_QUIRK(DELORME, EARTHMATE, 0x0000, 0xffff, UQ_HID_IGNORE),
117 	USB_QUIRK(DREAMLINK, DL100B, 0x0000, 0xffff, UQ_HID_IGNORE),
118 	USB_QUIRK(ITUNERNET, USBLCD2X20, 0x0000, 0xffff, UQ_HID_IGNORE),
119 	USB_QUIRK(ITUNERNET, USBLCD4X20, 0x0000, 0xffff, UQ_HID_IGNORE),
120 	USB_QUIRK(LIEBERT, POWERSURE_PXT, 0x0000, 0xffff, UQ_HID_IGNORE),
121 	USB_QUIRK(LIEBERT2, PSI1000, 0x0000, 0xffff, UQ_HID_IGNORE),
122 	USB_QUIRK(MGE, UPS1, 0x0000, 0xffff, UQ_HID_IGNORE),
123 	USB_QUIRK(MGE, UPS2, 0x0000, 0xffff, UQ_HID_IGNORE),
124 	USB_QUIRK(APPLE, IPHONE, 0x0000, 0xffff, UQ_HID_IGNORE),
125 	USB_QUIRK(APPLE, IPHONE_3G, 0x0000, 0xffff, UQ_HID_IGNORE),
126 	USB_QUIRK(MEGATEC, UPS, 0x0000, 0xffff, UQ_HID_IGNORE),
127 	/* Devices which should be ignored by both ukbd and uhid */
128 	USB_QUIRK(CYPRESS, WISPY1A, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
129 	USB_QUIRK(METAGEEK, WISPY1B, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
130 	USB_QUIRK(METAGEEK, WISPY24X, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
131 	USB_QUIRK(METAGEEK2, WISPYDBX, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
132 	USB_QUIRK(TENX, UAUDIO0, 0x0101, 0x0101, UQ_AUDIO_SWAP_LR),
133 	/* MS keyboards do weird things */
134 	USB_QUIRK(MICROSOFT, NATURAL4000, 0x0000, 0xFFFF, UQ_KBD_BOOTPROTO),
135 	USB_QUIRK(MICROSOFT, WLINTELLIMOUSE, 0x0000, 0xffff, UQ_MS_LEADING_BYTE),
136 	/* Quirk for Corsair Vengeance K60 keyboard */
137 	USB_QUIRK(CORSAIR, K60, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
138 	/* Quirk for Corsair Gaming K68 keyboard */
139 	USB_QUIRK(CORSAIR, K68, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
140 	/* Quirk for Corsair Vengeance K70 keyboard */
141 	USB_QUIRK(CORSAIR, K70, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
142 	/* Quirk for Corsair K70 RGB keyboard */
143 	USB_QUIRK(CORSAIR, K70_RGB, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
144 	/* Quirk for Corsair STRAFE Gaming keyboard */
145 	USB_QUIRK(CORSAIR, STRAFE, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
146 	USB_QUIRK(CORSAIR, STRAFE2, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
147 	/* umodem(4) device quirks */
148 	USB_QUIRK(METRICOM, RICOCHET_GS, 0x100, 0x100, UQ_ASSUME_CM_OVER_DATA),
149 	USB_QUIRK(SANYO, SCP4900, 0x000, 0x000, UQ_ASSUME_CM_OVER_DATA),
150 	USB_QUIRK(MOTOROLA2, T720C, 0x001, 0x001, UQ_ASSUME_CM_OVER_DATA),
151 	USB_QUIRK(EICON, DIVA852, 0x100, 0x100, UQ_ASSUME_CM_OVER_DATA),
152 	USB_QUIRK(SIEMENS2, ES75, 0x000, 0x000, UQ_ASSUME_CM_OVER_DATA),
153 	USB_QUIRK(QUALCOMM, CDMA_MSM, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
154 	USB_QUIRK(QUALCOMM2, CDMA_MSM, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
155 	USB_QUIRK(CURITEL, UM150, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
156 	USB_QUIRK(CURITEL, UM175, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
157 	USB_QUIRK(VERTEX, VW110L, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
158 
159 	/* USB Mass Storage Class Quirks */
160 	USB_QUIRK_VP(USB_VENDOR_ASAHIOPTICAL, 0, UQ_MSC_NO_RS_CLEAR_UA,
161 	    UQ_MATCH_VENDOR_ONLY),
162 	USB_QUIRK(ADDON, ATTACHE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
163 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
164 	USB_QUIRK(ADDON, A256MB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
165 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
166 	USB_QUIRK(ADDON, DISKPRO512, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
167 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
168 	USB_QUIRK(ADDONICS2, CABLE_205, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
169 	    UQ_MSC_FORCE_PROTO_SCSI),
170 	USB_QUIRK(AIPTEK, POCKETCAM3M, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
171 	    UQ_MSC_FORCE_PROTO_SCSI),
172 	USB_QUIRK(ALCOR, UMCR_9361, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
173 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
174 	USB_QUIRK(ALCOR, TRANSCEND, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN,
175 	    UQ_MSC_NO_SYNC_CACHE, UQ_MSC_NO_TEST_UNIT_READY),
176 	USB_QUIRK(APACER, HT202, 0x0000, 0xffff, UQ_MSC_NO_TEST_UNIT_READY,
177 	    UQ_MSC_NO_SYNC_CACHE),
178 	USB_QUIRK(ASAHIOPTICAL, OPTIO230, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
179 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
180 	USB_QUIRK(ASAHIOPTICAL, OPTIO330, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
181 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
182 	USB_QUIRK(ATP, EUSB, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
183 	USB_QUIRK(BELKIN, USB2SCSI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
184 	    UQ_MSC_FORCE_PROTO_SCSI),
185 	USB_QUIRK(CASIO, QV_DIGICAM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
186 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
187 	USB_QUIRK(CCYU, ED1064, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
188 	    UQ_MSC_FORCE_PROTO_SCSI),
189 	USB_QUIRK(CENTURY, EX35QUAT, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
190 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
191 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
192 	USB_QUIRK(CYPRESS, XX6830XX, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN,
193 	    UQ_MSC_NO_SYNC_CACHE),
194 	USB_QUIRK(EMTEC, DANEELEC4GB, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
195 	USB_QUIRK(DESKNOTE, UCR_61S2B, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
196 	    UQ_MSC_FORCE_PROTO_SCSI),
197 	USB_QUIRK(DMI, CFSM_RW, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI,
198 	    UQ_MSC_NO_GETMAXLUN),
199 	USB_QUIRK(EMTEC, RUF2PS, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
200 	USB_QUIRK(EPSON, STYLUS_875DC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
201 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
202 	USB_QUIRK(EPSON, STYLUS_895, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
203 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
204 	USB_QUIRK(FEIYA, 5IN1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
205 	    UQ_MSC_FORCE_PROTO_SCSI),
206 	USB_QUIRK(FEIYA, ELANGO, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
207 	USB_QUIRK(FREECOM, DVD, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
208 	USB_QUIRK(FUJIPHOTO, MASS0100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
209 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_NO_SYNC_CACHE),
210 	USB_QUIRK(GARMIN, DAKOTA20, 0x0000, 0xffff, UQ_MSC_NO_INQUIRY),
211 	USB_QUIRK(GARMIN, FORERUNNER230, 0x0000, 0xffff, UQ_MSC_NO_INQUIRY),
212 	USB_QUIRK(GARMIN, GPSMAP62S, 0x0000, 0xffff, UQ_MSC_NO_INQUIRY),
213 	USB_QUIRK(GENESYS, GL641USB2IDE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
214 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
215 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE, UQ_MSC_NO_SYNC_CACHE),
216 	USB_QUIRK(GENESYS, GL641USB2IDE_2, 0x0000, 0xffff,
217 	    UQ_MSC_FORCE_WIRE_BBB, UQ_MSC_FORCE_PROTO_ATAPI,
218 	    UQ_MSC_FORCE_SHORT_INQ, UQ_MSC_NO_START_STOP,
219 	    UQ_MSC_IGNORE_RESIDUE),
220 	USB_QUIRK(GENESYS, GL641USB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
221 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
222 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
223 	USB_QUIRK(GENESYS, GL641USB_2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
224 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_WRONG_CSWSIG),
225 	USB_QUIRK(HAGIWARA, FG, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
226 	    UQ_MSC_FORCE_PROTO_SCSI),
227 	USB_QUIRK(HAGIWARA, FGSM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
228 	    UQ_MSC_FORCE_PROTO_SCSI),
229 	USB_QUIRK(HITACHI, DVDCAM_DZ_MV100A, 0x0000, 0xffff,
230 	    UQ_MSC_FORCE_WIRE_CBI, UQ_MSC_FORCE_PROTO_SCSI,
231 	    UQ_MSC_NO_GETMAXLUN),
232 	USB_QUIRK(HITACHI, DVDCAM_USB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
233 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
234 	USB_QUIRK(HP, CDW4E, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_ATAPI),
235 	USB_QUIRK(HP, CDW8200, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
236 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_TEST_UNIT_READY,
237 	    UQ_MSC_NO_START_STOP),
238 	USB_QUIRK(IMAGINATION, DBX1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
239 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_WRONG_CSWSIG),
240 	USB_QUIRK(INSYSTEM, USBCABLE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
241 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_TEST_UNIT_READY,
242 	    UQ_MSC_NO_START_STOP, UQ_MSC_ALT_IFACE_1),
243 	USB_QUIRK(INSYSTEM, ATAPI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
244 	    UQ_MSC_FORCE_PROTO_RBC),
245 	USB_QUIRK(INSYSTEM, STORAGE_V2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
246 	    UQ_MSC_FORCE_PROTO_RBC),
247 	USB_QUIRK(INTENSO, MEMORY_BOX, 0x0000, 0xffff, UQ_MSC_NO_INQUIRY),
248 	USB_QUIRK(IODATA, IU_CD2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
249 	    UQ_MSC_FORCE_PROTO_SCSI),
250 	USB_QUIRK(IODATA, DVR_UEH8, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
251 	    UQ_MSC_FORCE_PROTO_SCSI),
252 	USB_QUIRK(IOMEGA, ZIP100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
253 	    UQ_MSC_FORCE_PROTO_SCSI,
254 	    UQ_MSC_NO_TEST_UNIT_READY), /* XXX ZIP drives can also use ATAPI */
255 	USB_QUIRK(JMICRON, JMS566, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN),
256 	USB_QUIRK(JMICRON, JMS567, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN),
257 	USB_QUIRK(JMICRON, JM20337, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
258 	    UQ_MSC_FORCE_PROTO_SCSI,
259 	    UQ_MSC_NO_SYNC_CACHE),
260 	USB_QUIRK(KINGSTON, HYPERX3_0, 0x0000, 0xffff, UQ_MSC_NO_INQUIRY),
261 	USB_QUIRK(KYOCERA, FINECAM_L3, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
262 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
263 	USB_QUIRK(KYOCERA, FINECAM_S3X, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
264 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
265 	USB_QUIRK(KYOCERA, FINECAM_S4, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
266 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
267 	USB_QUIRK(KYOCERA, FINECAM_S5, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
268 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
269 	USB_QUIRK(LACIE, HD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
270 	    UQ_MSC_FORCE_PROTO_RBC),
271 	USB_QUIRK(LEXAR, CF_READER, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
272 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
273 	USB_QUIRK(LEXAR, JUMPSHOT, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
274 	USB_QUIRK(LEXAR, JUMPDRIVE, 0x0000, 0xffff, UQ_MSC_NO_INQUIRY),
275 	USB_QUIRK(LOGITEC, LDR_H443SU2, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
276 	USB_QUIRK(LOGITEC, LDR_H443U2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
277 	    UQ_MSC_FORCE_PROTO_SCSI,),
278 	USB_QUIRK(MELCO, DUBPXXG, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
279 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
280 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
281 	USB_QUIRK(MICROTECH, DPCM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
282 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_TEST_UNIT_READY,
283 	    UQ_MSC_NO_START_STOP),
284 	USB_QUIRK(MICRON, REALSSD, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
285 	USB_QUIRK(MICROTECH, SCSIDB25, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
286 	    UQ_MSC_FORCE_PROTO_SCSI),
287 	USB_QUIRK(MICROTECH, SCSIHD50, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
288 	    UQ_MSC_FORCE_PROTO_SCSI),
289 	USB_QUIRK(MINOLTA, E223, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
290 	USB_QUIRK(MINOLTA, F300, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
291 	    UQ_MSC_FORCE_PROTO_SCSI),
292 	USB_QUIRK(MITSUMI, CDRRW, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI |
293 	    UQ_MSC_FORCE_PROTO_ATAPI),
294 	USB_QUIRK(MOTOROLA2, E398, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
295 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
296 	    UQ_MSC_NO_INQUIRY_EVPD, UQ_MSC_NO_GETMAXLUN),
297 	USB_QUIRK_VP(USB_VENDOR_MPMAN, 0, UQ_MSC_NO_SYNC_CACHE,
298 	    UQ_MATCH_VENDOR_ONLY),
299 	USB_QUIRK(MSYSTEMS, DISKONKEY, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
300 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE, UQ_MSC_NO_GETMAXLUN,
301 	    UQ_MSC_NO_RS_CLEAR_UA),
302 	USB_QUIRK(MSYSTEMS, DISKONKEY2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
303 	    UQ_MSC_FORCE_PROTO_ATAPI),
304 	USB_QUIRK(MYSON, HEDEN, 0x0000, 0xffff, UQ_MSC_IGNORE_RESIDUE,
305 	    UQ_MSC_NO_SYNC_CACHE),
306 	USB_QUIRK(NEODIO, ND3260, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
307 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ),
308 	USB_QUIRK(NETAC, CF_CARD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
309 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
310 	USB_QUIRK(NETAC, ONLYDISK, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
311 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
312 	USB_QUIRK(NETCHIP, CLIK_40, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_ATAPI,
313 	    UQ_MSC_NO_INQUIRY),
314 	USB_QUIRK(NETCHIP, POCKETBOOK, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
315 	USB_QUIRK(NIKON, D300, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
316 	    UQ_MSC_FORCE_PROTO_SCSI),
317 	USB_QUIRK(OLYMPUS, C1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
318 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_WRONG_CSWSIG),
319 	USB_QUIRK(OLYMPUS, C700, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN),
320 	USB_QUIRK(ONSPEC, SDS_HOTFIND_D, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
321 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN, UQ_MSC_NO_SYNC_CACHE),
322 	USB_QUIRK(ONSPEC, CFMS_RW, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
323 	USB_QUIRK(ONSPEC, CFSM_COMBO, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
324 	USB_QUIRK(ONSPEC, CFSM_READER, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
325 	USB_QUIRK(ONSPEC, CFSM_READER2, 0x0000, 0xffff,
326 	    UQ_MSC_FORCE_PROTO_SCSI),
327 	USB_QUIRK(ONSPEC, MDCFE_B_CF_READER, 0x0000, 0xffff,
328 	    UQ_MSC_FORCE_PROTO_SCSI),
329 	USB_QUIRK(ONSPEC, MDSM_B_READER, 0x0000, 0xffff,
330 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
331 	USB_QUIRK(ONSPEC, READER, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
332 	USB_QUIRK(ONSPEC, UCF100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
333 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY, UQ_MSC_NO_GETMAXLUN),
334 	USB_QUIRK(ONSPEC2, IMAGEMATE_SDDR55, 0x0000, 0xffff,
335 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
336 	USB_QUIRK(PANASONIC, KXL840AN, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
337 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_GETMAXLUN),
338 	USB_QUIRK(PANASONIC, KXLCB20AN, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
339 	    UQ_MSC_FORCE_PROTO_SCSI),
340 	USB_QUIRK(PANASONIC, KXLCB35AN, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
341 	    UQ_MSC_FORCE_PROTO_SCSI),
342 	USB_QUIRK(PANASONIC, LS120CAM, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_UFI),
343 	USB_QUIRK(PLEXTOR, 40_12_40U, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
344 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_TEST_UNIT_READY),
345 	USB_QUIRK(PNY, ATTACHE2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
346 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE,
347 	    UQ_MSC_NO_START_STOP),
348 	USB_QUIRK(PROLIFIC, PL2506, 0x0000, 0xffff,
349 	    UQ_MSC_NO_SYNC_CACHE, UQ_MSC_NO_PREVENT_ALLOW),
350 	USB_QUIRK_VP(USB_VENDOR_SAMSUNG_TECHWIN,
351 	    USB_PRODUCT_SAMSUNG_TECHWIN_DIGIMAX_410, UQ_MSC_FORCE_WIRE_BBB,
352 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
353 	USB_QUIRK(SANDISK, SDDR05A, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
354 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_READ_CAP_OFFBY1,
355 	    UQ_MSC_NO_GETMAXLUN),
356 	USB_QUIRK(SANDISK, SDDR09, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI,
357 	    UQ_MSC_READ_CAP_OFFBY1, UQ_MSC_NO_GETMAXLUN),
358 	USB_QUIRK(SANDISK, SDDR12, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
359 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_READ_CAP_OFFBY1,
360 	    UQ_MSC_NO_GETMAXLUN),
361 	USB_QUIRK(SANDISK, SDCZ2_128, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
362 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE,
363 	    UQ_MSC_NO_SYNC_CACHE),
364 	USB_QUIRK(SANDISK, SDCZ2_256, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
365 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
366 	USB_QUIRK(SANDISK, SDCZ4_128, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
367 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
368 	USB_QUIRK(SANDISK, SDCZ4_256, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
369 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
370 	USB_QUIRK(SANDISK, SDCZ48_32, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE,
371 	    UQ_MSC_NO_TEST_UNIT_READY),
372 	USB_QUIRK(SANDISK, SDDR31, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
373 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_READ_CAP_OFFBY1),
374 	USB_QUIRK(SANDISK, IMAGEMATE_SDDR289, 0x0000, 0xffff,
375 	    UQ_MSC_NO_SYNC_CACHE, UQ_MSC_NO_GETMAXLUN),
376 	USB_QUIRK(SCANLOGIC, SL11R, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
377 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
378 	USB_QUIRK(SHUTTLE, EUSB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
379 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_TEST_UNIT_READY,
380 	    UQ_MSC_NO_START_STOP, UQ_MSC_SHUTTLE_INIT),
381 	USB_QUIRK(SHUTTLE, CDRW, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
382 	    UQ_MSC_FORCE_PROTO_ATAPI),
383 	USB_QUIRK(SHUTTLE, CF, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
384 	    UQ_MSC_FORCE_PROTO_ATAPI),
385 	USB_QUIRK(SHUTTLE, EUSBATAPI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
386 	    UQ_MSC_FORCE_PROTO_ATAPI),
387 	USB_QUIRK(SHUTTLE, EUSBCFSM, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
388 	USB_QUIRK(SHUTTLE, EUSCSI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
389 	    UQ_MSC_FORCE_PROTO_SCSI),
390 	USB_QUIRK(SHUTTLE, HIFD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
391 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
392 	USB_QUIRK(SHUTTLE, SDDR09, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI,
393 	    UQ_MSC_NO_GETMAXLUN),
394 	USB_QUIRK(SHUTTLE, ZIOMMC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
395 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
396 	USB_QUIRK(SIGMATEL, I_BEAD100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
397 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_SHUTTLE_INIT),
398 	USB_QUIRK(SIIG, WINTERREADER, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
399 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
400 	USB_QUIRK(SKANHEX, MD_7425, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
401 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
402 	USB_QUIRK(SKANHEX, SX_520Z, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
403 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
404 	USB_QUIRK(SONY, HANDYCAM, 0x0500, 0x0500, UQ_MSC_FORCE_WIRE_CBI,
405 	    UQ_MSC_FORCE_PROTO_RBC, UQ_MSC_RBC_PAD_TO_12),
406 	USB_QUIRK(SONY, CLIE_40_MS, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
407 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
408 	USB_QUIRK(SONY, DSC, 0x0500, 0x0500, UQ_MSC_FORCE_WIRE_CBI,
409 	    UQ_MSC_FORCE_PROTO_RBC, UQ_MSC_RBC_PAD_TO_12),
410 	USB_QUIRK(SONY, DSC, 0x0600, 0x0600, UQ_MSC_FORCE_WIRE_CBI,
411 	    UQ_MSC_FORCE_PROTO_RBC, UQ_MSC_RBC_PAD_TO_12),
412 	USB_QUIRK(SONY, DSC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
413 	    UQ_MSC_FORCE_PROTO_RBC),
414 	USB_QUIRK(SONY, HANDYCAM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
415 	    UQ_MSC_FORCE_PROTO_RBC),
416 	USB_QUIRK(SONY, MSC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
417 	    UQ_MSC_FORCE_PROTO_RBC),
418 	USB_QUIRK(SONY, MS_MSC_U03, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
419 	    UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_GETMAXLUN),
420 	USB_QUIRK(SONY, MS_NW_MS7, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
421 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
422 	USB_QUIRK(SONY, MS_PEG_N760C, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
423 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
424 	USB_QUIRK(SONY, MSACUS1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
425 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
426 	USB_QUIRK(SONY, PORTABLE_HDD_V2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
427 	    UQ_MSC_FORCE_PROTO_SCSI),
428 	USB_QUIRK(STMICRO, ST72682, 0x0000, 0xffff, UQ_MSC_NO_PREVENT_ALLOW),
429 	USB_QUIRK(SUPERTOP, IDE, 0x0000, 0xffff, UQ_MSC_IGNORE_RESIDUE,
430 	    UQ_MSC_NO_SYNC_CACHE),
431 	USB_QUIRK(SUPERTOP, FLASHDRIVE, 0x0000, 0xffff, UQ_MSC_NO_TEST_UNIT_READY,
432 	    UQ_MSC_NO_SYNC_CACHE),
433 	USB_QUIRK(TAUGA, CAMERAMATE, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
434 	USB_QUIRK(TEAC, FD05PUB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
435 	    UQ_MSC_FORCE_PROTO_UFI),
436 	USB_QUIRK(TECLAST, TLC300, 0x0000, 0xffff, UQ_MSC_NO_TEST_UNIT_READY,
437 	    UQ_MSC_NO_SYNC_CACHE),
438 	USB_QUIRK(TREK, MEMKEY, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
439 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
440 	USB_QUIRK(TREK, THUMBDRIVE_8MB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
441 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_IGNORE_RESIDUE),
442 	USB_QUIRK(TRUMPION, C3310, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
443 	    UQ_MSC_FORCE_PROTO_UFI),
444 	USB_QUIRK(TRUMPION, MP3, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_RBC),
445 	USB_QUIRK(TRUMPION, T33520, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
446 	USB_QUIRK(TWINMOS, MDIV, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
447 	    UQ_MSC_FORCE_PROTO_SCSI),
448 	USB_QUIRK(VIA, USB2IDEBRIDGE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
449 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_SYNC_CACHE),
450 	USB_QUIRK(VIVITAR, 35XX, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
451 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
452 	USB_QUIRK(WESTERN, COMBO, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
453 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
454 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
455 	USB_QUIRK(WESTERN, EXTHDD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
456 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
457 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
458 	USB_QUIRK(WESTERN, MYBOOK, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
459 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY_EVPD,
460 	    UQ_MSC_NO_SYNC_CACHE),
461 	USB_QUIRK(WESTERN, MYPASSPORT_00, 0x0000, 0xffff, UQ_MSC_FORCE_SHORT_INQ),
462 	USB_QUIRK(WESTERN, MYPASSPORT_01, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
463 	USB_QUIRK(WESTERN, MYPASSPORT_02, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
464 	USB_QUIRK(WESTERN, MYPASSPORT_03, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
465 	USB_QUIRK(WESTERN, MYPASSPORT_04, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
466 	USB_QUIRK(WESTERN, MYPASSPORT_05, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
467 	USB_QUIRK(WESTERN, MYPASSPORT_06, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
468 	USB_QUIRK(WESTERN, MYPASSPORT_07, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
469 	USB_QUIRK(WESTERN, MYPASSPORT_08, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
470 	USB_QUIRK(WESTERN, MYPASSPORT_09, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
471 	USB_QUIRK(WESTERN, MYPASSPORT_10, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
472 	USB_QUIRK(WESTERN, MYPASSPORT_11, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
473 	USB_QUIRK(WESTERN, MYPASSPORTES_00, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
474 	USB_QUIRK(WESTERN, MYPASSPORTES_01, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
475 	USB_QUIRK(WESTERN, MYPASSPORTES_02, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
476 	USB_QUIRK(WESTERN, MYPASSPORTES_03, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
477 	USB_QUIRK(WESTERN, MYPASSPORTES_04, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
478 	USB_QUIRK(WESTERN, MYPASSPORTES_05, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
479 	USB_QUIRK(WESTERN, MYPASSPORTES_06, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
480 	USB_QUIRK(WESTERN, MYPASSPORTES_07, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
481 	USB_QUIRK(WESTERN, MYPASSPORTES_08, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
482 	USB_QUIRK(WESTERN, MYPASSPORTES_09, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
483 	USB_QUIRK(WINMAXGROUP, FLASH64MC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
484 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
485 	USB_QUIRK(YANO, FW800HD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
486 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
487 	    UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
488 	USB_QUIRK(YANO, U640MO, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
489 	    UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_FORCE_SHORT_INQ),
490 	USB_QUIRK(YEDATA, FLASHBUSTERU, 0x0000, 0x007F, UQ_MSC_FORCE_WIRE_CBI,
491 	    UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_FLOPPY_SPEED,
492 	    UQ_MSC_NO_TEST_UNIT_READY, UQ_MSC_NO_GETMAXLUN),
493 	USB_QUIRK(YEDATA, FLASHBUSTERU, 0x0080, 0x0080, UQ_MSC_FORCE_WIRE_CBI_I,
494 	    UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_FLOPPY_SPEED,
495 	    UQ_MSC_NO_TEST_UNIT_READY, UQ_MSC_NO_GETMAXLUN),
496 	USB_QUIRK(YEDATA, FLASHBUSTERU, 0x0081, 0xFFFF, UQ_MSC_FORCE_WIRE_CBI_I,
497 	    UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_FLOPPY_SPEED,
498 	    UQ_MSC_NO_GETMAXLUN),
499 	USB_QUIRK(ZORAN, EX20DSC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
500 	    UQ_MSC_FORCE_PROTO_ATAPI),
501 	USB_QUIRK(MEIZU, M6_SL, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
502 	    UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY, UQ_MSC_NO_SYNC_CACHE),
503 	USB_QUIRK(TOSHIBA, TRANSMEMORY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE,
504 	    UQ_MSC_NO_PREVENT_ALLOW),
505 	USB_QUIRK(VIALABS, USB30SATABRIDGE, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
506 	USB_QUIRK(QUALCOMMINC, ZTE_MF730M, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN,
507 	    UQ_MSC_NO_INQUIRY, UQ_CFG_INDEX_0),
508 	/* Non-standard USB MIDI devices */
509 	USB_QUIRK(ROLAND, UM1, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
510 	USB_QUIRK(ROLAND, SC8850, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
511 	USB_QUIRK(ROLAND, SD90, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
512 	USB_QUIRK(ROLAND, UM880N, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
513 	USB_QUIRK(ROLAND, UA100, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
514 	USB_QUIRK(ROLAND, UM4, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
515 	USB_QUIRK(ROLAND, U8, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
516 	USB_QUIRK(ROLAND, UM2, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
517 	USB_QUIRK(ROLAND, SC8820, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
518 	USB_QUIRK(ROLAND, PC300, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
519 	USB_QUIRK(ROLAND, SK500, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
520 	USB_QUIRK(ROLAND, SCD70, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
521 	USB_QUIRK(ROLAND, UM550, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
522 	USB_QUIRK(ROLAND, SD20, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
523 	USB_QUIRK(ROLAND, SD80, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
524 	USB_QUIRK(ROLAND, UA700, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
525 	USB_QUIRK(ROLAND, PCR300, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
526 	USB_QUIRK(EGO, M4U, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI),
527 	USB_QUIRK(LOGILINK, U2M, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI),
528 	USB_QUIRK(MEDELI, DD305, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI, UQ_MATCH_VENDOR_ONLY),
529 	USB_QUIRK(REDOCTANE, GHMIDI, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI),
530 	USB_QUIRK(TEXTECH, U2M_1, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI),
531 	USB_QUIRK(TEXTECH, U2M_2, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI),
532 	USB_QUIRK(WCH2, U2M, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI),
533 
534 	/* Non-standard USB AUDIO devices */
535 	USB_QUIRK(MAUDIO, FASTTRACKULTRA, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
536 	USB_QUIRK(MAUDIO, FASTTRACKULTRA8R, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
537 	USB_QUIRK(CMEDIA, CM6206, 0x0000, 0xffff, UQ_AU_SET_SPDIF_CM6206),
538 	USB_QUIRK(PLOYTEC, SPL_CRIMSON_1, 0x0000, 0xffff, UQ_CFG_INDEX_1),
539 	USB_QUIRK(ROLAND, UA25EX_AD, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
540 
541 	/*
542 	 * Quirks for manufacturers which USB devices does not respond
543 	 * after issuing non-supported commands:
544 	 */
545 	USB_QUIRK(ALCOR, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MSC_NO_TEST_UNIT_READY, UQ_MATCH_VENDOR_ONLY),
546 	USB_QUIRK(APPLE, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
547 	USB_QUIRK(FEIYA, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
548 	USB_QUIRK(REALTEK, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
549 	USB_QUIRK(INITIO, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
550 
551 	/* DYMO LabelManager Pnp */
552 	USB_QUIRK(DYMO, LABELMANAGERPNP, 0x0000, 0xffff, UQ_MSC_DYMO_EJECT),
553 
554 	/* Holtek USB gaming keyboard */
555 	USB_QUIRK(HOLTEK, F85, 0x0000, 0xffff, UQ_KBD_BOOTPROTO),
556 };
557 #undef USB_QUIRK_VP
558 #undef USB_QUIRK
559 
560 static const char *usb_quirk_str[USB_QUIRK_MAX] = {
561 	[UQ_NONE]		= "UQ_NONE",
562 	[UQ_MATCH_VENDOR_ONLY]	= "UQ_MATCH_VENDOR_ONLY",
563 	[UQ_AUDIO_SWAP_LR]	= "UQ_AUDIO_SWAP_LR",
564 	[UQ_AU_INP_ASYNC]	= "UQ_AU_INP_ASYNC",
565 	[UQ_AU_NO_FRAC]		= "UQ_AU_NO_FRAC",
566 	[UQ_AU_NO_XU]		= "UQ_AU_NO_XU",
567 	[UQ_BAD_ADC]		= "UQ_BAD_ADC",
568 	[UQ_BAD_AUDIO]		= "UQ_BAD_AUDIO",
569 	[UQ_BROKEN_BIDIR]	= "UQ_BROKEN_BIDIR",
570 	[UQ_BUS_POWERED]	= "UQ_BUS_POWERED",
571 	[UQ_HID_IGNORE]		= "UQ_HID_IGNORE",
572 	[UQ_KBD_IGNORE]		= "UQ_KBD_IGNORE",
573 	[UQ_KBD_BOOTPROTO]	= "UQ_KBD_BOOTPROTO",
574 	[UQ_UMS_IGNORE]		= "UQ_UMS_IGNORE",
575 	[UQ_MS_BAD_CLASS]	= "UQ_MS_BAD_CLASS",
576 	[UQ_MS_LEADING_BYTE]	= "UQ_MS_LEADING_BYTE",
577 	[UQ_MS_REVZ]		= "UQ_MS_REVZ",
578 	[UQ_NO_STRINGS]		= "UQ_NO_STRINGS",
579 	[UQ_POWER_CLAIM]	= "UQ_POWER_CLAIM",
580 	[UQ_SPUR_BUT_UP]	= "UQ_SPUR_BUT_UP",
581 	[UQ_SWAP_UNICODE]	= "UQ_SWAP_UNICODE",
582 	[UQ_CFG_INDEX_1]	= "UQ_CFG_INDEX_1",
583 	[UQ_CFG_INDEX_2]	= "UQ_CFG_INDEX_2",
584 	[UQ_CFG_INDEX_3]	= "UQ_CFG_INDEX_3",
585 	[UQ_CFG_INDEX_4]	= "UQ_CFG_INDEX_4",
586 	[UQ_CFG_INDEX_0]	= "UQ_CFG_INDEX_0",
587 	[UQ_ASSUME_CM_OVER_DATA]	= "UQ_ASSUME_CM_OVER_DATA",
588 	[UQ_MSC_NO_TEST_UNIT_READY]	= "UQ_MSC_NO_TEST_UNIT_READY",
589 	[UQ_MSC_NO_RS_CLEAR_UA]		= "UQ_MSC_NO_RS_CLEAR_UA",
590 	[UQ_MSC_NO_START_STOP]		= "UQ_MSC_NO_START_STOP",
591 	[UQ_MSC_NO_GETMAXLUN]		= "UQ_MSC_NO_GETMAXLUN",
592 	[UQ_MSC_NO_INQUIRY]		= "UQ_MSC_NO_INQUIRY",
593 	[UQ_MSC_NO_INQUIRY_EVPD]	= "UQ_MSC_NO_INQUIRY_EVPD",
594 	[UQ_MSC_NO_PREVENT_ALLOW]	= "UQ_MSC_NO_PREVENT_ALLOW",
595 	[UQ_MSC_NO_SYNC_CACHE]		= "UQ_MSC_NO_SYNC_CACHE",
596 	[UQ_MSC_SHUTTLE_INIT]		= "UQ_MSC_SHUTTLE_INIT",
597 	[UQ_MSC_ALT_IFACE_1]		= "UQ_MSC_ALT_IFACE_1",
598 	[UQ_MSC_FLOPPY_SPEED]		= "UQ_MSC_FLOPPY_SPEED",
599 	[UQ_MSC_IGNORE_RESIDUE]		= "UQ_MSC_IGNORE_RESIDUE",
600 	[UQ_MSC_WRONG_CSWSIG]		= "UQ_MSC_WRONG_CSWSIG",
601 	[UQ_MSC_RBC_PAD_TO_12]		= "UQ_MSC_RBC_PAD_TO_12",
602 	[UQ_MSC_READ_CAP_OFFBY1]	= "UQ_MSC_READ_CAP_OFFBY1",
603 	[UQ_MSC_FORCE_SHORT_INQ]	= "UQ_MSC_FORCE_SHORT_INQ",
604 	[UQ_MSC_FORCE_WIRE_BBB]		= "UQ_MSC_FORCE_WIRE_BBB",
605 	[UQ_MSC_FORCE_WIRE_CBI]		= "UQ_MSC_FORCE_WIRE_CBI",
606 	[UQ_MSC_FORCE_WIRE_CBI_I]	= "UQ_MSC_FORCE_WIRE_CBI_I",
607 	[UQ_MSC_FORCE_PROTO_SCSI]	= "UQ_MSC_FORCE_PROTO_SCSI",
608 	[UQ_MSC_FORCE_PROTO_ATAPI]	= "UQ_MSC_FORCE_PROTO_ATAPI",
609 	[UQ_MSC_FORCE_PROTO_UFI]	= "UQ_MSC_FORCE_PROTO_UFI",
610 	[UQ_MSC_FORCE_PROTO_RBC]	= "UQ_MSC_FORCE_PROTO_RBC",
611 	[UQ_MSC_EJECT_HUAWEI]		= "UQ_MSC_EJECT_HUAWEI",
612 	[UQ_MSC_EJECT_SIERRA]		= "UQ_MSC_EJECT_SIERRA",
613 	[UQ_MSC_EJECT_SCSIEJECT]	= "UQ_MSC_EJECT_SCSIEJECT",
614 	[UQ_MSC_EJECT_REZERO]		= "UQ_MSC_EJECT_REZERO",
615 	[UQ_MSC_EJECT_ZTESTOR]		= "UQ_MSC_EJECT_ZTESTOR",
616 	[UQ_MSC_EJECT_CMOTECH]		= "UQ_MSC_EJECT_CMOTECH",
617 	[UQ_MSC_EJECT_WAIT]		= "UQ_MSC_EJECT_WAIT",
618 	[UQ_MSC_EJECT_SAEL_M460]	= "UQ_MSC_EJECT_SAEL_M460",
619 	[UQ_MSC_EJECT_HUAWEISCSI]	= "UQ_MSC_EJECT_HUAWEISCSI",
620 	[UQ_MSC_EJECT_HUAWEISCSI2]	= "UQ_MSC_EJECT_HUAWEISCSI2",
621 	[UQ_MSC_EJECT_TCT]		= "UQ_MSC_EJECT_TCT",
622 	[UQ_BAD_MIDI]			= "UQ_BAD_MIDI",
623 	[UQ_AU_VENDOR_CLASS]		= "UQ_AU_VENDOR_CLASS",
624 	[UQ_SINGLE_CMD_MIDI]		= "UQ_SINGLE_CMD_MIDI",
625 	[UQ_MSC_DYMO_EJECT]		= "UQ_MSC_DYMO_EJECT",
626 	[UQ_AU_SET_SPDIF_CM6206]	= "UQ_AU_SET_SPDIF_CM6206",
627 	[UQ_WMT_IGNORE]			= "UQ_WMT_IGNORE",
628 };
629 
630 /*------------------------------------------------------------------------*
631  *	usb_quirkstr
632  *
633  * This function converts an USB quirk code into a string.
634  *------------------------------------------------------------------------*/
635 static const char *
usb_quirkstr(uint16_t quirk)636 usb_quirkstr(uint16_t quirk)
637 {
638 	return ((quirk < USB_QUIRK_MAX && usb_quirk_str[quirk] != NULL) ?
639 	    usb_quirk_str[quirk] : "UQ_UNKNOWN");
640 }
641 
642 /*------------------------------------------------------------------------*
643  *	usb_strquirk
644  *
645  * This function converts a string into a USB quirk code.
646  *
647  * Returns:
648  * Less than USB_QUIRK_MAX: Quirk code
649  * Else: Quirk code not found
650  *------------------------------------------------------------------------*/
651 static uint16_t
usb_strquirk(const char * str,size_t len)652 usb_strquirk(const char *str, size_t len)
653 {
654 	const char *quirk;
655 	uint16_t x;
656 
657 	for (x = 0; x != USB_QUIRK_MAX; x++) {
658 		quirk = usb_quirkstr(x);
659 		if (strncmp(str, quirk, len) == 0 &&
660 		    quirk[len] == 0)
661 			break;
662 	}
663 	return (x);
664 }
665 
666 /*------------------------------------------------------------------------*
667  *	usb_test_quirk_by_info
668  *
669  * Returns:
670  * 0: Quirk not found
671  * Else: Quirk found
672  *------------------------------------------------------------------------*/
673 static uint8_t
usb_test_quirk_by_info(const struct usbd_lookup_info * info,uint16_t quirk)674 usb_test_quirk_by_info(const struct usbd_lookup_info *info, uint16_t quirk)
675 {
676 	uint16_t x;
677 	uint16_t y;
678 
679 	if (quirk == UQ_NONE)
680 		goto done;
681 
682 	mtx_lock(&usb_quirk_mtx);
683 
684 	for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) {
685 		/* see if quirk information does not match */
686 		if ((usb_quirks[x].vid != info->idVendor) ||
687 		    (usb_quirks[x].lo_rev > info->bcdDevice) ||
688 		    (usb_quirks[x].hi_rev < info->bcdDevice)) {
689 			continue;
690 		}
691 		/* see if quirk only should match vendor ID */
692 		if (usb_quirks[x].pid != info->idProduct) {
693 			if (usb_quirks[x].pid != 0)
694 				continue;
695 
696 			for (y = 0; y != USB_SUB_QUIRKS_MAX; y++) {
697 				if (usb_quirks[x].quirks[y] == UQ_MATCH_VENDOR_ONLY)
698 					break;
699 			}
700 			if (y == USB_SUB_QUIRKS_MAX)
701 				continue;
702 		}
703 		/* lookup quirk */
704 		for (y = 0; y != USB_SUB_QUIRKS_MAX; y++) {
705 			if (usb_quirks[x].quirks[y] == quirk) {
706 				mtx_unlock(&usb_quirk_mtx);
707 				DPRINTF("Found quirk '%s'.\n", usb_quirkstr(quirk));
708 				return (1);
709 			}
710 		}
711 	}
712 	mtx_unlock(&usb_quirk_mtx);
713 done:
714 	return (0);			/* no quirk match */
715 }
716 
717 static struct usb_quirk_entry *
usb_quirk_get_entry(uint16_t vid,uint16_t pid,uint16_t lo_rev,uint16_t hi_rev,uint8_t do_alloc)718 usb_quirk_get_entry(uint16_t vid, uint16_t pid,
719     uint16_t lo_rev, uint16_t hi_rev, uint8_t do_alloc)
720 {
721 	uint16_t x;
722 
723 	mtx_assert(&usb_quirk_mtx, MA_OWNED);
724 
725 	if ((vid | pid | lo_rev | hi_rev) == 0) {
726 		/* all zero - special case */
727 		return (usb_quirks + USB_DEV_QUIRKS_MAX - 1);
728 	}
729 	/* search for an existing entry */
730 	for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) {
731 		/* see if quirk information does not match */
732 		if ((usb_quirks[x].vid != vid) ||
733 		    (usb_quirks[x].pid != pid) ||
734 		    (usb_quirks[x].lo_rev != lo_rev) ||
735 		    (usb_quirks[x].hi_rev != hi_rev)) {
736 			continue;
737 		}
738 		return (usb_quirks + x);
739 	}
740 
741 	if (do_alloc == 0) {
742 		/* no match */
743 		return (NULL);
744 	}
745 	/* search for a free entry */
746 	for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) {
747 		/* see if quirk information does not match */
748 		if ((usb_quirks[x].vid |
749 		    usb_quirks[x].pid |
750 		    usb_quirks[x].lo_rev |
751 		    usb_quirks[x].hi_rev) != 0) {
752 			continue;
753 		}
754 		usb_quirks[x].vid = vid;
755 		usb_quirks[x].pid = pid;
756 		usb_quirks[x].lo_rev = lo_rev;
757 		usb_quirks[x].hi_rev = hi_rev;
758 
759 		return (usb_quirks + x);
760 	}
761 
762 	/* no entry found */
763 	return (NULL);
764 }
765 
766 /*------------------------------------------------------------------------*
767  *	usb_quirk_ioctl - handle quirk IOCTLs
768  *
769  * Returns:
770  * 0: Success
771  * Else: Failure
772  *------------------------------------------------------------------------*/
773 static int
usb_quirk_ioctl(unsigned long cmd,caddr_t data,int fflag,struct thread * td)774 usb_quirk_ioctl(unsigned long cmd, caddr_t data,
775     int fflag, struct thread *td)
776 {
777 	struct usb_gen_quirk *pgq;
778 	struct usb_quirk_entry *pqe;
779 	uint32_t x;
780 	uint32_t y;
781 	int err;
782 
783 	switch (cmd) {
784 	case USB_DEV_QUIRK_GET:
785 		pgq = (void *)data;
786 		x = pgq->index % USB_SUB_QUIRKS_MAX;
787 		y = pgq->index / USB_SUB_QUIRKS_MAX;
788 		if (y >= USB_DEV_QUIRKS_MAX) {
789 			return (EINVAL);
790 		}
791 		mtx_lock(&usb_quirk_mtx);
792 		/* copy out data */
793 		pgq->vid = usb_quirks[y].vid;
794 		pgq->pid = usb_quirks[y].pid;
795 		pgq->bcdDeviceLow = usb_quirks[y].lo_rev;
796 		pgq->bcdDeviceHigh = usb_quirks[y].hi_rev;
797 		strlcpy(pgq->quirkname,
798 		    usb_quirkstr(usb_quirks[y].quirks[x]),
799 		    sizeof(pgq->quirkname));
800 		mtx_unlock(&usb_quirk_mtx);
801 		return (0);		/* success */
802 
803 	case USB_QUIRK_NAME_GET:
804 		pgq = (void *)data;
805 		x = pgq->index;
806 		if (x >= USB_QUIRK_MAX) {
807 			return (EINVAL);
808 		}
809 		strlcpy(pgq->quirkname,
810 		    usb_quirkstr(x), sizeof(pgq->quirkname));
811 		return (0);		/* success */
812 
813 	case USB_DEV_QUIRK_ADD:
814 		pgq = (void *)data;
815 
816 		/* check privileges */
817 		err = priv_check(curthread, PRIV_DRIVER);
818 		if (err) {
819 			return (err);
820 		}
821 		/* convert quirk string into numerical */
822 		for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) {
823 			if (strcmp(pgq->quirkname, usb_quirkstr(y)) == 0) {
824 				break;
825 			}
826 		}
827 		if (y == USB_DEV_QUIRKS_MAX) {
828 			return (EINVAL);
829 		}
830 		if (y == UQ_NONE) {
831 			return (EINVAL);
832 		}
833 		mtx_lock(&usb_quirk_mtx);
834 		pqe = usb_quirk_get_entry(pgq->vid, pgq->pid,
835 		    pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 1);
836 		if (pqe == NULL) {
837 			mtx_unlock(&usb_quirk_mtx);
838 			return (EINVAL);
839 		}
840 		for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) {
841 			if (pqe->quirks[x] == UQ_NONE) {
842 				pqe->quirks[x] = y;
843 				break;
844 			}
845 		}
846 		mtx_unlock(&usb_quirk_mtx);
847 		if (x == USB_SUB_QUIRKS_MAX) {
848 			return (ENOMEM);
849 		}
850 		return (0);		/* success */
851 
852 	case USB_DEV_QUIRK_REMOVE:
853 		pgq = (void *)data;
854 		/* check privileges */
855 		err = priv_check(curthread, PRIV_DRIVER);
856 		if (err) {
857 			return (err);
858 		}
859 		/* convert quirk string into numerical */
860 		for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) {
861 			if (strcmp(pgq->quirkname, usb_quirkstr(y)) == 0) {
862 				break;
863 			}
864 		}
865 		if (y == USB_DEV_QUIRKS_MAX) {
866 			return (EINVAL);
867 		}
868 		if (y == UQ_NONE) {
869 			return (EINVAL);
870 		}
871 		mtx_lock(&usb_quirk_mtx);
872 		pqe = usb_quirk_get_entry(pgq->vid, pgq->pid,
873 		    pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 0);
874 		if (pqe == NULL) {
875 			mtx_unlock(&usb_quirk_mtx);
876 			return (EINVAL);
877 		}
878 		for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) {
879 			if (pqe->quirks[x] == y) {
880 				pqe->quirks[x] = UQ_NONE;
881 				break;
882 			}
883 		}
884 		if (x == USB_SUB_QUIRKS_MAX) {
885 			mtx_unlock(&usb_quirk_mtx);
886 			return (ENOMEM);
887 		}
888 		for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) {
889 			if (pqe->quirks[x] != UQ_NONE) {
890 				break;
891 			}
892 		}
893 		if (x == USB_SUB_QUIRKS_MAX) {
894 			/* all quirk entries are unused - release */
895 			memset(pqe, 0, sizeof(*pqe));
896 		}
897 		mtx_unlock(&usb_quirk_mtx);
898 		return (0);		/* success */
899 
900 	default:
901 		break;
902 	}
903 	return (ENOIOCTL);
904 }
905 
906 /*------------------------------------------------------------------------*
907  *	usb_quirk_strtou16
908  *
909  * Helper function to scan a 16-bit integer.
910  *------------------------------------------------------------------------*/
911 static uint16_t
usb_quirk_strtou16(const char ** pptr,const char * name,const char * what)912 usb_quirk_strtou16(const char **pptr, const char *name, const char *what)
913 {
914 	unsigned long value;
915 	char *end;
916 
917 	value = strtoul(*pptr, &end, 0);
918 	if (value > 65535 || *pptr == end || (*end != ' ' && *end != '\t')) {
919 		printf("%s: %s 16-bit %s value set to zero\n",
920 		    name, what, *end == 0 ? "incomplete" : "invalid");
921 		return (0);
922 	}
923 	*pptr = end + 1;
924 	return ((uint16_t)value);
925 }
926 
927 /*------------------------------------------------------------------------*
928  *	usb_quirk_add_entry_from_str
929  *
930  * Add a USB quirk entry from string.
931  *     "VENDOR PRODUCT LO_REV HI_REV QUIRK[,QUIRK[,...]]"
932  *------------------------------------------------------------------------*/
933 static void
usb_quirk_add_entry_from_str(const char * name,const char * env)934 usb_quirk_add_entry_from_str(const char *name, const char *env)
935 {
936 	struct usb_quirk_entry entry = { };
937 	struct usb_quirk_entry *new;
938 	uint16_t quirk_idx;
939 	uint16_t quirk;
940 	const char *end;
941 
942 	/* check for invalid environment variable */
943 	if (name == NULL || env == NULL)
944 		return;
945 
946 	if (bootverbose)
947 		printf("Adding USB QUIRK '%s' = '%s'\n", name, env);
948 
949 	/* parse device information */
950 	entry.vid = usb_quirk_strtou16(&env, name, "Vendor ID");
951 	entry.pid = usb_quirk_strtou16(&env, name, "Product ID");
952 	entry.lo_rev = usb_quirk_strtou16(&env, name, "Low revision");
953 	entry.hi_rev = usb_quirk_strtou16(&env, name, "High revision");
954 
955 	/* parse quirk information */
956 	quirk_idx = 0;
957 	while (*env != 0 && quirk_idx != USB_SUB_QUIRKS_MAX) {
958 		/* skip whitespace before quirks */
959 		while (*env == ' ' || *env == '\t')
960 			env++;
961 
962 		/* look for quirk separation character */
963 		end = strchr(env, ',');
964 		if (end == NULL)
965 			end = env + strlen(env);
966 
967 		/* lookup quirk in string table */
968 		quirk = usb_strquirk(env, end - env);
969 		if (quirk < USB_QUIRK_MAX) {
970 			entry.quirks[quirk_idx++] = quirk;
971 		} else {
972 			printf("%s: unknown USB quirk '%.*s' (skipped)\n",
973 			    name, (int)(end - env), env);
974 		}
975 		env = end;
976 
977 		/* skip quirk delimiter, if any */
978 		if (*env != 0)
979 			env++;
980 	}
981 
982 	/* register quirk */
983 	if (quirk_idx != 0) {
984 		if (*env != 0) {
985 			printf("%s: Too many USB quirks, only %d allowed!\n",
986 			    name, USB_SUB_QUIRKS_MAX);
987 		}
988 		mtx_lock(&usb_quirk_mtx);
989 		new = usb_quirk_get_entry(entry.vid, entry.pid,
990 		    entry.lo_rev, entry.hi_rev, 1);
991 		if (new == NULL)
992 			printf("%s: USB quirks table is full!\n", name);
993 		else
994 			memcpy(new->quirks, entry.quirks, sizeof(entry.quirks));
995 		mtx_unlock(&usb_quirk_mtx);
996 	} else {
997 		printf("%s: No USB quirks found!\n", name);
998 	}
999 }
1000 
1001 static void
usb_quirk_init(void * arg)1002 usb_quirk_init(void *arg)
1003 {
1004 	char envkey[sizeof(USB_QUIRK_ENVROOT) + 2];	/* 2 digits max, 0 to 99 */
1005 	int i;
1006 
1007 	/* initialize mutex */
1008 	mtx_init(&usb_quirk_mtx, "USB quirk", NULL, MTX_DEF);
1009 
1010 	/* look for quirks defined by the environment variable */
1011 	for (i = 0; i != 100; i++) {
1012 		snprintf(envkey, sizeof(envkey), USB_QUIRK_ENVROOT "%d", i);
1013 
1014 		/* Stop at first undefined var */
1015 		if (!testenv(envkey))
1016 			break;
1017 
1018 		/* parse environment variable */
1019 		usb_quirk_add_entry_from_str(envkey, kern_getenv(envkey));
1020 	}
1021 
1022 	/* register our function */
1023 	usb_test_quirk_p = &usb_test_quirk_by_info;
1024 	usb_quirk_ioctl_p = &usb_quirk_ioctl;
1025 }
1026 
1027 static void
usb_quirk_uninit(void * arg)1028 usb_quirk_uninit(void *arg)
1029 {
1030 	usb_quirk_unload(arg);
1031 
1032 	/* destroy mutex */
1033 	mtx_destroy(&usb_quirk_mtx);
1034 }
1035 
1036 SYSINIT(usb_quirk_init, SI_SUB_LOCK, SI_ORDER_FIRST, usb_quirk_init, NULL);
1037 SYSUNINIT(usb_quirk_uninit, SI_SUB_LOCK, SI_ORDER_ANY, usb_quirk_uninit, NULL);
1038