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