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