xref: /openbsd/sys/dev/usb/usb_quirks.c (revision 404b540a)
1 /*	$OpenBSD: usb_quirks.c,v 1.52 2009/05/11 08:07:42 yuo Exp $ */
2 /*	$NetBSD: usb_quirks.c,v 1.45 2003/05/10 17:47:14 hamajima Exp $	*/
3 /*	$FreeBSD: src/sys/dev/usb/usb_quirks.c,v 1.30 2003/01/02 04:15:55 imp Exp $	*/
4 
5 /*
6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to The NetBSD Foundation
10  * by Lennart Augustsson (lennart@augustsson.net) at
11  * Carlstedt Research & Technology.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 
38 #include <dev/usb/usb.h>
39 
40 #include <dev/usb/usbdevs.h>
41 #include <dev/usb/usb_quirks.h>
42 
43 #ifdef USB_DEBUG
44 extern int usbdebug;
45 #endif
46 
47 #define ANY 0xffff
48 
49 const struct usbd_quirk_entry {
50 	u_int16_t idVendor;
51 	u_int16_t idProduct;
52 	u_int16_t bcdDevice;
53 	struct usbd_quirks quirks;
54 } usb_quirks[] = {
55  { USB_VENDOR_KYE, USB_PRODUCT_KYE_NICHE,	    0x100, { UQ_NO_SET_PROTO}},
56  { USB_VENDOR_INSIDEOUT, USB_PRODUCT_INSIDEOUT_EDGEPORT4,
57    						    0x094, { UQ_SWAP_UNICODE}},
58  { USB_VENDOR_DALLAS, USB_PRODUCT_DALLAS_J6502,	    0x0a2, { UQ_BAD_ADC }},
59  { USB_VENDOR_DALLAS, USB_PRODUCT_DALLAS_J6502,	    0x0a2, { UQ_AU_NO_XU }},
60  { USB_VENDOR_ALTEC, USB_PRODUCT_ALTEC_ADA70,	    0x103, { UQ_BAD_ADC }},
61  { USB_VENDOR_ALTEC, USB_PRODUCT_ALTEC_ASC495,      0x000, { UQ_BAD_AUDIO }},
62  { USB_VENDOR_LOGITECH, USB_PRODUCT_LOGITECH_QUICKCAMNBDLX,
63 	0x100, { UQ_BAD_AUDIO }},
64  { USB_VENDOR_LOGITECH, USB_PRODUCT_LOGITECH_QUICKCAMPRONB,
65 	0x000, { UQ_BAD_AUDIO }},
66  { USB_VENDOR_LOGITECH, USB_PRODUCT_LOGITECH_QUICKCAMPRO4K,
67 	0x000, { UQ_BAD_AUDIO }},
68  { USB_VENDOR_LOGITECH, USB_PRODUCT_LOGITECH_QUICKCAMZOOM,
69 	0x000, { UQ_BAD_AUDIO }},
70  { USB_VENDOR_QTRONIX, USB_PRODUCT_QTRONIX_980N,    0x110, { UQ_SPUR_BUT_UP }},
71  { USB_VENDOR_ALCOR2, USB_PRODUCT_ALCOR2_KBD_HUB,   0x001, { UQ_SPUR_BUT_UP }},
72  { USB_VENDOR_MCT, USB_PRODUCT_MCT_HUB0100,         0x102, { UQ_BUS_POWERED }},
73  { USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232,          0x102, { UQ_BUS_POWERED }},
74  { USB_VENDOR_METRICOM, USB_PRODUCT_METRICOM_RICOCHET_GS,
75  	0x100, { UQ_ASSUME_CM_OVER_DATA }},
76  { USB_VENDOR_SANYO, USB_PRODUCT_SANYO_SCP4900,
77  	0x000, { UQ_ASSUME_CM_OVER_DATA }},
78  { USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_T720C,
79 	0x001, { UQ_ASSUME_CM_OVER_DATA }},
80  { USB_VENDOR_EICON, USB_PRODUCT_EICON_DIVA852,
81 	0x100, { UQ_ASSUME_CM_OVER_DATA }},
82  /* YAMAHA router's ucdDevice is the version of farmware and often changes. */
83  { USB_VENDOR_YAMAHA, USB_PRODUCT_YAMAHA_RTA54I,
84 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
85  { USB_VENDOR_YAMAHA, USB_PRODUCT_YAMAHA_RTA55I,
86 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
87  { USB_VENDOR_YAMAHA, USB_PRODUCT_YAMAHA_RTW65B,
88 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
89  { USB_VENDOR_YAMAHA, USB_PRODUCT_YAMAHA_RTW65I,
90 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
91  { USB_VENDOR_QUALCOMM, USB_PRODUCT_QUALCOMM_MSM_MODEM,
92 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
93  { USB_VENDOR_QUALCOMM2, USB_PRODUCT_QUALCOMM2_MSM_PHONE,
94 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
95  { USB_VENDOR_SUNTAC, USB_PRODUCT_SUNTAC_AS64LX,
96 	0x100, { UQ_ASSUME_CM_OVER_DATA }},
97  { USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CM5100P,
98 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
99  { USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CCU550,
100 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
101  { USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CNU550pro,
102 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
103  { USB_VENDOR_SIEMENS2, USB_PRODUCT_SIEMENS2_ES75,
104 	ANY, { UQ_ASSUME_CM_OVER_DATA }},
105 
106  { USB_VENDOR_TI, USB_PRODUCT_TI_UTUSB41,	    0x110, { UQ_POWER_CLAIM }},
107  { USB_VENDOR_TELEX, USB_PRODUCT_TELEX_MIC1,	    0x009, { UQ_AU_NO_FRAC }},
108  { USB_VENDOR_SILICONPORTALS, USB_PRODUCT_SILICONPORTALS_YAPPHONE,
109    						    0x100, { UQ_AU_INP_ASYNC }},
110  { USB_VENDOR_AVANCELOGIC, USB_PRODUCT_AVANCELOGIC_USBAUDIO,
111    						    0x101, { UQ_AU_INP_ASYNC }},
112  { USB_VENDOR_PLANTRONICS, USB_PRODUCT_PLANTRONICS_HEADSET,
113    						    0x004, { UQ_AU_INP_ASYNC }},
114 
115  { USB_VENDOR_TERRATEC, USB_PRODUCT_TERRATEC_AUREON,
116    						    ANY, { UQ_BAD_HID }},
117 
118  /* XXX These should have a revision number, but I don't know what they are. */
119  { USB_VENDOR_HP, USB_PRODUCT_HP_895C,		    ANY,   { UQ_BROKEN_BIDIR }},
120  { USB_VENDOR_HP, USB_PRODUCT_HP_880C,		    ANY,   { UQ_BROKEN_BIDIR }},
121  { USB_VENDOR_HP, USB_PRODUCT_HP_815C,		    ANY,   { UQ_BROKEN_BIDIR }},
122  { USB_VENDOR_HP, USB_PRODUCT_HP_810C,		    ANY,   { UQ_BROKEN_BIDIR }},
123  { USB_VENDOR_HP, USB_PRODUCT_HP_830C,		    ANY,   { UQ_BROKEN_BIDIR }},
124  { USB_VENDOR_HP, USB_PRODUCT_HP_885C,		    ANY,   { UQ_BROKEN_BIDIR }},
125  { USB_VENDOR_HP, USB_PRODUCT_HP_840C,		    ANY,   { UQ_BROKEN_BIDIR }},
126  { USB_VENDOR_HP, USB_PRODUCT_HP_816C,		    ANY,   { UQ_BROKEN_BIDIR }},
127  { USB_VENDOR_HP, USB_PRODUCT_HP_959C,		    ANY,   { UQ_BROKEN_BIDIR }},
128  { USB_VENDOR_HP, USB_PRODUCT_HP_1220C,		    ANY,   { UQ_BROKEN_BIDIR }},
129  { USB_VENDOR_ITUNER, USB_PRODUCT_ITUNER_USBLCD20x2,	    ANY,   { UQ_BAD_HID }},
130  { USB_VENDOR_NEC, USB_PRODUCT_NEC_PICTY900,	    ANY,   { UQ_BROKEN_BIDIR }},
131  { USB_VENDOR_NEC, USB_PRODUCT_NEC_PICTY760,	    ANY,   { UQ_BROKEN_BIDIR }},
132  { USB_VENDOR_NEC, USB_PRODUCT_NEC_PICTY920,	    ANY,   { UQ_BROKEN_BIDIR }},
133  { USB_VENDOR_NEC, USB_PRODUCT_NEC_PICTY800,	    ANY,   { UQ_BROKEN_BIDIR }},
134  { USB_VENDOR_MECANIQUE, USB_PRODUCT_MECANIQUE_WISPY, ANY,   { UQ_BAD_HID }},
135  { USB_VENDOR_OMRON, USB_PRODUCT_OMRON_BX35F,       ANY,   { UQ_BAD_HID }},
136  { USB_VENDOR_OMRON, USB_PRODUCT_OMRON_BX50F,       ANY,   { UQ_BAD_HID }},
137  { USB_VENDOR_TENX, USB_PRODUCT_TENX_MISSILE,	    ANY,   { UQ_BAD_HID }},
138  { USB_VENDOR_APC, USB_PRODUCT_APC_UPSPRO500,	    ANY,   { UQ_BAD_HID }},
139  { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F6C550AVR, ANY,   { UQ_BAD_HID }},
140  { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F6C1500EITWRK,    ANY,    { UQ_BAD_HID }},
141  { USB_VENDOR_MGE, USB_PRODUCT_MGE_UPS1,	    ANY,   { UQ_BAD_HID }},
142  { USB_VENDOR_MGE, USB_PRODUCT_MGE_UPS2,	    ANY,   { UQ_BAD_HID }},
143  { USB_VENDOR_CYBERPOWER, USB_PRODUCT_CYBERPOWER_1500,	ANY,	{ UQ_BAD_HID }},
144  { USB_VENDOR_MUSTEK2, USB_PRODUCT_MUSTEK2_PM800,	ANY,	{ UQ_BAD_HID }},
145  { USB_VENDOR_LIEBERT, USB_PRODUCT_LIEBERT_POWERSURE_PXT, ANY, { UQ_BAD_HID }},
146 
147   /* MS keyboards do weird things */
148   { USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLNOTEBOOK,
149 	ANY, { UQ_MS_BAD_CLASS | UQ_MS_LEADING_BYTE }},
150   { USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLNOTEBOOK2,
151 	ANY, { UQ_MS_BAD_CLASS | UQ_MS_LEADING_BYTE }},
152   { USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLINTELLIMOUSE,
153 	ANY, { UQ_MS_LEADING_BYTE }},
154 
155  /* SISPM devices */
156  { USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_SISPM_OLD,	    ANY,   { UQ_BAD_HID }},
157  { USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_SISPM,	    ANY,   { UQ_BAD_HID }},
158  { USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_SISPM_FLASH,	    ANY,   { UQ_BAD_HID }},
159 
160  /* HUAWEI devices */
161  { USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E220,	ANY,	{ UQ_NO_STRINGS }},
162 
163  { 0, 0, 0, { 0 } }
164 };
165 
166 #define bANY 0xff
167 const struct usbd_dev_quirk_entry {
168 	u_int8_t bDeviceClass;
169 	u_int8_t bDeviceSubClass;
170 	u_int8_t bDeviceProtocol;
171 	struct usbd_quirks quirks;
172 } usb_dev_quirks[] = {
173  { 0, 0, 0, { 0 } }
174 };
175 
176 const struct usbd_quirks usbd_no_quirk = { 0 };
177 
178 const struct usbd_quirks *
179 usbd_find_quirk(usb_device_descriptor_t *d)
180 {
181 	const struct usbd_quirk_entry *t;
182 	const struct usbd_dev_quirk_entry *td;
183 	u_int16_t vendor = UGETW(d->idVendor);
184 	u_int16_t product = UGETW(d->idProduct);
185 	u_int16_t revision = UGETW(d->bcdDevice);
186 
187 	/* search device specific quirks entry */
188 	for (t = usb_quirks; t->idVendor != 0; t++) {
189 		if (t->idVendor  == vendor &&
190 		    t->idProduct == product &&
191 		    (t->bcdDevice == ANY || t->bcdDevice == revision)) {
192 #ifdef USB_DEBUG
193 			if (usbdebug && t->quirks.uq_flags)
194 				printf("usbd_find_quirk for specific device 0x%04x/0x%04x/%x: %d\n",
195 					vendor, product, UGETW(d->bcdDevice),
196 					t->quirks.uq_flags);
197 #endif
198 
199 			return (&t->quirks);
200 		}
201 	}
202 	/* no device specific quirks found, search class specific entry */
203 	for (td = usb_dev_quirks; td->bDeviceClass != 0; td++) {
204 		if (td->bDeviceClass == d->bDeviceClass &&
205 		    (td->bDeviceSubClass == bANY ||
206 		     td->bDeviceSubClass == d->bDeviceSubClass) &&
207 		    (td->bDeviceProtocol == bANY ||
208 		     td->bDeviceProtocol == d->bDeviceProtocol)) {
209 #ifdef USB_DEBUG
210 			if (usbdebug && td->quirks.uq_flags)
211 				printf("usbd_find_quirk for device class 0x%02x/0x%02x/%x: %d\n",
212 					d->bDeviceClass, d->bDeviceSubClass,
213 					UGETW(d->bcdDevice),
214 					td->quirks.uq_flags);
215 #endif
216 			return (&td->quirks);
217 		}
218 	}
219 
220 	return (&usbd_no_quirk);
221 }
222