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