xref: /netbsd-src/sys/dev/usb/umass_quirks.c (revision 0dd5877adce57db949b16ae963e5a6831cccdfb6)
1 /*	$NetBSD: umass_quirks.c,v 1.12 2002/02/20 22:28:54 augustss 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_FUJIPHOTO, USB_PRODUCT_FUJIPHOTO_MASS0100 },
62 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
63 	  UMASS_QUIRK_NO_START_STOP,
64 	  PQUIRK_NOTUR | PQUIRK_NOSENSE,
65 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
66 	  NULL, NULL
67 	},
68 
69 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_USBCABLE },
70 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
71 	  UMASS_QUIRK_NO_START_STOP,
72 	  PQUIRK_NOTUR,
73 	  UMATCH_VENDOR_PRODUCT,
74 	  umass_init_insystem, NULL
75 	},
76 
77 	{ { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP100 },
78 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
79 	  0,
80 	  PQUIRK_NOTUR,
81 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
82 	  NULL, NULL
83 	},
84 
85 	{ { USB_VENDOR_IOMEGA, USB_PRODUCT_IOMEGA_ZIP250 },
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_MICROTECH, USB_PRODUCT_MICROTECH_DPCM },
94 	  UMASS_WPROTO_CBI, UMASS_CPROTO_ATAPI,
95 	  0,
96 	  0,
97 	  UMATCH_VENDOR_PRODUCT,
98 	  NULL, NULL
99 	},
100 
101 	{ { USB_VENDOR_MSYSTEMS, USB_PRODUCT_MSYSTEMS_DISKONKEY },
102 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
103 	  0,
104 	  PQUIRK_NOMODESENSE | PQUIRK_NODOORLOCK | PQUIRK_NOBIGMODESENSE,
105 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
106 	  NULL, NULL
107 	},
108 
109 	{ { USB_VENDOR_OLYMPUS, USB_PRODUCT_OLYMPUS_C1 },
110 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
111 	  UMASS_QUIRK_WRONG_CSWSIG,
112 	  0,
113 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
114 	  NULL, NULL
115 	},
116 
117 	{ { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD2 },
118 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
119 	  0,
120 	  PQUIRK_NOMODESENSE,
121 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
122 	  NULL, NULL
123 	},
124 
125 	{ { USB_VENDOR_ONSPEC, USB_PRODUCT_ONSPEC_MD1II },
126 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
127 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
128 	  PQUIRK_NOMODESENSE,
129 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
130 	  NULL, NULL
131 	},
132 
133 	{ { USB_VENDOR_SCANLOGIC, USB_PRODUCT_SCANLOGIC_SL11R },
134 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
135 	  0,
136 	  0,
137 	  UMATCH_VENDOR_PRODUCT,
138 	  NULL, NULL
139 	},
140 
141 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_EUSB },
142 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
143 	  UMASS_QUIRK_NO_START_STOP,
144 	  PQUIRK_NOTUR,
145 	  UMATCH_VENDOR_PRODUCT,
146 	  umass_init_shuttle, NULL
147 	},
148 
149 	{ { USB_VENDOR_SHUTTLE, USB_PRODUCT_SHUTTLE_ZIOMMC },
150 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
151 	  UMASS_QUIRK_NO_START_STOP,
152 	  PQUIRK_NOTUR,
153 	  UMATCH_VENDOR_PRODUCT,
154 	  NULL, NULL
155 	},
156 
157 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_MSC },
158 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
159 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY,
160 	  0,
161 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
162 	  NULL, umass_fixup_sony
163 	},
164 
165 	{ { USB_VENDOR_SONY, USB_PRODUCT_ANY },
166 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_RBC,
167 	  0,
168 	  0,
169 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
170 	  NULL, umass_fixup_sony
171 	},
172 
173 	{ { USB_VENDOR_TEAC, USB_PRODUCT_TEAC_FD05PUB },
174 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
175 	  0,
176 	  PQUIRK_NOMODESENSE,
177 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
178 	  NULL, NULL
179 	},
180 
181 	{ { USB_VENDOR_YANO, USB_PRODUCT_YANO_U640MO },
182 	  UMASS_WPROTO_CBI_I, UMASS_CPROTO_ATAPI,
183 	  UMASS_QUIRK_FORCE_SHORT_INQUIRY,
184 	  0,
185 	  UMATCH_VENDOR_PRODUCT,
186 	  NULL, NULL
187 	},
188 
189 	{ { USB_VENDOR_YEDATA, USB_PRODUCT_YEDATA_FLASHBUSTERU },
190 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UFI,
191 	  UMASS_QUIRK_RS_NO_CLEAR_UA,
192 	  PQUIRK_NOMODESENSE,
193 	  UMATCH_VENDOR_PRODUCT_REV,
194 	  NULL, umass_fixup_yedata
195 	},
196 
197 	{ { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_S304 },
198 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
199 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
200 	  0,
201 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
202 	  NULL, NULL
203 	},
204 
205 	{ { USB_VENDOR_MINOLTA, USB_PRODUCT_MINOLTA_X },
206 	  UMASS_WPROTO_UNSPEC, UMASS_CPROTO_UNSPEC,
207 	  UMASS_QUIRK_NO_MAX_LUN | UMASS_QUIRK_NO_START_STOP,
208 	  0,
209 	  UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO,
210 	  NULL, NULL
211 	},
212 
213 	/* InSystem Design ATA over USB devices */
214 	{ { USB_VENDOR_ATI, USB_PRODUCT_ATI2_205 },
215 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
216 	  0,
217 	  0,
218 	  UMATCH_VENDOR_PRODUCT,
219 	  NULL, NULL
220 	},
221 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ATAPI },
222 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
223 	  0,
224 	  0,
225 	  UMATCH_VENDOR_PRODUCT,
226 	  NULL, NULL
227 	},
228 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_DRIVEV2_5 },
229 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
230 	  0,
231 	  0,
232 	  UMATCH_VENDOR_PRODUCT,
233 	  NULL, NULL
234 	},
235 	{ { USB_VENDOR_INSYSTEM, USB_PRODUCT_INSYSTEM_ADAPTERV2 },
236 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
237 	  0,
238 	  0,
239 	  UMATCH_VENDOR_PRODUCT,
240 	  NULL, NULL
241 	},
242 	{ { USB_VENDOR_SONY, USB_PRODUCT_SONY_DRIVEV2 },
243 	  UMASS_WPROTO_BBB, UMASS_CPROTO_ISD_ATA,
244 	  0,
245 	  0,
246 	  UMATCH_VENDOR_PRODUCT,
247 	  NULL, NULL
248 	},
249 };
250 
251 const struct umass_quirk *
252 umass_lookup(u_int16_t vendor, u_int16_t product)
253 {
254 	return ((const struct umass_quirk *)
255 		usb_lookup(umass_quirks, vendor, product));
256 }
257 
258 Static usbd_status
259 umass_init_insystem(struct umass_softc *sc)
260 {
261 	usbd_status err;
262 
263 	err = usbd_set_interface(sc->sc_iface, 1);
264 	if (err) {
265 		DPRINTF(UDMASS_USB,
266 			("%s: could not switch to Alt Interface 1\n",
267 			USBDEVNAME(sc->sc_dev)));
268 		return (err);
269 	}
270 
271 	return (USBD_NORMAL_COMPLETION);
272 }
273 
274 Static usbd_status
275 umass_init_shuttle(struct umass_softc *sc)
276 {
277 	usb_device_request_t req;
278 	u_int8_t status[2];
279 
280 	/* The Linux driver does this */
281 	req.bmRequestType = UT_READ_VENDOR_DEVICE;
282 	req.bRequest = 1;
283 	USETW(req.wValue, 0);
284 	USETW(req.wIndex, sc->sc_ifaceno);
285 	USETW(req.wLength, sizeof(status));
286 
287 	return (usbd_do_request(sc->sc_udev, &req, &status));
288 }
289 
290 Static void
291 umass_fixup_sony(struct umass_softc *sc)
292 {
293 	usb_interface_descriptor_t *id;
294 
295 	id = usbd_get_interface_descriptor(sc->sc_iface);
296 	if (id->bInterfaceSubClass == 0xff) {
297 		sc->sc_cmd = UMASS_CPROTO_RBC;
298 	}
299 }
300 
301 Static void
302 umass_fixup_yedata(struct umass_softc *sc)
303 {
304 	usb_device_descriptor_t *dd;
305 
306 	dd = usbd_get_device_descriptor(sc->sc_udev);
307 
308 	/*
309 	 * Revisions < 1.28 do not handle the interrupt endpoint very well.
310 	 */
311 	if (UGETW(dd->bcdDevice) < 0x128)
312 		sc->sc_wire = UMASS_WPROTO_CBI;
313 	else
314 		sc->sc_wire = UMASS_WPROTO_CBI_I;
315 
316 	/*
317 	 * Revisions < 1.28 do not have the TEST UNIT READY command
318 	 * Revisions == 1.28 have a broken TEST UNIT READY
319 	 */
320 	if (UGETW(dd->bcdDevice) <= 0x128)
321 		sc->sc_busquirks |= PQUIRK_NOTUR;
322 }
323