xref: /freebsd/sys/dev/usb/serial/u3g.c (revision 3b8f08459569bf0faa21473e5cec2491e95c9349)
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/module.h>
43 #include <sys/lock.h>
44 #include <sys/mutex.h>
45 #include <sys/condvar.h>
46 #include <sys/sysctl.h>
47 #include <sys/sx.h>
48 #include <sys/unistd.h>
49 #include <sys/callout.h>
50 #include <sys/malloc.h>
51 #include <sys/priv.h>
52 
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
55 #include <dev/usb/usbdi_util.h>
56 #include <dev/usb/usb_cdc.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 #include <dev/usb/quirk/usb_quirk.h>
66 
67 #ifdef USB_DEBUG
68 static int u3g_debug = 0;
69 
70 static SYSCTL_NODE(_hw_usb, OID_AUTO, u3g, CTLFLAG_RW, 0, "USB 3g");
71 SYSCTL_INT(_hw_usb_u3g, OID_AUTO, debug, CTLFLAG_RW,
72     &u3g_debug, 0, "Debug level");
73 #endif
74 
75 #define	U3G_MAXPORTS		12
76 #define	U3G_CONFIG_INDEX	0
77 #define	U3G_BSIZE		2048
78 
79 #define	U3GSP_GPRS		0
80 #define	U3GSP_EDGE		1
81 #define	U3GSP_CDMA		2
82 #define	U3GSP_UMTS		3
83 #define	U3GSP_HSDPA		4
84 #define	U3GSP_HSUPA		5
85 #define	U3GSP_HSPA		6
86 #define	U3GSP_MAX		7
87 
88 /* Eject methods; See also usb_quirks.h:UQ_MSC_EJECT_* */
89 #define	U3GINIT_HUAWEI		1	/* Requires Huawei init command */
90 #define	U3GINIT_SIERRA		2	/* Requires Sierra init command */
91 #define	U3GINIT_SCSIEJECT	3	/* Requires SCSI eject command */
92 #define	U3GINIT_REZERO		4	/* Requires SCSI rezero command */
93 #define	U3GINIT_ZTESTOR		5	/* Requires ZTE SCSI command */
94 #define	U3GINIT_CMOTECH		6	/* Requires CMOTECH SCSI command */
95 #define	U3GINIT_WAIT		7	/* Device reappears after a delay */
96 #define	U3GINIT_SAEL_M460	8	/* Requires vendor init */
97 #define	U3GINIT_HUAWEISCSI	9	/* Requires Huawei SCSI init command */
98 #define	U3GINIT_TCT		10	/* Requires TCT Mobile init command */
99 
100 enum {
101 	U3G_BULK_WR,
102 	U3G_BULK_RD,
103 	U3G_INTR,
104 	U3G_N_TRANSFER,
105 };
106 
107 struct u3g_softc {
108 	struct ucom_super_softc sc_super_ucom;
109 	struct ucom_softc sc_ucom[U3G_MAXPORTS];
110 
111 	struct usb_xfer *sc_xfer[U3G_MAXPORTS][U3G_N_TRANSFER];
112 	uint8_t sc_iface[U3G_MAXPORTS];			/* local status register */
113 	uint8_t sc_lsr[U3G_MAXPORTS];			/* local status register */
114 	uint8_t sc_msr[U3G_MAXPORTS];			/* u3g status register */
115 	uint16_t sc_line[U3G_MAXPORTS];			/* line status */
116 
117 	struct usb_device *sc_udev;
118 	struct mtx sc_mtx;
119 
120 	uint8_t sc_numports;
121 };
122 
123 static device_probe_t u3g_probe;
124 static device_attach_t u3g_attach;
125 static device_detach_t u3g_detach;
126 static void u3g_free_softc(struct u3g_softc *);
127 
128 static usb_callback_t u3g_write_callback;
129 static usb_callback_t u3g_read_callback;
130 static usb_callback_t u3g_intr_callback;
131 
132 static void u3g_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
133 static void u3g_cfg_set_dtr(struct ucom_softc *, uint8_t);
134 static void u3g_cfg_set_rts(struct ucom_softc *, uint8_t);
135 static void u3g_start_read(struct ucom_softc *ucom);
136 static void u3g_stop_read(struct ucom_softc *ucom);
137 static void u3g_start_write(struct ucom_softc *ucom);
138 static void u3g_stop_write(struct ucom_softc *ucom);
139 static void u3g_poll(struct ucom_softc *ucom);
140 static void u3g_free(struct ucom_softc *ucom);
141 
142 
143 static void u3g_test_autoinst(void *, struct usb_device *,
144 		struct usb_attach_arg *);
145 static int u3g_driver_loaded(struct module *mod, int what, void *arg);
146 
147 static eventhandler_tag u3g_etag;
148 
149 static const struct usb_config u3g_config[U3G_N_TRANSFER] = {
150 
151 	[U3G_BULK_WR] = {
152 		.type = UE_BULK,
153 		.endpoint = UE_ADDR_ANY,
154 		.direction = UE_DIR_OUT,
155 		.bufsize = U3G_BSIZE,/* bytes */
156 		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
157 		.callback = &u3g_write_callback,
158 	},
159 
160 	[U3G_BULK_RD] = {
161 		.type = UE_BULK,
162 		.endpoint = UE_ADDR_ANY,
163 		.direction = UE_DIR_IN,
164 		.bufsize = U3G_BSIZE,/* bytes */
165 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
166 		.callback = &u3g_read_callback,
167 	},
168 
169 	[U3G_INTR] = {
170 		.type = UE_INTERRUPT,
171 		.endpoint = UE_ADDR_ANY,
172 		.direction = UE_DIR_IN,
173 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,.no_pipe_ok = 1,},
174 		.bufsize = 0,	/* use wMaxPacketSize */
175 		.callback = &u3g_intr_callback,
176 	},
177 };
178 
179 static const struct ucom_callback u3g_callback = {
180 	.ucom_cfg_get_status = &u3g_cfg_get_status,
181 	.ucom_cfg_set_dtr = &u3g_cfg_set_dtr,
182 	.ucom_cfg_set_rts = &u3g_cfg_set_rts,
183 	.ucom_start_read = &u3g_start_read,
184 	.ucom_stop_read = &u3g_stop_read,
185 	.ucom_start_write = &u3g_start_write,
186 	.ucom_stop_write = &u3g_stop_write,
187 	.ucom_poll = &u3g_poll,
188 	.ucom_free = &u3g_free,
189 };
190 
191 static device_method_t u3g_methods[] = {
192 	DEVMETHOD(device_probe, u3g_probe),
193 	DEVMETHOD(device_attach, u3g_attach),
194 	DEVMETHOD(device_detach, u3g_detach),
195 	DEVMETHOD_END
196 };
197 
198 static devclass_t u3g_devclass;
199 
200 static driver_t u3g_driver = {
201 	.name = "u3g",
202 	.methods = u3g_methods,
203 	.size = sizeof(struct u3g_softc),
204 };
205 
206 DRIVER_MODULE(u3g, uhub, u3g_driver, u3g_devclass, u3g_driver_loaded, 0);
207 MODULE_DEPEND(u3g, ucom, 1, 1, 1);
208 MODULE_DEPEND(u3g, usb, 1, 1, 1);
209 MODULE_VERSION(u3g, 1);
210 
211 static const STRUCT_USB_HOST_ID u3g_devs[] = {
212 #define	U3G_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
213 	U3G_DEV(ACERP, H10, 0),
214 	U3G_DEV(AIRPLUS, MCD650, 0),
215 	U3G_DEV(AIRPRIME, PC5220, 0),
216 	U3G_DEV(AIRPRIME, AC313U, 0),
217 	U3G_DEV(ALINK, 3G, 0),
218 	U3G_DEV(ALINK, 3GU, 0),
219 	U3G_DEV(ALINK, DWM652U5, 0),
220 	U3G_DEV(AMOI, H01, 0),
221 	U3G_DEV(AMOI, H01A, 0),
222 	U3G_DEV(AMOI, H02, 0),
223 	U3G_DEV(ANYDATA, ADU_500A, 0),
224 	U3G_DEV(ANYDATA, ADU_620UW, 0),
225 	U3G_DEV(ANYDATA, ADU_E100X, 0),
226 	U3G_DEV(AXESSTEL, DATAMODEM, 0),
227 	U3G_DEV(CMOTECH, CDMA_MODEM1, 0),
228 	U3G_DEV(CMOTECH, CGU628, U3GINIT_CMOTECH),
229 	U3G_DEV(DELL, U5500, 0),
230 	U3G_DEV(DELL, U5505, 0),
231 	U3G_DEV(DELL, U5510, 0),
232 	U3G_DEV(DELL, U5520, 0),
233 	U3G_DEV(DELL, U5520_2, 0),
234 	U3G_DEV(DELL, U5520_3, 0),
235 	U3G_DEV(DELL, U5700, 0),
236 	U3G_DEV(DELL, U5700_2, 0),
237 	U3G_DEV(DELL, U5700_3, 0),
238 	U3G_DEV(DELL, U5700_4, 0),
239 	U3G_DEV(DELL, U5720, 0),
240 	U3G_DEV(DELL, U5720_2, 0),
241 	U3G_DEV(DELL, U5730, 0),
242 	U3G_DEV(DELL, U5730_2, 0),
243 	U3G_DEV(DELL, U5730_3, 0),
244 	U3G_DEV(DELL, U740, 0),
245 	U3G_DEV(DLINK, DWR510_CD, U3GINIT_SCSIEJECT),
246 	U3G_DEV(DLINK, DWR510, 0),
247 	U3G_DEV(DLINK3, DWM652, 0),
248 	U3G_DEV(HP, EV2200, 0),
249 	U3G_DEV(HP, HS2300, 0),
250 	U3G_DEV(HUAWEI, E1401, U3GINIT_HUAWEI),
251 	U3G_DEV(HUAWEI, E1402, U3GINIT_HUAWEI),
252 	U3G_DEV(HUAWEI, E1403, U3GINIT_HUAWEI),
253 	U3G_DEV(HUAWEI, E1404, U3GINIT_HUAWEI),
254 	U3G_DEV(HUAWEI, E1405, U3GINIT_HUAWEI),
255 	U3G_DEV(HUAWEI, E1406, U3GINIT_HUAWEI),
256 	U3G_DEV(HUAWEI, E1407, U3GINIT_HUAWEI),
257 	U3G_DEV(HUAWEI, E1408, U3GINIT_HUAWEI),
258 	U3G_DEV(HUAWEI, E1409, U3GINIT_HUAWEI),
259 	U3G_DEV(HUAWEI, E140A, U3GINIT_HUAWEI),
260 	U3G_DEV(HUAWEI, E140B, U3GINIT_HUAWEI),
261 	U3G_DEV(HUAWEI, E140D, U3GINIT_HUAWEI),
262 	U3G_DEV(HUAWEI, E140E, U3GINIT_HUAWEI),
263 	U3G_DEV(HUAWEI, E140F, U3GINIT_HUAWEI),
264 	U3G_DEV(HUAWEI, E1410, U3GINIT_HUAWEI),
265 	U3G_DEV(HUAWEI, E1411, U3GINIT_HUAWEI),
266 	U3G_DEV(HUAWEI, E1412, U3GINIT_HUAWEI),
267 	U3G_DEV(HUAWEI, E1413, U3GINIT_HUAWEI),
268 	U3G_DEV(HUAWEI, E1414, U3GINIT_HUAWEI),
269 	U3G_DEV(HUAWEI, E1415, U3GINIT_HUAWEI),
270 	U3G_DEV(HUAWEI, E1416, U3GINIT_HUAWEI),
271 	U3G_DEV(HUAWEI, E1417, U3GINIT_HUAWEI),
272 	U3G_DEV(HUAWEI, E1418, U3GINIT_HUAWEI),
273 	U3G_DEV(HUAWEI, E1419, U3GINIT_HUAWEI),
274 	U3G_DEV(HUAWEI, E141A, U3GINIT_HUAWEI),
275 	U3G_DEV(HUAWEI, E141B, U3GINIT_HUAWEI),
276 	U3G_DEV(HUAWEI, E141C, U3GINIT_HUAWEI),
277 	U3G_DEV(HUAWEI, E141D, U3GINIT_HUAWEI),
278 	U3G_DEV(HUAWEI, E141E, U3GINIT_HUAWEI),
279 	U3G_DEV(HUAWEI, E141F, U3GINIT_HUAWEI),
280 	U3G_DEV(HUAWEI, E1420, U3GINIT_HUAWEI),
281 	U3G_DEV(HUAWEI, E1421, U3GINIT_HUAWEI),
282 	U3G_DEV(HUAWEI, E1422, U3GINIT_HUAWEI),
283 	U3G_DEV(HUAWEI, E1423, U3GINIT_HUAWEI),
284 	U3G_DEV(HUAWEI, E1424, U3GINIT_HUAWEI),
285 	U3G_DEV(HUAWEI, E1425, U3GINIT_HUAWEI),
286 	U3G_DEV(HUAWEI, E1426, U3GINIT_HUAWEI),
287 	U3G_DEV(HUAWEI, E1427, U3GINIT_HUAWEI),
288 	U3G_DEV(HUAWEI, E1428, U3GINIT_HUAWEI),
289 	U3G_DEV(HUAWEI, E1429, U3GINIT_HUAWEI),
290 	U3G_DEV(HUAWEI, E142A, U3GINIT_HUAWEI),
291 	U3G_DEV(HUAWEI, E142B, U3GINIT_HUAWEI),
292 	U3G_DEV(HUAWEI, E142C, U3GINIT_HUAWEI),
293 	U3G_DEV(HUAWEI, E142D, U3GINIT_HUAWEI),
294 	U3G_DEV(HUAWEI, E142E, U3GINIT_HUAWEI),
295 	U3G_DEV(HUAWEI, E142F, U3GINIT_HUAWEI),
296 	U3G_DEV(HUAWEI, E1430, U3GINIT_HUAWEI),
297 	U3G_DEV(HUAWEI, E1431, U3GINIT_HUAWEI),
298 	U3G_DEV(HUAWEI, E1432, U3GINIT_HUAWEI),
299 	U3G_DEV(HUAWEI, E1433, U3GINIT_HUAWEI),
300 	U3G_DEV(HUAWEI, E1434, U3GINIT_HUAWEI),
301 	U3G_DEV(HUAWEI, E1435, U3GINIT_HUAWEI),
302 	U3G_DEV(HUAWEI, E1436, U3GINIT_HUAWEI),
303 	U3G_DEV(HUAWEI, E1437, U3GINIT_HUAWEI),
304 	U3G_DEV(HUAWEI, E1438, U3GINIT_HUAWEI),
305 	U3G_DEV(HUAWEI, E1439, U3GINIT_HUAWEI),
306 	U3G_DEV(HUAWEI, E143A, U3GINIT_HUAWEI),
307 	U3G_DEV(HUAWEI, E143B, U3GINIT_HUAWEI),
308 	U3G_DEV(HUAWEI, E143C, U3GINIT_HUAWEI),
309 	U3G_DEV(HUAWEI, E143D, U3GINIT_HUAWEI),
310 	U3G_DEV(HUAWEI, E143E, U3GINIT_HUAWEI),
311 	U3G_DEV(HUAWEI, E143F, U3GINIT_HUAWEI),
312 	U3G_DEV(HUAWEI, E173, 0),
313 	U3G_DEV(HUAWEI, E173_INIT, U3GINIT_HUAWEISCSI),
314 	U3G_DEV(HUAWEI, E3131, 0),
315 	U3G_DEV(HUAWEI, E3131_INIT, U3GINIT_HUAWEISCSI),
316 	U3G_DEV(HUAWEI, E180V, U3GINIT_HUAWEI),
317 	U3G_DEV(HUAWEI, E220, U3GINIT_HUAWEI),
318 	U3G_DEV(HUAWEI, E220BIS, U3GINIT_HUAWEI),
319 	U3G_DEV(HUAWEI, E392, U3GINIT_HUAWEISCSI),
320 	U3G_DEV(HUAWEI, MOBILE, U3GINIT_HUAWEI),
321 	U3G_DEV(HUAWEI, E1752, U3GINIT_HUAWEISCSI),
322 	U3G_DEV(HUAWEI, E1820, U3GINIT_HUAWEISCSI),
323 	U3G_DEV(HUAWEI, K3765, U3GINIT_HUAWEI),
324 	U3G_DEV(HUAWEI, K3765_INIT, U3GINIT_HUAWEISCSI),
325 	U3G_DEV(HUAWEI, K3770, U3GINIT_HUAWEI),
326 	U3G_DEV(HUAWEI, K3770_INIT, U3GINIT_HUAWEISCSI),
327 	U3G_DEV(HUAWEI, K4505, U3GINIT_HUAWEI),
328 	U3G_DEV(HUAWEI, K4505_INIT, U3GINIT_HUAWEISCSI),
329 	U3G_DEV(HUAWEI, ETS2055, U3GINIT_HUAWEI),
330 	U3G_DEV(KYOCERA2, CDMA_MSM_K, 0),
331 	U3G_DEV(KYOCERA2, KPC680, 0),
332 	U3G_DEV(LONGCHEER, WM66, U3GINIT_HUAWEI),
333 	U3G_DEV(LONGCHEER, DISK, U3GINIT_TCT),
334 	U3G_DEV(LONGCHEER, W14, 0),
335 	U3G_DEV(LONGCHEER, XSSTICK, 0),
336 	U3G_DEV(MERLIN, V620, 0),
337 	U3G_DEV(NEOTEL, PRIME, 0),
338 	U3G_DEV(NOVATEL, E725, 0),
339 	U3G_DEV(NOVATEL, ES620, 0),
340 	U3G_DEV(NOVATEL, ES620_2, 0),
341 	U3G_DEV(NOVATEL, EU730, 0),
342 	U3G_DEV(NOVATEL, EU740, 0),
343 	U3G_DEV(NOVATEL, EU870D, 0),
344 	U3G_DEV(NOVATEL, MC760, 0),
345 	U3G_DEV(NOVATEL, MC547, 0),
346 	U3G_DEV(NOVATEL, MC950D, 0),
347 	U3G_DEV(NOVATEL, MIFI2200, U3GINIT_SCSIEJECT),
348 	U3G_DEV(NOVATEL, MIFI2200V, U3GINIT_SCSIEJECT),
349 	U3G_DEV(NOVATEL, U720, 0),
350 	U3G_DEV(NOVATEL, U727, 0),
351 	U3G_DEV(NOVATEL, U727_2, 0),
352 	U3G_DEV(NOVATEL, U740, 0),
353 	U3G_DEV(NOVATEL, U740_2, 0),
354 	U3G_DEV(NOVATEL, U760, U3GINIT_SCSIEJECT),
355 	U3G_DEV(NOVATEL, U870, 0),
356 	U3G_DEV(NOVATEL, V620, 0),
357 	U3G_DEV(NOVATEL, V640, 0),
358 	U3G_DEV(NOVATEL, V720, 0),
359 	U3G_DEV(NOVATEL, V740, 0),
360 	U3G_DEV(NOVATEL, X950D, 0),
361 	U3G_DEV(NOVATEL, XU870, 0),
362 	U3G_DEV(MOTOROLA2, MB886, U3GINIT_SCSIEJECT),
363 	U3G_DEV(OPTION, E6500, 0),
364 	U3G_DEV(OPTION, E6501, 0),
365 	U3G_DEV(OPTION, E6601, 0),
366 	U3G_DEV(OPTION, E6721, 0),
367 	U3G_DEV(OPTION, E6741, 0),
368 	U3G_DEV(OPTION, E6761, 0),
369 	U3G_DEV(OPTION, E6800, 0),
370 	U3G_DEV(OPTION, E7021, 0),
371 	U3G_DEV(OPTION, E7041, 0),
372 	U3G_DEV(OPTION, E7061, 0),
373 	U3G_DEV(OPTION, E7100, 0),
374 	U3G_DEV(OPTION, GE40X, 0),
375 	U3G_DEV(OPTION, GT3G, 0),
376 	U3G_DEV(OPTION, GT3GPLUS, 0),
377 	U3G_DEV(OPTION, GT3GQUAD, 0),
378 	U3G_DEV(OPTION, GT3G_1, 0),
379 	U3G_DEV(OPTION, GT3G_2, 0),
380 	U3G_DEV(OPTION, GT3G_3, 0),
381 	U3G_DEV(OPTION, GT3G_4, 0),
382 	U3G_DEV(OPTION, GT3G_5, 0),
383 	U3G_DEV(OPTION, GT3G_6, 0),
384 	U3G_DEV(OPTION, GTHSDPA, 0),
385 	U3G_DEV(OPTION, GTM380, 0),
386 	U3G_DEV(OPTION, GTMAX36, 0),
387 	U3G_DEV(OPTION, GTMAX380HSUPAE, 0),
388 	U3G_DEV(OPTION, GTMAXHSUPA, 0),
389 	U3G_DEV(OPTION, GTMAXHSUPAE, 0),
390 	U3G_DEV(OPTION, VODAFONEMC3G, 0),
391 	U3G_DEV(QISDA, H20_1, 0),
392 	U3G_DEV(QISDA, H20_2, 0),
393 	U3G_DEV(QISDA, H21_1, 0),
394 	U3G_DEV(QISDA, H21_2, 0),
395 	U3G_DEV(QUALCOMM, NTT_L02C_MODEM, U3GINIT_SCSIEJECT),
396 	U3G_DEV(QUALCOMM2, AC8700, 0),
397 	U3G_DEV(QUALCOMM2, MF330, 0),
398 	U3G_DEV(QUALCOMM2, SIM5218, 0),
399 	U3G_DEV(QUALCOMM2, VW110L, U3GINIT_SCSIEJECT),
400 	U3G_DEV(QUALCOMM2, GOBI2000_QDL, 0),
401 	U3G_DEV(QUALCOMM2, GOBI2000, 0),
402 	U3G_DEV(QUALCOMMINC, AC2726, 0),
403 	U3G_DEV(QUALCOMMINC, AC8700, 0),
404 	U3G_DEV(QUALCOMMINC, AC8710, 0),
405 	U3G_DEV(QUALCOMMINC, CDMA_MSM, U3GINIT_SCSIEJECT),
406 	U3G_DEV(QUALCOMMINC, E0002, 0),
407 	U3G_DEV(QUALCOMMINC, E0003, 0),
408 	U3G_DEV(QUALCOMMINC, E0004, 0),
409 	U3G_DEV(QUALCOMMINC, E0005, 0),
410 	U3G_DEV(QUALCOMMINC, E0006, 0),
411 	U3G_DEV(QUALCOMMINC, E0007, 0),
412 	U3G_DEV(QUALCOMMINC, E0008, 0),
413 	U3G_DEV(QUALCOMMINC, E0009, 0),
414 	U3G_DEV(QUALCOMMINC, E000A, 0),
415 	U3G_DEV(QUALCOMMINC, E000B, 0),
416 	U3G_DEV(QUALCOMMINC, E000C, 0),
417 	U3G_DEV(QUALCOMMINC, E000D, 0),
418 	U3G_DEV(QUALCOMMINC, E000E, 0),
419 	U3G_DEV(QUALCOMMINC, E000F, 0),
420 	U3G_DEV(QUALCOMMINC, E0010, 0),
421 	U3G_DEV(QUALCOMMINC, E0011, 0),
422 	U3G_DEV(QUALCOMMINC, E0012, 0),
423 	U3G_DEV(QUALCOMMINC, E0013, 0),
424 	U3G_DEV(QUALCOMMINC, E0014, 0),
425 	U3G_DEV(QUALCOMMINC, E0017, 0),
426 	U3G_DEV(QUALCOMMINC, E0018, 0),
427 	U3G_DEV(QUALCOMMINC, E0019, 0),
428 	U3G_DEV(QUALCOMMINC, E0020, 0),
429 	U3G_DEV(QUALCOMMINC, E0021, 0),
430 	U3G_DEV(QUALCOMMINC, E0022, 0),
431 	U3G_DEV(QUALCOMMINC, E0023, 0),
432 	U3G_DEV(QUALCOMMINC, E0024, 0),
433 	U3G_DEV(QUALCOMMINC, E0025, 0),
434 	U3G_DEV(QUALCOMMINC, E0026, 0),
435 	U3G_DEV(QUALCOMMINC, E0027, 0),
436 	U3G_DEV(QUALCOMMINC, E0028, 0),
437 	U3G_DEV(QUALCOMMINC, E0029, 0),
438 	U3G_DEV(QUALCOMMINC, E0030, 0),
439 	U3G_DEV(QUALCOMMINC, E0032, 0),
440 	U3G_DEV(QUALCOMMINC, E0033, 0),
441 	U3G_DEV(QUALCOMMINC, E0037, 0),
442 	U3G_DEV(QUALCOMMINC, E0039, 0),
443 	U3G_DEV(QUALCOMMINC, E0042, 0),
444 	U3G_DEV(QUALCOMMINC, E0043, 0),
445 	U3G_DEV(QUALCOMMINC, E0048, 0),
446 	U3G_DEV(QUALCOMMINC, E0049, 0),
447 	U3G_DEV(QUALCOMMINC, E0051, 0),
448 	U3G_DEV(QUALCOMMINC, E0052, 0),
449 	U3G_DEV(QUALCOMMINC, E0054, 0),
450 	U3G_DEV(QUALCOMMINC, E0055, 0),
451 	U3G_DEV(QUALCOMMINC, E0057, 0),
452 	U3G_DEV(QUALCOMMINC, E0058, 0),
453 	U3G_DEV(QUALCOMMINC, E0059, 0),
454 	U3G_DEV(QUALCOMMINC, E0060, 0),
455 	U3G_DEV(QUALCOMMINC, E0061, 0),
456 	U3G_DEV(QUALCOMMINC, E0062, 0),
457 	U3G_DEV(QUALCOMMINC, E0063, 0),
458 	U3G_DEV(QUALCOMMINC, E0064, 0),
459 	U3G_DEV(QUALCOMMINC, E0066, 0),
460 	U3G_DEV(QUALCOMMINC, E0069, 0),
461 	U3G_DEV(QUALCOMMINC, E0070, 0),
462 	U3G_DEV(QUALCOMMINC, E0073, 0),
463 	U3G_DEV(QUALCOMMINC, E0076, 0),
464 	U3G_DEV(QUALCOMMINC, E0078, 0),
465 	U3G_DEV(QUALCOMMINC, E0082, 0),
466 	U3G_DEV(QUALCOMMINC, E0086, 0),
467 	U3G_DEV(QUALCOMMINC, SURFSTICK, 0),
468 	U3G_DEV(QUALCOMMINC, E2002, 0),
469 	U3G_DEV(QUALCOMMINC, E2003, 0),
470 	U3G_DEV(QUALCOMMINC, K3772_Z, U3GINIT_SCSIEJECT),
471 	U3G_DEV(QUALCOMMINC, MF626, 0),
472 	U3G_DEV(QUALCOMMINC, MF628, 0),
473 	U3G_DEV(QUALCOMMINC, MF633R, 0),
474 	U3G_DEV(QUANTA, GKE, 0),
475 	U3G_DEV(QUANTA, GLE, 0),
476 	U3G_DEV(QUANTA, GLX, 0),
477 	U3G_DEV(QUANTA, Q101, 0),
478 	U3G_DEV(QUANTA, Q111, 0),
479 	U3G_DEV(SIERRA, AC402, 0),
480 	U3G_DEV(SIERRA, AC595U, 0),
481 	U3G_DEV(SIERRA, AC313U, 0),
482 	U3G_DEV(SIERRA, AC597E, 0),
483 	U3G_DEV(SIERRA, AC875E, 0),
484 	U3G_DEV(SIERRA, AC875U, 0),
485 	U3G_DEV(SIERRA, AC875U_2, 0),
486 	U3G_DEV(SIERRA, AC880, 0),
487 	U3G_DEV(SIERRA, AC880E, 0),
488 	U3G_DEV(SIERRA, AC880U, 0),
489 	U3G_DEV(SIERRA, AC881, 0),
490 	U3G_DEV(SIERRA, AC881E, 0),
491 	U3G_DEV(SIERRA, AC881U, 0),
492 	U3G_DEV(SIERRA, AC885E, 0),
493 	U3G_DEV(SIERRA, AC885E_2, 0),
494 	U3G_DEV(SIERRA, AC885U, 0),
495 	U3G_DEV(SIERRA, AIRCARD580, 0),
496 	U3G_DEV(SIERRA, AIRCARD595, 0),
497 	U3G_DEV(SIERRA, AIRCARD875, 0),
498 	U3G_DEV(SIERRA, C22, 0),
499 	U3G_DEV(SIERRA, C597, 0),
500 	U3G_DEV(SIERRA, C888, 0),
501 	U3G_DEV(SIERRA, E0029, 0),
502 	U3G_DEV(SIERRA, E6892, 0),
503 	U3G_DEV(SIERRA, E6893, 0),
504 	U3G_DEV(SIERRA, EM5625, 0),
505 	U3G_DEV(SIERRA, EM5725, 0),
506 	U3G_DEV(SIERRA, MC5720, 0),
507 	U3G_DEV(SIERRA, MC5720_2, 0),
508 	U3G_DEV(SIERRA, MC5725, 0),
509 	U3G_DEV(SIERRA, MC5727, 0),
510 	U3G_DEV(SIERRA, MC5727_2, 0),
511 	U3G_DEV(SIERRA, MC5728, 0),
512 	U3G_DEV(SIERRA, MC8700, 0),
513 	U3G_DEV(SIERRA, MC8755, 0),
514 	U3G_DEV(SIERRA, MC8755_2, 0),
515 	U3G_DEV(SIERRA, MC8755_3, 0),
516 	U3G_DEV(SIERRA, MC8755_4, 0),
517 	U3G_DEV(SIERRA, MC8765, 0),
518 	U3G_DEV(SIERRA, MC8765_2, 0),
519 	U3G_DEV(SIERRA, MC8765_3, 0),
520 	U3G_DEV(SIERRA, MC8775, 0),
521 	U3G_DEV(SIERRA, MC8775_2, 0),
522 	U3G_DEV(SIERRA, MC8780, 0),
523 	U3G_DEV(SIERRA, MC8780_2, 0),
524 	U3G_DEV(SIERRA, MC8780_3, 0),
525 	U3G_DEV(SIERRA, MC8781, 0),
526 	U3G_DEV(SIERRA, MC8781_2, 0),
527 	U3G_DEV(SIERRA, MC8781_3, 0),
528 	U3G_DEV(SIERRA, MC8785, 0),
529 	U3G_DEV(SIERRA, MC8785_2, 0),
530 	U3G_DEV(SIERRA, MC8790, 0),
531 	U3G_DEV(SIERRA, MC8791, 0),
532 	U3G_DEV(SIERRA, MC8792, 0),
533 	U3G_DEV(SIERRA, MINI5725, 0),
534 	U3G_DEV(SIERRA, T11, 0),
535 	U3G_DEV(SIERRA, T598, 0),
536 	U3G_DEV(SILABS, SAEL, U3GINIT_SAEL_M460),
537 	U3G_DEV(STELERA, C105, 0),
538 	U3G_DEV(STELERA, E1003, 0),
539 	U3G_DEV(STELERA, E1004, 0),
540 	U3G_DEV(STELERA, E1005, 0),
541 	U3G_DEV(STELERA, E1006, 0),
542 	U3G_DEV(STELERA, E1007, 0),
543 	U3G_DEV(STELERA, E1008, 0),
544 	U3G_DEV(STELERA, E1009, 0),
545 	U3G_DEV(STELERA, E100A, 0),
546 	U3G_DEV(STELERA, E100B, 0),
547 	U3G_DEV(STELERA, E100C, 0),
548 	U3G_DEV(STELERA, E100D, 0),
549 	U3G_DEV(STELERA, E100E, 0),
550 	U3G_DEV(STELERA, E100F, 0),
551 	U3G_DEV(STELERA, E1010, 0),
552 	U3G_DEV(STELERA, E1011, 0),
553 	U3G_DEV(STELERA, E1012, 0),
554 	U3G_DEV(TCTMOBILE, X060S, 0),
555 	U3G_DEV(TCTMOBILE, X080S, U3GINIT_TCT),
556 	U3G_DEV(TELIT, UC864E, 0),
557 	U3G_DEV(TELIT, UC864G, 0),
558 	U3G_DEV(TLAYTECH, TEU800, 0),
559 	U3G_DEV(TOSHIBA, G450, 0),
560 	U3G_DEV(TOSHIBA, HSDPA, 0),
561 	U3G_DEV(YISO, C893, 0),
562 	U3G_DEV(WETELECOM, WM_D200, 0),
563 	/* Autoinstallers */
564 	U3G_DEV(NOVATEL, ZEROCD, U3GINIT_SCSIEJECT),
565 	U3G_DEV(OPTION, GTICON322, U3GINIT_REZERO),
566 	U3G_DEV(QUALCOMMINC, ZTE_STOR, U3GINIT_ZTESTOR),
567 	U3G_DEV(QUALCOMMINC, ZTE_STOR2, U3GINIT_SCSIEJECT),
568 	U3G_DEV(QUANTA, Q101_STOR, U3GINIT_SCSIEJECT),
569 	U3G_DEV(SIERRA, TRUINSTALL, U3GINIT_SIERRA),
570 #undef	U3G_DEV
571 };
572 
573 static int
574 u3g_sierra_init(struct usb_device *udev)
575 {
576 	struct usb_device_request req;
577 
578 	req.bmRequestType = UT_VENDOR;
579 	req.bRequest = UR_SET_INTERFACE;
580 	USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
581 	USETW(req.wIndex, UHF_PORT_CONNECTION);
582 	USETW(req.wLength, 0);
583 
584 	if (usbd_do_request_flags(udev, NULL, &req,
585 	    NULL, 0, NULL, USB_MS_HZ)) {
586 		/* ignore any errors */
587 	}
588 	return (0);
589 }
590 
591 static int
592 u3g_huawei_init(struct usb_device *udev)
593 {
594 	struct usb_device_request req;
595 
596 	req.bmRequestType = UT_WRITE_DEVICE;
597 	req.bRequest = UR_SET_FEATURE;
598 	USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
599 	USETW(req.wIndex, UHF_PORT_SUSPEND);
600 	USETW(req.wLength, 0);
601 
602 	if (usbd_do_request_flags(udev, NULL, &req,
603 	    NULL, 0, NULL, USB_MS_HZ)) {
604 		/* ignore any errors */
605 	}
606 	return (0);
607 }
608 
609 static void
610 u3g_sael_m460_init(struct usb_device *udev)
611 {
612 	static const uint8_t setup[][24] = {
613 	     { 0x41, 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
614 	     { 0x41, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 },
615 	     { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
616 	       0x01, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00,
617 	       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
618 	     { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x40, 0x02 },
619 	     { 0xc1, 0x08, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00 },
620 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
621 	     { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 },
622 	     { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
623 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
624 	     { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
625 	     { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
626 	       0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
627 	     { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
628 	       0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
629 	       0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
630 	     { 0x41, 0x12, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00 },
631 	     { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
632 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
633 	     { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
634 	     { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
635 	       0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
636 	     { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
637 	       0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
638 	       0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
639 	     { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
640 	};
641 
642 	struct usb_device_request req;
643 	usb_error_t err;
644 	uint16_t len;
645 	uint8_t buf[0x300];
646 	uint8_t n;
647 
648 	DPRINTFN(1, "\n");
649 
650 	if (usbd_req_set_alt_interface_no(udev, NULL, 0, 0)) {
651 		DPRINTFN(0, "Alt setting 0 failed\n");
652 		return;
653 	}
654 
655 	for (n = 0; n != (sizeof(setup)/sizeof(setup[0])); n++) {
656 
657 		memcpy(&req, setup[n], sizeof(req));
658 
659 		len = UGETW(req.wLength);
660 		if (req.bmRequestType & UE_DIR_IN) {
661 			if (len > sizeof(buf)) {
662 				DPRINTFN(0, "too small buffer\n");
663 				continue;
664 			}
665 			err = usbd_do_request(udev, NULL, &req, buf);
666 		} else {
667 			if (len > (sizeof(setup[0]) - 8)) {
668 				DPRINTFN(0, "too small buffer\n");
669 				continue;
670 			}
671 			err = usbd_do_request(udev, NULL, &req,
672 			    __DECONST(uint8_t *, &setup[n][8]));
673 		}
674 		if (err) {
675 			DPRINTFN(1, "request %u failed\n",
676 			    (unsigned int)n);
677 			/*
678 			 * Some of the requests will fail. Stop doing
679 			 * requests when we are getting timeouts so
680 			 * that we don't block the explore/attach
681 			 * thread forever.
682 			 */
683 			if (err == USB_ERR_TIMEOUT)
684 				break;
685 		}
686 	}
687 }
688 
689 /*
690  * The following function handles 3G modem devices (E220, Mobile,
691  * etc.) with auto-install flash disks for Windows/MacOSX on the first
692  * interface.  After some command or some delay they change appearance
693  * to a modem.
694  */
695 static void
696 u3g_test_autoinst(void *arg, struct usb_device *udev,
697     struct usb_attach_arg *uaa)
698 {
699 	struct usb_interface *iface;
700 	struct usb_interface_descriptor *id;
701 	int error;
702 	unsigned long method;
703 
704 	if (uaa->dev_state != UAA_DEV_READY)
705 		return;
706 
707 	iface = usbd_get_iface(udev, 0);
708 	if (iface == NULL)
709 		return;
710 	id = iface->idesc;
711 	if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
712 		return;
713 
714 	if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEI))
715 		method = U3GINIT_HUAWEI;
716 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_SIERRA))
717 		method = U3GINIT_SIERRA;
718 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_SCSIEJECT))
719 		method = U3GINIT_SCSIEJECT;
720 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_REZERO))
721 		method = U3GINIT_REZERO;
722 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_ZTESTOR))
723 		method = U3GINIT_ZTESTOR;
724 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_CMOTECH))
725 		method = U3GINIT_CMOTECH;
726 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_WAIT))
727 		method = U3GINIT_WAIT;
728 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEISCSI))
729 		method = U3GINIT_HUAWEISCSI;
730 	else if (usb_test_quirk(uaa, UQ_MSC_EJECT_TCT))
731 		method = U3GINIT_TCT;
732 	else if (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa) == 0)
733 		method = USB_GET_DRIVER_INFO(uaa);
734 	else
735 		return;		/* no device match */
736 
737 	if (bootverbose) {
738 		printf("Ejecting %s %s using method %ld\n",
739 		       usb_get_manufacturer(udev),
740 		       usb_get_product(udev), method);
741 	}
742 
743 	switch (method) {
744 		case U3GINIT_HUAWEI:
745 			error = u3g_huawei_init(udev);
746 			break;
747 		case U3GINIT_HUAWEISCSI:
748 			error = usb_msc_eject(udev, 0, MSC_EJECT_HUAWEI);
749 			break;
750 		case U3GINIT_SCSIEJECT:
751 			error = usb_msc_eject(udev, 0, MSC_EJECT_STOPUNIT);
752 			break;
753 		case U3GINIT_REZERO:
754 			error = usb_msc_eject(udev, 0, MSC_EJECT_REZERO);
755 			break;
756 		case U3GINIT_ZTESTOR:
757 			error = usb_msc_eject(udev, 0, MSC_EJECT_STOPUNIT);
758 			error |= usb_msc_eject(udev, 0, MSC_EJECT_ZTESTOR);
759 			break;
760 		case U3GINIT_CMOTECH:
761 			error = usb_msc_eject(udev, 0, MSC_EJECT_CMOTECH);
762 			break;
763 		case U3GINIT_TCT:
764 			error = usb_msc_eject(udev, 0, MSC_EJECT_TCT);
765 			break;
766 		case U3GINIT_SIERRA:
767 			error = u3g_sierra_init(udev);
768 			break;
769 		case U3GINIT_WAIT:
770 			/* Just pretend we ejected, the card will timeout */
771 			error = 0;
772 			break;
773 		default:
774 			/* no 3G eject quirks */
775 			error = EOPNOTSUPP;
776 			break;
777 	}
778 	if (error == 0) {
779 		/* success, mark the udev as disappearing */
780 		uaa->dev_state = UAA_DEV_EJECTING;
781 	}
782 }
783 
784 static int
785 u3g_driver_loaded(struct module *mod, int what, void *arg)
786 {
787 	switch (what) {
788 	case MOD_LOAD:
789 		/* register our autoinstall handler */
790 		u3g_etag = EVENTHANDLER_REGISTER(usb_dev_configured,
791 		    u3g_test_autoinst, NULL, EVENTHANDLER_PRI_ANY);
792 		break;
793 	case MOD_UNLOAD:
794 		EVENTHANDLER_DEREGISTER(usb_dev_configured, u3g_etag);
795 		break;
796 	default:
797 		return (EOPNOTSUPP);
798 	}
799  	return (0);
800 }
801 
802 static int
803 u3g_probe(device_t self)
804 {
805 	struct usb_attach_arg *uaa = device_get_ivars(self);
806 
807 	if (uaa->usb_mode != USB_MODE_HOST) {
808 		return (ENXIO);
809 	}
810 	if (uaa->info.bConfigIndex != U3G_CONFIG_INDEX) {
811 		return (ENXIO);
812 	}
813 	if (uaa->info.bInterfaceClass != UICLASS_VENDOR) {
814 		return (ENXIO);
815 	}
816 	return (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa));
817 }
818 
819 static int
820 u3g_attach(device_t dev)
821 {
822 	struct usb_config u3g_config_tmp[U3G_N_TRANSFER];
823 	struct usb_attach_arg *uaa = device_get_ivars(dev);
824 	struct u3g_softc *sc = device_get_softc(dev);
825 	struct usb_interface *iface;
826 	struct usb_interface_descriptor *id;
827 	uint32_t iface_valid;
828 	int error, type, nports;
829 	int ep, n;
830 	uint8_t i;
831 
832 	DPRINTF("sc=%p\n", sc);
833 
834 	type = USB_GET_DRIVER_INFO(uaa);
835 	if (type == U3GINIT_SAEL_M460
836 	    || usb_test_quirk(uaa, UQ_MSC_EJECT_SAEL_M460)) {
837 		u3g_sael_m460_init(uaa->device);
838 	}
839 
840 	/* copy in USB config */
841 	for (n = 0; n != U3G_N_TRANSFER; n++)
842 		u3g_config_tmp[n] = u3g_config[n];
843 
844 	device_set_usb_desc(dev);
845 	mtx_init(&sc->sc_mtx, "u3g", NULL, MTX_DEF);
846 	ucom_ref(&sc->sc_super_ucom);
847 
848 	sc->sc_udev = uaa->device;
849 
850 	/* Claim all interfaces on the device */
851 	iface_valid = 0;
852 	for (i = uaa->info.bIfaceIndex; i < USB_IFACE_MAX; i++) {
853 		iface = usbd_get_iface(uaa->device, i);
854 		if (iface == NULL)
855 			break;
856 		id = usbd_get_interface_descriptor(iface);
857 		if (id == NULL || id->bInterfaceClass != UICLASS_VENDOR)
858 			continue;
859 		usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
860 		iface_valid |= (1<<i);
861 	}
862 
863 	i = 0;		/* interface index */
864 	ep = 0;		/* endpoint index */
865 	nports = 0;	/* number of ports */
866 	while (i < USB_IFACE_MAX) {
867 		if ((iface_valid & (1<<i)) == 0) {
868 			i++;
869 			continue;
870 		}
871 
872 		/* update BULK endpoint index */
873 		for (n = 0; n < U3G_N_TRANSFER; n++)
874 			u3g_config_tmp[n].ep_index = ep;
875 
876 		/* try to allocate a set of BULK endpoints */
877 		error = usbd_transfer_setup(uaa->device, &i,
878 		    sc->sc_xfer[nports], u3g_config_tmp, U3G_N_TRANSFER,
879 		    &sc->sc_ucom[nports], &sc->sc_mtx);
880 		if (error) {
881 			/* next interface */
882 			i++;
883 			ep = 0;
884 			continue;
885 		}
886 
887 		iface = usbd_get_iface(uaa->device, i);
888 		id = usbd_get_interface_descriptor(iface);
889 		sc->sc_iface[nports] = id->bInterfaceNumber;
890 
891 		if (bootverbose && sc->sc_xfer[nports][U3G_INTR]) {
892 			device_printf(dev, "port %d supports modem control",
893 				      nports);
894 		}
895 
896 		/* set stall by default */
897 		mtx_lock(&sc->sc_mtx);
898 		usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_WR]);
899 		usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_RD]);
900 		mtx_unlock(&sc->sc_mtx);
901 
902 		nports++;	/* found one port */
903 		ep++;
904 		if (nports == U3G_MAXPORTS)
905 			break;
906 	}
907 	if (nports == 0) {
908 		device_printf(dev, "no ports found\n");
909 		goto detach;
910 	}
911 	sc->sc_numports = nports;
912 
913 	error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
914 	    sc->sc_numports, sc, &u3g_callback, &sc->sc_mtx);
915 	if (error) {
916 		DPRINTF("ucom_attach failed\n");
917 		goto detach;
918 	}
919 	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
920 	device_printf(dev, "Found %u port%s.\n", sc->sc_numports,
921 	    sc->sc_numports > 1 ? "s":"");
922 
923 	return (0);
924 
925 detach:
926 	u3g_detach(dev);
927 	return (ENXIO);
928 }
929 
930 static int
931 u3g_detach(device_t dev)
932 {
933 	struct u3g_softc *sc = device_get_softc(dev);
934 	uint8_t subunit;
935 
936 	DPRINTF("sc=%p\n", sc);
937 
938 	/* NOTE: It is not dangerous to detach more ports than attached! */
939 	ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
940 
941 	for (subunit = 0; subunit != U3G_MAXPORTS; subunit++)
942 		usbd_transfer_unsetup(sc->sc_xfer[subunit], U3G_N_TRANSFER);
943 
944 	device_claim_softc(dev);
945 
946 	u3g_free_softc(sc);
947 
948 	return (0);
949 }
950 
951 UCOM_UNLOAD_DRAIN(u3g);
952 
953 static void
954 u3g_free_softc(struct u3g_softc *sc)
955 {
956 	if (ucom_unref(&sc->sc_super_ucom)) {
957 		mtx_destroy(&sc->sc_mtx);
958 		device_free_softc(sc);
959 	}
960 }
961 
962 static void
963 u3g_free(struct ucom_softc *ucom)
964 {
965 	u3g_free_softc(ucom->sc_parent);
966 }
967 
968 static void
969 u3g_start_read(struct ucom_softc *ucom)
970 {
971 	struct u3g_softc *sc = ucom->sc_parent;
972 
973 	/* start interrupt endpoint (if configured) */
974 	usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_INTR]);
975 
976 	/* start read endpoint */
977 	usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_RD]);
978 }
979 
980 static void
981 u3g_stop_read(struct ucom_softc *ucom)
982 {
983 	struct u3g_softc *sc = ucom->sc_parent;
984 
985 	/* stop interrupt endpoint (if configured) */
986 	usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_INTR]);
987 
988 	/* stop read endpoint */
989 	usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_RD]);
990 }
991 
992 static void
993 u3g_start_write(struct ucom_softc *ucom)
994 {
995 	struct u3g_softc *sc = ucom->sc_parent;
996 
997 	usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_WR]);
998 }
999 
1000 static void
1001 u3g_stop_write(struct ucom_softc *ucom)
1002 {
1003 	struct u3g_softc *sc = ucom->sc_parent;
1004 
1005 	usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_WR]);
1006 }
1007 
1008 static void
1009 u3g_write_callback(struct usb_xfer *xfer, usb_error_t error)
1010 {
1011 	struct ucom_softc *ucom = usbd_xfer_softc(xfer);
1012 	struct usb_page_cache *pc;
1013 	uint32_t actlen;
1014 
1015 	switch (USB_GET_STATE(xfer)) {
1016 	case USB_ST_TRANSFERRED:
1017 	case USB_ST_SETUP:
1018 tr_setup:
1019 		pc = usbd_xfer_get_frame(xfer, 0);
1020 		if (ucom_get_data(ucom, pc, 0, U3G_BSIZE, &actlen)) {
1021 			usbd_xfer_set_frame_len(xfer, 0, actlen);
1022 			usbd_transfer_submit(xfer);
1023 		}
1024 		break;
1025 
1026 	default:			/* Error */
1027 		if (error != USB_ERR_CANCELLED) {
1028 			/* do a builtin clear-stall */
1029 			usbd_xfer_set_stall(xfer);
1030 			goto tr_setup;
1031 		}
1032 		break;
1033 	}
1034 }
1035 
1036 static void
1037 u3g_read_callback(struct usb_xfer *xfer, usb_error_t error)
1038 {
1039 	struct ucom_softc *ucom = usbd_xfer_softc(xfer);
1040 	struct usb_page_cache *pc;
1041 	int actlen;
1042 
1043 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1044 
1045 	switch (USB_GET_STATE(xfer)) {
1046 	case USB_ST_TRANSFERRED:
1047 		pc = usbd_xfer_get_frame(xfer, 0);
1048 		ucom_put_data(ucom, pc, 0, actlen);
1049 
1050 	case USB_ST_SETUP:
1051 tr_setup:
1052 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1053 		usbd_transfer_submit(xfer);
1054 		break;
1055 
1056 	default:			/* Error */
1057 		if (error != USB_ERR_CANCELLED) {
1058 			/* do a builtin clear-stall */
1059 			usbd_xfer_set_stall(xfer);
1060 			goto tr_setup;
1061 		}
1062 		break;
1063 	}
1064 }
1065 
1066 static void
1067 u3g_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
1068 {
1069 	struct u3g_softc *sc = ucom->sc_parent;
1070 
1071 	*lsr = sc->sc_lsr[ucom->sc_subunit];
1072 	*msr = sc->sc_msr[ucom->sc_subunit];
1073 }
1074 
1075 static void
1076 u3g_cfg_set_line(struct ucom_softc *ucom)
1077 {
1078 	struct u3g_softc *sc = ucom->sc_parent;
1079 	struct usb_device_request req;
1080 
1081 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1082 	req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
1083 	USETW(req.wValue, sc->sc_line[ucom->sc_subunit]);
1084 	req.wIndex[0] = sc->sc_iface[ucom->sc_subunit];
1085 	req.wIndex[1] = 0;
1086 	USETW(req.wLength, 0);
1087 
1088 	ucom_cfg_do_request(sc->sc_udev, ucom,
1089 	    &req, NULL, 0, 1000);
1090 }
1091 
1092 static void
1093 u3g_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
1094 {
1095 	struct u3g_softc *sc = ucom->sc_parent;
1096 
1097 	DPRINTF("onoff = %d\n", onoff);
1098 
1099 	if (onoff)
1100 		sc->sc_line[ucom->sc_subunit] |= UCDC_LINE_DTR;
1101 	else
1102 		sc->sc_line[ucom->sc_subunit] &= ~UCDC_LINE_DTR;
1103 
1104 	u3g_cfg_set_line(ucom);
1105 }
1106 
1107 static void
1108 u3g_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
1109 {
1110 	struct u3g_softc *sc = ucom->sc_parent;
1111 
1112 	DPRINTF("onoff = %d\n", onoff);
1113 
1114 	if (onoff)
1115 		sc->sc_line[ucom->sc_subunit] |= UCDC_LINE_RTS;
1116 	else
1117 		sc->sc_line[ucom->sc_subunit] &= ~UCDC_LINE_RTS;
1118 
1119 	u3g_cfg_set_line(ucom);
1120 }
1121 
1122 static void
1123 u3g_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1124 {
1125 	struct ucom_softc *ucom = usbd_xfer_softc(xfer);
1126 	struct u3g_softc *sc = ucom->sc_parent;
1127 	struct usb_page_cache *pc;
1128 	struct usb_cdc_notification pkt;
1129 	int actlen;
1130 	uint16_t wLen;
1131 	uint8_t mstatus;
1132 
1133 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1134 
1135 	switch (USB_GET_STATE(xfer)) {
1136 	case USB_ST_TRANSFERRED:
1137 		if (actlen < 8) {	/* usb_cdc_notification with 2 data bytes */
1138 			DPRINTF("message too short (expected 8, received %d)\n", actlen);
1139 			goto tr_setup;
1140 		}
1141 		pc = usbd_xfer_get_frame(xfer, 0);
1142 		usbd_copy_out(pc, 0, &pkt, actlen);
1143 
1144 		wLen = UGETW(pkt.wLength);
1145 		if (wLen < 2) {
1146 			DPRINTF("message too short (expected 2 data bytes, received %d)\n", wLen);
1147 			goto tr_setup;
1148 		}
1149 
1150 		if (pkt.bmRequestType == UCDC_NOTIFICATION
1151 		    && pkt.bNotification == UCDC_N_SERIAL_STATE) {
1152 			/*
1153 		         * Set the serial state in ucom driver based on
1154 		         * the bits from the notify message
1155 		         */
1156 			DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
1157 			    pkt.data[0], pkt.data[1]);
1158 
1159 			/* currently, lsr is always zero. */
1160 			sc->sc_lsr[ucom->sc_subunit] = 0;
1161 			sc->sc_msr[ucom->sc_subunit] = 0;
1162 
1163 			mstatus = pkt.data[0];
1164 
1165 			if (mstatus & UCDC_N_SERIAL_RI)
1166 				sc->sc_msr[ucom->sc_subunit] |= SER_RI;
1167 			if (mstatus & UCDC_N_SERIAL_DSR)
1168 				sc->sc_msr[ucom->sc_subunit] |= SER_DSR;
1169 			if (mstatus & UCDC_N_SERIAL_DCD)
1170 				sc->sc_msr[ucom->sc_subunit] |= SER_DCD;
1171 			ucom_status_change(ucom);
1172 		}
1173 
1174 	case USB_ST_SETUP:
1175 tr_setup:
1176 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1177 		usbd_transfer_submit(xfer);
1178 		return;
1179 
1180 	default:			/* Error */
1181 		if (error != USB_ERR_CANCELLED) {
1182 			/* try to clear stall first */
1183 			usbd_xfer_set_stall(xfer);
1184 			goto tr_setup;
1185 		}
1186 		return;
1187 	}
1188 }
1189 
1190 static void
1191 u3g_poll(struct ucom_softc *ucom)
1192 {
1193 	struct u3g_softc *sc = ucom->sc_parent;
1194 	usbd_transfer_poll(sc->sc_xfer[ucom->sc_subunit], U3G_N_TRANSFER);
1195 }
1196