usb4bsd: Bring in FreeBSD's libusbhid, usbhidctl and USB kernel code.
[dragonfly.git] / sys / bus / u4b / quirk / usb_quirk.c
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 256
63 #define USB_SUB_QUIRKS_MAX 8
64
65 struct usb_quirk_entry {
66         uint16_t vid;
67         uint16_t pid;
68         uint16_t lo_rev;
69         uint16_t hi_rev;
70         uint16_t quirks[USB_SUB_QUIRKS_MAX];
71 };
72
73 static struct mtx usb_quirk_mtx;
74
75 #define USB_QUIRK_VP(v,p,l,h,...) \
76   { .vid = (v), .pid = (p), .lo_rev = (l), .hi_rev = (h), \
77     .quirks = { __VA_ARGS__ } }
78 #define USB_QUIRK(v,p,l,h,...) \
79   USB_QUIRK_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, l, h, __VA_ARGS__)
80
81 static struct usb_quirk_entry usb_quirks[USB_DEV_QUIRKS_MAX] = {
82         USB_QUIRK(ASUS, LCM, 0x0000, 0xffff, UQ_HID_IGNORE),
83         USB_QUIRK(INSIDEOUT, EDGEPORT4, 0x094, 0x094, UQ_SWAP_UNICODE),
84         USB_QUIRK(DALLAS, J6502, 0x0a2, 0x0a2, UQ_BAD_ADC),
85         USB_QUIRK(DALLAS, J6502, 0x0a2, 0x0a2, UQ_AU_NO_XU),
86         USB_QUIRK(ALTEC, ADA70, 0x103, 0x103, UQ_BAD_ADC),
87         USB_QUIRK(ALTEC, ASC495, 0x000, 0x000, UQ_BAD_AUDIO),
88         USB_QUIRK(QTRONIX, 980N, 0x110, 0x110, UQ_SPUR_BUT_UP),
89         USB_QUIRK(ALCOR2, KBD_HUB, 0x001, 0x001, UQ_SPUR_BUT_UP),
90         USB_QUIRK(MCT, HUB0100, 0x102, 0x102, UQ_BUS_POWERED),
91         USB_QUIRK(MCT, USB232, 0x102, 0x102, UQ_BUS_POWERED),
92         USB_QUIRK(TI, UTUSB41, 0x110, 0x110, UQ_POWER_CLAIM),
93         USB_QUIRK(TELEX, MIC1, 0x009, 0x009, UQ_AU_NO_FRAC),
94         USB_QUIRK(SILICONPORTALS, YAPPHONE, 0x100, 0x100, UQ_AU_INP_ASYNC),
95         USB_QUIRK(LOGITECH, UN53B, 0x0000, 0xffff, UQ_NO_STRINGS),
96         USB_QUIRK(ELSA, MODEM1, 0x0000, 0xffff, UQ_CFG_INDEX_1),
97         /* Quirks for printer devices */
98         USB_QUIRK(HP, 895C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
99         USB_QUIRK(HP, 880C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
100         USB_QUIRK(HP, 815C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
101         USB_QUIRK(HP, 810C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
102         USB_QUIRK(HP, 830C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
103         USB_QUIRK(HP, 1220C, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
104         USB_QUIRK(XEROX, WCM15, 0x0000, 0xffff, UQ_BROKEN_BIDIR),
105         /* Devices which should be ignored by uhid */
106         USB_QUIRK(APC, UPS, 0x0000, 0xffff, UQ_HID_IGNORE),
107         USB_QUIRK(BELKIN, F6C550AVR, 0x0000, 0xffff, UQ_HID_IGNORE),
108         USB_QUIRK(CYBERPOWER, 1500CAVRLCD, 0x0000, 0xffff, UQ_HID_IGNORE),
109         USB_QUIRK(CYPRESS, SILVERSHIELD, 0x0000, 0xffff, UQ_HID_IGNORE),
110         USB_QUIRK(DELORME, EARTHMATE, 0x0000, 0xffff, UQ_HID_IGNORE),
111         USB_QUIRK(ITUNERNET, USBLCD2X20, 0x0000, 0xffff, UQ_HID_IGNORE),
112         USB_QUIRK(ITUNERNET, USBLCD4X20, 0x0000, 0xffff, UQ_HID_IGNORE),
113         USB_QUIRK(LIEBERT, POWERSURE_PXT, 0x0000, 0xffff, UQ_HID_IGNORE),
114         USB_QUIRK(MGE, UPS1, 0x0000, 0xffff, UQ_HID_IGNORE),
115         USB_QUIRK(MGE, UPS2, 0x0000, 0xffff, UQ_HID_IGNORE),
116         USB_QUIRK(APPLE, IPHONE, 0x0000, 0xffff, UQ_HID_IGNORE),
117         USB_QUIRK(APPLE, IPHONE_3G, 0x0000, 0xffff, UQ_HID_IGNORE),
118         USB_QUIRK(MEGATEC, UPS, 0x0000, 0xffff, UQ_HID_IGNORE),
119         /* Devices which should be ignored by both ukbd and uhid */
120         USB_QUIRK(CYPRESS, WISPY1A, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
121         USB_QUIRK(METAGEEK, WISPY1B, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
122         USB_QUIRK(METAGEEK, WISPY24X, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
123         USB_QUIRK(METAGEEK2, WISPYDBX, 0x0000, 0xffff, UQ_KBD_IGNORE, UQ_HID_IGNORE),
124         USB_QUIRK(TENX, UAUDIO0, 0x0101, 0x0101, UQ_AUDIO_SWAP_LR),
125         /* MS keyboards do weird things */
126         USB_QUIRK(MICROSOFT, WLINTELLIMOUSE, 0x0000, 0xffff, UQ_MS_LEADING_BYTE),
127         /* umodem(4) device quirks */
128         USB_QUIRK(METRICOM, RICOCHET_GS, 0x100, 0x100, UQ_ASSUME_CM_OVER_DATA),
129         USB_QUIRK(SANYO, SCP4900, 0x000, 0x000, UQ_ASSUME_CM_OVER_DATA),
130         USB_QUIRK(MOTOROLA2, T720C, 0x001, 0x001, UQ_ASSUME_CM_OVER_DATA),
131         USB_QUIRK(EICON, DIVA852, 0x100, 0x100, UQ_ASSUME_CM_OVER_DATA),
132         USB_QUIRK(SIEMENS2, ES75, 0x000, 0x000, UQ_ASSUME_CM_OVER_DATA),
133         USB_QUIRK(QUALCOMM, CDMA_MSM, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
134         USB_QUIRK(QUALCOMM2, CDMA_MSM, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
135         USB_QUIRK(CURITEL, UM150, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
136         USB_QUIRK(CURITEL, UM175, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
137         USB_QUIRK(VERTEX, VW110L, 0x0000, 0xffff, UQ_ASSUME_CM_OVER_DATA),
138
139         /* USB Mass Storage Class Quirks */
140         USB_QUIRK_VP(USB_VENDOR_ASAHIOPTICAL, 0, UQ_MSC_NO_RS_CLEAR_UA,
141             UQ_MATCH_VENDOR_ONLY),
142         USB_QUIRK(ADDON, ATTACHE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
143             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
144         USB_QUIRK(ADDON, A256MB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
145             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
146         USB_QUIRK(ADDON, DISKPRO512, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
147             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
148         USB_QUIRK(ADDONICS2, CABLE_205, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
149             UQ_MSC_FORCE_PROTO_SCSI),
150         USB_QUIRK(AIPTEK, POCKETCAM3M, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
151             UQ_MSC_FORCE_PROTO_SCSI),
152         USB_QUIRK(ALCOR, UMCR_9361, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
153             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
154         USB_QUIRK(ALCOR, TRANSCEND, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN,
155             UQ_MSC_NO_SYNC_CACHE, UQ_MSC_NO_TEST_UNIT_READY),
156         USB_QUIRK(APACER, HT202, 0x0000, 0xffff, UQ_MSC_NO_TEST_UNIT_READY,
157             UQ_MSC_NO_SYNC_CACHE),
158         USB_QUIRK(ASAHIOPTICAL, OPTIO230, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
159             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
160         USB_QUIRK(ASAHIOPTICAL, OPTIO330, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
161             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
162         USB_QUIRK(BELKIN, USB2SCSI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
163             UQ_MSC_FORCE_PROTO_SCSI),
164         USB_QUIRK(CASIO, QV_DIGICAM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
165             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
166         USB_QUIRK(CCYU, ED1064, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
167             UQ_MSC_FORCE_PROTO_SCSI),
168         USB_QUIRK(CENTURY, EX35QUAT, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
169             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
170             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
171         USB_QUIRK(CYPRESS, XX6830XX, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN,
172             UQ_MSC_NO_SYNC_CACHE),
173         USB_QUIRK(DESKNOTE, UCR_61S2B, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
174             UQ_MSC_FORCE_PROTO_SCSI),
175         USB_QUIRK(DMI, CFSM_RW, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI,
176             UQ_MSC_NO_GETMAXLUN),
177         USB_QUIRK(EPSON, STYLUS_875DC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
178             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
179         USB_QUIRK(EPSON, STYLUS_895, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
180             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
181         USB_QUIRK(FEIYA, 5IN1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
182             UQ_MSC_FORCE_PROTO_SCSI),
183         USB_QUIRK(FREECOM, DVD, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
184         USB_QUIRK(FUJIPHOTO, MASS0100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
185             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_NO_SYNC_CACHE),
186         USB_QUIRK(GENESYS, GL641USB2IDE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
187             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
188             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE, UQ_MSC_NO_SYNC_CACHE),
189         USB_QUIRK(GENESYS, GL641USB2IDE_2, 0x0000, 0xffff,
190             UQ_MSC_FORCE_WIRE_BBB, UQ_MSC_FORCE_PROTO_ATAPI,
191             UQ_MSC_FORCE_SHORT_INQ, UQ_MSC_NO_START_STOP,
192             UQ_MSC_IGNORE_RESIDUE),
193         USB_QUIRK(GENESYS, GL641USB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
194             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
195             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
196         USB_QUIRK(GENESYS, GL641USB_2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
197             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_WRONG_CSWSIG),
198         USB_QUIRK(HAGIWARA, FG, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
199             UQ_MSC_FORCE_PROTO_SCSI),
200         USB_QUIRK(HAGIWARA, FGSM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
201             UQ_MSC_FORCE_PROTO_SCSI),
202         USB_QUIRK(HITACHI, DVDCAM_DZ_MV100A, 0x0000, 0xffff,
203             UQ_MSC_FORCE_WIRE_CBI, UQ_MSC_FORCE_PROTO_SCSI,
204             UQ_MSC_NO_GETMAXLUN),
205         USB_QUIRK(HITACHI, DVDCAM_USB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
206             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
207         USB_QUIRK(HP, CDW4E, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_ATAPI),
208         USB_QUIRK(HP, CDW8200, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
209             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_TEST_UNIT_READY,
210             UQ_MSC_NO_START_STOP),
211         USB_QUIRK(IMAGINATION, DBX1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
212             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_WRONG_CSWSIG),
213         USB_QUIRK(INSYSTEM, USBCABLE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
214             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_TEST_UNIT_READY,
215             UQ_MSC_NO_START_STOP, UQ_MSC_ALT_IFACE_1),
216         USB_QUIRK(INSYSTEM, ATAPI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
217             UQ_MSC_FORCE_PROTO_RBC),
218         USB_QUIRK(INSYSTEM, STORAGE_V2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
219             UQ_MSC_FORCE_PROTO_RBC),
220         USB_QUIRK(IODATA, IU_CD2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
221             UQ_MSC_FORCE_PROTO_SCSI),
222         USB_QUIRK(IODATA, DVR_UEH8, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
223             UQ_MSC_FORCE_PROTO_SCSI),
224         USB_QUIRK(IOMEGA, ZIP100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
225             UQ_MSC_FORCE_PROTO_SCSI,
226             UQ_MSC_NO_TEST_UNIT_READY), /* XXX ZIP drives can also use ATAPI */
227         USB_QUIRK(JMICRON, JM20337, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
228             UQ_MSC_FORCE_PROTO_SCSI,
229             UQ_MSC_NO_SYNC_CACHE),
230         USB_QUIRK(KYOCERA, FINECAM_L3, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
231             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
232         USB_QUIRK(KYOCERA, FINECAM_S3X, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
233             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
234         USB_QUIRK(KYOCERA, FINECAM_S4, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
235             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
236         USB_QUIRK(KYOCERA, FINECAM_S5, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
237             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
238         USB_QUIRK(LACIE, HD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
239             UQ_MSC_FORCE_PROTO_RBC),
240         USB_QUIRK(LEXAR, CF_READER, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
241             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
242         USB_QUIRK(LEXAR, JUMPSHOT, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
243         USB_QUIRK(LOGITEC, LDR_H443SU2, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
244         USB_QUIRK(LOGITEC, LDR_H443U2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
245             UQ_MSC_FORCE_PROTO_SCSI,),
246         USB_QUIRK(MELCO, DUBPXXG, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
247             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
248             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
249         USB_QUIRK(MICROTECH, DPCM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
250             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_TEST_UNIT_READY,
251             UQ_MSC_NO_START_STOP),
252         USB_QUIRK(MICRON, REALSSD, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE),
253         USB_QUIRK(MICROTECH, SCSIDB25, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
254             UQ_MSC_FORCE_PROTO_SCSI),
255         USB_QUIRK(MICROTECH, SCSIHD50, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
256             UQ_MSC_FORCE_PROTO_SCSI),
257         USB_QUIRK(MINOLTA, E223, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
258         USB_QUIRK(MINOLTA, F300, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
259             UQ_MSC_FORCE_PROTO_SCSI),
260         USB_QUIRK(MITSUMI, CDRRW, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI |
261             UQ_MSC_FORCE_PROTO_ATAPI),
262         USB_QUIRK(MOTOROLA2, E398, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
263             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
264             UQ_MSC_NO_INQUIRY_EVPD, UQ_MSC_NO_GETMAXLUN),
265         USB_QUIRK_VP(USB_VENDOR_MPMAN, 0, UQ_MSC_NO_SYNC_CACHE,
266             UQ_MATCH_VENDOR_ONLY),
267         USB_QUIRK(MSYSTEMS, DISKONKEY, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
268             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE, UQ_MSC_NO_GETMAXLUN,
269             UQ_MSC_NO_RS_CLEAR_UA),
270         USB_QUIRK(MSYSTEMS, DISKONKEY2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
271             UQ_MSC_FORCE_PROTO_ATAPI),
272         USB_QUIRK(MYSON, HEDEN, 0x0000, 0xffff, UQ_MSC_IGNORE_RESIDUE,
273             UQ_MSC_NO_SYNC_CACHE),
274         USB_QUIRK(NEODIO, ND3260, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
275             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ),
276         USB_QUIRK(NETAC, CF_CARD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
277             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
278         USB_QUIRK(NETAC, ONLYDISK, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
279             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
280         USB_QUIRK(NETCHIP, CLIK_40, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_ATAPI,
281             UQ_MSC_NO_INQUIRY),
282         USB_QUIRK(NIKON, D300, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
283             UQ_MSC_FORCE_PROTO_SCSI),
284         USB_QUIRK(OLYMPUS, C1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
285             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_WRONG_CSWSIG),
286         USB_QUIRK(OLYMPUS, C700, 0x0000, 0xffff, UQ_MSC_NO_GETMAXLUN),
287         USB_QUIRK(ONSPEC, SDS_HOTFIND_D, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
288             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN, UQ_MSC_NO_SYNC_CACHE),
289         USB_QUIRK(ONSPEC, CFMS_RW, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
290         USB_QUIRK(ONSPEC, CFSM_COMBO, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
291         USB_QUIRK(ONSPEC, CFSM_READER, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
292         USB_QUIRK(ONSPEC, CFSM_READER2, 0x0000, 0xffff,
293             UQ_MSC_FORCE_PROTO_SCSI),
294         USB_QUIRK(ONSPEC, MDCFE_B_CF_READER, 0x0000, 0xffff,
295             UQ_MSC_FORCE_PROTO_SCSI),
296         USB_QUIRK(ONSPEC, MDSM_B_READER, 0x0000, 0xffff,
297             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
298         USB_QUIRK(ONSPEC, READER, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
299         USB_QUIRK(ONSPEC, UCF100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
300             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY | UQ_MSC_NO_GETMAXLUN),
301         USB_QUIRK(ONSPEC2, IMAGEMATE_SDDR55, 0x0000, 0xffff,
302             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
303         USB_QUIRK(PANASONIC, KXL840AN, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
304             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_GETMAXLUN),
305         USB_QUIRK(PANASONIC, KXLCB20AN, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
306             UQ_MSC_FORCE_PROTO_SCSI),
307         USB_QUIRK(PANASONIC, KXLCB35AN, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
308             UQ_MSC_FORCE_PROTO_SCSI),
309         USB_QUIRK(PANASONIC, LS120CAM, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_UFI),
310         USB_QUIRK(PLEXTOR, 40_12_40U, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
311             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_TEST_UNIT_READY),
312         USB_QUIRK(PNY, ATTACHE2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
313             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE,
314             UQ_MSC_NO_START_STOP),
315         USB_QUIRK(PROLIFIC, PL2506, 0x0000, 0xffff,
316             UQ_MSC_NO_SYNC_CACHE),
317         USB_QUIRK_VP(USB_VENDOR_SAMSUNG_TECHWIN,
318             USB_PRODUCT_SAMSUNG_TECHWIN_DIGIMAX_410, UQ_MSC_FORCE_WIRE_BBB,
319             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
320         USB_QUIRK(SANDISK, SDDR05A, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
321             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_READ_CAP_OFFBY1,
322             UQ_MSC_NO_GETMAXLUN),
323         USB_QUIRK(SANDISK, SDDR09, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI,
324             UQ_MSC_READ_CAP_OFFBY1, UQ_MSC_NO_GETMAXLUN),
325         USB_QUIRK(SANDISK, SDDR12, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
326             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_READ_CAP_OFFBY1,
327             UQ_MSC_NO_GETMAXLUN),
328         USB_QUIRK(SANDISK, SDCZ2_256, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
329             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
330         USB_QUIRK(SANDISK, SDCZ4_128, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
331             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
332         USB_QUIRK(SANDISK, SDCZ4_256, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
333             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
334         USB_QUIRK(SANDISK, SDDR31, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
335             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_READ_CAP_OFFBY1),
336         USB_QUIRK(SCANLOGIC, SL11R, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
337             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_INQUIRY),
338         USB_QUIRK(SHUTTLE, EUSB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
339             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_NO_TEST_UNIT_READY,
340             UQ_MSC_NO_START_STOP, UQ_MSC_SHUTTLE_INIT),
341         USB_QUIRK(SHUTTLE, CDRW, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
342             UQ_MSC_FORCE_PROTO_ATAPI),
343         USB_QUIRK(SHUTTLE, CF, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
344             UQ_MSC_FORCE_PROTO_ATAPI),
345         USB_QUIRK(SHUTTLE, EUSBATAPI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
346             UQ_MSC_FORCE_PROTO_ATAPI),
347         USB_QUIRK(SHUTTLE, EUSBCFSM, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
348         USB_QUIRK(SHUTTLE, EUSCSI, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
349             UQ_MSC_FORCE_PROTO_SCSI),
350         USB_QUIRK(SHUTTLE, HIFD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
351             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
352         USB_QUIRK(SHUTTLE, SDDR09, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI,
353             UQ_MSC_NO_GETMAXLUN),
354         USB_QUIRK(SHUTTLE, ZIOMMC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
355             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
356         USB_QUIRK(SIGMATEL, I_BEAD100, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
357             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_SHUTTLE_INIT),
358         USB_QUIRK(SIIG, WINTERREADER, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
359             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_IGNORE_RESIDUE),
360         USB_QUIRK(SKANHEX, MD_7425, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
361             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
362         USB_QUIRK(SKANHEX, SX_520Z, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
363             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
364         USB_QUIRK(SONY, HANDYCAM, 0x0500, 0x0500, UQ_MSC_FORCE_WIRE_CBI,
365             UQ_MSC_FORCE_PROTO_RBC, UQ_MSC_RBC_PAD_TO_12),
366         USB_QUIRK(SONY, CLIE_40_MS, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
367             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
368         USB_QUIRK(SONY, DSC, 0x0500, 0x0500, UQ_MSC_FORCE_WIRE_CBI,
369             UQ_MSC_FORCE_PROTO_RBC, UQ_MSC_RBC_PAD_TO_12),
370         USB_QUIRK(SONY, DSC, 0x0600, 0x0600, UQ_MSC_FORCE_WIRE_CBI,
371             UQ_MSC_FORCE_PROTO_RBC, UQ_MSC_RBC_PAD_TO_12),
372         USB_QUIRK(SONY, DSC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
373             UQ_MSC_FORCE_PROTO_RBC),
374         USB_QUIRK(SONY, HANDYCAM, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
375             UQ_MSC_FORCE_PROTO_RBC),
376         USB_QUIRK(SONY, MSC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
377             UQ_MSC_FORCE_PROTO_RBC),
378         USB_QUIRK(SONY, MS_MSC_U03, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
379             UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_GETMAXLUN),
380         USB_QUIRK(SONY, MS_NW_MS7, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
381             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
382         USB_QUIRK(SONY, MS_PEG_N760C, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
383             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
384         USB_QUIRK(SONY, MSACUS1, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
385             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_GETMAXLUN),
386         USB_QUIRK(SONY, PORTABLE_HDD_V2, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
387             UQ_MSC_FORCE_PROTO_SCSI),
388         USB_QUIRK(SUPERTOP, IDE, 0x0000, 0xffff, UQ_MSC_IGNORE_RESIDUE,
389             UQ_MSC_NO_SYNC_CACHE),
390         USB_QUIRK(TAUGA, CAMERAMATE, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
391         USB_QUIRK(TEAC, FD05PUB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
392             UQ_MSC_FORCE_PROTO_UFI),
393         USB_QUIRK(TECLAST, TLC300, 0x0000, 0xffff, UQ_MSC_NO_TEST_UNIT_READY,
394             UQ_MSC_NO_SYNC_CACHE),
395         USB_QUIRK(TREK, MEMKEY, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
396             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
397         USB_QUIRK(TREK, THUMBDRIVE_8MB, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
398             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_IGNORE_RESIDUE),
399         USB_QUIRK(TRUMPION, C3310, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
400             UQ_MSC_FORCE_PROTO_UFI),
401         USB_QUIRK(TRUMPION, MP3, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_RBC),
402         USB_QUIRK(TRUMPION, T33520, 0x0000, 0xffff, UQ_MSC_FORCE_PROTO_SCSI),
403         USB_QUIRK(TWINMOS, MDIV, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
404             UQ_MSC_FORCE_PROTO_SCSI),
405         USB_QUIRK(VIA, USB2IDEBRIDGE, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
406             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_SYNC_CACHE),
407         USB_QUIRK(VIVITAR, 35XX, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
408             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
409         USB_QUIRK(WESTERN, COMBO, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
410             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
411             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
412         USB_QUIRK(WESTERN, EXTHDD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
413             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
414             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
415         USB_QUIRK(WESTERN, MYBOOK, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
416             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY_EVPD,
417             UQ_MSC_NO_SYNC_CACHE),
418         USB_QUIRK(WESTERN, MYPASSWORD, 0x0000, 0xffff, UQ_MSC_FORCE_SHORT_INQ),
419         USB_QUIRK(WINMAXGROUP, FLASH64MC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
420             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY),
421         USB_QUIRK(YANO, FW800HD, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
422             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_FORCE_SHORT_INQ,
423             UQ_MSC_NO_START_STOP, UQ_MSC_IGNORE_RESIDUE),
424         USB_QUIRK(YANO, U640MO, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI_I,
425             UQ_MSC_FORCE_PROTO_ATAPI, UQ_MSC_FORCE_SHORT_INQ),
426         USB_QUIRK(YEDATA, FLASHBUSTERU, 0x0000, 0x007F, UQ_MSC_FORCE_WIRE_CBI,
427             UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_FLOPPY_SPEED,
428             UQ_MSC_NO_TEST_UNIT_READY, UQ_MSC_NO_GETMAXLUN),
429         USB_QUIRK(YEDATA, FLASHBUSTERU, 0x0080, 0x0080, UQ_MSC_FORCE_WIRE_CBI_I,
430             UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_FLOPPY_SPEED,
431             UQ_MSC_NO_TEST_UNIT_READY, UQ_MSC_NO_GETMAXLUN),
432         USB_QUIRK(YEDATA, FLASHBUSTERU, 0x0081, 0xFFFF, UQ_MSC_FORCE_WIRE_CBI_I,
433             UQ_MSC_FORCE_PROTO_UFI, UQ_MSC_NO_RS_CLEAR_UA, UQ_MSC_FLOPPY_SPEED,
434             UQ_MSC_NO_GETMAXLUN),
435         USB_QUIRK(ZORAN, EX20DSC, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_CBI,
436             UQ_MSC_FORCE_PROTO_ATAPI),
437         USB_QUIRK(MEIZU, M6_SL, 0x0000, 0xffff, UQ_MSC_FORCE_WIRE_BBB,
438             UQ_MSC_FORCE_PROTO_SCSI, UQ_MSC_NO_INQUIRY, UQ_MSC_NO_SYNC_CACHE),
439
440         /* Non-standard USB MIDI devices */
441         USB_QUIRK(ROLAND, UM1, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
442         USB_QUIRK(ROLAND, SC8850, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
443         USB_QUIRK(ROLAND, SD90, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
444         USB_QUIRK(ROLAND, UM880N, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
445         USB_QUIRK(ROLAND, UA100, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
446         USB_QUIRK(ROLAND, UM4, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
447         USB_QUIRK(ROLAND, U8, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
448         USB_QUIRK(ROLAND, UM2, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
449         USB_QUIRK(ROLAND, SC8820, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
450         USB_QUIRK(ROLAND, PC300, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
451         USB_QUIRK(ROLAND, SK500, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
452         USB_QUIRK(ROLAND, SCD70, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
453         USB_QUIRK(ROLAND, UM550, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
454         USB_QUIRK(ROLAND, SD20, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
455         USB_QUIRK(ROLAND, SD80, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
456         USB_QUIRK(ROLAND, UA700, 0x0000, 0xffff, UQ_AU_VENDOR_CLASS),
457         USB_QUIRK(MEDELI, DD305, 0x0000, 0xffff, UQ_SINGLE_CMD_MIDI, UQ_MATCH_VENDOR_ONLY),
458
459         /*
460          * Quirks for manufacturers which USB devices does not respond
461          * after issuing non-supported commands:
462          */
463         USB_QUIRK(ALCOR, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MSC_NO_TEST_UNIT_READY, UQ_MATCH_VENDOR_ONLY),
464         USB_QUIRK(FEIYA, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
465         USB_QUIRK(REALTEK, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
466         USB_QUIRK(INITIO, DUMMY, 0x0000, 0xffff, UQ_MSC_NO_SYNC_CACHE, UQ_MATCH_VENDOR_ONLY),
467 };
468 #undef USB_QUIRK_VP
469 #undef USB_QUIRK
470
471 static const char *usb_quirk_str[USB_QUIRK_MAX] = {
472         [UQ_NONE]               = "UQ_NONE",
473         [UQ_MATCH_VENDOR_ONLY]  = "UQ_MATCH_VENDOR_ONLY",
474         [UQ_AUDIO_SWAP_LR]      = "UQ_AUDIO_SWAP_LR",
475         [UQ_AU_INP_ASYNC]       = "UQ_AU_INP_ASYNC",
476         [UQ_AU_NO_FRAC]         = "UQ_AU_NO_FRAC",
477         [UQ_AU_NO_XU]           = "UQ_AU_NO_XU",
478         [UQ_BAD_ADC]            = "UQ_BAD_ADC",
479         [UQ_BAD_AUDIO]          = "UQ_BAD_AUDIO",
480         [UQ_BROKEN_BIDIR]       = "UQ_BROKEN_BIDIR",
481         [UQ_BUS_POWERED]        = "UQ_BUS_POWERED",
482         [UQ_HID_IGNORE]         = "UQ_HID_IGNORE",
483         [UQ_KBD_IGNORE]         = "UQ_KBD_IGNORE",
484         [UQ_KBD_BOOTPROTO]      = "UQ_KBD_BOOTPROTO",
485         [UQ_MS_BAD_CLASS]       = "UQ_MS_BAD_CLASS",
486         [UQ_MS_LEADING_BYTE]    = "UQ_MS_LEADING_BYTE",
487         [UQ_MS_REVZ]            = "UQ_MS_REVZ",
488         [UQ_NO_STRINGS]         = "UQ_NO_STRINGS",
489         [UQ_OPEN_CLEARSTALL]    = "UQ_OPEN_CLEARSTALL",
490         [UQ_POWER_CLAIM]        = "UQ_POWER_CLAIM",
491         [UQ_SPUR_BUT_UP]        = "UQ_SPUR_BUT_UP",
492         [UQ_SWAP_UNICODE]       = "UQ_SWAP_UNICODE",
493         [UQ_CFG_INDEX_1]        = "UQ_CFG_INDEX_1",
494         [UQ_CFG_INDEX_2]        = "UQ_CFG_INDEX_2",
495         [UQ_CFG_INDEX_3]        = "UQ_CFG_INDEX_3",
496         [UQ_CFG_INDEX_4]        = "UQ_CFG_INDEX_4",
497         [UQ_CFG_INDEX_0]        = "UQ_CFG_INDEX_0",
498         [UQ_ASSUME_CM_OVER_DATA]        = "UQ_ASSUME_CM_OVER_DATA",
499         [UQ_MSC_NO_TEST_UNIT_READY]     = "UQ_MSC_NO_TEST_UNIT_READY",
500         [UQ_MSC_NO_RS_CLEAR_UA]         = "UQ_MSC_NO_RS_CLEAR_UA",
501         [UQ_MSC_NO_START_STOP]          = "UQ_MSC_NO_START_STOP",
502         [UQ_MSC_NO_GETMAXLUN]           = "UQ_MSC_NO_GETMAXLUN",
503         [UQ_MSC_NO_INQUIRY]             = "UQ_MSC_NO_INQUIRY",
504         [UQ_MSC_NO_INQUIRY_EVPD]        = "UQ_MSC_NO_INQUIRY_EVPD",
505         [UQ_MSC_NO_SYNC_CACHE]          = "UQ_MSC_NO_SYNC_CACHE",
506         [UQ_MSC_SHUTTLE_INIT]           = "UQ_MSC_SHUTTLE_INIT",
507         [UQ_MSC_ALT_IFACE_1]            = "UQ_MSC_ALT_IFACE_1",
508         [UQ_MSC_FLOPPY_SPEED]           = "UQ_MSC_FLOPPY_SPEED",
509         [UQ_MSC_IGNORE_RESIDUE]         = "UQ_MSC_IGNORE_RESIDUE",
510         [UQ_MSC_WRONG_CSWSIG]           = "UQ_MSC_WRONG_CSWSIG",
511         [UQ_MSC_RBC_PAD_TO_12]          = "UQ_MSC_RBC_PAD_TO_12",
512         [UQ_MSC_READ_CAP_OFFBY1]        = "UQ_MSC_READ_CAP_OFFBY1",
513         [UQ_MSC_FORCE_SHORT_INQ]        = "UQ_MSC_FORCE_SHORT_INQ",
514         [UQ_MSC_FORCE_WIRE_BBB]         = "UQ_MSC_FORCE_WIRE_BBB",
515         [UQ_MSC_FORCE_WIRE_CBI]         = "UQ_MSC_FORCE_WIRE_CBI",
516         [UQ_MSC_FORCE_WIRE_CBI_I]       = "UQ_MSC_FORCE_WIRE_CBI_I",
517         [UQ_MSC_FORCE_PROTO_SCSI]       = "UQ_MSC_FORCE_PROTO_SCSI",
518         [UQ_MSC_FORCE_PROTO_ATAPI]      = "UQ_MSC_FORCE_PROTO_ATAPI",
519         [UQ_MSC_FORCE_PROTO_UFI]        = "UQ_MSC_FORCE_PROTO_UFI",
520         [UQ_MSC_FORCE_PROTO_RBC]        = "UQ_MSC_FORCE_PROTO_RBC",
521         [UQ_MSC_EJECT_HUAWEI]           = "UQ_MSC_EJECT_HUAWEI",
522         [UQ_MSC_EJECT_SIERRA]           = "UQ_MSC_EJECT_SIERRA",
523         [UQ_MSC_EJECT_SCSIEJECT]        = "UQ_MSC_EJECT_SCSIEJECT",
524         [UQ_MSC_EJECT_REZERO]           = "UQ_MSC_EJECT_REZERO",
525         [UQ_MSC_EJECT_ZTESTOR]          = "UQ_MSC_EJECT_ZTESTOR",
526         [UQ_MSC_EJECT_CMOTECH]          = "UQ_MSC_EJECT_CMOTECH",
527         [UQ_MSC_EJECT_WAIT]             = "UQ_MSC_EJECT_WAIT",
528         [UQ_MSC_EJECT_SAEL_M460]        = "UQ_MSC_EJECT_SAEL_M460",
529         [UQ_MSC_EJECT_HUAWEISCSI]       = "UQ_MSC_EJECT_HUAWEISCSI",
530         [UQ_MSC_EJECT_TCT]              = "UQ_MSC_EJECT_TCT",
531         [UQ_BAD_MIDI]                   = "UQ_BAD_MIDI",
532         [UQ_AU_VENDOR_CLASS]            = "UQ_AU_VENDOR_CLASS",
533         [UQ_SINGLE_CMD_MIDI]            = "UQ_SINGLE_CMD_MIDI",
534 };
535
536 /*------------------------------------------------------------------------*
537  *      usb_quirkstr
538  *
539  * This function converts an USB quirk code into a string.
540  *------------------------------------------------------------------------*/
541 static const char *
542 usb_quirkstr(uint16_t quirk)
543 {
544         return ((quirk < USB_QUIRK_MAX) ?
545             usb_quirk_str[quirk] : "USB_QUIRK_UNKNOWN");
546 }
547
548 /*------------------------------------------------------------------------*
549  *      usb_test_quirk_by_info
550  *
551  * Returns:
552  * 0: Quirk not found
553  * Else: Quirk found
554  *------------------------------------------------------------------------*/
555 static uint8_t
556 usb_test_quirk_by_info(const struct usbd_lookup_info *info, uint16_t quirk)
557 {
558         uint16_t x;
559         uint16_t y;
560
561         if (quirk == UQ_NONE)
562                 goto done;
563
564         mtx_lock(&usb_quirk_mtx);
565
566         for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) {
567                 /* see if quirk information does not match */
568                 if ((usb_quirks[x].vid != info->idVendor) ||
569                     (usb_quirks[x].lo_rev > info->bcdDevice) ||
570                     (usb_quirks[x].hi_rev < info->bcdDevice)) {
571                         continue;
572                 }
573                 /* see if quirk only should match vendor ID */
574                 if (usb_quirks[x].pid != info->idProduct) {
575                         if (usb_quirks[x].pid != 0)
576                                 continue;
577
578                         for (y = 0; y != USB_SUB_QUIRKS_MAX; y++) {
579                                 if (usb_quirks[x].quirks[y] == UQ_MATCH_VENDOR_ONLY)
580                                         break;
581                         }
582                         if (y == USB_SUB_QUIRKS_MAX)
583                                 continue;
584                 }
585                 /* lookup quirk */
586                 for (y = 0; y != USB_SUB_QUIRKS_MAX; y++) {
587                         if (usb_quirks[x].quirks[y] == quirk) {
588                                 mtx_unlock(&usb_quirk_mtx);
589                                 DPRINTF("Found quirk '%s'.\n", usb_quirkstr(quirk));
590                                 return (1);
591                         }
592                 }
593                 /* no quirk found */
594                 break;
595         }
596         mtx_unlock(&usb_quirk_mtx);
597 done:
598         return (0);                     /* no quirk match */
599 }
600
601 static struct usb_quirk_entry *
602 usb_quirk_get_entry(uint16_t vid, uint16_t pid,
603     uint16_t lo_rev, uint16_t hi_rev, uint8_t do_alloc)
604 {
605         uint16_t x;
606
607         mtx_assert(&usb_quirk_mtx, MA_OWNED);
608
609         if ((vid | pid | lo_rev | hi_rev) == 0) {
610                 /* all zero - special case */
611                 return (usb_quirks + USB_DEV_QUIRKS_MAX - 1);
612         }
613         /* search for an existing entry */
614         for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) {
615                 /* see if quirk information does not match */
616                 if ((usb_quirks[x].vid != vid) ||
617                     (usb_quirks[x].pid != pid) ||
618                     (usb_quirks[x].lo_rev != lo_rev) ||
619                     (usb_quirks[x].hi_rev != hi_rev)) {
620                         continue;
621                 }
622                 return (usb_quirks + x);
623         }
624
625         if (do_alloc == 0) {
626                 /* no match */
627                 return (NULL);
628         }
629         /* search for a free entry */
630         for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) {
631                 /* see if quirk information does not match */
632                 if ((usb_quirks[x].vid |
633                     usb_quirks[x].pid |
634                     usb_quirks[x].lo_rev |
635                     usb_quirks[x].hi_rev) != 0) {
636                         continue;
637                 }
638                 usb_quirks[x].vid = vid;
639                 usb_quirks[x].pid = pid;
640                 usb_quirks[x].lo_rev = lo_rev;
641                 usb_quirks[x].hi_rev = hi_rev;
642
643                 return (usb_quirks + x);
644         }
645
646         /* no entry found */
647         return (NULL);
648 }
649
650 /*------------------------------------------------------------------------*
651  *      usb_quirk_ioctl - handle quirk IOCTLs
652  *
653  * Returns:
654  * 0: Success
655  * Else: Failure
656  *------------------------------------------------------------------------*/
657 static int
658 usb_quirk_ioctl(unsigned long cmd, caddr_t data,
659     int fflag, struct thread *td)
660 {
661         struct usb_gen_quirk *pgq;
662         struct usb_quirk_entry *pqe;
663         uint32_t x;
664         uint32_t y;
665         int err;
666
667         switch (cmd) {
668         case USB_DEV_QUIRK_GET:
669                 pgq = (void *)data;
670                 x = pgq->index % USB_SUB_QUIRKS_MAX;
671                 y = pgq->index / USB_SUB_QUIRKS_MAX;
672                 if (y >= USB_DEV_QUIRKS_MAX) {
673                         return (EINVAL);
674                 }
675                 mtx_lock(&usb_quirk_mtx);
676                 /* copy out data */
677                 pgq->vid = usb_quirks[y].vid;
678                 pgq->pid = usb_quirks[y].pid;
679                 pgq->bcdDeviceLow = usb_quirks[y].lo_rev;
680                 pgq->bcdDeviceHigh = usb_quirks[y].hi_rev;
681                 strlcpy(pgq->quirkname,
682                     usb_quirkstr(usb_quirks[y].quirks[x]),
683                     sizeof(pgq->quirkname));
684                 mtx_unlock(&usb_quirk_mtx);
685                 return (0);             /* success */
686
687         case USB_QUIRK_NAME_GET:
688                 pgq = (void *)data;
689                 x = pgq->index;
690                 if (x >= USB_QUIRK_MAX) {
691                         return (EINVAL);
692                 }
693                 strlcpy(pgq->quirkname,
694                     usb_quirkstr(x), sizeof(pgq->quirkname));
695                 return (0);             /* success */
696
697         case USB_DEV_QUIRK_ADD:
698                 pgq = (void *)data;
699
700                 /* check privileges */
701                 err = priv_check(curthread, PRIV_DRIVER);
702                 if (err) {
703                         return (err);
704                 }
705                 /* convert quirk string into numerical */
706                 for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) {
707                         if (strcmp(pgq->quirkname, usb_quirkstr(y)) == 0) {
708                                 break;
709                         }
710                 }
711                 if (y == USB_DEV_QUIRKS_MAX) {
712                         return (EINVAL);
713                 }
714                 if (y == UQ_NONE) {
715                         return (EINVAL);
716                 }
717                 mtx_lock(&usb_quirk_mtx);
718                 pqe = usb_quirk_get_entry(pgq->vid, pgq->pid,
719                     pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 1);
720                 if (pqe == NULL) {
721                         mtx_unlock(&usb_quirk_mtx);
722                         return (EINVAL);
723                 }
724                 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) {
725                         if (pqe->quirks[x] == UQ_NONE) {
726                                 pqe->quirks[x] = y;
727                                 break;
728                         }
729                 }
730                 mtx_unlock(&usb_quirk_mtx);
731                 if (x == USB_SUB_QUIRKS_MAX) {
732                         return (ENOMEM);
733                 }
734                 return (0);             /* success */
735
736         case USB_DEV_QUIRK_REMOVE:
737                 pgq = (void *)data;
738                 /* check privileges */
739                 err = priv_check(curthread, PRIV_DRIVER);
740                 if (err) {
741                         return (err);
742                 }
743                 /* convert quirk string into numerical */
744                 for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) {
745                         if (strcmp(pgq->quirkname, usb_quirkstr(y)) == 0) {
746                                 break;
747                         }
748                 }
749                 if (y == USB_DEV_QUIRKS_MAX) {
750                         return (EINVAL);
751                 }
752                 if (y == UQ_NONE) {
753                         return (EINVAL);
754                 }
755                 mtx_lock(&usb_quirk_mtx);
756                 pqe = usb_quirk_get_entry(pgq->vid, pgq->pid,
757                     pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 0);
758                 if (pqe == NULL) {
759                         mtx_unlock(&usb_quirk_mtx);
760                         return (EINVAL);
761                 }
762                 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) {
763                         if (pqe->quirks[x] == y) {
764                                 pqe->quirks[x] = UQ_NONE;
765                                 break;
766                         }
767                 }
768                 if (x == USB_SUB_QUIRKS_MAX) {
769                         mtx_unlock(&usb_quirk_mtx);
770                         return (ENOMEM);
771                 }
772                 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) {
773                         if (pqe->quirks[x] != UQ_NONE) {
774                                 break;
775                         }
776                 }
777                 if (x == USB_SUB_QUIRKS_MAX) {
778                         /* all quirk entries are unused - release */
779                         memset(pqe, 0, sizeof(pqe));
780                 }
781                 mtx_unlock(&usb_quirk_mtx);
782                 return (0);             /* success */
783
784         default:
785                 break;
786         }
787         return (ENOIOCTL);
788 }
789
790 static void
791 usb_quirk_init(void *arg)
792 {
793         /* initialize mutex */
794         mtx_init(&usb_quirk_mtx, "USB quirk", NULL, MTX_DEF);
795
796         /* register our function */
797         usb_test_quirk_p = &usb_test_quirk_by_info;
798         usb_quirk_ioctl_p = &usb_quirk_ioctl;
799 }
800
801 static void
802 usb_quirk_uninit(void *arg)
803 {
804         usb_quirk_unload(arg);
805
806         /* destroy mutex */
807         mtx_destroy(&usb_quirk_mtx);
808 }
809
810 SYSINIT(usb_quirk_init, SI_SUB_LOCK, SI_ORDER_FIRST, usb_quirk_init, NULL);
811 SYSUNINIT(usb_quirk_uninit, SI_SUB_LOCK, SI_ORDER_ANY, usb_quirk_uninit, NULL);