xref: /freebsd/sys/dev/usb/serial/u3g.c (revision 71ccf09269546d398fa847168fc74c22d6338a62)
1 /*
2  * Copyright (c) 2008 AnyWi Technologies
3  * Author: Andrea Guzzo <aguzzo@anywi.com>
4  * * based on uark.c 1.1 2006/08/14 08:30:22 jsg *
5  * * parts from ubsa.c 183348 2008-09-25 12:00:56Z phk *
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  *
19  * $FreeBSD$
20  */
21 
22 /*
23  * NOTE:
24  *
25  * - The detour through the tty layer is ridiculously expensive wrt
26  *   buffering due to the high speeds.
27  *
28  *   We should consider adding a simple r/w device which allows
29  *   attaching of PPP in a more efficient way.
30  *
31  */
32 
33 
34 #include <sys/stdint.h>
35 #include <sys/stddef.h>
36 #include <sys/param.h>
37 #include <sys/queue.h>
38 #include <sys/types.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/bus.h>
42 #include <sys/linker_set.h>
43 #include <sys/module.h>
44 #include <sys/lock.h>
45 #include <sys/mutex.h>
46 #include <sys/condvar.h>
47 #include <sys/sysctl.h>
48 #include <sys/sx.h>
49 #include <sys/unistd.h>
50 #include <sys/callout.h>
51 #include <sys/malloc.h>
52 #include <sys/priv.h>
53 
54 #include <dev/usb/usb.h>
55 #include <dev/usb/usbdi.h>
56 #include <dev/usb/usbdi_util.h>
57 #include "usbdevs.h"
58 
59 #define	USB_DEBUG_VAR u3g_debug
60 #include <dev/usb/usb_debug.h>
61 #include <dev/usb/usb_process.h>
62 #include <dev/usb/usb_dynamic.h>
63 #include <dev/usb/usb_msctest.h>
64 #include <dev/usb/usb_device.h>
65 
66 #include <dev/usb/serial/usb_serial.h>
67 
68 #if USB_DEBUG
69 static int u3g_debug = 0;
70 
71 SYSCTL_NODE(_hw_usb, OID_AUTO, u3g, CTLFLAG_RW, 0, "USB 3g");
72 SYSCTL_INT(_hw_usb_u3g, OID_AUTO, debug, CTLFLAG_RW,
73     &u3g_debug, 0, "Debug level");
74 #endif
75 
76 #define	U3G_MAXPORTS		8
77 #define	U3G_CONFIG_INDEX	0
78 #define	U3G_BSIZE		2048
79 
80 #define	U3GSP_GPRS		0
81 #define	U3GSP_EDGE		1
82 #define	U3GSP_CDMA		2
83 #define	U3GSP_UMTS		3
84 #define	U3GSP_HSDPA		4
85 #define	U3GSP_HSUPA		5
86 #define	U3GSP_HSPA		6
87 #define	U3GSP_MAX		7
88 
89 #define	U3GFL_HUAWEI_INIT	0x0001	/* Init command required */
90 #define	U3GFL_SCSI_EJECT	0x0002	/* SCSI eject command required */
91 #define	U3GFL_SIERRA_INIT	0x0004	/* Init command required */
92 #define	U3GFL_SAEL_M460_INIT	0x0008	/* Init device */
93 
94 enum {
95 	U3G_BULK_WR,
96 	U3G_BULK_RD,
97 	U3G_N_TRANSFER,
98 };
99 
100 struct u3g_softc {
101 	struct ucom_super_softc sc_super_ucom;
102 	struct ucom_softc sc_ucom[U3G_MAXPORTS];
103 
104 	struct usb_xfer *sc_xfer[U3G_MAXPORTS][U3G_N_TRANSFER];
105 	struct usb_device *sc_udev;
106 	struct mtx sc_mtx;
107 
108 	uint8_t	sc_lsr;			/* local status register */
109 	uint8_t	sc_msr;			/* U3G status register */
110 	uint8_t	sc_numports;
111 };
112 
113 static device_probe_t u3g_probe;
114 static device_attach_t u3g_attach;
115 static device_detach_t u3g_detach;
116 
117 static usb_callback_t u3g_write_callback;
118 static usb_callback_t u3g_read_callback;
119 
120 static void u3g_start_read(struct ucom_softc *ucom);
121 static void u3g_stop_read(struct ucom_softc *ucom);
122 static void u3g_start_write(struct ucom_softc *ucom);
123 static void u3g_stop_write(struct ucom_softc *ucom);
124 
125 
126 static void u3g_test_autoinst(void *, struct usb_device *,
127 		struct usb_attach_arg *);
128 static int u3g_driver_loaded(struct module *mod, int what, void *arg);
129 
130 static eventhandler_tag u3g_etag;
131 
132 static const struct usb_config u3g_config[U3G_N_TRANSFER] = {
133 
134 	[U3G_BULK_WR] = {
135 		.type = UE_BULK,
136 		.endpoint = UE_ADDR_ANY,
137 		.direction = UE_DIR_OUT,
138 		.bufsize = U3G_BSIZE,/* bytes */
139 		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
140 		.callback = &u3g_write_callback,
141 	},
142 
143 	[U3G_BULK_RD] = {
144 		.type = UE_BULK,
145 		.endpoint = UE_ADDR_ANY,
146 		.direction = UE_DIR_IN,
147 		.bufsize = U3G_BSIZE,/* bytes */
148 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
149 		.callback = &u3g_read_callback,
150 	},
151 };
152 
153 static const struct ucom_callback u3g_callback = {
154 	.ucom_start_read = &u3g_start_read,
155 	.ucom_stop_read = &u3g_stop_read,
156 	.ucom_start_write = &u3g_start_write,
157 	.ucom_stop_write = &u3g_stop_write,
158 };
159 
160 static device_method_t u3g_methods[] = {
161 	DEVMETHOD(device_probe, u3g_probe),
162 	DEVMETHOD(device_attach, u3g_attach),
163 	DEVMETHOD(device_detach, u3g_detach),
164 	{0, 0}
165 };
166 
167 static devclass_t u3g_devclass;
168 
169 static driver_t u3g_driver = {
170 	.name = "u3g",
171 	.methods = u3g_methods,
172 	.size = sizeof(struct u3g_softc),
173 };
174 
175 DRIVER_MODULE(u3g, uhub, u3g_driver, u3g_devclass, u3g_driver_loaded, 0);
176 MODULE_DEPEND(u3g, ucom, 1, 1, 1);
177 MODULE_DEPEND(u3g, usb, 1, 1, 1);
178 
179 static const struct usb_device_id u3g_devs[] = {
180 #define	U3G_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
181 	U3G_DEV(ACERP, H10, 0),
182 	U3G_DEV(AIRPLUS, MCD650, 0),
183 	U3G_DEV(AIRPRIME, PC5220, 0),
184 	U3G_DEV(ALINK, 3G, 0),
185 	U3G_DEV(ALINK, 3GU, 0),
186 	U3G_DEV(ALINK, DWM652U5, 0),
187 	U3G_DEV(AMOI, H01, 0),
188 	U3G_DEV(AMOI, H01A, 0),
189 	U3G_DEV(AMOI, H02, 0),
190 	U3G_DEV(ANYDATA, ADU_500A, 0),
191 	U3G_DEV(ANYDATA, ADU_620UW, 0),
192 	U3G_DEV(ANYDATA, ADU_E100X, 0),
193 	U3G_DEV(AXESSTEL, DATAMODEM, 0),
194 	U3G_DEV(CMOTECH, CDMA_MODEM1, 0),
195 	U3G_DEV(DELL, U5500, 0),
196 	U3G_DEV(DELL, U5505, 0),
197 	U3G_DEV(DELL, U5510, 0),
198 	U3G_DEV(DELL, U5520, 0),
199 	U3G_DEV(DELL, U5520_2, 0),
200 	U3G_DEV(DELL, U5520_3, 0),
201 	U3G_DEV(DELL, U5700, 0),
202 	U3G_DEV(DELL, U5700_2, 0),
203 	U3G_DEV(DELL, U5700_3, 0),
204 	U3G_DEV(DELL, U5700_4, 0),
205 	U3G_DEV(DELL, U5720, 0),
206 	U3G_DEV(DELL, U5720_2, 0),
207 	U3G_DEV(DELL, U5730, 0),
208 	U3G_DEV(DELL, U5730_2, 0),
209 	U3G_DEV(DELL, U5730_3, 0),
210 	U3G_DEV(DELL, U740, 0),
211 	U3G_DEV(DLINK3, DWM652, 0),
212 	U3G_DEV(HP, EV2200, 0),
213 	U3G_DEV(HP, HS2300, 0),
214 	U3G_DEV(HUAWEI, E1401, U3GFL_HUAWEI_INIT),
215 	U3G_DEV(HUAWEI, E1402, U3GFL_HUAWEI_INIT),
216 	U3G_DEV(HUAWEI, E1403, U3GFL_HUAWEI_INIT),
217 	U3G_DEV(HUAWEI, E1404, U3GFL_HUAWEI_INIT),
218 	U3G_DEV(HUAWEI, E1405, U3GFL_HUAWEI_INIT),
219 	U3G_DEV(HUAWEI, E1406, U3GFL_HUAWEI_INIT),
220 	U3G_DEV(HUAWEI, E1407, U3GFL_HUAWEI_INIT),
221 	U3G_DEV(HUAWEI, E1408, U3GFL_HUAWEI_INIT),
222 	U3G_DEV(HUAWEI, E1409, U3GFL_HUAWEI_INIT),
223 	U3G_DEV(HUAWEI, E140A, U3GFL_HUAWEI_INIT),
224 	U3G_DEV(HUAWEI, E140B, U3GFL_HUAWEI_INIT),
225 	U3G_DEV(HUAWEI, E140D, U3GFL_HUAWEI_INIT),
226 	U3G_DEV(HUAWEI, E140E, U3GFL_HUAWEI_INIT),
227 	U3G_DEV(HUAWEI, E140F, U3GFL_HUAWEI_INIT),
228 	U3G_DEV(HUAWEI, E1410, U3GFL_HUAWEI_INIT),
229 	U3G_DEV(HUAWEI, E1411, U3GFL_HUAWEI_INIT),
230 	U3G_DEV(HUAWEI, E1412, U3GFL_HUAWEI_INIT),
231 	U3G_DEV(HUAWEI, E1413, U3GFL_HUAWEI_INIT),
232 	U3G_DEV(HUAWEI, E1414, U3GFL_HUAWEI_INIT),
233 	U3G_DEV(HUAWEI, E1415, U3GFL_HUAWEI_INIT),
234 	U3G_DEV(HUAWEI, E1416, U3GFL_HUAWEI_INIT),
235 	U3G_DEV(HUAWEI, E1417, U3GFL_HUAWEI_INIT),
236 	U3G_DEV(HUAWEI, E1418, U3GFL_HUAWEI_INIT),
237 	U3G_DEV(HUAWEI, E1419, U3GFL_HUAWEI_INIT),
238 	U3G_DEV(HUAWEI, E141A, U3GFL_HUAWEI_INIT),
239 	U3G_DEV(HUAWEI, E141B, U3GFL_HUAWEI_INIT),
240 	U3G_DEV(HUAWEI, E141C, U3GFL_HUAWEI_INIT),
241 	U3G_DEV(HUAWEI, E141D, U3GFL_HUAWEI_INIT),
242 	U3G_DEV(HUAWEI, E141E, U3GFL_HUAWEI_INIT),
243 	U3G_DEV(HUAWEI, E141F, U3GFL_HUAWEI_INIT),
244 	U3G_DEV(HUAWEI, E1420, U3GFL_HUAWEI_INIT),
245 	U3G_DEV(HUAWEI, E1421, U3GFL_HUAWEI_INIT),
246 	U3G_DEV(HUAWEI, E1422, U3GFL_HUAWEI_INIT),
247 	U3G_DEV(HUAWEI, E1423, U3GFL_HUAWEI_INIT),
248 	U3G_DEV(HUAWEI, E1424, U3GFL_HUAWEI_INIT),
249 	U3G_DEV(HUAWEI, E1425, U3GFL_HUAWEI_INIT),
250 	U3G_DEV(HUAWEI, E1426, U3GFL_HUAWEI_INIT),
251 	U3G_DEV(HUAWEI, E1427, U3GFL_HUAWEI_INIT),
252 	U3G_DEV(HUAWEI, E1428, U3GFL_HUAWEI_INIT),
253 	U3G_DEV(HUAWEI, E1429, U3GFL_HUAWEI_INIT),
254 	U3G_DEV(HUAWEI, E142A, U3GFL_HUAWEI_INIT),
255 	U3G_DEV(HUAWEI, E142B, U3GFL_HUAWEI_INIT),
256 	U3G_DEV(HUAWEI, E142C, U3GFL_HUAWEI_INIT),
257 	U3G_DEV(HUAWEI, E142D, U3GFL_HUAWEI_INIT),
258 	U3G_DEV(HUAWEI, E142E, U3GFL_HUAWEI_INIT),
259 	U3G_DEV(HUAWEI, E142F, U3GFL_HUAWEI_INIT),
260 	U3G_DEV(HUAWEI, E1430, U3GFL_HUAWEI_INIT),
261 	U3G_DEV(HUAWEI, E1431, U3GFL_HUAWEI_INIT),
262 	U3G_DEV(HUAWEI, E1432, U3GFL_HUAWEI_INIT),
263 	U3G_DEV(HUAWEI, E1433, U3GFL_HUAWEI_INIT),
264 	U3G_DEV(HUAWEI, E1434, U3GFL_HUAWEI_INIT),
265 	U3G_DEV(HUAWEI, E1435, U3GFL_HUAWEI_INIT),
266 	U3G_DEV(HUAWEI, E1436, U3GFL_HUAWEI_INIT),
267 	U3G_DEV(HUAWEI, E1437, U3GFL_HUAWEI_INIT),
268 	U3G_DEV(HUAWEI, E1438, U3GFL_HUAWEI_INIT),
269 	U3G_DEV(HUAWEI, E1439, U3GFL_HUAWEI_INIT),
270 	U3G_DEV(HUAWEI, E143A, U3GFL_HUAWEI_INIT),
271 	U3G_DEV(HUAWEI, E143B, U3GFL_HUAWEI_INIT),
272 	U3G_DEV(HUAWEI, E143C, U3GFL_HUAWEI_INIT),
273 	U3G_DEV(HUAWEI, E143D, U3GFL_HUAWEI_INIT),
274 	U3G_DEV(HUAWEI, E143E, U3GFL_HUAWEI_INIT),
275 	U3G_DEV(HUAWEI, E143F, U3GFL_HUAWEI_INIT),
276 	U3G_DEV(HUAWEI, E14AC, U3GFL_HUAWEI_INIT),
277 	U3G_DEV(HUAWEI, E180V, U3GFL_HUAWEI_INIT),
278 	U3G_DEV(HUAWEI, E220, U3GFL_HUAWEI_INIT),
279 	U3G_DEV(HUAWEI, E220BIS, U3GFL_HUAWEI_INIT),
280 	U3G_DEV(HUAWEI, MOBILE, U3GFL_HUAWEI_INIT),
281 	U3G_DEV(KYOCERA2, CDMA_MSM_K, 0),
282 	U3G_DEV(KYOCERA2, KPC680, 0),
283 	U3G_DEV(MERLIN, V620, 0),
284 	U3G_DEV(NOVATEL, E725, 0),
285 	U3G_DEV(NOVATEL, ES620, 0),
286 	U3G_DEV(NOVATEL, ES620_2, 0),
287 	U3G_DEV(NOVATEL, EU730, 0),
288 	U3G_DEV(NOVATEL, EU740, 0),
289 	U3G_DEV(NOVATEL, EU870D, 0),
290 	U3G_DEV(NOVATEL, MC760, 0),
291 	U3G_DEV(NOVATEL, MC950D, 0),
292 	U3G_DEV(NOVATEL, U720, 0),
293 	U3G_DEV(NOVATEL, U727, 0),
294 	U3G_DEV(NOVATEL, U727_2, 0),
295 	U3G_DEV(NOVATEL, U740, 0),
296 	U3G_DEV(NOVATEL, U740_2, 0),
297 	U3G_DEV(NOVATEL, U760, U3GFL_SCSI_EJECT),
298 	U3G_DEV(NOVATEL, U870, 0),
299 	U3G_DEV(NOVATEL, V620, 0),
300 	U3G_DEV(NOVATEL, V640, 0),
301 	U3G_DEV(NOVATEL, V720, 0),
302 	U3G_DEV(NOVATEL, V740, 0),
303 	U3G_DEV(NOVATEL, X950D, 0),
304 	U3G_DEV(NOVATEL, XU870, 0),
305 	U3G_DEV(OPTION, E6500, 0),
306 	U3G_DEV(OPTION, E6501, 0),
307 	U3G_DEV(OPTION, E6601, 0),
308 	U3G_DEV(OPTION, E6721, 0),
309 	U3G_DEV(OPTION, E6741, 0),
310 	U3G_DEV(OPTION, E6761, 0),
311 	U3G_DEV(OPTION, E6800, 0),
312 	U3G_DEV(OPTION, E7021, 0),
313 	U3G_DEV(OPTION, E7041, 0),
314 	U3G_DEV(OPTION, E7061, 0),
315 	U3G_DEV(OPTION, E7100, 0),
316 	U3G_DEV(OPTION, GT3G, 0),
317 	U3G_DEV(OPTION, GT3GPLUS, 0),
318 	U3G_DEV(OPTION, GT3GQUAD, 0),
319 	U3G_DEV(OPTION, GT3G_1, 0),
320 	U3G_DEV(OPTION, GT3G_2, 0),
321 	U3G_DEV(OPTION, GT3G_3, 0),
322 	U3G_DEV(OPTION, GT3G_4, 0),
323 	U3G_DEV(OPTION, GT3G_5, 0),
324 	U3G_DEV(OPTION, GT3G_6, 0),
325 	U3G_DEV(OPTION, GTHSDPA, 0),
326 	U3G_DEV(OPTION, GTM380, 0),
327 	U3G_DEV(OPTION, GTMAX36, 0),
328 	U3G_DEV(OPTION, GTMAX380HSUPAE, 0),
329 	U3G_DEV(OPTION, GTMAXHSUPA, 0),
330 	U3G_DEV(OPTION, GTMAXHSUPAE, 0),
331 	U3G_DEV(OPTION, VODAFONEMC3G, 0),
332 	U3G_DEV(QISDA, H20_1, 0),
333 	U3G_DEV(QISDA, H20_2, 0),
334 	U3G_DEV(QISDA, H21_1, 0),
335 	U3G_DEV(QISDA, H21_2, 0),
336 	U3G_DEV(QUALCOMM2, AC8700, 0),
337 	U3G_DEV(QUALCOMM2, MF330, 0),
338 	U3G_DEV(QUALCOMMINC, AC2726, 0),
339 	U3G_DEV(QUALCOMMINC, AC8700, 0),
340 	U3G_DEV(QUALCOMMINC, AC8710, 0),
341 	U3G_DEV(QUALCOMMINC, CDMA_MSM, U3GFL_SCSI_EJECT),
342 	U3G_DEV(QUALCOMMINC, E0002, 0),
343 	U3G_DEV(QUALCOMMINC, E0003, 0),
344 	U3G_DEV(QUALCOMMINC, E0004, 0),
345 	U3G_DEV(QUALCOMMINC, E0005, 0),
346 	U3G_DEV(QUALCOMMINC, E0006, 0),
347 	U3G_DEV(QUALCOMMINC, E0007, 0),
348 	U3G_DEV(QUALCOMMINC, E0008, 0),
349 	U3G_DEV(QUALCOMMINC, E0009, 0),
350 	U3G_DEV(QUALCOMMINC, E000A, 0),
351 	U3G_DEV(QUALCOMMINC, E000B, 0),
352 	U3G_DEV(QUALCOMMINC, E000C, 0),
353 	U3G_DEV(QUALCOMMINC, E000D, 0),
354 	U3G_DEV(QUALCOMMINC, E000E, 0),
355 	U3G_DEV(QUALCOMMINC, E000F, 0),
356 	U3G_DEV(QUALCOMMINC, E0010, 0),
357 	U3G_DEV(QUALCOMMINC, E0011, 0),
358 	U3G_DEV(QUALCOMMINC, E0012, 0),
359 	U3G_DEV(QUALCOMMINC, E0013, 0),
360 	U3G_DEV(QUALCOMMINC, E0014, 0),
361 	U3G_DEV(QUALCOMMINC, E0016, 0),
362 	U3G_DEV(QUALCOMMINC, E0017, 0),
363 	U3G_DEV(QUALCOMMINC, E0018, 0),
364 	U3G_DEV(QUALCOMMINC, E0019, 0),
365 	U3G_DEV(QUALCOMMINC, E0020, 0),
366 	U3G_DEV(QUALCOMMINC, E0021, 0),
367 	U3G_DEV(QUALCOMMINC, E0022, 0),
368 	U3G_DEV(QUALCOMMINC, E0023, 0),
369 	U3G_DEV(QUALCOMMINC, E0024, 0),
370 	U3G_DEV(QUALCOMMINC, E0025, 0),
371 	U3G_DEV(QUALCOMMINC, E0026, 0),
372 	U3G_DEV(QUALCOMMINC, E0027, 0),
373 	U3G_DEV(QUALCOMMINC, E0028, 0),
374 	U3G_DEV(QUALCOMMINC, E0029, 0),
375 	U3G_DEV(QUALCOMMINC, E0030, 0),
376 	U3G_DEV(QUALCOMMINC, E0032, 0),
377 	U3G_DEV(QUALCOMMINC, E0033, 0),
378 	U3G_DEV(QUALCOMMINC, E0037, 0),
379 	U3G_DEV(QUALCOMMINC, E0039, 0),
380 	U3G_DEV(QUALCOMMINC, E0042, 0),
381 	U3G_DEV(QUALCOMMINC, E0043, 0),
382 	U3G_DEV(QUALCOMMINC, E0048, 0),
383 	U3G_DEV(QUALCOMMINC, E0049, 0),
384 	U3G_DEV(QUALCOMMINC, E0051, 0),
385 	U3G_DEV(QUALCOMMINC, E0052, 0),
386 	U3G_DEV(QUALCOMMINC, E0054, 0),
387 	U3G_DEV(QUALCOMMINC, E0055, 0),
388 	U3G_DEV(QUALCOMMINC, E0057, 0),
389 	U3G_DEV(QUALCOMMINC, E0058, 0),
390 	U3G_DEV(QUALCOMMINC, E0059, 0),
391 	U3G_DEV(QUALCOMMINC, E0060, 0),
392 	U3G_DEV(QUALCOMMINC, E0061, 0),
393 	U3G_DEV(QUALCOMMINC, E0062, 0),
394 	U3G_DEV(QUALCOMMINC, E0063, 0),
395 	U3G_DEV(QUALCOMMINC, E0064, 0),
396 	U3G_DEV(QUALCOMMINC, E0066, 0),
397 	U3G_DEV(QUALCOMMINC, E0069, 0),
398 	U3G_DEV(QUALCOMMINC, E0070, 0),
399 	U3G_DEV(QUALCOMMINC, E0073, 0),
400 	U3G_DEV(QUALCOMMINC, E0076, 0),
401 	U3G_DEV(QUALCOMMINC, E0078, 0),
402 	U3G_DEV(QUALCOMMINC, E0082, 0),
403 	U3G_DEV(QUALCOMMINC, E0086, 0),
404 	U3G_DEV(QUALCOMMINC, E2002, 0),
405 	U3G_DEV(QUALCOMMINC, E2003, 0),
406 	U3G_DEV(QUALCOMMINC, MF626, 0),
407 	U3G_DEV(QUALCOMMINC, MF628, 0),
408 	U3G_DEV(QUALCOMMINC, ZTE_STOR, U3GFL_SCSI_EJECT),
409 	U3G_DEV(QUANTA, GKE, 0),
410 	U3G_DEV(QUANTA, GLE, 0),
411 	U3G_DEV(QUANTA, GLX, 0),
412 	U3G_DEV(QUANTA, Q101, 0),
413 	U3G_DEV(QUANTA, Q111, 0),
414 	U3G_DEV(SIERRA, AC402, 0),
415 	U3G_DEV(SIERRA, AC595U, 0),
416 	U3G_DEV(SIERRA, AC597E, 0),
417 	U3G_DEV(SIERRA, AC875E, 0),
418 	U3G_DEV(SIERRA, AC875U, 0),
419 	U3G_DEV(SIERRA, AC875U_2, 0),
420 	U3G_DEV(SIERRA, AC880, 0),
421 	U3G_DEV(SIERRA, AC880E, 0),
422 	U3G_DEV(SIERRA, AC880U, 0),
423 	U3G_DEV(SIERRA, AC881, 0),
424 	U3G_DEV(SIERRA, AC881E, 0),
425 	U3G_DEV(SIERRA, AC881U, 0),
426 	U3G_DEV(SIERRA, AC885E, 0),
427 	U3G_DEV(SIERRA, AC885E_2, 0),
428 	U3G_DEV(SIERRA, AC885U, 0),
429 	U3G_DEV(SIERRA, AIRCARD580, 0),
430 	U3G_DEV(SIERRA, AIRCARD595, 0),
431 	U3G_DEV(SIERRA, AIRCARD875, 0),
432 	U3G_DEV(SIERRA, C22, 0),
433 	U3G_DEV(SIERRA, C597, 0),
434 	U3G_DEV(SIERRA, C888, 0),
435 	U3G_DEV(SIERRA, E0029, 0),
436 	U3G_DEV(SIERRA, E6892, 0),
437 	U3G_DEV(SIERRA, E6893, 0),
438 	U3G_DEV(SIERRA, EM5625, 0),
439 	U3G_DEV(SIERRA, EM5725, 0),
440 	U3G_DEV(SIERRA, MC5720, 0),
441 	U3G_DEV(SIERRA, MC5720_2, 0),
442 	U3G_DEV(SIERRA, MC5725, 0),
443 	U3G_DEV(SIERRA, MC5727, 0),
444 	U3G_DEV(SIERRA, MC5727_2, 0),
445 	U3G_DEV(SIERRA, MC5728, 0),
446 	U3G_DEV(SIERRA, MC8755, 0),
447 	U3G_DEV(SIERRA, MC8755_2, 0),
448 	U3G_DEV(SIERRA, MC8755_3, 0),
449 	U3G_DEV(SIERRA, MC8755_4, 0),
450 	U3G_DEV(SIERRA, MC8765, 0),
451 	U3G_DEV(SIERRA, MC8765_2, 0),
452 	U3G_DEV(SIERRA, MC8765_3, 0),
453 	U3G_DEV(SIERRA, MC8775, 0),
454 	U3G_DEV(SIERRA, MC8775_2, 0),
455 	U3G_DEV(SIERRA, MC8780, 0),
456 	U3G_DEV(SIERRA, MC8780_2, 0),
457 	U3G_DEV(SIERRA, MC8780_3, 0),
458 	U3G_DEV(SIERRA, MC8781, 0),
459 	U3G_DEV(SIERRA, MC8781_2, 0),
460 	U3G_DEV(SIERRA, MC8781_3, 0),
461 	U3G_DEV(SIERRA, MC8785, 0),
462 	U3G_DEV(SIERRA, MC8785_2, 0),
463 	U3G_DEV(SIERRA, MC8790, 0),
464 	U3G_DEV(SIERRA, MC8791, 0),
465 	U3G_DEV(SIERRA, MC8792, 0),
466 	U3G_DEV(SIERRA, MINI5725, 0),
467 	U3G_DEV(SIERRA, T11, 0),
468 	U3G_DEV(SIERRA, T598, 0),
469 	U3G_DEV(SILABS, SAEL, U3GFL_SAEL_M460_INIT),
470 	U3G_DEV(STELERA, C105, 0),
471 	U3G_DEV(STELERA, E1003, 0),
472 	U3G_DEV(STELERA, E1004, 0),
473 	U3G_DEV(STELERA, E1005, 0),
474 	U3G_DEV(STELERA, E1006, 0),
475 	U3G_DEV(STELERA, E1007, 0),
476 	U3G_DEV(STELERA, E1008, 0),
477 	U3G_DEV(STELERA, E1009, 0),
478 	U3G_DEV(STELERA, E100A, 0),
479 	U3G_DEV(STELERA, E100B, 0),
480 	U3G_DEV(STELERA, E100C, 0),
481 	U3G_DEV(STELERA, E100D, 0),
482 	U3G_DEV(STELERA, E100E, 0),
483 	U3G_DEV(STELERA, E100F, 0),
484 	U3G_DEV(STELERA, E1010, 0),
485 	U3G_DEV(STELERA, E1011, 0),
486 	U3G_DEV(STELERA, E1012, 0),
487 	U3G_DEV(TCTMOBILE, X060S, 0),
488 	U3G_DEV(TELIT, UC864E, 0),
489 	U3G_DEV(TELIT, UC864G, 0),
490 	U3G_DEV(TLAYTECH, TEU800, 0),
491 	U3G_DEV(TOSHIBA, G450, 0),
492 	U3G_DEV(TOSHIBA, HSDPA, 0),
493 	U3G_DEV(YISO, C893, 0),
494 	/* Autoinstallers */
495 	U3G_DEV(NOVATEL, ZEROCD, U3GFL_SCSI_EJECT),
496 	U3G_DEV(SIERRA, TRUINSTALL, U3GFL_SIERRA_INIT),
497 #undef	U3G_DEV
498 };
499 
500 static void
501 u3g_sierra_init(struct usb_device *udev)
502 {
503 	struct usb_device_request req;
504 
505 	req.bmRequestType = UT_VENDOR;
506 	req.bRequest = UR_SET_INTERFACE;
507 	USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
508 	USETW(req.wIndex, UHF_PORT_CONNECTION);
509 	USETW(req.wLength, 0);
510 
511 	if (usbd_do_request_flags(udev, NULL, &req,
512 	    NULL, 0, NULL, USB_MS_HZ)) {
513 		/* ignore any errors */
514 	}
515 	return;
516 }
517 
518 static void
519 u3g_huawei_init(struct usb_device *udev)
520 {
521 	struct usb_device_request req;
522 
523 	req.bmRequestType = UT_WRITE_DEVICE;
524 	req.bRequest = UR_SET_FEATURE;
525 	USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
526 	USETW(req.wIndex, UHF_PORT_SUSPEND);
527 	USETW(req.wLength, 0);
528 
529 	if (usbd_do_request_flags(udev, NULL, &req,
530 	    NULL, 0, NULL, USB_MS_HZ)) {
531 		/* ignore any errors */
532 	}
533 	return;
534 }
535 
536 static void
537 u3g_sael_m460_init(struct usb_device *udev)
538 {
539 	static const uint8_t setup[][24] = {
540 	     { 0x41, 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
541 	     { 0x41, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 },
542 	     { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
543 	       0x01, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00,
544 	       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
545 	     { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x40, 0x02 },
546 	     { 0xc1, 0x08, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00 },
547 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
548 	     { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 },
549 	     { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
550 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
551 	     { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
552 	     { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
553 	       0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
554 	     { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
555 	       0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
556 	       0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
557 	     { 0x41, 0x12, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00 },
558 	     { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
559 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
560 	     { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
561 	     { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
562 	       0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
563 	     { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
564 	       0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
565 	       0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
566 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
567 	};
568 
569 	struct usb_device_request req;
570 	usb_error_t err;
571 	uint16_t len;
572 	uint8_t buf[0x300];
573 	uint8_t n;
574 
575 	DPRINTFN(1, "\n");
576 
577 	if (usbd_req_set_alt_interface_no(udev, NULL, 0, 0)) {
578 		DPRINTFN(0, "Alt setting 0 failed\n");
579 		return;
580 	}
581 
582 	for (n = 0; n != (sizeof(setup)/sizeof(setup[0])); n++) {
583 
584 		memcpy(&req, setup[n], sizeof(req));
585 
586 		len = UGETW(req.wLength);
587 		if (req.bmRequestType & UE_DIR_IN) {
588 			if (len > sizeof(buf)) {
589 				DPRINTFN(0, "too small buffer\n");
590 				continue;
591 			}
592 			err = usbd_do_request(udev, NULL, &req, buf);
593 		} else {
594 			if (len > (sizeof(setup[0]) - 8)) {
595 				DPRINTFN(0, "too small buffer\n");
596 				continue;
597 			}
598 			err = usbd_do_request(udev, NULL, &req,
599 			    __DECONST(uint8_t *, &setup[n][8]));
600 		}
601 		if (err) {
602 			DPRINTFN(1, "request %u failed\n",
603 			    (unsigned int)n);
604 			/*
605 			 * Some of the requests will fail. Stop doing
606 			 * requests when we are getting timeouts so
607 			 * that we don't block the explore/attach
608 			 * thread forever.
609 			 */
610 			if (err == USB_ERR_TIMEOUT)
611 				break;
612 		}
613 	}
614 }
615 
616 /*
617  * The following function handles 3G modem devices (E220, Mobile,
618  * etc.) with auto-install flash disks for Windows/MacOSX on the first
619  * interface.  After some command or some delay they change appearance
620  * to a modem.
621  */
622 static void
623 u3g_test_autoinst(void *arg, struct usb_device *udev,
624     struct usb_attach_arg *uaa)
625 {
626 	struct usb_interface *iface;
627 	struct usb_interface_descriptor *id;
628 	uint32_t flags;
629 
630 	if (uaa->dev_state != UAA_DEV_READY)
631 		return;
632 
633 	iface = usbd_get_iface(udev, 0);
634 	if (iface == NULL)
635 		return;
636 	id = iface->idesc;
637 	if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
638 		return;
639 	if (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa)) {
640 		/* no device match */
641 		return;
642 	}
643 	flags = USB_GET_DRIVER_INFO(uaa);
644 
645 	if (flags & U3GFL_HUAWEI_INIT) {
646 		u3g_huawei_init(udev);
647 	} else if (flags & U3GFL_SCSI_EJECT) {
648 		if (usb_test_autoinstall(udev, 0, 1) != 0)
649 			return;
650 	} else if (flags & U3GFL_SIERRA_INIT) {
651 		u3g_sierra_init(udev);
652 	} else {
653 		/* no quirks */
654 		return;
655 	}
656 	uaa->dev_state = UAA_DEV_EJECTING;
657 	return;		/* success */
658 }
659 
660 static int
661 u3g_driver_loaded(struct module *mod, int what, void *arg)
662 {
663 	switch (what) {
664 	case MOD_LOAD:
665 		/* register our autoinstall handler */
666 		u3g_etag = EVENTHANDLER_REGISTER(usb_dev_configured,
667 		    u3g_test_autoinst, NULL, EVENTHANDLER_PRI_ANY);
668 		break;
669 	case MOD_UNLOAD:
670 		EVENTHANDLER_DEREGISTER(usb_dev_configured, u3g_etag);
671 		break;
672 	default:
673 		return (EOPNOTSUPP);
674 	}
675  	return (0);
676 }
677 
678 static int
679 u3g_probe(device_t self)
680 {
681 	struct usb_attach_arg *uaa = device_get_ivars(self);
682 
683 	if (uaa->usb_mode != USB_MODE_HOST) {
684 		return (ENXIO);
685 	}
686 	if (uaa->info.bConfigIndex != U3G_CONFIG_INDEX) {
687 		return (ENXIO);
688 	}
689 	if (uaa->info.bInterfaceClass != UICLASS_VENDOR) {
690 		return (ENXIO);
691 	}
692 	return (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa));
693 }
694 
695 static int
696 u3g_attach(device_t dev)
697 {
698 	struct usb_config u3g_config_tmp[U3G_N_TRANSFER];
699 	struct usb_attach_arg *uaa = device_get_ivars(dev);
700 	struct u3g_softc *sc = device_get_softc(dev);
701 	struct usb_interface *iface;
702 	struct usb_interface_descriptor *id;
703 	uint32_t iface_valid;
704 	int error, flags, nports;
705 	int ep, n;
706 	uint8_t i;
707 
708 	DPRINTF("sc=%p\n", sc);
709 
710 	flags = USB_GET_DRIVER_INFO(uaa);
711 
712 	if (flags & U3GFL_SAEL_M460_INIT)
713 		u3g_sael_m460_init(uaa->device);
714 
715 	/* copy in USB config */
716 	for (n = 0; n != U3G_N_TRANSFER; n++)
717 		u3g_config_tmp[n] = u3g_config[n];
718 
719 	device_set_usb_desc(dev);
720 	mtx_init(&sc->sc_mtx, "u3g", NULL, MTX_DEF);
721 
722 	sc->sc_udev = uaa->device;
723 
724 	/* Claim all interfaces on the device */
725 	iface_valid = 0;
726 	for (i = uaa->info.bIfaceIndex; i < USB_IFACE_MAX; i++) {
727 		iface = usbd_get_iface(uaa->device, i);
728 		if (iface == NULL)
729 			break;
730 		id = usbd_get_interface_descriptor(iface);
731 		if (id == NULL || id->bInterfaceClass != UICLASS_VENDOR)
732 			continue;
733 		usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
734 		iface_valid |= (1<<i);
735 	}
736 
737 	i = 0;		/* interface index */
738 	ep = 0;		/* endpoint index */
739 	nports = 0;	/* number of ports */
740 	while (i < USB_IFACE_MAX) {
741 		if ((iface_valid & (1<<i)) == 0) {
742 			i++;
743 			continue;
744 		}
745 
746 		/* update BULK endpoint index */
747 		for (n = 0; n < U3G_N_TRANSFER; n++)
748 			u3g_config_tmp[n].ep_index = ep;
749 
750 		/* try to allocate a set of BULK endpoints */
751 		error = usbd_transfer_setup(uaa->device, &i,
752 		    sc->sc_xfer[nports], u3g_config_tmp, U3G_N_TRANSFER,
753 		    &sc->sc_ucom[nports], &sc->sc_mtx);
754 		if (error) {
755 			/* next interface */
756 			i++;
757 			ep = 0;
758 			continue;
759 		}
760 
761 		/* set stall by default */
762 		mtx_lock(&sc->sc_mtx);
763 		usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_WR]);
764 		usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_RD]);
765 		mtx_unlock(&sc->sc_mtx);
766 
767 		nports++;	/* found one port */
768 		ep++;
769 		if (nports == U3G_MAXPORTS)
770 			break;
771 	}
772 	if (nports == 0) {
773 		device_printf(dev, "no ports found\n");
774 		goto detach;
775 	}
776 	sc->sc_numports = nports;
777 
778 	error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
779 	    sc->sc_numports, sc, &u3g_callback, &sc->sc_mtx);
780 	if (error) {
781 		DPRINTF("ucom_attach failed\n");
782 		goto detach;
783 	}
784 	if (sc->sc_numports > 1)
785 		device_printf(dev, "Found %u ports.\n", sc->sc_numports);
786 	return (0);
787 
788 detach:
789 	u3g_detach(dev);
790 	return (ENXIO);
791 }
792 
793 static int
794 u3g_detach(device_t dev)
795 {
796 	struct u3g_softc *sc = device_get_softc(dev);
797 	uint8_t m;
798 
799 	DPRINTF("sc=%p\n", sc);
800 
801 	/* NOTE: It is not dangerous to detach more ports than attached! */
802 	ucom_detach(&sc->sc_super_ucom, sc->sc_ucom, U3G_MAXPORTS);
803 
804 	for (m = 0; m != U3G_MAXPORTS; m++)
805 		usbd_transfer_unsetup(sc->sc_xfer[m], U3G_N_TRANSFER);
806 	mtx_destroy(&sc->sc_mtx);
807 
808 	return (0);
809 }
810 
811 static void
812 u3g_start_read(struct ucom_softc *ucom)
813 {
814 	struct u3g_softc *sc = ucom->sc_parent;
815 
816 	/* start read endpoint */
817 	usbd_transfer_start(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_RD]);
818 	return;
819 }
820 
821 static void
822 u3g_stop_read(struct ucom_softc *ucom)
823 {
824 	struct u3g_softc *sc = ucom->sc_parent;
825 
826 	/* stop read endpoint */
827 	usbd_transfer_stop(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_RD]);
828 	return;
829 }
830 
831 static void
832 u3g_start_write(struct ucom_softc *ucom)
833 {
834 	struct u3g_softc *sc = ucom->sc_parent;
835 
836 	usbd_transfer_start(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_WR]);
837 	return;
838 }
839 
840 static void
841 u3g_stop_write(struct ucom_softc *ucom)
842 {
843 	struct u3g_softc *sc = ucom->sc_parent;
844 
845 	usbd_transfer_stop(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_WR]);
846 	return;
847 }
848 
849 static void
850 u3g_write_callback(struct usb_xfer *xfer, usb_error_t error)
851 {
852 	struct ucom_softc *ucom = usbd_xfer_softc(xfer);
853 	struct usb_page_cache *pc;
854 	uint32_t actlen;
855 
856 	switch (USB_GET_STATE(xfer)) {
857 	case USB_ST_TRANSFERRED:
858 	case USB_ST_SETUP:
859 tr_setup:
860 		pc = usbd_xfer_get_frame(xfer, 0);
861 		if (ucom_get_data(ucom, pc, 0, U3G_BSIZE, &actlen)) {
862 			usbd_xfer_set_frame_len(xfer, 0, actlen);
863 			usbd_transfer_submit(xfer);
864 		}
865 		break;
866 
867 	default:			/* Error */
868 		if (error != USB_ERR_CANCELLED) {
869 			/* do a builtin clear-stall */
870 			usbd_xfer_set_stall(xfer);
871 			goto tr_setup;
872 		}
873 		break;
874 	}
875 	return;
876 }
877 
878 static void
879 u3g_read_callback(struct usb_xfer *xfer, usb_error_t error)
880 {
881 	struct ucom_softc *ucom = usbd_xfer_softc(xfer);
882 	struct usb_page_cache *pc;
883 	int actlen;
884 
885 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
886 
887 	switch (USB_GET_STATE(xfer)) {
888 	case USB_ST_TRANSFERRED:
889 		pc = usbd_xfer_get_frame(xfer, 0);
890 		ucom_put_data(ucom, pc, 0, actlen);
891 
892 	case USB_ST_SETUP:
893 tr_setup:
894 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
895 		usbd_transfer_submit(xfer);
896 		break;
897 
898 	default:			/* Error */
899 		if (error != USB_ERR_CANCELLED) {
900 			/* do a builtin clear-stall */
901 			usbd_xfer_set_stall(xfer);
902 			goto tr_setup;
903 		}
904 		break;
905 	}
906 	return;
907 }
908