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