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