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