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),
272 UHSO_DEV(OPTION, GTM661W, UHSO_AUTO_IFACE),
273 /* Option iCON EDGE */
274 UHSO_DEV(OPTION, ICONEDGE, UHSO_STATIC_IFACE),
275 /* Option Module HSxPA */
276 UHSO_DEV(OPTION, MODHSXPA, UHSO_STATIC_IFACE),
277 /* Option iCON 321 */
278 UHSO_DEV(OPTION, ICON321, UHSO_STATIC_IFACE),
279 /* Option iCON 322 */
280 UHSO_DEV(OPTION, GTICON322, UHSO_STATIC_IFACE),
281 /* Option iCON 505 */
282 UHSO_DEV(OPTION, ICON505, UHSO_AUTO_IFACE),
283 /* Option iCON 452 */
284 UHSO_DEV(OPTION, ICON505, UHSO_AUTO_IFACE),
288 static SYSCTL_NODE(_hw_usb, OID_AUTO, uhso, CTLFLAG_RW, 0, "USB uhso");
289 static int uhso_autoswitch = 1;
290 SYSCTL_INT(_hw_usb_uhso, OID_AUTO, auto_switch, CTLFLAG_RW,
291 &uhso_autoswitch, 0, "Automatically switch to modem mode");
295 static int uhso_debug = UHSO_DEBUG;
297 static int uhso_debug = -1;
300 SYSCTL_INT(_hw_usb_uhso, OID_AUTO, debug, CTLFLAG_RW,
301 &uhso_debug, 0, "Debug level");
303 #define UHSO_DPRINTF(n, x, ...) {\
304 if (uhso_debug >= n) {\
305 printf("%s: " x, __func__, ##__VA_ARGS__);\
309 #define UHSO_DPRINTF(n, x, ...)
312 #ifdef UHSO_DEBUG_HEXDUMP
313 # define UHSO_HEXDUMP(_buf, _len) do { \
316 const char *__buf = (const char *)_buf; \
317 for (__tmp = 0; __tmp < _len; __tmp++) \
318 printf("%02hhx ", *__buf++); \
323 # define UHSO_HEXDUMP(_buf, _len)
327 UHSO_MUX_ENDPT_INTR = 0,
344 UHSO_BULK_ENDPT_READ = 0,
345 UHSO_BULK_ENDPT_WRITE,
346 UHSO_BULK_ENDPT_INTR,
350 static usb_callback_t uhso_mux_intr_callback;
351 static usb_callback_t uhso_mux_read_callback;
352 static usb_callback_t uhso_mux_write_callback;
353 static usb_callback_t uhso_bs_read_callback;
354 static usb_callback_t uhso_bs_write_callback;
355 static usb_callback_t uhso_bs_intr_callback;
356 static usb_callback_t uhso_ifnet_read_callback;
357 static usb_callback_t uhso_ifnet_write_callback;
359 /* Config used for the default control pipes */
360 static const struct usb_config uhso_ctrl_config[UHSO_CTRL_MAX] = {
364 .direction = UE_DIR_ANY,
365 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
366 .bufsize = sizeof(struct usb_device_request) + 1024,
367 .callback = &uhso_mux_read_callback
370 [UHSO_CTRL_WRITE] = {
373 .direction = UE_DIR_ANY,
374 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
375 .bufsize = sizeof(struct usb_device_request) + 1024,
377 .callback = &uhso_mux_write_callback
381 /* Config for the multiplexed serial ports */
382 static const struct usb_config uhso_mux_config[UHSO_MUX_ENDPT_MAX] = {
383 [UHSO_MUX_ENDPT_INTR] = {
384 .type = UE_INTERRUPT,
385 .endpoint = UE_ADDR_ANY,
386 .direction = UE_DIR_IN,
387 .flags = { .short_xfer_ok = 1 },
389 .callback = &uhso_mux_intr_callback,
393 /* Config for the raw IP-packet interface */
394 static const struct usb_config uhso_ifnet_config[UHSO_IFNET_MAX] = {
395 [UHSO_IFNET_READ] = {
397 .endpoint = UE_ADDR_ANY,
398 .direction = UE_DIR_IN,
399 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
401 .callback = &uhso_ifnet_read_callback
403 [UHSO_IFNET_WRITE] = {
405 .endpoint = UE_ADDR_ANY,
406 .direction = UE_DIR_OUT,
407 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
409 .timeout = 5 * USB_MS_HZ,
410 .callback = &uhso_ifnet_write_callback
414 /* Config for interfaces with normal bulk serial ports */
415 static const struct usb_config uhso_bs_config[UHSO_BULK_ENDPT_MAX] = {
416 [UHSO_BULK_ENDPT_READ] = {
418 .endpoint = UE_ADDR_ANY,
419 .direction = UE_DIR_IN,
420 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
422 .callback = &uhso_bs_read_callback
425 [UHSO_BULK_ENDPT_WRITE] = {
427 .endpoint = UE_ADDR_ANY,
428 .direction = UE_DIR_OUT,
429 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
431 .callback = &uhso_bs_write_callback
434 [UHSO_BULK_ENDPT_INTR] = {
435 .type = UE_INTERRUPT,
436 .endpoint = UE_ADDR_ANY,
437 .direction = UE_DIR_IN,
438 .flags = { .short_xfer_ok = 1 },
440 .callback = &uhso_bs_intr_callback,
444 static int uhso_probe_iface(struct uhso_softc *, int,
445 int (*probe)(struct usb_device *, int));
446 static int uhso_probe_iface_auto(struct usb_device *, int);
447 static int uhso_probe_iface_static(struct usb_device *, int);
448 static int uhso_attach_muxserial(struct uhso_softc *, struct usb_interface *,
450 static int uhso_attach_bulkserial(struct uhso_softc *, struct usb_interface *,
452 static int uhso_attach_ifnet(struct uhso_softc *, struct usb_interface *,
454 static void uhso_test_autoinst(void *, struct usb_device *,
455 struct usb_attach_arg *);
456 static int uhso_driver_loaded(struct module *, int, void *);
457 static int uhso_radio_sysctl(SYSCTL_HANDLER_ARGS);
458 static int uhso_radio_ctrl(struct uhso_softc *, int);
460 static void uhso_free(struct ucom_softc *);
461 static void uhso_ucom_start_read(struct ucom_softc *);
462 static void uhso_ucom_stop_read(struct ucom_softc *);
463 static void uhso_ucom_start_write(struct ucom_softc *);
464 static void uhso_ucom_stop_write(struct ucom_softc *);
465 static void uhso_ucom_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
466 static void uhso_ucom_cfg_set_dtr(struct ucom_softc *, uint8_t);
467 static void uhso_ucom_cfg_set_rts(struct ucom_softc *, uint8_t);
468 static void uhso_if_init(void *);
469 static void uhso_if_start(struct ifnet *);
470 static void uhso_if_stop(struct uhso_softc *);
471 static int uhso_if_ioctl(struct ifnet *, u_long, caddr_t);
472 static int uhso_if_output(struct ifnet *, struct mbuf *,
473 const struct sockaddr *, struct route *);
474 static void uhso_if_rxflush(void *);
476 static device_probe_t uhso_probe;
477 static device_attach_t uhso_attach;
478 static device_detach_t uhso_detach;
479 static void uhso_free_softc(struct uhso_softc *);
481 static device_method_t uhso_methods[] = {
482 DEVMETHOD(device_probe, uhso_probe),
483 DEVMETHOD(device_attach, uhso_attach),
484 DEVMETHOD(device_detach, uhso_detach),
488 static driver_t uhso_driver = {
490 .methods = uhso_methods,
491 .size = sizeof(struct uhso_softc)
494 static devclass_t uhso_devclass;
495 DRIVER_MODULE(uhso, uhub, uhso_driver, uhso_devclass, uhso_driver_loaded, 0);
496 MODULE_DEPEND(uhso, ucom, 1, 1, 1);
497 MODULE_DEPEND(uhso, usb, 1, 1, 1);
498 MODULE_VERSION(uhso, 1);
500 static struct ucom_callback uhso_ucom_callback = {
501 .ucom_cfg_get_status = &uhso_ucom_cfg_get_status,
502 .ucom_cfg_set_dtr = &uhso_ucom_cfg_set_dtr,
503 .ucom_cfg_set_rts = &uhso_ucom_cfg_set_rts,
504 .ucom_start_read = uhso_ucom_start_read,
505 .ucom_stop_read = uhso_ucom_stop_read,
506 .ucom_start_write = uhso_ucom_start_write,
507 .ucom_stop_write = uhso_ucom_stop_write,
508 .ucom_free = &uhso_free,
512 uhso_probe(device_t self)
514 struct usb_attach_arg *uaa = device_get_ivars(self);
517 if (uaa->usb_mode != USB_MODE_HOST)
519 if (uaa->info.bConfigIndex != 0)
521 if (uaa->info.bDeviceClass != 0xff)
524 error = usbd_lookup_id_by_uaa(uhso_devs, sizeof(uhso_devs), uaa);
529 * Probe device to see if we are able to attach
530 * to this interface or not.
532 if (USB_GET_DRIVER_INFO(uaa) == UHSO_AUTO_IFACE) {
533 if (uhso_probe_iface_auto(uaa->device,
534 uaa->info.bIfaceNum) == 0)
541 uhso_attach(device_t self)
543 struct uhso_softc *sc = device_get_softc(self);
544 struct usb_attach_arg *uaa = device_get_ivars(self);
545 struct usb_interface_descriptor *id;
546 struct sysctl_ctx_list *sctx;
547 struct sysctl_oid *soid;
548 struct sysctl_oid *tree = NULL, *tty_node;
549 struct ucom_softc *ucom;
557 sc->sc_udev = uaa->device;
558 mtx_init(&sc->sc_mtx, "uhso", NULL, MTX_DEF);
559 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,
682 if (sc->sc_ifp != NULL) {
683 callout_drain(&sc->sc_c);
684 free_unr(uhso_ifnet_unit, sc->sc_ifp->if_dunit);
685 mtx_lock(&sc->sc_mtx);
687 bpfdetach(sc->sc_ifp);
688 if_detach(sc->sc_ifp);
690 mtx_unlock(&sc->sc_mtx);
691 usbd_transfer_unsetup(sc->sc_if_xfer, UHSO_IFNET_MAX);
694 device_claim_softc(self);
701 UCOM_UNLOAD_DRAIN(uhso);
704 uhso_free_softc(struct uhso_softc *sc)
706 if (ucom_unref(&sc->sc_super_ucom)) {
707 free(sc->sc_tty, M_USBDEV);
708 free(sc->sc_ucom, M_USBDEV);
709 mtx_destroy(&sc->sc_mtx);
710 device_free_softc(sc);
715 uhso_free(struct ucom_softc *ucom)
717 uhso_free_softc(ucom->sc_parent);
721 uhso_test_autoinst(void *arg, struct usb_device *udev,
722 struct usb_attach_arg *uaa)
724 struct usb_interface *iface;
725 struct usb_interface_descriptor *id;
727 if (uaa->dev_state != UAA_DEV_READY || !uhso_autoswitch)
730 iface = usbd_get_iface(udev, 0);
734 if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
736 if (usbd_lookup_id_by_uaa(uhso_devs, sizeof(uhso_devs), uaa))
737 return; /* no device match */
739 if (usb_msc_eject(udev, 0, MSC_EJECT_REZERO) == 0) {
740 /* success, mark the udev as disappearing */
741 uaa->dev_state = UAA_DEV_EJECTING;
746 uhso_driver_loaded(struct module *mod, int what, void *arg)
750 /* register our autoinstall handler */
751 uhso_etag = EVENTHANDLER_REGISTER(usb_dev_configured,
752 uhso_test_autoinst, NULL, EVENTHANDLER_PRI_ANY);
753 /* create our unit allocator for inet devs */
754 uhso_ifnet_unit = new_unrhdr(0, INT_MAX, NULL);
757 EVENTHANDLER_DEREGISTER(usb_dev_configured, uhso_etag);
758 delete_unrhdr(uhso_ifnet_unit);
767 * Probe the interface type by querying the device. The elements
768 * of an array indicates the capabilities of a particular interface.
769 * Returns a bit mask with the interface capabilities.
772 uhso_probe_iface_auto(struct usb_device *udev, int index)
774 struct usb_device_request req;
780 req.bmRequestType = UT_READ_VENDOR_DEVICE;
782 USETW(req.wValue, 0);
783 USETW(req.wIndex, 0);
784 USETW(req.wLength, 17);
786 uerr = usbd_do_request_flags(udev, NULL, &req, buf,
787 0, &actlen, USB_MS_HZ);
789 printf("%s: usbd_do_request_flags failed, %s\n",
790 __func__, usbd_errstr(uerr));
794 UHSO_DPRINTF(1, "actlen=%d\n", actlen);
795 UHSO_HEXDUMP(buf, 17);
797 if (index < 0 || index > 16) {
798 UHSO_DPRINTF(0, "Index %d out of range\n", index);
802 UHSO_DPRINTF(1, "index=%d, type=%x[%s]\n", index, buf[index],
803 uhso_port_type[(int)uhso_port_map[(int)buf[index]]]);
805 if (buf[index] >= uhso_port_map_max)
808 port = uhso_port_map[(int)buf[index]];
811 case UHSO_PORT_TYPE_NETWORK:
812 return (UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
813 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK, port));
814 case UHSO_PORT_TYPE_DIAG:
815 case UHSO_PORT_TYPE_DIAG2:
816 case UHSO_PORT_TYPE_GPS:
817 case UHSO_PORT_TYPE_GPSCTL:
818 case UHSO_PORT_TYPE_CTL:
819 case UHSO_PORT_TYPE_APP:
820 case UHSO_PORT_TYPE_APP2:
821 case UHSO_PORT_TYPE_MODEM:
822 return (UHSO_IFACE_SPEC(UHSO_IF_BULK,
823 UHSO_PORT_SERIAL, port));
824 case UHSO_PORT_TYPE_MSD:
826 case UHSO_PORT_TYPE_UNKNOWN:
835 * Returns the capabilities of interfaces for devices that don't
836 * support the automatic query.
837 * Returns a bit mask with the interface capabilities.
840 uhso_probe_iface_static(struct usb_device *udev, int index)
842 struct usb_config_descriptor *cd;
844 cd = usbd_get_config_descriptor(udev);
845 if (cd->bNumInterface <= 3) {
846 /* Cards with 3 or less interfaces */
849 return UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
850 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK,
851 UHSO_PORT_TYPE_NETWORK);
853 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
854 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG);
856 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
857 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_MODEM);
860 /* Cards with 4 interfaces */
863 return UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
864 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK,
865 UHSO_PORT_TYPE_NETWORK);
867 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
868 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG2);
870 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
871 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_MODEM);
873 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
874 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG);
881 * Probes an interface for its particular capabilities and attaches if
882 * it's a supported interface.
885 uhso_probe_iface(struct uhso_softc *sc, int index,
886 int (*probe)(struct usb_device *, int))
888 struct usb_interface *iface;
891 UHSO_DPRINTF(1, "Probing for interface %d, probe_func=%p\n", index, probe);
893 type = probe(sc->sc_udev, index);
894 UHSO_DPRINTF(1, "Probe result %x\n", type);
899 iface = usbd_get_iface(sc->sc_udev, index);
901 if (UHSO_IFACE_PORT_TYPE(type) == UHSO_PORT_TYPE_NETWORK) {
902 error = uhso_attach_ifnet(sc, iface, type);
904 UHSO_DPRINTF(1, "uhso_attach_ifnet failed");
909 * If there is an additional interrupt endpoint on this
910 * interface then we most likely have a multiplexed serial port
913 if (iface->idesc->bNumEndpoints < 3) {
914 sc->sc_type = UHSO_IFACE_SPEC(
915 UHSO_IFACE_USB_TYPE(type) & ~UHSO_IF_MUX,
916 UHSO_IFACE_PORT(type) & ~UHSO_PORT_SERIAL,
917 UHSO_IFACE_PORT_TYPE(type));
921 UHSO_DPRINTF(1, "Trying to attach mux. serial\n");
922 error = uhso_attach_muxserial(sc, iface, type);
923 if (error == 0 && sc->sc_ttys > 0) {
924 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
925 sc->sc_ttys, sc, &uhso_ucom_callback, &sc->sc_mtx);
927 device_printf(sc->sc_dev, "ucom_attach failed\n");
930 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, sc->sc_dev);
932 mtx_lock(&sc->sc_mtx);
933 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
934 mtx_unlock(&sc->sc_mtx);
936 } else if ((UHSO_IFACE_USB_TYPE(type) & UHSO_IF_BULK) &&
937 UHSO_IFACE_PORT(type) & UHSO_PORT_SERIAL) {
939 error = uhso_attach_bulkserial(sc, iface, type);
943 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
944 sc->sc_ttys, sc, &uhso_ucom_callback, &sc->sc_mtx);
946 device_printf(sc->sc_dev, "ucom_attach failed\n");
949 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, sc->sc_dev);
952 UHSO_DPRINTF(0, "Unknown type %x\n", type);
960 uhso_radio_ctrl(struct uhso_softc *sc, int onoff)
962 struct usb_device_request req;
965 req.bmRequestType = UT_VENDOR;
966 req.bRequest = onoff ? 0x82 : 0x81;
967 USETW(req.wValue, 0);
968 USETW(req.wIndex, 0);
969 USETW(req.wLength, 0);
971 uerr = usbd_do_request(sc->sc_udev, NULL, &req, NULL);
973 device_printf(sc->sc_dev, "usbd_do_request_flags failed: %s\n",
981 uhso_radio_sysctl(SYSCTL_HANDLER_ARGS)
983 struct uhso_softc *sc = arg1;
986 radio = sc->sc_radio;
987 error = sysctl_handle_int(oidp, &radio, 0, req);
990 if (radio != sc->sc_radio) {
991 radio = radio != 0 ? 1 : 0;
992 error = uhso_radio_ctrl(sc, radio);
994 sc->sc_radio = radio;
1001 * Expands allocated memory to fit an additional TTY.
1002 * Two arrays are kept with matching indexes, one for ucom and one
1003 * for our private data.
1006 uhso_alloc_tty(struct uhso_softc *sc)
1010 sc->sc_tty = reallocf(sc->sc_tty, sizeof(struct uhso_tty) * sc->sc_ttys,
1011 M_USBDEV, M_WAITOK | M_ZERO);
1012 if (sc->sc_tty == NULL)
1015 sc->sc_ucom = reallocf(sc->sc_ucom,
1016 sizeof(struct ucom_softc) * sc->sc_ttys, M_USBDEV, M_WAITOK | M_ZERO);
1017 if (sc->sc_ucom == NULL)
1020 sc->sc_tty[sc->sc_ttys - 1].ht_sc = sc;
1022 UHSO_DPRINTF(1, "Allocated TTY %d\n", sc->sc_ttys - 1);
1023 return (sc->sc_ttys - 1);
1027 * Attach a multiplexed serial port
1028 * Data is read/written with requests on the default control pipe. An interrupt
1029 * endpoint returns when there is new data to be read.
1032 uhso_attach_muxserial(struct uhso_softc *sc, struct usb_interface *iface,
1035 struct usb_descriptor *desc;
1040 * The class specific interface (type 0x24) descriptor subtype field
1041 * contains a bitmask that specifies which (and how many) ports that
1042 * are available through this multiplexed serial port.
1044 desc = usbd_find_descriptor(sc->sc_udev, NULL,
1045 iface->idesc->bInterfaceNumber, UDESC_CS_INTERFACE, 0xff, 0, 0);
1047 UHSO_DPRINTF(0, "Failed to find UDESC_CS_INTERFACE\n");
1051 UHSO_DPRINTF(1, "Mux port mask %x\n", desc->bDescriptorSubtype);
1052 if (desc->bDescriptorSubtype == 0)
1056 * The bitmask is one octet, loop through the number of
1057 * bits that are set and create a TTY for each.
1059 for (i = 0; i < 8; i++) {
1061 if ((port & desc->bDescriptorSubtype) == port) {
1062 UHSO_DPRINTF(2, "Found mux port %x (%d)\n", port, i);
1063 tty = uhso_alloc_tty(sc);
1066 sc->sc_tty[tty].ht_muxport = i;
1067 uerr = usbd_transfer_setup(sc->sc_udev,
1068 &sc->sc_iface_index, sc->sc_tty[tty].ht_xfer,
1069 uhso_ctrl_config, UHSO_CTRL_MAX, sc, &sc->sc_mtx);
1071 device_printf(sc->sc_dev,
1072 "Failed to setup control pipe: %s\n",
1079 /* Setup the intr. endpoint */
1080 uerr = usbd_transfer_setup(sc->sc_udev,
1081 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1082 uhso_mux_config, 1, sc, &sc->sc_mtx);
1090 * Interrupt callback for the multiplexed serial port. Indicates
1091 * which serial port has data waiting.
1094 uhso_mux_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1096 struct usb_page_cache *pc;
1097 struct usb_page_search res;
1098 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1099 unsigned int i, mux;
1101 UHSO_DPRINTF(3, "status %d\n", USB_GET_STATE(xfer));
1103 switch (USB_GET_STATE(xfer)) {
1104 case USB_ST_TRANSFERRED:
1106 * The multiplexed port number can be found at the first byte.
1107 * It contains a bit mask, we transform this in to an integer.
1109 pc = usbd_xfer_get_frame(xfer, 0);
1110 usbd_get_page(pc, 0, &res);
1112 i = *((unsigned char *)res.buffer);
1118 UHSO_DPRINTF(3, "mux port %d (%d)\n", mux, i);
1119 if (mux > UHSO_MPORT_TYPE_NOMAX)
1122 /* Issue a read for this serial port */
1124 sc->sc_tty[mux].ht_xfer[UHSO_CTRL_READ],
1126 usbd_transfer_start(sc->sc_tty[mux].ht_xfer[UHSO_CTRL_READ]);
1131 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1132 usbd_transfer_submit(xfer);
1135 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1136 if (error == USB_ERR_CANCELLED)
1139 usbd_xfer_set_stall(xfer);
1145 uhso_mux_read_callback(struct usb_xfer *xfer, usb_error_t error)
1147 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1148 struct usb_page_cache *pc;
1149 struct usb_device_request req;
1150 struct uhso_tty *ht;
1153 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1155 UHSO_DPRINTF(3, "status %d\n", USB_GET_STATE(xfer));
1157 ht = usbd_xfer_get_priv(xfer);
1158 UHSO_DPRINTF(3, "ht=%p open=%d\n", ht, ht->ht_open);
1160 switch (USB_GET_STATE(xfer)) {
1161 case USB_ST_TRANSFERRED:
1162 /* Got data, send to ucom */
1163 pc = usbd_xfer_get_frame(xfer, 1);
1164 len = usbd_xfer_frame_len(xfer, 1);
1166 UHSO_DPRINTF(3, "got %d bytes on mux port %d\n", len,
1169 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1173 /* Deliver data if the TTY is open, discard otherwise */
1175 ucom_put_data(&sc->sc_ucom[ht->ht_muxport], pc, 0, len);
1179 memset(&req, 0, sizeof(struct usb_device_request));
1180 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1181 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
1182 USETW(req.wValue, 0);
1183 USETW(req.wIndex, ht->ht_muxport);
1184 USETW(req.wLength, 1024);
1186 pc = usbd_xfer_get_frame(xfer, 0);
1187 usbd_copy_in(pc, 0, &req, sizeof(req));
1189 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1190 usbd_xfer_set_frame_len(xfer, 1, 1024);
1191 usbd_xfer_set_frames(xfer, 2);
1192 usbd_transfer_submit(xfer);
1195 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1196 if (error == USB_ERR_CANCELLED)
1198 usbd_xfer_set_stall(xfer);
1204 uhso_mux_write_callback(struct usb_xfer *xfer, usb_error_t error)
1206 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1207 struct uhso_tty *ht;
1208 struct usb_page_cache *pc;
1209 struct usb_device_request req;
1211 struct usb_page_search res;
1213 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1215 ht = usbd_xfer_get_priv(xfer);
1216 UHSO_DPRINTF(3, "status=%d, using mux port %d\n",
1217 USB_GET_STATE(xfer), ht->ht_muxport);
1219 switch (USB_GET_STATE(xfer)) {
1220 case USB_ST_TRANSFERRED:
1221 UHSO_DPRINTF(3, "wrote %zd data bytes to muxport %d\n",
1222 actlen - sizeof(struct usb_device_request) ,
1226 pc = usbd_xfer_get_frame(xfer, 1);
1227 if (ucom_get_data(&sc->sc_ucom[ht->ht_muxport], pc,
1230 usbd_get_page(pc, 0, &res);
1232 memset(&req, 0, sizeof(struct usb_device_request));
1233 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1234 req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
1235 USETW(req.wValue, 0);
1236 USETW(req.wIndex, ht->ht_muxport);
1237 USETW(req.wLength, actlen);
1239 pc = usbd_xfer_get_frame(xfer, 0);
1240 usbd_copy_in(pc, 0, &req, sizeof(req));
1242 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1243 usbd_xfer_set_frame_len(xfer, 1, actlen);
1244 usbd_xfer_set_frames(xfer, 2);
1246 UHSO_DPRINTF(3, "Prepared %d bytes for transmit "
1247 "on muxport %d\n", actlen, ht->ht_muxport);
1249 usbd_transfer_submit(xfer);
1253 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1254 if (error == USB_ERR_CANCELLED)
1261 uhso_attach_bulkserial(struct uhso_softc *sc, struct usb_interface *iface,
1267 /* Try attaching RD/WR/INTR first */
1268 uerr = usbd_transfer_setup(sc->sc_udev,
1269 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1270 uhso_bs_config, UHSO_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1272 /* Try only RD/WR */
1273 uerr = usbd_transfer_setup(sc->sc_udev,
1274 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1275 uhso_bs_config, UHSO_BULK_ENDPT_MAX - 1, sc, &sc->sc_mtx);
1278 UHSO_DPRINTF(0, "usbd_transfer_setup failed");
1282 tty = uhso_alloc_tty(sc);
1284 usbd_transfer_unsetup(sc->sc_xfer, UHSO_BULK_ENDPT_MAX);
1288 sc->sc_tty[tty].ht_muxport = -1;
1293 uhso_bs_read_callback(struct usb_xfer *xfer, usb_error_t error)
1295 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1296 struct usb_page_cache *pc;
1299 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1301 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1303 switch (USB_GET_STATE(xfer)) {
1304 case USB_ST_TRANSFERRED:
1305 pc = usbd_xfer_get_frame(xfer, 0);
1306 ucom_put_data(&sc->sc_ucom[0], pc, 0, actlen);
1310 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1311 usbd_transfer_submit(xfer);
1314 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1315 if (error == USB_ERR_CANCELLED)
1317 usbd_xfer_set_stall(xfer);
1323 uhso_bs_write_callback(struct usb_xfer *xfer, usb_error_t error)
1325 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1326 struct usb_page_cache *pc;
1329 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1331 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1333 switch (USB_GET_STATE(xfer)) {
1334 case USB_ST_TRANSFERRED:
1337 pc = usbd_xfer_get_frame(xfer, 0);
1338 if (ucom_get_data(&sc->sc_ucom[0], pc, 0, 8192, &actlen)) {
1339 usbd_xfer_set_frame_len(xfer, 0, actlen);
1340 usbd_transfer_submit(xfer);
1345 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1346 if (error == USB_ERR_CANCELLED)
1348 usbd_xfer_set_stall(xfer);
1354 uhso_bs_cfg(struct uhso_softc *sc)
1356 struct usb_device_request req;
1359 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1362 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1363 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
1364 USETW(req.wValue, sc->sc_line);
1365 USETW(req.wIndex, sc->sc_iface_no);
1366 USETW(req.wLength, 0);
1368 uerr = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom[0], &req, NULL, 0, 1000);
1370 device_printf(sc->sc_dev, "failed to set ctrl line state to "
1371 "0x%02x: %s\n", sc->sc_line, usbd_errstr(uerr));
1376 uhso_bs_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1378 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1379 struct usb_page_cache *pc;
1381 struct usb_cdc_notification cdc;
1383 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1384 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1386 switch (USB_GET_STATE(xfer)) {
1387 case USB_ST_TRANSFERRED:
1388 if (actlen < UCDC_NOTIFICATION_LENGTH) {
1389 UHSO_DPRINTF(0, "UCDC notification too short: %d\n", actlen);
1392 else if (actlen > (int)sizeof(struct usb_cdc_notification)) {
1393 UHSO_DPRINTF(0, "UCDC notification too large: %d\n", actlen);
1394 actlen = sizeof(struct usb_cdc_notification);
1397 pc = usbd_xfer_get_frame(xfer, 0);
1398 usbd_copy_out(pc, 0, &cdc, actlen);
1400 if (UGETW(cdc.wIndex) != sc->sc_iface_no) {
1401 UHSO_DPRINTF(0, "Interface mismatch, got %d expected %d\n",
1402 UGETW(cdc.wIndex), sc->sc_iface_no);
1406 if (cdc.bmRequestType == UCDC_NOTIFICATION &&
1407 cdc.bNotification == UCDC_N_SERIAL_STATE) {
1408 UHSO_DPRINTF(2, "notify = 0x%02x\n", cdc.data[0]);
1412 if (cdc.data[0] & UCDC_N_SERIAL_RI)
1413 sc->sc_msr |= SER_RI;
1414 if (cdc.data[0] & UCDC_N_SERIAL_DSR)
1415 sc->sc_msr |= SER_DSR;
1416 if (cdc.data[0] & UCDC_N_SERIAL_DCD)
1417 sc->sc_msr |= SER_DCD;
1419 ucom_status_change(&sc->sc_ucom[0]);
1424 if (error == USB_ERR_CANCELLED)
1426 usbd_xfer_set_stall(xfer);
1432 uhso_ucom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
1434 struct uhso_softc *sc = ucom->sc_parent;
1441 uhso_ucom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
1443 struct uhso_softc *sc = ucom->sc_parent;
1445 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1449 sc->sc_line |= UCDC_LINE_DTR;
1451 sc->sc_line &= ~UCDC_LINE_DTR;
1457 uhso_ucom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
1459 struct uhso_softc *sc = ucom->sc_parent;
1461 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1465 sc->sc_line |= UCDC_LINE_RTS;
1467 sc->sc_line &= ~UCDC_LINE_RTS;
1473 uhso_ucom_start_read(struct ucom_softc *ucom)
1475 struct uhso_softc *sc = ucom->sc_parent;
1477 UHSO_DPRINTF(3, "unit=%d, subunit=%d\n",
1478 ucom->sc_super->sc_unit, ucom->sc_subunit);
1480 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1481 sc->sc_tty[ucom->sc_subunit].ht_open = 1;
1482 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1484 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1485 sc->sc_tty[0].ht_open = 1;
1486 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_READ]);
1487 if (sc->sc_xfer[UHSO_BULK_ENDPT_INTR] != NULL)
1488 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_INTR]);
1493 uhso_ucom_stop_read(struct ucom_softc *ucom)
1496 struct uhso_softc *sc = ucom->sc_parent;
1498 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1499 sc->sc_tty[ucom->sc_subunit].ht_open = 0;
1501 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_READ]);
1503 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1504 sc->sc_tty[0].ht_open = 0;
1505 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_READ]);
1506 if (sc->sc_xfer[UHSO_BULK_ENDPT_INTR] != NULL)
1507 usbd_transfer_stop(sc->sc_xfer[UHSO_BULK_ENDPT_INTR]);
1512 uhso_ucom_start_write(struct ucom_softc *ucom)
1514 struct uhso_softc *sc = ucom->sc_parent;
1516 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1517 UHSO_DPRINTF(3, "local unit %d\n", ucom->sc_subunit);
1519 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1522 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE],
1523 &sc->sc_tty[ucom->sc_subunit]);
1524 usbd_transfer_start(
1525 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE]);
1528 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1529 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_WRITE]);
1534 uhso_ucom_stop_write(struct ucom_softc *ucom)
1536 struct uhso_softc *sc = ucom->sc_parent;
1538 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1540 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE]);
1542 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1543 usbd_transfer_stop(sc->sc_xfer[UHSO_BULK_ENDPT_WRITE]);
1548 uhso_attach_ifnet(struct uhso_softc *sc, struct usb_interface *iface, int type)
1552 struct sysctl_ctx_list *sctx;
1553 struct sysctl_oid *soid;
1554 unsigned int devunit;
1556 uerr = usbd_transfer_setup(sc->sc_udev,
1557 &iface->idesc->bInterfaceNumber, sc->sc_if_xfer,
1558 uhso_ifnet_config, UHSO_IFNET_MAX, sc, &sc->sc_mtx);
1560 UHSO_DPRINTF(0, "usbd_transfer_setup failed: %s\n",
1565 sc->sc_ifp = ifp = if_alloc(IFT_OTHER);
1566 if (sc->sc_ifp == NULL) {
1567 device_printf(sc->sc_dev, "if_alloc() failed\n");
1571 callout_init_mtx(&sc->sc_c, &sc->sc_mtx, 0);
1572 mtx_lock(&sc->sc_mtx);
1573 callout_reset(&sc->sc_c, 1, uhso_if_rxflush, sc);
1574 mtx_unlock(&sc->sc_mtx);
1577 * We create our own unit numbers for ifnet devices because the
1578 * USB interface unit numbers can be at arbitrary positions yielding
1579 * odd looking device names.
1581 devunit = alloc_unr(uhso_ifnet_unit);
1583 if_initname(ifp, device_get_name(sc->sc_dev), devunit);
1584 ifp->if_mtu = UHSO_MAX_MTU;
1585 ifp->if_ioctl = uhso_if_ioctl;
1586 ifp->if_init = uhso_if_init;
1587 ifp->if_start = uhso_if_start;
1588 ifp->if_output = uhso_if_output;
1589 ifp->if_flags = IFF_BROADCAST | IFF_MULTICAST | IFF_NOARP;
1591 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
1592 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
1593 IFQ_SET_READY(&ifp->if_snd);
1596 bpfattach(ifp, DLT_RAW, 0);
1598 sctx = device_get_sysctl_ctx(sc->sc_dev);
1599 soid = device_get_sysctl_tree(sc->sc_dev);
1600 /* Unlocked read... */
1601 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "netif",
1602 CTLFLAG_RD, ifp->if_xname, 0, "Attached network interface");
1608 uhso_ifnet_read_callback(struct usb_xfer *xfer, usb_error_t error)
1610 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1612 struct usb_page_cache *pc;
1615 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1617 UHSO_DPRINTF(3, "status=%d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1619 switch (USB_GET_STATE(xfer)) {
1620 case USB_ST_TRANSFERRED:
1621 if (actlen > 0 && (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)) {
1622 pc = usbd_xfer_get_frame(xfer, 0);
1623 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1624 usbd_copy_out(pc, 0, mtod(m, uint8_t *), actlen);
1625 m->m_pkthdr.len = m->m_len = actlen;
1626 /* Enqueue frame for further processing */
1627 _IF_ENQUEUE(&sc->sc_rxq, m);
1628 if (!callout_pending(&sc->sc_c) ||
1629 !callout_active(&sc->sc_c)) {
1630 callout_schedule(&sc->sc_c, 1);
1636 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1637 usbd_transfer_submit(xfer);
1640 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1641 if (error == USB_ERR_CANCELLED)
1643 usbd_xfer_set_stall(xfer);
1649 * Deferred RX processing, called with mutex locked.
1651 * Each frame we receive might contain several small ip-packets as well
1652 * as partial ip-packets. We need to separate/assemble them into individual
1653 * packets before sending them to the ip-layer.
1656 uhso_if_rxflush(void *arg)
1658 struct uhso_softc *sc = arg;
1659 struct ifnet *ifp = sc->sc_ifp;
1661 struct mbuf *m, *m0, *mwait;
1664 struct ip6_hdr *ip6;
1670 mwait = sc->sc_mwait;
1673 _IF_DEQUEUE(&sc->sc_rxq, m);
1676 UHSO_DPRINTF(3, "dequeue m=%p, len=%d\n", m, m->m_len);
1678 mtx_unlock(&sc->sc_mtx);
1680 /* Do we have a partial packet waiting? */
1681 if (mwait != NULL) {
1685 UHSO_DPRINTF(3, "partial m0=%p(%d), concat w/ m=%p(%d)\n",
1686 m0, m0->m_len, m, m->m_len);
1687 len = m->m_len + m0->m_len;
1689 /* Concat mbufs and fix headers */
1691 m0->m_pkthdr.len = len;
1692 m->m_flags &= ~M_PKTHDR;
1694 m = m_pullup(m0, sizeof(struct ip));
1697 UHSO_DPRINTF(0, "m_pullup failed\n");
1698 mtx_lock(&sc->sc_mtx);
1701 UHSO_DPRINTF(3, "Constructed mbuf=%p, len=%d\n",
1702 m, m->m_pkthdr.len);
1705 cp = mtod(m, uint8_t *);
1706 ip = (struct ip *)cp;
1708 ip6 = (struct ip6_hdr *)cp;
1711 /* Check for IPv4 */
1712 if (ip->ip_v == IPVERSION) {
1713 iplen = htons(ip->ip_len);
1717 /* Check for IPv6 */
1718 else if ((ip6->ip6_vfc & IPV6_VERSION_MASK) == IPV6_VERSION) {
1719 iplen = htons(ip6->ip6_plen);
1724 UHSO_DPRINTF(0, "got unexpected ip version %d, "
1725 "m=%p, len=%d\n", (*cp & 0xf0) >> 4, m, m->m_len);
1727 UHSO_HEXDUMP(cp, 4);
1730 mtx_lock(&sc->sc_mtx);
1735 UHSO_DPRINTF(0, "Zero IP length\n");
1739 mtx_lock(&sc->sc_mtx);
1743 UHSO_DPRINTF(3, "m=%p, len=%d, cp=%p, iplen=%d\n",
1744 m, m->m_pkthdr.len, cp, iplen);
1748 /* More IP packets in this mbuf */
1749 if (iplen < m->m_pkthdr.len) {
1753 * Allocate a new mbuf for this IP packet and
1754 * copy the IP-packet into it.
1756 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1757 memcpy(mtod(m, uint8_t *), mtod(m0, uint8_t *), iplen);
1758 m->m_pkthdr.len = m->m_len = iplen;
1760 /* Adjust the size of the original mbuf */
1762 m0 = m_defrag(m0, M_WAITOK);
1764 UHSO_DPRINTF(3, "New mbuf=%p, len=%d/%d, m0=%p, "
1765 "m0_len=%d/%d\n", m, m->m_pkthdr.len, m->m_len,
1766 m0, m0->m_pkthdr.len, m0->m_len);
1768 else if (iplen > m->m_pkthdr.len) {
1769 UHSO_DPRINTF(3, "Deferred mbuf=%p, len=%d\n",
1770 m, m->m_pkthdr.len);
1773 mtx_lock(&sc->sc_mtx);
1778 m->m_pkthdr.rcvif = ifp;
1780 /* Dispatch to IP layer */
1781 BPF_MTAP(sc->sc_ifp, m);
1782 M_SETFIB(m, ifp->if_fib);
1783 netisr_dispatch(isr, m);
1784 m = m0 != NULL ? m0 : NULL;
1785 mtx_lock(&sc->sc_mtx);
1787 sc->sc_mwait = mwait;
1791 uhso_ifnet_write_callback(struct usb_xfer *xfer, usb_error_t error)
1793 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1794 struct ifnet *ifp = sc->sc_ifp;
1795 struct usb_page_cache *pc;
1799 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1801 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1803 switch (USB_GET_STATE(xfer)) {
1804 case USB_ST_TRANSFERRED:
1806 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1809 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
1813 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1815 if (m->m_pkthdr.len > MCLBYTES)
1816 m->m_pkthdr.len = MCLBYTES;
1818 usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len);
1819 pc = usbd_xfer_get_frame(xfer, 0);
1820 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
1821 usbd_transfer_submit(xfer);
1827 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1828 if (error == USB_ERR_CANCELLED)
1830 usbd_xfer_set_stall(xfer);
1836 uhso_if_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
1838 struct uhso_softc *sc;
1844 if (ifp->if_flags & IFF_UP) {
1845 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) {
1850 if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
1851 mtx_lock(&sc->sc_mtx);
1853 mtx_unlock(&sc->sc_mtx);
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, const 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);