2 * Copyright (c) 2010 Fredrik Lindberg <fli@shapeshifter.se>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/param.h>
30 #include <sys/types.h>
31 #include <sys/sockio.h>
33 #include <sys/malloc.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/socket.h>
38 #include <sys/sysctl.h>
39 #include <sys/condvar.h>
44 #include <sys/systm.h>
45 #include <sys/limits.h>
47 #include <machine/bus.h>
50 #include <net/if_types.h>
51 #include <net/netisr.h>
53 #include <netinet/in.h>
54 #include <netinet/ip.h>
55 #include <netinet/ip6.h>
57 #include <dev/usb/usb.h>
58 #include <dev/usb/usbdi.h>
59 #include <dev/usb/usbdi_util.h>
60 #include <dev/usb/usb_cdc.h>
62 #define USB_DEBUG_VAR uhso_debug
63 #include <dev/usb/usb_debug.h>
64 #include <dev/usb/usb_process.h>
65 #include <dev/usb/usb_busdma.h>
66 #include <dev/usb/usb_msctest.h>
68 #include <dev/usb/serial/usb_serial.h>
71 struct uhso_softc *ht_sc;
72 struct usb_xfer *ht_xfer[3];
73 int ht_muxport; /* Mux. port no */
80 struct usb_device *sc_udev;
82 uint32_t sc_type; /* Interface definition */
85 struct usb_xfer *sc_xfer[3];
87 uint8_t sc_iface_index;
90 struct usb_xfer * sc_ctrl_xfer[2];
91 uint8_t sc_ctrl_iface_no;
94 struct usb_xfer *sc_if_xfer[2];
96 struct mbuf *sc_mwait; /* Partial packet */
97 size_t sc_waitlen; /* No. of outstanding bytes */
98 struct ifqueue sc_rxq;
101 /* TTY related structures */
102 struct ucom_super_softc sc_super_ucom;
104 struct uhso_tty *sc_tty;
105 struct ucom_softc *sc_ucom;
111 #define UHSO_MAX_MTU 2048
114 * There are mainly two type of cards floating around.
115 * The first one has 2,3 or 4 interfaces with a multiplexed serial port
116 * and packet interface on the first interface and bulk serial ports
118 * The second type of card has several other interfaces, their purpose
119 * can be detected during run-time.
121 #define UHSO_IFACE_SPEC(usb_type, port, port_type) \
122 (((usb_type) << 24) | ((port) << 16) | (port_type))
124 #define UHSO_IFACE_USB_TYPE(x) ((x >> 24) & 0xff)
125 #define UHSO_IFACE_PORT(x) ((x >> 16) & 0xff)
126 #define UHSO_IFACE_PORT_TYPE(x) (x & 0xff)
129 * USB interface types
131 #define UHSO_IF_NET 0x01 /* Network packet interface */
132 #define UHSO_IF_MUX 0x02 /* Multiplexed serial port */
133 #define UHSO_IF_BULK 0x04 /* Bulk interface */
138 #define UHSO_PORT_UNKNOWN 0x00
139 #define UHSO_PORT_SERIAL 0x01 /* Serial port */
140 #define UHSO_PORT_NETWORK 0x02 /* Network packet interface */
143 * Multiplexed serial port destination sub-port names
145 #define UHSO_MPORT_TYPE_CTL 0x00 /* Control port */
146 #define UHSO_MPORT_TYPE_APP 0x01 /* Application */
147 #define UHSO_MPORT_TYPE_PCSC 0x02
148 #define UHSO_MPORT_TYPE_GPS 0x03
149 #define UHSO_MPORT_TYPE_APP2 0x04 /* Secondary application */
150 #define UHSO_MPORT_TYPE_MAX UHSO_MPORT_TYPE_APP2
151 #define UHSO_MPORT_TYPE_NOMAX 8 /* Max number of mux ports */
155 * Note that these definitions are arbitrary and do not match the values
156 * returned by the auto config descriptor.
158 #define UHSO_PORT_TYPE_UNKNOWN 0x00
159 #define UHSO_PORT_TYPE_CTL 0x01
160 #define UHSO_PORT_TYPE_APP 0x02
161 #define UHSO_PORT_TYPE_APP2 0x03
162 #define UHSO_PORT_TYPE_MODEM 0x04
163 #define UHSO_PORT_TYPE_NETWORK 0x05
164 #define UHSO_PORT_TYPE_DIAG 0x06
165 #define UHSO_PORT_TYPE_DIAG2 0x07
166 #define UHSO_PORT_TYPE_GPS 0x08
167 #define UHSO_PORT_TYPE_GPSCTL 0x09
168 #define UHSO_PORT_TYPE_PCSC 0x0a
169 #define UHSO_PORT_TYPE_MSD 0x0b
170 #define UHSO_PORT_TYPE_VOICE 0x0c
171 #define UHSO_PORT_TYPE_MAX 0x0c
173 static eventhandler_tag uhso_etag;
175 /* Overall port type */
176 static char *uhso_port[] = {
184 * Map between interface port type read from device and description type.
185 * The position in this array is a direct map to the auto config
188 static unsigned char uhso_port_map[] = {
189 UHSO_PORT_TYPE_UNKNOWN,
192 UHSO_PORT_TYPE_GPSCTL,
196 UHSO_PORT_TYPE_NETWORK,
197 UHSO_PORT_TYPE_MODEM,
202 static char uhso_port_map_max = sizeof(uhso_port_map) / sizeof(char);
204 static unsigned char uhso_mux_port_map[] = {
212 static char *uhso_port_type[] = {
213 "Unknown", /* Not a valid port */
216 "Application (Secondary)",
220 "Diagnostic (Secondary)",
228 static char *uhso_port_type_sysctl[] = {
244 #define UHSO_STATIC_IFACE 0x01
245 #define UHSO_AUTO_IFACE 0x02
247 /* ifnet device unit allocations */
248 static struct unrhdr *uhso_ifnet_unit = NULL;
250 static const STRUCT_USB_HOST_ID uhso_devs[] = {
251 #define UHSO_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
252 /* Option GlobeTrotter MAX 7.2 with upgraded firmware */
253 UHSO_DEV(OPTION, GTMAX72, UHSO_STATIC_IFACE),
254 /* Option GlobeSurfer iCON 7.2 */
255 UHSO_DEV(OPTION, GSICON72, UHSO_STATIC_IFACE),
256 /* Option iCON 225 */
257 UHSO_DEV(OPTION, GTHSDPA, UHSO_STATIC_IFACE),
258 /* Option GlobeSurfer iCON HSUPA */
259 UHSO_DEV(OPTION, GSICONHSUPA, UHSO_STATIC_IFACE),
260 /* Option GlobeTrotter HSUPA */
261 UHSO_DEV(OPTION, GTHSUPA, UHSO_STATIC_IFACE),
263 UHSO_DEV(OPTION, GE40X, UHSO_AUTO_IFACE),
264 UHSO_DEV(OPTION, GE40X_1, UHSO_AUTO_IFACE),
265 UHSO_DEV(OPTION, GE40X_2, UHSO_AUTO_IFACE),
266 UHSO_DEV(OPTION, GE40X_3, UHSO_AUTO_IFACE),
267 /* Option GlobeSurfer iCON 401 */
268 UHSO_DEV(OPTION, ICON401, UHSO_AUTO_IFACE),
269 /* Option GlobeTrotter Module 382 */
270 UHSO_DEV(OPTION, GMT382, UHSO_AUTO_IFACE),
271 /* Option iCON EDGE */
272 UHSO_DEV(OPTION, ICONEDGE, UHSO_STATIC_IFACE),
273 /* Option Module HSxPA */
274 UHSO_DEV(OPTION, MODHSXPA, UHSO_STATIC_IFACE),
275 /* Option iCON 321 */
276 UHSO_DEV(OPTION, ICON321, UHSO_STATIC_IFACE),
277 /* Option iCON 322 */
278 UHSO_DEV(OPTION, GTICON322, UHSO_STATIC_IFACE),
279 /* Option iCON 505 */
280 UHSO_DEV(OPTION, ICON505, UHSO_AUTO_IFACE),
281 /* Option iCON 452 */
282 UHSO_DEV(OPTION, ICON505, UHSO_AUTO_IFACE),
286 static SYSCTL_NODE(_hw_usb, OID_AUTO, uhso, CTLFLAG_RW, 0, "USB uhso");
287 static int uhso_autoswitch = 1;
288 SYSCTL_INT(_hw_usb_uhso, OID_AUTO, auto_switch, CTLFLAG_RW,
289 &uhso_autoswitch, 0, "Automatically switch to modem mode");
293 static int uhso_debug = UHSO_DEBUG;
295 static int uhso_debug = -1;
298 SYSCTL_INT(_hw_usb_uhso, OID_AUTO, debug, CTLFLAG_RW,
299 &uhso_debug, 0, "Debug level");
301 #define UHSO_DPRINTF(n, x, ...) {\
302 if (uhso_debug >= n) {\
303 printf("%s: " x, __func__, ##__VA_ARGS__);\
307 #define UHSO_DPRINTF(n, x, ...)
310 #ifdef UHSO_DEBUG_HEXDUMP
311 # define UHSO_HEXDUMP(_buf, _len) do { \
314 const char *__buf = (const char *)_buf; \
315 for (__tmp = 0; __tmp < _len; __tmp++) \
316 printf("%02hhx ", *__buf++); \
321 # define UHSO_HEXDUMP(_buf, _len)
325 UHSO_MUX_ENDPT_INTR = 0,
342 UHSO_BULK_ENDPT_READ = 0,
343 UHSO_BULK_ENDPT_WRITE,
344 UHSO_BULK_ENDPT_INTR,
348 static usb_callback_t uhso_mux_intr_callback;
349 static usb_callback_t uhso_mux_read_callback;
350 static usb_callback_t uhso_mux_write_callback;
351 static usb_callback_t uhso_bs_read_callback;
352 static usb_callback_t uhso_bs_write_callback;
353 static usb_callback_t uhso_bs_intr_callback;
354 static usb_callback_t uhso_ifnet_read_callback;
355 static usb_callback_t uhso_ifnet_write_callback;
357 /* Config used for the default control pipes */
358 static const struct usb_config uhso_ctrl_config[UHSO_CTRL_MAX] = {
362 .direction = UE_DIR_ANY,
363 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
364 .bufsize = sizeof(struct usb_device_request) + 1024,
365 .callback = &uhso_mux_read_callback
368 [UHSO_CTRL_WRITE] = {
371 .direction = UE_DIR_ANY,
372 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
373 .bufsize = sizeof(struct usb_device_request) + 1024,
375 .callback = &uhso_mux_write_callback
379 /* Config for the multiplexed serial ports */
380 static const struct usb_config uhso_mux_config[UHSO_MUX_ENDPT_MAX] = {
381 [UHSO_MUX_ENDPT_INTR] = {
382 .type = UE_INTERRUPT,
383 .endpoint = UE_ADDR_ANY,
384 .direction = UE_DIR_IN,
385 .flags = { .short_xfer_ok = 1 },
387 .callback = &uhso_mux_intr_callback,
391 /* Config for the raw IP-packet interface */
392 static const struct usb_config uhso_ifnet_config[UHSO_IFNET_MAX] = {
393 [UHSO_IFNET_READ] = {
395 .endpoint = UE_ADDR_ANY,
396 .direction = UE_DIR_IN,
397 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
399 .callback = &uhso_ifnet_read_callback
401 [UHSO_IFNET_WRITE] = {
403 .endpoint = UE_ADDR_ANY,
404 .direction = UE_DIR_OUT,
405 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
407 .timeout = 5 * USB_MS_HZ,
408 .callback = &uhso_ifnet_write_callback
412 /* Config for interfaces with normal bulk serial ports */
413 static const struct usb_config uhso_bs_config[UHSO_BULK_ENDPT_MAX] = {
414 [UHSO_BULK_ENDPT_READ] = {
416 .endpoint = UE_ADDR_ANY,
417 .direction = UE_DIR_IN,
418 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
420 .callback = &uhso_bs_read_callback
423 [UHSO_BULK_ENDPT_WRITE] = {
425 .endpoint = UE_ADDR_ANY,
426 .direction = UE_DIR_OUT,
427 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
429 .callback = &uhso_bs_write_callback
432 [UHSO_BULK_ENDPT_INTR] = {
433 .type = UE_INTERRUPT,
434 .endpoint = UE_ADDR_ANY,
435 .direction = UE_DIR_IN,
436 .flags = { .short_xfer_ok = 1 },
438 .callback = &uhso_bs_intr_callback,
442 static int uhso_probe_iface(struct uhso_softc *, int,
443 int (*probe)(struct usb_device *, int));
444 static int uhso_probe_iface_auto(struct usb_device *, int);
445 static int uhso_probe_iface_static(struct usb_device *, int);
446 static int uhso_attach_muxserial(struct uhso_softc *, struct usb_interface *,
448 static int uhso_attach_bulkserial(struct uhso_softc *, struct usb_interface *,
450 static int uhso_attach_ifnet(struct uhso_softc *, struct usb_interface *,
452 static void uhso_test_autoinst(void *, struct usb_device *,
453 struct usb_attach_arg *);
454 static int uhso_driver_loaded(struct module *, int, void *);
455 static int uhso_radio_sysctl(SYSCTL_HANDLER_ARGS);
456 static int uhso_radio_ctrl(struct uhso_softc *, int);
458 static void uhso_free(struct ucom_softc *);
459 static void uhso_ucom_start_read(struct ucom_softc *);
460 static void uhso_ucom_stop_read(struct ucom_softc *);
461 static void uhso_ucom_start_write(struct ucom_softc *);
462 static void uhso_ucom_stop_write(struct ucom_softc *);
463 static void uhso_ucom_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
464 static void uhso_ucom_cfg_set_dtr(struct ucom_softc *, uint8_t);
465 static void uhso_ucom_cfg_set_rts(struct ucom_softc *, uint8_t);
466 static void uhso_if_init(void *);
467 static void uhso_if_start(struct ifnet *);
468 static void uhso_if_stop(struct uhso_softc *);
469 static int uhso_if_ioctl(struct ifnet *, u_long, caddr_t);
470 static int uhso_if_output(struct ifnet *, struct mbuf *, struct sockaddr *,
472 static void uhso_if_rxflush(void *);
474 static device_probe_t uhso_probe;
475 static device_attach_t uhso_attach;
476 static device_detach_t uhso_detach;
477 static void uhso_free_softc(struct uhso_softc *);
479 static device_method_t uhso_methods[] = {
480 DEVMETHOD(device_probe, uhso_probe),
481 DEVMETHOD(device_attach, uhso_attach),
482 DEVMETHOD(device_detach, uhso_detach),
486 static driver_t uhso_driver = {
488 .methods = uhso_methods,
489 .size = sizeof(struct uhso_softc)
492 static devclass_t uhso_devclass;
493 DRIVER_MODULE(uhso, uhub, uhso_driver, uhso_devclass, uhso_driver_loaded, 0);
494 MODULE_DEPEND(uhso, ucom, 1, 1, 1);
495 MODULE_DEPEND(uhso, usb, 1, 1, 1);
496 MODULE_VERSION(uhso, 1);
498 static struct ucom_callback uhso_ucom_callback = {
499 .ucom_cfg_get_status = &uhso_ucom_cfg_get_status,
500 .ucom_cfg_set_dtr = &uhso_ucom_cfg_set_dtr,
501 .ucom_cfg_set_rts = &uhso_ucom_cfg_set_rts,
502 .ucom_start_read = uhso_ucom_start_read,
503 .ucom_stop_read = uhso_ucom_stop_read,
504 .ucom_start_write = uhso_ucom_start_write,
505 .ucom_stop_write = uhso_ucom_stop_write,
506 .ucom_free = &uhso_free,
510 uhso_probe(device_t self)
512 struct usb_attach_arg *uaa = device_get_ivars(self);
515 if (uaa->usb_mode != USB_MODE_HOST)
517 if (uaa->info.bConfigIndex != 0)
519 if (uaa->info.bDeviceClass != 0xff)
522 error = usbd_lookup_id_by_uaa(uhso_devs, sizeof(uhso_devs), uaa);
527 * Probe device to see if we are able to attach
528 * to this interface or not.
530 if (USB_GET_DRIVER_INFO(uaa) == UHSO_AUTO_IFACE) {
531 if (uhso_probe_iface_auto(uaa->device,
532 uaa->info.bIfaceNum) == 0)
539 uhso_attach(device_t self)
541 struct uhso_softc *sc = device_get_softc(self);
542 struct usb_attach_arg *uaa = device_get_ivars(self);
543 struct usb_interface_descriptor *id;
544 struct sysctl_ctx_list *sctx;
545 struct sysctl_oid *soid;
546 struct sysctl_oid *tree = NULL, *tty_node;
547 struct ucom_softc *ucom;
555 sc->sc_udev = uaa->device;
556 mtx_init(&sc->sc_mtx, "uhso", NULL, MTX_DEF);
557 ucom_ref(&sc->sc_super_ucom);
563 id = usbd_get_interface_descriptor(uaa->iface);
564 sc->sc_ctrl_iface_no = id->bInterfaceNumber;
566 sc->sc_iface_no = uaa->info.bIfaceNum;
567 sc->sc_iface_index = uaa->info.bIfaceIndex;
569 /* Setup control pipe */
570 uerr = usbd_transfer_setup(uaa->device,
571 &sc->sc_iface_index, sc->sc_ctrl_xfer,
572 uhso_ctrl_config, UHSO_CTRL_MAX, sc, &sc->sc_mtx);
574 device_printf(self, "Failed to setup control pipe: %s\n",
579 if (USB_GET_DRIVER_INFO(uaa) == UHSO_STATIC_IFACE)
580 probe_f = uhso_probe_iface_static;
581 else if (USB_GET_DRIVER_INFO(uaa) == UHSO_AUTO_IFACE)
582 probe_f = uhso_probe_iface_auto;
586 error = uhso_probe_iface(sc, uaa->info.bIfaceNum, probe_f);
590 sctx = device_get_sysctl_ctx(sc->sc_dev);
591 soid = device_get_sysctl_tree(sc->sc_dev);
593 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "type",
594 CTLFLAG_RD, uhso_port[UHSO_IFACE_PORT(sc->sc_type)], 0,
595 "Port available at this interface");
596 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "radio",
597 CTLTYPE_INT | CTLFLAG_RW, sc, 0, uhso_radio_sysctl, "I", "Enable radio");
600 * The default interface description on most Option devices isn't
601 * very helpful. So we skip device_set_usb_desc and set the
602 * device description manually.
604 device_set_desc_copy(self, uhso_port_type[UHSO_IFACE_PORT_TYPE(sc->sc_type)]);
605 /* Announce device */
606 device_printf(self, "<%s port> at <%s %s> on %s\n",
607 uhso_port_type[UHSO_IFACE_PORT_TYPE(sc->sc_type)],
608 usb_get_manufacturer(uaa->device),
609 usb_get_product(uaa->device),
610 device_get_nameunit(device_get_parent(self)));
612 if (sc->sc_ttys > 0) {
613 SYSCTL_ADD_INT(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "ports",
614 CTLFLAG_RD, &sc->sc_ttys, 0, "Number of attached serial ports");
616 tree = SYSCTL_ADD_NODE(sctx, SYSCTL_CHILDREN(soid), OID_AUTO,
617 "port", CTLFLAG_RD, NULL, "Serial ports");
621 * Loop through the number of found TTYs and create sysctl
624 for (i = 0; i < sc->sc_ttys; i++) {
626 ucom = &sc->sc_ucom[i];
628 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX)
629 port = uhso_mux_port_map[ht->ht_muxport];
631 port = UHSO_IFACE_PORT_TYPE(sc->sc_type);
633 desc = uhso_port_type_sysctl[port];
635 tty_node = SYSCTL_ADD_NODE(sctx, SYSCTL_CHILDREN(tree), OID_AUTO,
636 desc, CTLFLAG_RD, NULL, "");
639 if (sc->sc_ttys == 1)
640 snprintf(ht->ht_name, 32, "cuaU%d", ucom->sc_super->sc_unit);
642 snprintf(ht->ht_name, 32, "cuaU%d.%d",
643 ucom->sc_super->sc_unit, ucom->sc_subunit);
646 desc = uhso_port_type[port];
647 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(tty_node), OID_AUTO,
648 "tty", CTLFLAG_RD, ht->ht_name, 0, "");
649 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(tty_node), OID_AUTO,
650 "desc", CTLFLAG_RD, desc, 0, "");
653 device_printf(sc->sc_dev,
654 "\"%s\" port at %s\n", desc, ht->ht_name);
659 uhso_detach(sc->sc_dev);
664 uhso_detach(device_t self)
666 struct uhso_softc *sc = device_get_softc(self);
669 usbd_transfer_unsetup(sc->sc_xfer, 3);
670 usbd_transfer_unsetup(sc->sc_ctrl_xfer, UHSO_CTRL_MAX);
671 if (sc->sc_ttys > 0) {
672 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
674 for (i = 0; i < sc->sc_ttys; i++) {
675 if (sc->sc_tty[i].ht_muxport != -1) {
676 usbd_transfer_unsetup(sc->sc_tty[i].ht_xfer,
681 free(sc->sc_tty, M_USBDEV);
682 free(sc->sc_ucom, M_USBDEV);
685 if (sc->sc_ifp != NULL) {
686 callout_drain(&sc->sc_c);
687 free_unr(uhso_ifnet_unit, sc->sc_ifp->if_dunit);
688 mtx_lock(&sc->sc_mtx);
690 bpfdetach(sc->sc_ifp);
691 if_detach(sc->sc_ifp);
693 mtx_unlock(&sc->sc_mtx);
694 usbd_transfer_unsetup(sc->sc_if_xfer, UHSO_IFNET_MAX);
697 device_claim_softc(self);
704 UCOM_UNLOAD_DRAIN(uhso);
707 uhso_free_softc(struct uhso_softc *sc)
709 if (ucom_unref(&sc->sc_super_ucom)) {
710 mtx_destroy(&sc->sc_mtx);
711 device_free_softc(sc);
716 uhso_free(struct ucom_softc *ucom)
718 uhso_free_softc(ucom->sc_parent);
722 uhso_test_autoinst(void *arg, struct usb_device *udev,
723 struct usb_attach_arg *uaa)
725 struct usb_interface *iface;
726 struct usb_interface_descriptor *id;
728 if (uaa->dev_state != UAA_DEV_READY || !uhso_autoswitch)
731 iface = usbd_get_iface(udev, 0);
735 if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
737 if (usbd_lookup_id_by_uaa(uhso_devs, sizeof(uhso_devs), uaa))
738 return; /* no device match */
740 if (usb_msc_eject(udev, 0, MSC_EJECT_REZERO) == 0) {
741 /* success, mark the udev as disappearing */
742 uaa->dev_state = UAA_DEV_EJECTING;
747 uhso_driver_loaded(struct module *mod, int what, void *arg)
751 /* register our autoinstall handler */
752 uhso_etag = EVENTHANDLER_REGISTER(usb_dev_configured,
753 uhso_test_autoinst, NULL, EVENTHANDLER_PRI_ANY);
754 /* create our unit allocator for inet devs */
755 uhso_ifnet_unit = new_unrhdr(0, INT_MAX, NULL);
758 EVENTHANDLER_DEREGISTER(usb_dev_configured, uhso_etag);
759 delete_unrhdr(uhso_ifnet_unit);
768 * Probe the interface type by querying the device. The elements
769 * of an array indicates the capabilities of a particular interface.
770 * Returns a bit mask with the interface capabilities.
773 uhso_probe_iface_auto(struct usb_device *udev, int index)
775 struct usb_device_request req;
781 req.bmRequestType = UT_READ_VENDOR_DEVICE;
783 USETW(req.wValue, 0);
784 USETW(req.wIndex, 0);
785 USETW(req.wLength, 17);
787 uerr = usbd_do_request_flags(udev, NULL, &req, buf,
788 0, &actlen, USB_MS_HZ);
790 printf("%s: usbd_do_request_flags failed, %s\n",
791 __func__, usbd_errstr(uerr));
795 UHSO_DPRINTF(1, "actlen=%d\n", actlen);
796 UHSO_HEXDUMP(buf, 17);
798 if (index < 0 || index > 16) {
799 UHSO_DPRINTF(0, "Index %d out of range\n", index);
803 UHSO_DPRINTF(1, "index=%d, type=%x[%s]\n", index, buf[index],
804 uhso_port_type[(int)uhso_port_map[(int)buf[index]]]);
806 if (buf[index] >= uhso_port_map_max)
809 port = uhso_port_map[(int)buf[index]];
812 case UHSO_PORT_TYPE_NETWORK:
813 return (UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
814 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK, port));
815 case UHSO_PORT_TYPE_DIAG:
816 case UHSO_PORT_TYPE_DIAG2:
817 case UHSO_PORT_TYPE_CTL:
818 case UHSO_PORT_TYPE_APP:
819 case UHSO_PORT_TYPE_APP2:
820 case UHSO_PORT_TYPE_MODEM:
821 return (UHSO_IFACE_SPEC(UHSO_IF_BULK,
822 UHSO_PORT_SERIAL, port));
823 case UHSO_PORT_TYPE_MSD:
825 case UHSO_PORT_TYPE_UNKNOWN:
834 * Returns the capabilities of interfaces for devices that don't
835 * support the automatic query.
836 * Returns a bit mask with the interface capabilities.
839 uhso_probe_iface_static(struct usb_device *udev, int index)
841 struct usb_config_descriptor *cd;
843 cd = usbd_get_config_descriptor(udev);
844 if (cd->bNumInterface <= 3) {
845 /* Cards with 3 or less interfaces */
848 return UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
849 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK,
850 UHSO_PORT_TYPE_NETWORK);
852 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
853 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG);
855 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
856 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_MODEM);
859 /* Cards with 4 interfaces */
862 return UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
863 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK,
864 UHSO_PORT_TYPE_NETWORK);
866 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
867 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG2);
869 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
870 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_MODEM);
872 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
873 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG);
880 * Probes an interface for its particular capabilities and attaches if
881 * it's a supported interface.
884 uhso_probe_iface(struct uhso_softc *sc, int index,
885 int (*probe)(struct usb_device *, int))
887 struct usb_interface *iface;
890 UHSO_DPRINTF(1, "Probing for interface %d, probe_func=%p\n", index, probe);
892 type = probe(sc->sc_udev, index);
893 UHSO_DPRINTF(1, "Probe result %x\n", type);
898 iface = usbd_get_iface(sc->sc_udev, index);
900 if (UHSO_IFACE_PORT_TYPE(type) == UHSO_PORT_TYPE_NETWORK) {
901 error = uhso_attach_ifnet(sc, iface, type);
903 UHSO_DPRINTF(1, "uhso_attach_ifnet failed");
908 * If there is an additional interrupt endpoint on this
909 * interface then we most likely have a multiplexed serial port
912 if (iface->idesc->bNumEndpoints < 3) {
913 sc->sc_type = UHSO_IFACE_SPEC(
914 UHSO_IFACE_USB_TYPE(type) & ~UHSO_IF_MUX,
915 UHSO_IFACE_PORT(type) & ~UHSO_PORT_SERIAL,
916 UHSO_IFACE_PORT_TYPE(type));
920 UHSO_DPRINTF(1, "Trying to attach mux. serial\n");
921 error = uhso_attach_muxserial(sc, iface, type);
922 if (error == 0 && sc->sc_ttys > 0) {
923 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
924 sc->sc_ttys, sc, &uhso_ucom_callback, &sc->sc_mtx);
926 device_printf(sc->sc_dev, "ucom_attach failed\n");
929 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, sc->sc_dev);
931 mtx_lock(&sc->sc_mtx);
932 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
933 mtx_unlock(&sc->sc_mtx);
935 } else if ((UHSO_IFACE_USB_TYPE(type) & UHSO_IF_BULK) &&
936 UHSO_IFACE_PORT(type) & UHSO_PORT_SERIAL) {
938 error = uhso_attach_bulkserial(sc, iface, type);
942 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
943 sc->sc_ttys, sc, &uhso_ucom_callback, &sc->sc_mtx);
945 device_printf(sc->sc_dev, "ucom_attach failed\n");
948 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, sc->sc_dev);
951 UHSO_DPRINTF(0, "Unknown type %x\n", type);
959 uhso_radio_ctrl(struct uhso_softc *sc, int onoff)
961 struct usb_device_request req;
964 req.bmRequestType = UT_VENDOR;
965 req.bRequest = onoff ? 0x82 : 0x81;
966 USETW(req.wValue, 0);
967 USETW(req.wIndex, 0);
968 USETW(req.wLength, 0);
970 uerr = usbd_do_request(sc->sc_udev, NULL, &req, NULL);
972 device_printf(sc->sc_dev, "usbd_do_request_flags failed: %s\n",
980 uhso_radio_sysctl(SYSCTL_HANDLER_ARGS)
982 struct uhso_softc *sc = arg1;
985 radio = sc->sc_radio;
986 error = sysctl_handle_int(oidp, &radio, 0, req);
989 if (radio != sc->sc_radio) {
990 radio = radio != 0 ? 1 : 0;
991 error = uhso_radio_ctrl(sc, radio);
993 sc->sc_radio = radio;
1000 * Expands allocated memory to fit an additional TTY.
1001 * Two arrays are kept with matching indexes, one for ucom and one
1002 * for our private data.
1005 uhso_alloc_tty(struct uhso_softc *sc)
1009 sc->sc_tty = reallocf(sc->sc_tty, sizeof(struct uhso_tty) * sc->sc_ttys,
1010 M_USBDEV, M_WAITOK | M_ZERO);
1011 if (sc->sc_tty == NULL)
1014 sc->sc_ucom = reallocf(sc->sc_ucom,
1015 sizeof(struct ucom_softc) * sc->sc_ttys, M_USBDEV, M_WAITOK | M_ZERO);
1016 if (sc->sc_ucom == NULL)
1019 sc->sc_tty[sc->sc_ttys - 1].ht_sc = sc;
1021 UHSO_DPRINTF(1, "Allocated TTY %d\n", sc->sc_ttys - 1);
1022 return (sc->sc_ttys - 1);
1026 * Attach a multiplexed serial port
1027 * Data is read/written with requests on the default control pipe. An interrupt
1028 * endpoint returns when there is new data to be read.
1031 uhso_attach_muxserial(struct uhso_softc *sc, struct usb_interface *iface,
1034 struct usb_descriptor *desc;
1039 * The class specific interface (type 0x24) descriptor subtype field
1040 * contains a bitmask that specifies which (and how many) ports that
1041 * are available through this multiplexed serial port.
1043 desc = usbd_find_descriptor(sc->sc_udev, NULL,
1044 iface->idesc->bInterfaceNumber, UDESC_CS_INTERFACE, 0xff, 0, 0);
1046 UHSO_DPRINTF(0, "Failed to find UDESC_CS_INTERFACE\n");
1050 UHSO_DPRINTF(1, "Mux port mask %x\n", desc->bDescriptorSubtype);
1051 if (desc->bDescriptorSubtype == 0)
1055 * The bitmask is one octet, loop through the number of
1056 * bits that are set and create a TTY for each.
1058 for (i = 0; i < 8; i++) {
1060 if ((port & desc->bDescriptorSubtype) == port) {
1061 UHSO_DPRINTF(2, "Found mux port %x (%d)\n", port, i);
1062 tty = uhso_alloc_tty(sc);
1065 sc->sc_tty[tty].ht_muxport = i;
1066 uerr = usbd_transfer_setup(sc->sc_udev,
1067 &sc->sc_iface_index, sc->sc_tty[tty].ht_xfer,
1068 uhso_ctrl_config, UHSO_CTRL_MAX, sc, &sc->sc_mtx);
1070 device_printf(sc->sc_dev,
1071 "Failed to setup control pipe: %s\n",
1078 /* Setup the intr. endpoint */
1079 uerr = usbd_transfer_setup(sc->sc_udev,
1080 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1081 uhso_mux_config, 1, sc, &sc->sc_mtx);
1089 * Interrupt callback for the multiplexed serial port. Indicates
1090 * which serial port has data waiting.
1093 uhso_mux_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1095 struct usb_page_cache *pc;
1096 struct usb_page_search res;
1097 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1098 unsigned int i, mux;
1100 UHSO_DPRINTF(3, "status %d\n", USB_GET_STATE(xfer));
1102 switch (USB_GET_STATE(xfer)) {
1103 case USB_ST_TRANSFERRED:
1105 * The multiplexed port number can be found at the first byte.
1106 * It contains a bit mask, we transform this in to an integer.
1108 pc = usbd_xfer_get_frame(xfer, 0);
1109 usbd_get_page(pc, 0, &res);
1111 i = *((unsigned char *)res.buffer);
1117 UHSO_DPRINTF(3, "mux port %d (%d)\n", mux, i);
1118 if (mux > UHSO_MPORT_TYPE_NOMAX)
1121 /* Issue a read for this serial port */
1123 sc->sc_tty[mux].ht_xfer[UHSO_CTRL_READ],
1125 usbd_transfer_start(sc->sc_tty[mux].ht_xfer[UHSO_CTRL_READ]);
1130 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1131 usbd_transfer_submit(xfer);
1134 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1135 if (error == USB_ERR_CANCELLED)
1138 usbd_xfer_set_stall(xfer);
1144 uhso_mux_read_callback(struct usb_xfer *xfer, usb_error_t error)
1146 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1147 struct usb_page_cache *pc;
1148 struct usb_device_request req;
1149 struct uhso_tty *ht;
1152 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1154 UHSO_DPRINTF(3, "status %d\n", USB_GET_STATE(xfer));
1156 ht = usbd_xfer_get_priv(xfer);
1157 UHSO_DPRINTF(3, "ht=%p open=%d\n", ht, ht->ht_open);
1159 switch (USB_GET_STATE(xfer)) {
1160 case USB_ST_TRANSFERRED:
1161 /* Got data, send to ucom */
1162 pc = usbd_xfer_get_frame(xfer, 1);
1163 len = usbd_xfer_frame_len(xfer, 1);
1165 UHSO_DPRINTF(3, "got %d bytes on mux port %d\n", len,
1168 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1172 /* Deliver data if the TTY is open, discard otherwise */
1174 ucom_put_data(&sc->sc_ucom[ht->ht_muxport], pc, 0, len);
1178 memset(&req, 0, sizeof(struct usb_device_request));
1179 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1180 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
1181 USETW(req.wValue, 0);
1182 USETW(req.wIndex, ht->ht_muxport);
1183 USETW(req.wLength, 1024);
1185 pc = usbd_xfer_get_frame(xfer, 0);
1186 usbd_copy_in(pc, 0, &req, sizeof(req));
1188 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1189 usbd_xfer_set_frame_len(xfer, 1, 1024);
1190 usbd_xfer_set_frames(xfer, 2);
1191 usbd_transfer_submit(xfer);
1194 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1195 if (error == USB_ERR_CANCELLED)
1197 usbd_xfer_set_stall(xfer);
1203 uhso_mux_write_callback(struct usb_xfer *xfer, usb_error_t error)
1205 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1206 struct uhso_tty *ht;
1207 struct usb_page_cache *pc;
1208 struct usb_device_request req;
1210 struct usb_page_search res;
1212 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1214 ht = usbd_xfer_get_priv(xfer);
1215 UHSO_DPRINTF(3, "status=%d, using mux port %d\n",
1216 USB_GET_STATE(xfer), ht->ht_muxport);
1218 switch (USB_GET_STATE(xfer)) {
1219 case USB_ST_TRANSFERRED:
1220 UHSO_DPRINTF(3, "wrote %zd data bytes to muxport %d\n",
1221 actlen - sizeof(struct usb_device_request) ,
1225 pc = usbd_xfer_get_frame(xfer, 1);
1226 if (ucom_get_data(&sc->sc_ucom[ht->ht_muxport], pc,
1229 usbd_get_page(pc, 0, &res);
1231 memset(&req, 0, sizeof(struct usb_device_request));
1232 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1233 req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
1234 USETW(req.wValue, 0);
1235 USETW(req.wIndex, ht->ht_muxport);
1236 USETW(req.wLength, actlen);
1238 pc = usbd_xfer_get_frame(xfer, 0);
1239 usbd_copy_in(pc, 0, &req, sizeof(req));
1241 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1242 usbd_xfer_set_frame_len(xfer, 1, actlen);
1243 usbd_xfer_set_frames(xfer, 2);
1245 UHSO_DPRINTF(3, "Prepared %d bytes for transmit "
1246 "on muxport %d\n", actlen, ht->ht_muxport);
1248 usbd_transfer_submit(xfer);
1252 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1253 if (error == USB_ERR_CANCELLED)
1260 uhso_attach_bulkserial(struct uhso_softc *sc, struct usb_interface *iface,
1266 /* Try attaching RD/WR/INTR first */
1267 uerr = usbd_transfer_setup(sc->sc_udev,
1268 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1269 uhso_bs_config, UHSO_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1271 /* Try only RD/WR */
1272 uerr = usbd_transfer_setup(sc->sc_udev,
1273 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1274 uhso_bs_config, UHSO_BULK_ENDPT_MAX - 1, sc, &sc->sc_mtx);
1277 UHSO_DPRINTF(0, "usbd_transfer_setup failed");
1281 tty = uhso_alloc_tty(sc);
1283 usbd_transfer_unsetup(sc->sc_xfer, UHSO_BULK_ENDPT_MAX);
1287 sc->sc_tty[tty].ht_muxport = -1;
1292 uhso_bs_read_callback(struct usb_xfer *xfer, usb_error_t error)
1294 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1295 struct usb_page_cache *pc;
1298 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1300 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1302 switch (USB_GET_STATE(xfer)) {
1303 case USB_ST_TRANSFERRED:
1304 pc = usbd_xfer_get_frame(xfer, 0);
1305 ucom_put_data(&sc->sc_ucom[0], pc, 0, actlen);
1309 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1310 usbd_transfer_submit(xfer);
1313 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1314 if (error == USB_ERR_CANCELLED)
1316 usbd_xfer_set_stall(xfer);
1322 uhso_bs_write_callback(struct usb_xfer *xfer, usb_error_t error)
1324 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1325 struct usb_page_cache *pc;
1328 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1330 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1332 switch (USB_GET_STATE(xfer)) {
1333 case USB_ST_TRANSFERRED:
1336 pc = usbd_xfer_get_frame(xfer, 0);
1337 if (ucom_get_data(&sc->sc_ucom[0], pc, 0, 8192, &actlen)) {
1338 usbd_xfer_set_frame_len(xfer, 0, actlen);
1339 usbd_transfer_submit(xfer);
1344 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1345 if (error == USB_ERR_CANCELLED)
1347 usbd_xfer_set_stall(xfer);
1353 uhso_bs_cfg(struct uhso_softc *sc)
1355 struct usb_device_request req;
1358 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1361 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1362 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
1363 USETW(req.wValue, sc->sc_line);
1364 USETW(req.wIndex, sc->sc_iface_no);
1365 USETW(req.wLength, 0);
1367 uerr = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom[0], &req, NULL, 0, 1000);
1369 device_printf(sc->sc_dev, "failed to set ctrl line state to "
1370 "0x%02x: %s\n", sc->sc_line, usbd_errstr(uerr));
1375 uhso_bs_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1377 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1378 struct usb_page_cache *pc;
1380 struct usb_cdc_notification cdc;
1382 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1383 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1385 switch (USB_GET_STATE(xfer)) {
1386 case USB_ST_TRANSFERRED:
1387 if (actlen < UCDC_NOTIFICATION_LENGTH) {
1388 UHSO_DPRINTF(0, "UCDC notification too short: %d\n", actlen);
1391 else if (actlen > (int)sizeof(struct usb_cdc_notification)) {
1392 UHSO_DPRINTF(0, "UCDC notification too large: %d\n", actlen);
1393 actlen = sizeof(struct usb_cdc_notification);
1396 pc = usbd_xfer_get_frame(xfer, 0);
1397 usbd_copy_out(pc, 0, &cdc, actlen);
1399 if (UGETW(cdc.wIndex) != sc->sc_iface_no) {
1400 UHSO_DPRINTF(0, "Interface mismatch, got %d expected %d\n",
1401 UGETW(cdc.wIndex), sc->sc_iface_no);
1405 if (cdc.bmRequestType == UCDC_NOTIFICATION &&
1406 cdc.bNotification == UCDC_N_SERIAL_STATE) {
1407 UHSO_DPRINTF(2, "notify = 0x%02x\n", cdc.data[0]);
1411 if (cdc.data[0] & UCDC_N_SERIAL_RI)
1412 sc->sc_msr |= SER_RI;
1413 if (cdc.data[0] & UCDC_N_SERIAL_DSR)
1414 sc->sc_msr |= SER_DSR;
1415 if (cdc.data[0] & UCDC_N_SERIAL_DCD)
1416 sc->sc_msr |= SER_DCD;
1418 ucom_status_change(&sc->sc_ucom[0]);
1423 if (error == USB_ERR_CANCELLED)
1425 usbd_xfer_set_stall(xfer);
1431 uhso_ucom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
1433 struct uhso_softc *sc = ucom->sc_parent;
1440 uhso_ucom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
1442 struct uhso_softc *sc = ucom->sc_parent;
1444 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1448 sc->sc_line |= UCDC_LINE_DTR;
1450 sc->sc_line &= ~UCDC_LINE_DTR;
1456 uhso_ucom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
1458 struct uhso_softc *sc = ucom->sc_parent;
1460 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1464 sc->sc_line |= UCDC_LINE_RTS;
1466 sc->sc_line &= ~UCDC_LINE_RTS;
1472 uhso_ucom_start_read(struct ucom_softc *ucom)
1474 struct uhso_softc *sc = ucom->sc_parent;
1476 UHSO_DPRINTF(3, "unit=%d, subunit=%d\n",
1477 ucom->sc_super->sc_unit, ucom->sc_subunit);
1479 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1480 sc->sc_tty[ucom->sc_subunit].ht_open = 1;
1481 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1483 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1484 sc->sc_tty[0].ht_open = 1;
1485 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_READ]);
1486 if (sc->sc_xfer[UHSO_BULK_ENDPT_INTR] != NULL)
1487 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_INTR]);
1492 uhso_ucom_stop_read(struct ucom_softc *ucom)
1495 struct uhso_softc *sc = ucom->sc_parent;
1497 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1498 sc->sc_tty[ucom->sc_subunit].ht_open = 0;
1500 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_READ]);
1502 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1503 sc->sc_tty[0].ht_open = 0;
1504 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_READ]);
1505 if (sc->sc_xfer[UHSO_BULK_ENDPT_INTR] != NULL)
1506 usbd_transfer_stop(sc->sc_xfer[UHSO_BULK_ENDPT_INTR]);
1511 uhso_ucom_start_write(struct ucom_softc *ucom)
1513 struct uhso_softc *sc = ucom->sc_parent;
1515 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1516 UHSO_DPRINTF(3, "local unit %d\n", ucom->sc_subunit);
1518 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1521 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE],
1522 &sc->sc_tty[ucom->sc_subunit]);
1523 usbd_transfer_start(
1524 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE]);
1527 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1528 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_WRITE]);
1533 uhso_ucom_stop_write(struct ucom_softc *ucom)
1535 struct uhso_softc *sc = ucom->sc_parent;
1537 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1539 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE]);
1541 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1542 usbd_transfer_stop(sc->sc_xfer[UHSO_BULK_ENDPT_WRITE]);
1547 uhso_attach_ifnet(struct uhso_softc *sc, struct usb_interface *iface, int type)
1551 struct sysctl_ctx_list *sctx;
1552 struct sysctl_oid *soid;
1553 unsigned int devunit;
1555 uerr = usbd_transfer_setup(sc->sc_udev,
1556 &iface->idesc->bInterfaceNumber, sc->sc_if_xfer,
1557 uhso_ifnet_config, UHSO_IFNET_MAX, sc, &sc->sc_mtx);
1559 UHSO_DPRINTF(0, "usbd_transfer_setup failed: %s\n",
1564 sc->sc_ifp = ifp = if_alloc(IFT_OTHER);
1565 if (sc->sc_ifp == NULL) {
1566 device_printf(sc->sc_dev, "if_alloc() failed\n");
1570 callout_init_mtx(&sc->sc_c, &sc->sc_mtx, 0);
1571 mtx_lock(&sc->sc_mtx);
1572 callout_reset(&sc->sc_c, 1, uhso_if_rxflush, sc);
1573 mtx_unlock(&sc->sc_mtx);
1576 * We create our own unit numbers for ifnet devices because the
1577 * USB interface unit numbers can be at arbitrary positions yielding
1578 * odd looking device names.
1580 devunit = alloc_unr(uhso_ifnet_unit);
1582 if_initname(ifp, device_get_name(sc->sc_dev), devunit);
1583 ifp->if_mtu = UHSO_MAX_MTU;
1584 ifp->if_ioctl = uhso_if_ioctl;
1585 ifp->if_init = uhso_if_init;
1586 ifp->if_start = uhso_if_start;
1587 ifp->if_output = uhso_if_output;
1588 ifp->if_flags = IFF_BROADCAST | IFF_MULTICAST | IFF_NOARP;
1590 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
1591 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
1592 IFQ_SET_READY(&ifp->if_snd);
1595 bpfattach(ifp, DLT_RAW, 0);
1597 sctx = device_get_sysctl_ctx(sc->sc_dev);
1598 soid = device_get_sysctl_tree(sc->sc_dev);
1599 /* Unlocked read... */
1600 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "netif",
1601 CTLFLAG_RD, ifp->if_xname, 0, "Attached network interface");
1607 uhso_ifnet_read_callback(struct usb_xfer *xfer, usb_error_t error)
1609 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1611 struct usb_page_cache *pc;
1614 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1616 UHSO_DPRINTF(3, "status=%d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1618 switch (USB_GET_STATE(xfer)) {
1619 case USB_ST_TRANSFERRED:
1620 if (actlen > 0 && (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)) {
1621 pc = usbd_xfer_get_frame(xfer, 0);
1622 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1623 usbd_copy_out(pc, 0, mtod(m, uint8_t *), actlen);
1624 m->m_pkthdr.len = m->m_len = actlen;
1625 /* Enqueue frame for further processing */
1626 _IF_ENQUEUE(&sc->sc_rxq, m);
1627 if (!callout_pending(&sc->sc_c) ||
1628 !callout_active(&sc->sc_c)) {
1629 callout_schedule(&sc->sc_c, 1);
1635 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1636 usbd_transfer_submit(xfer);
1639 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1640 if (error == USB_ERR_CANCELLED)
1642 usbd_xfer_set_stall(xfer);
1648 * Deferred RX processing, called with mutex locked.
1650 * Each frame we receive might contain several small ip-packets as well
1651 * as partial ip-packets. We need to separate/assemble them into individual
1652 * packets before sending them to the ip-layer.
1655 uhso_if_rxflush(void *arg)
1657 struct uhso_softc *sc = arg;
1658 struct ifnet *ifp = sc->sc_ifp;
1660 struct mbuf *m, *m0, *mwait;
1663 struct ip6_hdr *ip6;
1669 mwait = sc->sc_mwait;
1672 _IF_DEQUEUE(&sc->sc_rxq, m);
1675 UHSO_DPRINTF(3, "dequeue m=%p, len=%d\n", m, m->m_len);
1677 mtx_unlock(&sc->sc_mtx);
1679 /* Do we have a partial packet waiting? */
1680 if (mwait != NULL) {
1684 UHSO_DPRINTF(3, "partial m0=%p(%d), concat w/ m=%p(%d)\n",
1685 m0, m0->m_len, m, m->m_len);
1686 len = m->m_len + m0->m_len;
1688 /* Concat mbufs and fix headers */
1690 m0->m_pkthdr.len = len;
1691 m->m_flags &= ~M_PKTHDR;
1693 m = m_pullup(m0, sizeof(struct ip));
1696 UHSO_DPRINTF(0, "m_pullup failed\n");
1697 mtx_lock(&sc->sc_mtx);
1700 UHSO_DPRINTF(3, "Constructed mbuf=%p, len=%d\n",
1701 m, m->m_pkthdr.len);
1704 cp = mtod(m, uint8_t *);
1705 ip = (struct ip *)cp;
1707 ip6 = (struct ip6_hdr *)cp;
1710 /* Check for IPv4 */
1711 if (ip->ip_v == IPVERSION) {
1712 iplen = htons(ip->ip_len);
1716 /* Check for IPv6 */
1717 else if ((ip6->ip6_vfc & IPV6_VERSION_MASK) == IPV6_VERSION) {
1718 iplen = htons(ip6->ip6_plen);
1723 UHSO_DPRINTF(0, "got unexpected ip version %d, "
1724 "m=%p, len=%d\n", (*cp & 0xf0) >> 4, m, m->m_len);
1726 UHSO_HEXDUMP(cp, 4);
1729 mtx_lock(&sc->sc_mtx);
1734 UHSO_DPRINTF(0, "Zero IP length\n");
1738 mtx_lock(&sc->sc_mtx);
1742 UHSO_DPRINTF(3, "m=%p, len=%d, cp=%p, iplen=%d\n",
1743 m, m->m_pkthdr.len, cp, iplen);
1747 /* More IP packets in this mbuf */
1748 if (iplen < m->m_pkthdr.len) {
1752 * Allocate a new mbuf for this IP packet and
1753 * copy the IP-packet into it.
1755 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1756 memcpy(mtod(m, uint8_t *), mtod(m0, uint8_t *), iplen);
1757 m->m_pkthdr.len = m->m_len = iplen;
1759 /* Adjust the size of the original mbuf */
1761 m0 = m_defrag(m0, M_WAITOK);
1763 UHSO_DPRINTF(3, "New mbuf=%p, len=%d/%d, m0=%p, "
1764 "m0_len=%d/%d\n", m, m->m_pkthdr.len, m->m_len,
1765 m0, m0->m_pkthdr.len, m0->m_len);
1767 else if (iplen > m->m_pkthdr.len) {
1768 UHSO_DPRINTF(3, "Deferred mbuf=%p, len=%d\n",
1769 m, m->m_pkthdr.len);
1772 mtx_lock(&sc->sc_mtx);
1777 m->m_pkthdr.rcvif = ifp;
1779 /* Dispatch to IP layer */
1780 BPF_MTAP(sc->sc_ifp, m);
1781 M_SETFIB(m, ifp->if_fib);
1782 netisr_dispatch(isr, m);
1783 m = m0 != NULL ? m0 : NULL;
1784 mtx_lock(&sc->sc_mtx);
1786 sc->sc_mwait = mwait;
1790 uhso_ifnet_write_callback(struct usb_xfer *xfer, usb_error_t error)
1792 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1793 struct ifnet *ifp = sc->sc_ifp;
1794 struct usb_page_cache *pc;
1798 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1800 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1802 switch (USB_GET_STATE(xfer)) {
1803 case USB_ST_TRANSFERRED:
1805 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1808 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
1812 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1814 if (m->m_pkthdr.len > MCLBYTES)
1815 m->m_pkthdr.len = MCLBYTES;
1817 usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len);
1818 pc = usbd_xfer_get_frame(xfer, 0);
1819 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
1820 usbd_transfer_submit(xfer);
1826 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1827 if (error == USB_ERR_CANCELLED)
1829 usbd_xfer_set_stall(xfer);
1835 uhso_if_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
1837 struct uhso_softc *sc;
1843 if (ifp->if_flags & IFF_UP) {
1844 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
1849 if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
1850 mtx_lock(&sc->sc_mtx);
1852 mtx_unlock(&sc->sc_mtx);
1857 case SIOCSIFDSTADDR:
1868 uhso_if_init(void *priv)
1870 struct uhso_softc *sc = priv;
1871 struct ifnet *ifp = sc->sc_ifp;
1873 mtx_lock(&sc->sc_mtx);
1876 ifp->if_flags |= IFF_UP;
1877 ifp->if_drv_flags |= IFF_DRV_RUNNING;
1878 mtx_unlock(&sc->sc_mtx);
1880 UHSO_DPRINTF(2, "ifnet initialized\n");
1884 uhso_if_output(struct ifnet *ifp, struct mbuf *m0, struct sockaddr *dst,
1889 /* Only IPv4/6 support */
1890 if (dst->sa_family != AF_INET
1892 && dst->sa_family != AF_INET6
1895 return (EAFNOSUPPORT);
1898 error = (ifp->if_transmit)(ifp, m0);
1908 uhso_if_start(struct ifnet *ifp)
1910 struct uhso_softc *sc = ifp->if_softc;
1912 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
1913 UHSO_DPRINTF(1, "Not running\n");
1917 mtx_lock(&sc->sc_mtx);
1918 usbd_transfer_start(sc->sc_if_xfer[UHSO_IFNET_READ]);
1919 usbd_transfer_start(sc->sc_if_xfer[UHSO_IFNET_WRITE]);
1920 mtx_unlock(&sc->sc_mtx);
1921 UHSO_DPRINTF(3, "interface started\n");
1925 uhso_if_stop(struct uhso_softc *sc)
1928 usbd_transfer_stop(sc->sc_if_xfer[UHSO_IFNET_READ]);
1929 usbd_transfer_stop(sc->sc_if_xfer[UHSO_IFNET_WRITE]);
1930 sc->sc_ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);