xref: /netbsd-src/sys/dev/usb/umass_quirks.c (revision 08c81a9c2dc8c7300e893321eb65c0925d60871c)
1 /*	$NetBSD: umass_quirks.c,v 1.19 2002/09/10 16:52:48 nathanw Exp $	*/
2 
3 /*
4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by MAEKAWA Masahide (gehenna@NetBSD.org).
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	  This product includes software developed by the NetBSD
21  *	  Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/device.h>
42 #include <sys/buf.h>
43 
44 #include <dev/scsipi/scsipi_all.h> /* for scsiconf.h below */
45 #include <dev/scsipi/scsiconf.h> /* for quirks defines */
46 
47 #include <dev/usb/usb.h>
48 #include <dev/usb/usbdi.h>
49 #include <dev/usb/usbdevs.h>
50 
51 #include <dev/usb/umassvar.h>
52 #include <dev/usb/umass_quirks.h>
53 
54 Static usbd_status umass_init_insystem(struct umass_softc *);
55 Static usbd_status umass_init_shuttle(struct umass_softc *);
56 
57 Static void umass_fixup_sony(struct umass_softc *);
58 Static void umass_fixup_yedata(struct umass_softc *);
59 
60 Static const struct umass_quirk umass_quirks[] = {
61         { { USB_VENDOR_DMI, USB_PRODUCT_DMI_SA2_0 },
62 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
63           0,
64           PQUIRK_NOMODESENSE,
65 	  UMATCH_VENDOR_PRODUCT,
66 	  NULL, NULL
67 	},
68 
69 	{ { USB_VENDOR_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100 },
70 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
71 	  UMASS_QUIRK_NO_START_STOP,
72 	  PQUIRK_NOTUR | PQUIRK_NOSENSE,
73 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
74 	  NULL, NULL
75 	},
76 
77 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE },
78 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
79 	  UMASS_QUIRK_NO_START_STOP,
80 	  PQUIRK_NOTUR,
81 	  UMATCH_VENDOR_PRODUCT,
82 	  umass_init_insystem, NULL
83 	},
84 
85 	{ { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100 },
86 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
87 	  0,
88 	  PQUIRK_NOTUR,
89 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
90 	  NULL, NULL
91 	},
92 
93 	{ { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP250 },
94 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
95 	  0,
96 	  PQUIRK_NOTUR,
97 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
98 	  NULL, NULL
99 	},
100 
101 	{ { USB_VENDOR_MICROTECH, USB_PRODUCT_MICROTECH_DPCM },
102 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
103 	  0,
104 	  0,
105 	  UMATCH_VENDOR_PRODUCT,
106 	  NULL, NULL
107 	},
108 
109 	{ { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY },
110 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
111 	  UMASS_QUIRK_NO_MAX_LUN,
112 	  PQUIRK_NOMODESENSE | PQUIRK_NODOORLOCK | PQUIRK_NOBIGMODESENSE,
113 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
114 	  NULL, NULL
115 	},
116 
117 	{ { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1 },
118 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
119 	  UMASS_QUIRK_WRONG_CSWSIG,
120 	  0,
121 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
122 	  NULL, NULL
123 	},
124 
125 	{ { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD2 },
126 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
127 	  0,
128 	  PQUIRK_NOMODESENSE,
129 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
130 	  NULL, NULL
131 	},
132 
133 	{ { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD1II },
134 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
135 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
136 	  PQUIRK_NOMODESENSE,
137 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
138 	  NULL, NULL
139 	},
140 
141 	{ { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R },
142 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
143 	  0,
144 	  0,
145 	  UMATCH_VENDOR_PRODUCT,
146 	  NULL, NULL
147 	},
148 
149 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB },
150 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
151 	  UMASS_QUIRK_NO_START_STOP,
152 	  PQUIRK_NOTUR,
153 	  UMATCH_VENDOR_PRODUCT,
154 	  umass_init_shuttle, NULL
155 	},
156 
157 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ZIOMMC },
158 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
159 	  UMASS_QUIRK_NO_START_STOP,
160 	  PQUIRK_NOTUR,
161 	  UMATCH_VENDOR_PRODUCT,
162 	  NULL, NULL
163 	},
164 
165 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC },
166 	  UMASS_WPROTO_CBI, UMASS_CPROTO_UFI,
167 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY | UMASS_QUIRK_RS_NO_CLEAR_UA,
168 	  PQUIRK_NOMODESENSE,
169 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
170 	  NULL, NULL
171 	},
172 
173 	{ { USB_VENDOR_SONY, USB_PRODUCT_ANY },
174 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
175 	  0,
176 	  0,
177 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
178 	  NULL, umass_fixup_sony
179 	},
180 
181 	{ { USB_VENDOR_TEAC, USB_PRODUCT_TEAC_FD05PUB },
182 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
183 	  0,
184 	  PQUIRK_NOMODESENSE,
185 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
186 	  NULL, NULL
187 	},
188 
189 	{ { USB_VENDOR_TRUMPION, USB_PRODUCT_TRUMPION_XXX1100 },
190 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
191 	  0,
192 	  0,
193 	  UMATCH_VENDOR_PRODUCT,
194 	  NULL, NULL
195 	},
196 
197 	{ { USB_VENDOR_YANO, USB_PRODUCT_YANO_U640MO },
198 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
199 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY,
200 	  0,
201 	  UMATCH_VENDOR_PRODUCT,
202 	  NULL, NULL
203 	},
204 
205 	{ { USB_VENDOR_YEDATA, USB_PRODUCT_YEDATA_FLASHBUSTERU },
206 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
207 	  UMASS_QUIRK_RS_NO_CLEAR_UA,
208 	  PQUIRK_NOMODESENSE,
209 	  UMATCH_VENDOR_PRODUCT_REV,
210 	  NULL, umass_fixup_yedata
211 	},
212 
213 	{ { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_S304 },
214 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
215 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
216 	  0,
217 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
218 	  NULL, NULL
219 	},
220 
221 	{ { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_X },
222 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
223 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
224 	  0,
225 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
226 	  NULL, NULL
227 	},
228 
229 	{ { USB_VENDOR_PEN, USB_PRODUCT_PEN_USBDISK },
230 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
231 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
232 	  0,
233 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
234 	  NULL, NULL
235 	},
236 
237 	/* InSystem Design ATA over USB devices */
238 	{ { USB_VENDOR_ATI, USB_PRODUCT_ATI2_205 },
239 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
240 	  0,
241 	  0,
242 	  UMATCH_VENDOR_PRODUCT,
243 	  NULL, NULL
244 	},
245 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI },
246 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
247 	  0,
248 	  0,
249 	  UMATCH_VENDOR_PRODUCT,
250 	  NULL, NULL
251 	},
252 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_DRIVEV2_5 },
253 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
254 	  0,
255 	  0,
256 	  UMATCH_VENDOR_PRODUCT,
257 	  NULL, NULL
258 	},
259 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ADAPTERV2 },
260 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
261 	  0,
262 	  0,
263 	  UMATCH_VENDOR_PRODUCT,
264 	  NULL, NULL
265 	},
266 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_DRIVEV2 },
267 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
268 	  0,
269 	  0,
270 	  UMATCH_VENDOR_PRODUCT,
271 	  NULL, NULL
272 	},
273 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_IDEUSB2 },
274 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
275 	  0,
276 	  PQUIRK_NOMODESENSE,
277 	  UMATCH_VENDOR_PRODUCT,
278 	  NULL, NULL
279 	},
280 	{ { USB_VENDOR_NEODIO, USB_PRODUCT_NEODIO_ND5010 },
281 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
282 	  0,
283 	  PQUIRK_NOMODESENSE | PQUIRK_FORCELUNS,
284 	  UMATCH_VENDOR_PRODUCT,
285 	  NULL, NULL
286 	},
287 };
288 
289 const struct umass_quirk *
290 umass_lookup(u_int16_t vendor, u_int16_t product)
291 {
292 	return ((const struct umass_quirk *)
293 		usb_lookup(umass_quirks, vendor, product));
294 }
295 
296 Static usbd_status
297 umass_init_insystem(struct umass_softc *sc)
298 {
299 	usbd_status err;
300 
301 	err = usbd_set_interface(sc->sc_iface, 1);
302 	if (err) {
303 		DPRINTF(UDMASS_USB,
304 			("%s: could not switch to Alt Interface 1\n",
305 			USBDEVNAME(sc->sc_dev)));
306 		return (err);
307 	}
308 
309 	return (USBD_NORMAL_COMPLETION);
310 }
311 
312 Static usbd_status
313 umass_init_shuttle(struct umass_softc *sc)
314 {
315 	usb_device_request_t req;
316 	u_int8_t status[2];
317 
318 	/* The Linux driver does this */
319 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
320 	req.bRequest = 1;
321 	USETW(req.wValue, 0);
322 	USETW(req.wIndex, sc->sc_ifaceno);
323 	USETW(req.wLength, sizeof(status));
324 
325 	return (usbd_do_request(sc->sc_udev, &req, &status));
326 }
327 
328 Static void
329 umass_fixup_sony(struct umass_softc *sc)
330 {
331 	usb_interface_descriptor_t *id;
332 
333 	id = usbd_get_interface_descriptor(sc->sc_iface);
334 	if (id->bInterfaceSubClass == 0xff) {
335 		sc->sc_cmd = UMASS_CPROTO_RBC;
336 	}
337 }
338 
339 Static void
340 umass_fixup_yedata(struct umass_softc *sc)
341 {
342 	usb_device_descriptor_t *dd;
343 
344 	dd = usbd_get_device_descriptor(sc->sc_udev);
345 
346 	/*
347 	 * Revisions < 1.28 do not handle the interrupt endpoint very well.
348 	 */
349 	if (UGETW(dd->bcdDevice) < 0x128)
350 		sc->sc_wire = UMASS_WPROTO_CBI;
351 	else
352 		sc->sc_wire = UMASS_WPROTO_CBI_I;
353 
354 	/*
355 	 * Revisions < 1.28 do not have the TEST UNIT READY command
356 	 * Revisions == 1.28 have a broken TEST UNIT READY
357 	 */
358 	if (UGETW(dd->bcdDevice) <= 0x128)
359 		sc->sc_busquirks |= PQUIRK_NOTUR;
360 }
361