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