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 *
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.
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.
25 * - The detour through the tty layer is ridiculously expensive wrt
26 * buffering due to the high speeds.
28 * We should consider adding a simple r/w device which allows
29 * attaching of PPP in a more efficient way.
34 #include <dev/usb/usb.h>
35 #include <dev/usb/usb_mfunc.h>
36 #include <dev/usb/usb_error.h>
38 #define USB_DEBUG_VAR u3g_debug
40 #include <dev/usb/usb_core.h>
41 #include <dev/usb/usb_debug.h>
42 #include <dev/usb/usb_process.h>
43 #include <dev/usb/usb_request.h>
44 #include <dev/usb/usb_lookup.h>
45 #include <dev/usb/usb_util.h>
46 #include <dev/usb/usb_busdma.h>
47 #include <dev/usb/usb_msctest.h>
48 #include <dev/usb/usb_dynamic.h>
49 #include <dev/usb/usb_device.h>
51 #include <dev/usb/serial/usb_serial.h>
54 static int u3g_debug = 0;
56 SYSCTL_NODE(_hw_usb, OID_AUTO, u3g, CTLFLAG_RW, 0, "USB 3g");
57 SYSCTL_INT(_hw_usb_u3g, OID_AUTO, debug, CTLFLAG_RW,
58 &u3g_debug, 0, "Debug level");
61 #define U3G_MAXPORTS 8
62 #define U3G_CONFIG_INDEX 0
63 #define U3G_BSIZE 2048
74 #define U3GFL_HUAWEI_INIT 0x0001 /* Init command required */
75 #define U3GFL_SCSI_EJECT 0x0002 /* SCSI eject command required */
76 #define U3GFL_SIERRA_INIT 0x0004 /* Init command required */
77 #define U3GFL_SAEL_M460_INIT 0x0008 /* Init device */
86 struct usb2_com_super_softc sc_super_ucom;
87 struct usb2_com_softc sc_ucom[U3G_MAXPORTS];
89 struct usb2_xfer *sc_xfer[U3G_MAXPORTS][U3G_N_TRANSFER];
90 struct usb2_device *sc_udev;
93 uint8_t sc_lsr; /* local status register */
94 uint8_t sc_msr; /* U3G status register */
98 static device_probe_t u3g_probe;
99 static device_attach_t u3g_attach;
100 static device_detach_t u3g_detach;
102 static usb2_callback_t u3g_write_callback;
103 static usb2_callback_t u3g_read_callback;
105 static void u3g_start_read(struct usb2_com_softc *ucom);
106 static void u3g_stop_read(struct usb2_com_softc *ucom);
107 static void u3g_start_write(struct usb2_com_softc *ucom);
108 static void u3g_stop_write(struct usb2_com_softc *ucom);
110 static int u3g_driver_loaded(struct module *mod, int what, void *arg);
112 static const struct usb2_config u3g_config[U3G_N_TRANSFER] = {
116 .endpoint = UE_ADDR_ANY,
117 .direction = UE_DIR_OUT,
118 .bufsize = U3G_BSIZE,/* bytes */
119 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
120 .callback = &u3g_write_callback,
125 .endpoint = UE_ADDR_ANY,
126 .direction = UE_DIR_IN,
127 .bufsize = U3G_BSIZE,/* bytes */
128 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
129 .callback = &u3g_read_callback,
133 static const struct usb2_com_callback u3g_callback = {
134 .usb2_com_start_read = &u3g_start_read,
135 .usb2_com_stop_read = &u3g_stop_read,
136 .usb2_com_start_write = &u3g_start_write,
137 .usb2_com_stop_write = &u3g_stop_write,
140 static device_method_t u3g_methods[] = {
141 DEVMETHOD(device_probe, u3g_probe),
142 DEVMETHOD(device_attach, u3g_attach),
143 DEVMETHOD(device_detach, u3g_detach),
147 static devclass_t u3g_devclass;
149 static driver_t u3g_driver = {
151 .methods = u3g_methods,
152 .size = sizeof(struct u3g_softc),
155 DRIVER_MODULE(u3g, uhub, u3g_driver, u3g_devclass, u3g_driver_loaded, 0);
156 MODULE_DEPEND(u3g, ucom, 1, 1, 1);
157 MODULE_DEPEND(u3g, usb, 1, 1, 1);
159 static const struct usb2_device_id u3g_devs[] = {
160 #define U3G_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
162 U3G_DEV(OPTION, GT3G, 0),
163 U3G_DEV(OPTION, GT3GQUAD, 0),
164 U3G_DEV(OPTION, GT3GPLUS, 0),
165 U3G_DEV(OPTION, GTMAX36, 0),
166 U3G_DEV(OPTION, GTMAXHSUPA, 0),
167 U3G_DEV(OPTION, VODAFONEMC3G, 0),
168 /* OEM: Qualcomm, Inc. */
169 U3G_DEV(QUALCOMMINC, ZTE_STOR, U3GFL_SCSI_EJECT),
170 U3G_DEV(QUALCOMMINC, CDMA_MSM, U3GFL_SCSI_EJECT),
172 U3G_DEV(HUAWEI, MOBILE, U3GFL_HUAWEI_INIT),
173 U3G_DEV(HUAWEI, E220, U3GFL_HUAWEI_INIT),
175 U3G_DEV(NOVATEL, CDMA_MODEM, 0),
176 U3G_DEV(NOVATEL, ES620, 0),
177 U3G_DEV(NOVATEL, MC950D, 0),
178 U3G_DEV(NOVATEL, U720, 0),
179 U3G_DEV(NOVATEL, U727, 0),
180 U3G_DEV(NOVATEL, U740, 0),
181 U3G_DEV(NOVATEL, U740_2, 0),
182 U3G_DEV(NOVATEL, U870, 0),
183 U3G_DEV(NOVATEL, V620, 0),
184 U3G_DEV(NOVATEL, V640, 0),
185 U3G_DEV(NOVATEL, V720, 0),
186 U3G_DEV(NOVATEL, V740, 0),
187 U3G_DEV(NOVATEL, X950D, 0),
188 U3G_DEV(NOVATEL, XU870, 0),
189 U3G_DEV(NOVATEL, ZEROCD, U3GFL_SCSI_EJECT),
190 U3G_DEV(DELL, U740, 0),
192 U3G_DEV(MERLIN, V620, 0),
193 /* OEM: Sierra Wireless: */
194 U3G_DEV(SIERRA, AIRCARD580, 0),
195 U3G_DEV(SIERRA, AIRCARD595, 0),
196 U3G_DEV(SIERRA, AC595U, 0),
197 U3G_DEV(SIERRA, AC597E, 0),
198 U3G_DEV(SIERRA, C597, 0),
199 U3G_DEV(SIERRA, AC880, 0),
200 U3G_DEV(SIERRA, AC880E, 0),
201 U3G_DEV(SIERRA, AC880U, 0),
202 U3G_DEV(SIERRA, AC881, 0),
203 U3G_DEV(SIERRA, AC881E, 0),
204 U3G_DEV(SIERRA, AC881U, 0),
205 U3G_DEV(SIERRA, AC885U, 0),
206 U3G_DEV(SIERRA, EM5625, 0),
207 U3G_DEV(SIERRA, MC5720, 0),
208 U3G_DEV(SIERRA, MC5720_2, 0),
209 U3G_DEV(SIERRA, MC5725, 0),
210 U3G_DEV(SIERRA, MINI5725, 0),
211 U3G_DEV(SIERRA, AIRCARD875, 0),
212 U3G_DEV(SIERRA, MC8755, 0),
213 U3G_DEV(SIERRA, MC8755_2, 0),
214 U3G_DEV(SIERRA, MC8755_3, 0),
215 U3G_DEV(SIERRA, MC8765, 0),
216 U3G_DEV(SIERRA, AC875U, 0),
217 U3G_DEV(SIERRA, MC8775_2, 0),
218 U3G_DEV(SIERRA, MC8780, 0),
219 U3G_DEV(SIERRA, MC8781, 0),
220 U3G_DEV(HP, HS2300, 0),
221 /* Sierra TruInstaller device ID */
222 U3G_DEV(SIERRA, TRUINSTALL, U3GFL_SIERRA_INIT),
224 U3G_DEV(SILABS, SAEL, U3GFL_SAEL_M460_INIT),
228 u3g_sierra_init(struct usb2_device *udev)
230 struct usb2_device_request req;
234 req.bmRequestType = UT_VENDOR;
235 req.bRequest = UR_SET_INTERFACE;
236 USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
237 USETW(req.wIndex, UHF_PORT_CONNECTION);
238 USETW(req.wLength, 0);
240 if (usb2_do_request_flags(udev, NULL, &req,
241 NULL, 0, NULL, USB_MS_HZ)) {
242 /* ignore any errors */
248 u3g_huawei_init(struct usb2_device *udev)
250 struct usb2_device_request req;
254 req.bmRequestType = UT_WRITE_DEVICE;
255 req.bRequest = UR_SET_FEATURE;
256 USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
257 USETW(req.wIndex, UHF_PORT_SUSPEND);
258 USETW(req.wLength, 0);
260 if (usb2_do_request_flags(udev, NULL, &req,
261 NULL, 0, NULL, USB_MS_HZ)) {
262 /* ignore any errors */
268 u3g_sael_m460_init(struct usb2_device *udev)
270 static const uint8_t setup[][24] = {
271 { 0x41, 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
272 { 0x41, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 },
273 { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
274 0x01, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00,
275 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
276 { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x40, 0x02 },
277 { 0xc1, 0x08, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00 },
278 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
279 { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 },
280 { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
281 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
282 { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
283 { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
284 0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
285 { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
286 0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
287 0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
288 { 0x41, 0x12, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00 },
289 { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
290 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
291 { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
292 { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
293 0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
294 { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
295 0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
296 0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
297 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
300 struct usb2_device_request req;
308 if (usb2_req_set_alt_interface_no(udev, NULL, 0, 0)) {
309 DPRINTFN(0, "Alt setting 0 failed\n");
313 for (n = 0; n != (sizeof(setup)/sizeof(setup[0])); n++) {
315 memcpy(&req, setup[n], sizeof(req));
317 len = UGETW(req.wLength);
318 if (req.bmRequestType & UE_DIR_IN) {
319 if (len > sizeof(buf)) {
320 DPRINTFN(0, "too small buffer\n");
323 err = usb2_do_request(udev, NULL, &req, buf);
325 if (len > (sizeof(setup[0]) - 8)) {
326 DPRINTFN(0, "too small buffer\n");
329 err = usb2_do_request(udev, NULL, &req,
330 __DECONST(uint8_t *, &setup[n][8]));
333 DPRINTFN(1, "request %u failed\n",
336 * Some of the requests will fail. Stop doing
337 * requests when we are getting timeouts so
338 * that we don't block the explore/attach
341 if (err == USB_ERR_TIMEOUT)
348 u3g_lookup_huawei(struct usb2_attach_arg *uaa)
350 /* Calling the lookup function will also set the driver info! */
351 return (usb2_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa));
355 * The following function handles 3G modem devices (E220, Mobile,
356 * etc.) with auto-install flash disks for Windows/MacOSX on the first
357 * interface. After some command or some delay they change appearance
361 u3g_test_huawei_autoinst(struct usb2_device *udev,
362 struct usb2_attach_arg *uaa)
364 struct usb2_interface *iface;
365 struct usb2_interface_descriptor *id;
369 return (USB_ERR_INVAL);
371 iface = usb2_get_iface(udev, 0);
373 return (USB_ERR_INVAL);
377 return (USB_ERR_INVAL);
379 if (id->bInterfaceClass != UICLASS_MASS) {
380 return (USB_ERR_INVAL);
382 if (u3g_lookup_huawei(uaa)) {
383 /* no device match */
384 return (USB_ERR_INVAL);
386 flags = USB_GET_DRIVER_INFO(uaa);
388 if (flags & U3GFL_HUAWEI_INIT) {
389 u3g_huawei_init(udev);
390 } else if (flags & U3GFL_SCSI_EJECT) {
391 return (usb2_test_autoinstall(udev, 0, 1));
392 } else if (flags & U3GFL_SIERRA_INIT) {
393 u3g_sierra_init(udev);
396 return (USB_ERR_INVAL);
398 return (0); /* success */
402 u3g_driver_loaded(struct module *mod, int what, void *arg)
406 /* register our autoinstall handler */
407 usb2_test_huawei_autoinst_p = &u3g_test_huawei_autoinst;
410 usb2_test_huawei_unload(NULL);
419 u3g_probe(device_t self)
421 struct usb2_attach_arg *uaa = device_get_ivars(self);
423 if (uaa->usb_mode != USB_MODE_HOST) {
426 if (uaa->info.bConfigIndex != U3G_CONFIG_INDEX) {
429 if (uaa->info.bInterfaceClass != UICLASS_VENDOR) {
432 return (u3g_lookup_huawei(uaa));
436 u3g_attach(device_t dev)
438 struct usb2_config u3g_config_tmp[U3G_N_TRANSFER];
439 struct usb2_attach_arg *uaa = device_get_ivars(dev);
440 struct u3g_softc *sc = device_get_softc(dev);
441 struct usb2_interface *iface;
442 struct usb2_interface_descriptor *id;
443 uint32_t iface_valid;
444 int error, flags, nports;
448 DPRINTF("sc=%p\n", sc);
450 flags = USB_GET_DRIVER_INFO(uaa);
452 if (flags & U3GFL_SAEL_M460_INIT)
453 u3g_sael_m460_init(uaa->device);
455 /* copy in USB config */
456 for (n = 0; n != U3G_N_TRANSFER; n++)
457 u3g_config_tmp[n] = u3g_config[n];
459 device_set_usb2_desc(dev);
460 mtx_init(&sc->sc_mtx, "u3g", NULL, MTX_DEF);
462 sc->sc_udev = uaa->device;
464 /* Claim all interfaces on the device */
466 for (i = uaa->info.bIfaceIndex; i < USB_IFACE_MAX; i++) {
467 iface = usb2_get_iface(uaa->device, i);
470 id = usb2_get_interface_descriptor(iface);
471 if (id == NULL || id->bInterfaceClass != UICLASS_VENDOR)
473 usb2_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
474 iface_valid |= (1<<i);
477 i = 0; /* interface index */
478 ep = 0; /* endpoint index */
479 nports = 0; /* number of ports */
480 while (i < USB_IFACE_MAX) {
481 if ((iface_valid & (1<<i)) == 0) {
486 /* update BULK endpoint index */
487 for (n = 0; n < U3G_N_TRANSFER; n++)
488 u3g_config_tmp[n].ep_index = ep;
490 /* try to allocate a set of BULK endpoints */
491 error = usb2_transfer_setup(uaa->device, &i,
492 sc->sc_xfer[nports], u3g_config_tmp, U3G_N_TRANSFER,
493 &sc->sc_ucom[nports], &sc->sc_mtx);
501 /* set stall by default */
502 mtx_lock(&sc->sc_mtx);
503 usb2_transfer_set_stall(sc->sc_xfer[nports][U3G_BULK_WR]);
504 usb2_transfer_set_stall(sc->sc_xfer[nports][U3G_BULK_RD]);
505 mtx_unlock(&sc->sc_mtx);
507 nports++; /* found one port */
509 if (nports == U3G_MAXPORTS)
513 device_printf(dev, "no ports found\n");
516 sc->sc_numports = nports;
518 error = usb2_com_attach(&sc->sc_super_ucom, sc->sc_ucom,
519 sc->sc_numports, sc, &u3g_callback, &sc->sc_mtx);
521 DPRINTF("usb2_com_attach failed\n");
524 if (sc->sc_numports > 1)
525 device_printf(dev, "Found %u ports.\n", sc->sc_numports);
534 u3g_detach(device_t dev)
536 struct u3g_softc *sc = device_get_softc(dev);
539 DPRINTF("sc=%p\n", sc);
541 /* NOTE: It is not dangerous to detach more ports than attached! */
542 usb2_com_detach(&sc->sc_super_ucom, sc->sc_ucom, U3G_MAXPORTS);
544 for (m = 0; m != U3G_MAXPORTS; m++)
545 usb2_transfer_unsetup(sc->sc_xfer[m], U3G_N_TRANSFER);
546 mtx_destroy(&sc->sc_mtx);
552 u3g_start_read(struct usb2_com_softc *ucom)
554 struct u3g_softc *sc = ucom->sc_parent;
556 /* start read endpoint */
557 usb2_transfer_start(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_RD]);
562 u3g_stop_read(struct usb2_com_softc *ucom)
564 struct u3g_softc *sc = ucom->sc_parent;
566 /* stop read endpoint */
567 usb2_transfer_stop(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_RD]);
572 u3g_start_write(struct usb2_com_softc *ucom)
574 struct u3g_softc *sc = ucom->sc_parent;
576 usb2_transfer_start(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_WR]);
581 u3g_stop_write(struct usb2_com_softc *ucom)
583 struct u3g_softc *sc = ucom->sc_parent;
585 usb2_transfer_stop(sc->sc_xfer[ucom->sc_local_unit][U3G_BULK_WR]);
590 u3g_write_callback(struct usb2_xfer *xfer)
592 struct usb2_com_softc *ucom = xfer->priv_sc;
595 switch (USB_GET_STATE(xfer)) {
596 case USB_ST_TRANSFERRED:
599 if (usb2_com_get_data(ucom, xfer->frbuffers, 0,
600 U3G_BSIZE, &actlen)) {
601 xfer->frlengths[0] = actlen;
602 usb2_start_hardware(xfer);
607 if (xfer->error != USB_ERR_CANCELLED) {
608 /* do a builtin clear-stall */
609 xfer->flags.stall_pipe = 1;
618 u3g_read_callback(struct usb2_xfer *xfer)
620 struct usb2_com_softc *ucom = xfer->priv_sc;
622 switch (USB_GET_STATE(xfer)) {
623 case USB_ST_TRANSFERRED:
624 usb2_com_put_data(ucom, xfer->frbuffers, 0, xfer->actlen);
628 xfer->frlengths[0] = xfer->max_data_length;
629 usb2_start_hardware(xfer);
633 if (xfer->error != USB_ERR_CANCELLED) {
634 /* do a builtin clear-stall */
635 xfer->flags.stall_pipe = 1;