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