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_var.h>
51 #include <net/if_types.h>
52 #include <net/netisr.h>
54 #include <netinet/in.h>
55 #include <netinet/ip.h>
56 #include <netinet/ip6.h>
58 #include <dev/usb/usb.h>
59 #include <dev/usb/usbdi.h>
60 #include <dev/usb/usbdi_util.h>
61 #include <dev/usb/usb_cdc.h>
63 #define USB_DEBUG_VAR uhso_debug
64 #include <dev/usb/usb_debug.h>
65 #include <dev/usb/usb_process.h>
66 #include <dev/usb/usb_busdma.h>
67 #include <dev/usb/usb_msctest.h>
69 #include <dev/usb/serial/usb_serial.h>
72 struct uhso_softc *ht_sc;
73 struct usb_xfer *ht_xfer[3];
74 int ht_muxport; /* Mux. port no */
81 struct usb_device *sc_udev;
83 uint32_t sc_type; /* Interface definition */
86 struct usb_xfer *sc_xfer[3];
88 uint8_t sc_iface_index;
91 struct usb_xfer * sc_ctrl_xfer[2];
92 uint8_t sc_ctrl_iface_no;
95 struct usb_xfer *sc_if_xfer[2];
97 struct mbuf *sc_mwait; /* Partial packet */
98 size_t sc_waitlen; /* No. of outstanding bytes */
99 struct ifqueue sc_rxq;
102 /* TTY related structures */
103 struct ucom_super_softc sc_super_ucom;
105 struct uhso_tty *sc_tty;
106 struct ucom_softc *sc_ucom;
112 #define UHSO_MAX_MTU 2048
115 * There are mainly two type of cards floating around.
116 * The first one has 2,3 or 4 interfaces with a multiplexed serial port
117 * and packet interface on the first interface and bulk serial ports
119 * The second type of card has several other interfaces, their purpose
120 * can be detected during run-time.
122 #define UHSO_IFACE_SPEC(usb_type, port, port_type) \
123 (((usb_type) << 24) | ((port) << 16) | (port_type))
125 #define UHSO_IFACE_USB_TYPE(x) ((x >> 24) & 0xff)
126 #define UHSO_IFACE_PORT(x) ((x >> 16) & 0xff)
127 #define UHSO_IFACE_PORT_TYPE(x) (x & 0xff)
130 * USB interface types
132 #define UHSO_IF_NET 0x01 /* Network packet interface */
133 #define UHSO_IF_MUX 0x02 /* Multiplexed serial port */
134 #define UHSO_IF_BULK 0x04 /* Bulk interface */
139 #define UHSO_PORT_UNKNOWN 0x00
140 #define UHSO_PORT_SERIAL 0x01 /* Serial port */
141 #define UHSO_PORT_NETWORK 0x02 /* Network packet interface */
144 * Multiplexed serial port destination sub-port names
146 #define UHSO_MPORT_TYPE_CTL 0x00 /* Control port */
147 #define UHSO_MPORT_TYPE_APP 0x01 /* Application */
148 #define UHSO_MPORT_TYPE_PCSC 0x02
149 #define UHSO_MPORT_TYPE_GPS 0x03
150 #define UHSO_MPORT_TYPE_APP2 0x04 /* Secondary application */
151 #define UHSO_MPORT_TYPE_MAX UHSO_MPORT_TYPE_APP2
152 #define UHSO_MPORT_TYPE_NOMAX 8 /* Max number of mux ports */
156 * Note that these definitions are arbitrary and do not match the values
157 * returned by the auto config descriptor.
159 #define UHSO_PORT_TYPE_UNKNOWN 0x00
160 #define UHSO_PORT_TYPE_CTL 0x01
161 #define UHSO_PORT_TYPE_APP 0x02
162 #define UHSO_PORT_TYPE_APP2 0x03
163 #define UHSO_PORT_TYPE_MODEM 0x04
164 #define UHSO_PORT_TYPE_NETWORK 0x05
165 #define UHSO_PORT_TYPE_DIAG 0x06
166 #define UHSO_PORT_TYPE_DIAG2 0x07
167 #define UHSO_PORT_TYPE_GPS 0x08
168 #define UHSO_PORT_TYPE_GPSCTL 0x09
169 #define UHSO_PORT_TYPE_PCSC 0x0a
170 #define UHSO_PORT_TYPE_MSD 0x0b
171 #define UHSO_PORT_TYPE_VOICE 0x0c
172 #define UHSO_PORT_TYPE_MAX 0x0c
174 static eventhandler_tag uhso_etag;
176 /* Overall port type */
177 static char *uhso_port[] = {
185 * Map between interface port type read from device and description type.
186 * The position in this array is a direct map to the auto config
189 static unsigned char uhso_port_map[] = {
190 UHSO_PORT_TYPE_UNKNOWN,
193 UHSO_PORT_TYPE_GPSCTL,
197 UHSO_PORT_TYPE_NETWORK,
198 UHSO_PORT_TYPE_MODEM,
203 static char uhso_port_map_max = sizeof(uhso_port_map) / sizeof(char);
205 static unsigned char uhso_mux_port_map[] = {
213 static char *uhso_port_type[] = {
214 "Unknown", /* Not a valid port */
217 "Application (Secondary)",
221 "Diagnostic (Secondary)",
229 static char *uhso_port_type_sysctl[] = {
245 #define UHSO_STATIC_IFACE 0x01
246 #define UHSO_AUTO_IFACE 0x02
248 /* ifnet device unit allocations */
249 static struct unrhdr *uhso_ifnet_unit = NULL;
251 static const STRUCT_USB_HOST_ID uhso_devs[] = {
252 #define UHSO_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
253 /* Option GlobeTrotter MAX 7.2 with upgraded firmware */
254 UHSO_DEV(OPTION, GTMAX72, UHSO_STATIC_IFACE),
255 /* Option GlobeSurfer iCON 7.2 */
256 UHSO_DEV(OPTION, GSICON72, UHSO_STATIC_IFACE),
257 /* Option iCON 225 */
258 UHSO_DEV(OPTION, GTHSDPA, UHSO_STATIC_IFACE),
259 /* Option GlobeSurfer iCON HSUPA */
260 UHSO_DEV(OPTION, GSICONHSUPA, UHSO_STATIC_IFACE),
261 /* Option GlobeTrotter HSUPA */
262 UHSO_DEV(OPTION, GTHSUPA, UHSO_STATIC_IFACE),
264 UHSO_DEV(OPTION, GE40X, UHSO_AUTO_IFACE),
265 UHSO_DEV(OPTION, GE40X_1, UHSO_AUTO_IFACE),
266 UHSO_DEV(OPTION, GE40X_2, UHSO_AUTO_IFACE),
267 UHSO_DEV(OPTION, GE40X_3, UHSO_AUTO_IFACE),
268 /* Option GlobeSurfer iCON 401 */
269 UHSO_DEV(OPTION, ICON401, UHSO_AUTO_IFACE),
270 /* Option GlobeTrotter Module 382 */
271 UHSO_DEV(OPTION, GMT382, UHSO_AUTO_IFACE),
273 UHSO_DEV(OPTION, GTM661W, UHSO_AUTO_IFACE),
274 /* Option iCON EDGE */
275 UHSO_DEV(OPTION, ICONEDGE, UHSO_STATIC_IFACE),
276 /* Option Module HSxPA */
277 UHSO_DEV(OPTION, MODHSXPA, UHSO_STATIC_IFACE),
278 /* Option iCON 321 */
279 UHSO_DEV(OPTION, ICON321, UHSO_STATIC_IFACE),
280 /* Option iCON 322 */
281 UHSO_DEV(OPTION, GTICON322, UHSO_STATIC_IFACE),
282 /* Option iCON 505 */
283 UHSO_DEV(OPTION, ICON505, UHSO_AUTO_IFACE),
284 /* Option iCON 452 */
285 UHSO_DEV(OPTION, ICON505, UHSO_AUTO_IFACE),
289 static SYSCTL_NODE(_hw_usb, OID_AUTO, uhso, CTLFLAG_RW, 0, "USB uhso");
290 static int uhso_autoswitch = 1;
291 SYSCTL_INT(_hw_usb_uhso, OID_AUTO, auto_switch, CTLFLAG_RWTUN,
292 &uhso_autoswitch, 0, "Automatically switch to modem mode");
296 static int uhso_debug = UHSO_DEBUG;
298 static int uhso_debug = -1;
301 SYSCTL_INT(_hw_usb_uhso, OID_AUTO, debug, CTLFLAG_RWTUN,
302 &uhso_debug, 0, "Debug level");
304 #define UHSO_DPRINTF(n, x, ...) {\
305 if (uhso_debug >= n) {\
306 printf("%s: " x, __func__, ##__VA_ARGS__);\
310 #define UHSO_DPRINTF(n, x, ...)
313 #ifdef UHSO_DEBUG_HEXDUMP
314 # define UHSO_HEXDUMP(_buf, _len) do { \
317 const char *__buf = (const char *)_buf; \
318 for (__tmp = 0; __tmp < _len; __tmp++) \
319 printf("%02hhx ", *__buf++); \
324 # define UHSO_HEXDUMP(_buf, _len)
328 UHSO_MUX_ENDPT_INTR = 0,
345 UHSO_BULK_ENDPT_READ = 0,
346 UHSO_BULK_ENDPT_WRITE,
347 UHSO_BULK_ENDPT_INTR,
351 static usb_callback_t uhso_mux_intr_callback;
352 static usb_callback_t uhso_mux_read_callback;
353 static usb_callback_t uhso_mux_write_callback;
354 static usb_callback_t uhso_bs_read_callback;
355 static usb_callback_t uhso_bs_write_callback;
356 static usb_callback_t uhso_bs_intr_callback;
357 static usb_callback_t uhso_ifnet_read_callback;
358 static usb_callback_t uhso_ifnet_write_callback;
360 /* Config used for the default control pipes */
361 static const struct usb_config uhso_ctrl_config[UHSO_CTRL_MAX] = {
365 .direction = UE_DIR_ANY,
366 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
367 .bufsize = sizeof(struct usb_device_request) + 1024,
368 .callback = &uhso_mux_read_callback
371 [UHSO_CTRL_WRITE] = {
374 .direction = UE_DIR_ANY,
375 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
376 .bufsize = sizeof(struct usb_device_request) + 1024,
378 .callback = &uhso_mux_write_callback
382 /* Config for the multiplexed serial ports */
383 static const struct usb_config uhso_mux_config[UHSO_MUX_ENDPT_MAX] = {
384 [UHSO_MUX_ENDPT_INTR] = {
385 .type = UE_INTERRUPT,
386 .endpoint = UE_ADDR_ANY,
387 .direction = UE_DIR_IN,
388 .flags = { .short_xfer_ok = 1 },
390 .callback = &uhso_mux_intr_callback,
394 /* Config for the raw IP-packet interface */
395 static const struct usb_config uhso_ifnet_config[UHSO_IFNET_MAX] = {
396 [UHSO_IFNET_READ] = {
398 .endpoint = UE_ADDR_ANY,
399 .direction = UE_DIR_IN,
400 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
402 .callback = &uhso_ifnet_read_callback
404 [UHSO_IFNET_WRITE] = {
406 .endpoint = UE_ADDR_ANY,
407 .direction = UE_DIR_OUT,
408 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
410 .timeout = 5 * USB_MS_HZ,
411 .callback = &uhso_ifnet_write_callback
415 /* Config for interfaces with normal bulk serial ports */
416 static const struct usb_config uhso_bs_config[UHSO_BULK_ENDPT_MAX] = {
417 [UHSO_BULK_ENDPT_READ] = {
419 .endpoint = UE_ADDR_ANY,
420 .direction = UE_DIR_IN,
421 .flags = { .pipe_bof = 1, .short_xfer_ok = 1 },
423 .callback = &uhso_bs_read_callback
426 [UHSO_BULK_ENDPT_WRITE] = {
428 .endpoint = UE_ADDR_ANY,
429 .direction = UE_DIR_OUT,
430 .flags = { .pipe_bof = 1, .force_short_xfer = 1 },
432 .callback = &uhso_bs_write_callback
435 [UHSO_BULK_ENDPT_INTR] = {
436 .type = UE_INTERRUPT,
437 .endpoint = UE_ADDR_ANY,
438 .direction = UE_DIR_IN,
439 .flags = { .short_xfer_ok = 1 },
441 .callback = &uhso_bs_intr_callback,
445 static int uhso_probe_iface(struct uhso_softc *, int,
446 int (*probe)(struct usb_device *, int));
447 static int uhso_probe_iface_auto(struct usb_device *, int);
448 static int uhso_probe_iface_static(struct usb_device *, int);
449 static int uhso_attach_muxserial(struct uhso_softc *, struct usb_interface *,
451 static int uhso_attach_bulkserial(struct uhso_softc *, struct usb_interface *,
453 static int uhso_attach_ifnet(struct uhso_softc *, struct usb_interface *,
455 static void uhso_test_autoinst(void *, struct usb_device *,
456 struct usb_attach_arg *);
457 static int uhso_driver_loaded(struct module *, int, void *);
458 static int uhso_radio_sysctl(SYSCTL_HANDLER_ARGS);
459 static int uhso_radio_ctrl(struct uhso_softc *, int);
461 static void uhso_free(struct ucom_softc *);
462 static void uhso_ucom_start_read(struct ucom_softc *);
463 static void uhso_ucom_stop_read(struct ucom_softc *);
464 static void uhso_ucom_start_write(struct ucom_softc *);
465 static void uhso_ucom_stop_write(struct ucom_softc *);
466 static void uhso_ucom_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
467 static void uhso_ucom_cfg_set_dtr(struct ucom_softc *, uint8_t);
468 static void uhso_ucom_cfg_set_rts(struct ucom_softc *, uint8_t);
469 static void uhso_if_init(void *);
470 static void uhso_if_start(struct ifnet *);
471 static void uhso_if_stop(struct uhso_softc *);
472 static int uhso_if_ioctl(struct ifnet *, u_long, caddr_t);
473 static int uhso_if_output(struct ifnet *, struct mbuf *,
474 const struct sockaddr *, struct route *);
475 static void uhso_if_rxflush(void *);
477 static device_probe_t uhso_probe;
478 static device_attach_t uhso_attach;
479 static device_detach_t uhso_detach;
480 static void uhso_free_softc(struct uhso_softc *);
482 static device_method_t uhso_methods[] = {
483 DEVMETHOD(device_probe, uhso_probe),
484 DEVMETHOD(device_attach, uhso_attach),
485 DEVMETHOD(device_detach, uhso_detach),
489 static driver_t uhso_driver = {
491 .methods = uhso_methods,
492 .size = sizeof(struct uhso_softc)
495 static devclass_t uhso_devclass;
496 DRIVER_MODULE(uhso, uhub, uhso_driver, uhso_devclass, uhso_driver_loaded, 0);
497 MODULE_DEPEND(uhso, ucom, 1, 1, 1);
498 MODULE_DEPEND(uhso, usb, 1, 1, 1);
499 MODULE_VERSION(uhso, 1);
500 USB_PNP_HOST_INFO(uhso_devs);
502 static struct ucom_callback uhso_ucom_callback = {
503 .ucom_cfg_get_status = &uhso_ucom_cfg_get_status,
504 .ucom_cfg_set_dtr = &uhso_ucom_cfg_set_dtr,
505 .ucom_cfg_set_rts = &uhso_ucom_cfg_set_rts,
506 .ucom_start_read = uhso_ucom_start_read,
507 .ucom_stop_read = uhso_ucom_stop_read,
508 .ucom_start_write = uhso_ucom_start_write,
509 .ucom_stop_write = uhso_ucom_stop_write,
510 .ucom_free = &uhso_free,
514 uhso_probe(device_t self)
516 struct usb_attach_arg *uaa = device_get_ivars(self);
519 if (uaa->usb_mode != USB_MODE_HOST)
521 if (uaa->info.bConfigIndex != 0)
523 if (uaa->info.bDeviceClass != 0xff)
526 error = usbd_lookup_id_by_uaa(uhso_devs, sizeof(uhso_devs), uaa);
531 * Probe device to see if we are able to attach
532 * to this interface or not.
534 if (USB_GET_DRIVER_INFO(uaa) == UHSO_AUTO_IFACE) {
535 if (uhso_probe_iface_auto(uaa->device,
536 uaa->info.bIfaceNum) == 0)
543 uhso_attach(device_t self)
545 struct uhso_softc *sc = device_get_softc(self);
546 struct usb_attach_arg *uaa = device_get_ivars(self);
547 struct usb_interface_descriptor *id;
548 struct sysctl_ctx_list *sctx;
549 struct sysctl_oid *soid;
550 struct sysctl_oid *tree = NULL, *tty_node;
551 struct ucom_softc *ucom;
559 sc->sc_udev = uaa->device;
560 mtx_init(&sc->sc_mtx, "uhso", NULL, MTX_DEF);
561 ucom_ref(&sc->sc_super_ucom);
565 id = usbd_get_interface_descriptor(uaa->iface);
566 sc->sc_ctrl_iface_no = id->bInterfaceNumber;
568 sc->sc_iface_no = uaa->info.bIfaceNum;
569 sc->sc_iface_index = uaa->info.bIfaceIndex;
571 /* Setup control pipe */
572 uerr = usbd_transfer_setup(uaa->device,
573 &sc->sc_iface_index, sc->sc_ctrl_xfer,
574 uhso_ctrl_config, UHSO_CTRL_MAX, sc, &sc->sc_mtx);
576 device_printf(self, "Failed to setup control pipe: %s\n",
581 if (USB_GET_DRIVER_INFO(uaa) == UHSO_STATIC_IFACE)
582 probe_f = uhso_probe_iface_static;
583 else if (USB_GET_DRIVER_INFO(uaa) == UHSO_AUTO_IFACE)
584 probe_f = uhso_probe_iface_auto;
588 error = uhso_probe_iface(sc, uaa->info.bIfaceNum, probe_f);
592 sctx = device_get_sysctl_ctx(sc->sc_dev);
593 soid = device_get_sysctl_tree(sc->sc_dev);
595 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "type",
596 CTLFLAG_RD, uhso_port[UHSO_IFACE_PORT(sc->sc_type)], 0,
597 "Port available at this interface");
598 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "radio",
599 CTLTYPE_INT | CTLFLAG_RWTUN, sc, 0, uhso_radio_sysctl, "I", "Enable radio");
602 * The default interface description on most Option devices isn't
603 * very helpful. So we skip device_set_usb_desc and set the
604 * device description manually.
606 device_set_desc_copy(self, uhso_port_type[UHSO_IFACE_PORT_TYPE(sc->sc_type)]);
607 /* Announce device */
608 device_printf(self, "<%s port> at <%s %s> on %s\n",
609 uhso_port_type[UHSO_IFACE_PORT_TYPE(sc->sc_type)],
610 usb_get_manufacturer(uaa->device),
611 usb_get_product(uaa->device),
612 device_get_nameunit(device_get_parent(self)));
614 if (sc->sc_ttys > 0) {
615 SYSCTL_ADD_INT(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "ports",
616 CTLFLAG_RD, &sc->sc_ttys, 0, "Number of attached serial ports");
618 tree = SYSCTL_ADD_NODE(sctx, SYSCTL_CHILDREN(soid), OID_AUTO,
619 "port", CTLFLAG_RD, NULL, "Serial ports");
623 * Loop through the number of found TTYs and create sysctl
626 for (i = 0; i < sc->sc_ttys; i++) {
628 ucom = &sc->sc_ucom[i];
630 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX)
631 port = uhso_mux_port_map[ht->ht_muxport];
633 port = UHSO_IFACE_PORT_TYPE(sc->sc_type);
635 desc = uhso_port_type_sysctl[port];
637 tty_node = SYSCTL_ADD_NODE(sctx, SYSCTL_CHILDREN(tree), OID_AUTO,
638 desc, CTLFLAG_RD, NULL, "");
641 if (sc->sc_ttys == 1)
642 snprintf(ht->ht_name, 32, "cuaU%d", ucom->sc_super->sc_unit);
644 snprintf(ht->ht_name, 32, "cuaU%d.%d",
645 ucom->sc_super->sc_unit, ucom->sc_subunit);
648 desc = uhso_port_type[port];
649 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(tty_node), OID_AUTO,
650 "tty", CTLFLAG_RD, ht->ht_name, 0, "");
651 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(tty_node), OID_AUTO,
652 "desc", CTLFLAG_RD, desc, 0, "");
655 device_printf(sc->sc_dev,
656 "\"%s\" port at %s\n", desc, ht->ht_name);
661 uhso_detach(sc->sc_dev);
666 uhso_detach(device_t self)
668 struct uhso_softc *sc = device_get_softc(self);
671 usbd_transfer_unsetup(sc->sc_xfer, 3);
672 usbd_transfer_unsetup(sc->sc_ctrl_xfer, UHSO_CTRL_MAX);
673 if (sc->sc_ttys > 0) {
674 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
676 for (i = 0; i < sc->sc_ttys; i++) {
677 if (sc->sc_tty[i].ht_muxport != -1) {
678 usbd_transfer_unsetup(sc->sc_tty[i].ht_xfer,
684 if (sc->sc_ifp != NULL) {
685 callout_drain(&sc->sc_c);
686 free_unr(uhso_ifnet_unit, sc->sc_ifp->if_dunit);
687 mtx_lock(&sc->sc_mtx);
689 bpfdetach(sc->sc_ifp);
690 if_detach(sc->sc_ifp);
692 mtx_unlock(&sc->sc_mtx);
693 usbd_transfer_unsetup(sc->sc_if_xfer, UHSO_IFNET_MAX);
696 device_claim_softc(self);
703 UCOM_UNLOAD_DRAIN(uhso);
706 uhso_free_softc(struct uhso_softc *sc)
708 if (ucom_unref(&sc->sc_super_ucom)) {
709 free(sc->sc_tty, M_USBDEV);
710 free(sc->sc_ucom, M_USBDEV);
711 mtx_destroy(&sc->sc_mtx);
712 device_free_softc(sc);
717 uhso_free(struct ucom_softc *ucom)
719 uhso_free_softc(ucom->sc_parent);
723 uhso_test_autoinst(void *arg, struct usb_device *udev,
724 struct usb_attach_arg *uaa)
726 struct usb_interface *iface;
727 struct usb_interface_descriptor *id;
729 if (uaa->dev_state != UAA_DEV_READY || !uhso_autoswitch)
732 iface = usbd_get_iface(udev, 0);
736 if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
738 if (usbd_lookup_id_by_uaa(uhso_devs, sizeof(uhso_devs), uaa))
739 return; /* no device match */
741 if (usb_msc_eject(udev, 0, MSC_EJECT_REZERO) == 0) {
742 /* success, mark the udev as disappearing */
743 uaa->dev_state = UAA_DEV_EJECTING;
748 uhso_driver_loaded(struct module *mod, int what, void *arg)
752 /* register our autoinstall handler */
753 uhso_etag = EVENTHANDLER_REGISTER(usb_dev_configured,
754 uhso_test_autoinst, NULL, EVENTHANDLER_PRI_ANY);
755 /* create our unit allocator for inet devs */
756 uhso_ifnet_unit = new_unrhdr(0, INT_MAX, NULL);
759 EVENTHANDLER_DEREGISTER(usb_dev_configured, uhso_etag);
760 delete_unrhdr(uhso_ifnet_unit);
769 * Probe the interface type by querying the device. The elements
770 * of an array indicates the capabilities of a particular interface.
771 * Returns a bit mask with the interface capabilities.
774 uhso_probe_iface_auto(struct usb_device *udev, int index)
776 struct usb_device_request req;
782 req.bmRequestType = UT_READ_VENDOR_DEVICE;
784 USETW(req.wValue, 0);
785 USETW(req.wIndex, 0);
786 USETW(req.wLength, 17);
788 uerr = usbd_do_request_flags(udev, NULL, &req, buf,
789 0, &actlen, USB_MS_HZ);
791 printf("%s: usbd_do_request_flags failed, %s\n",
792 __func__, usbd_errstr(uerr));
796 UHSO_DPRINTF(1, "actlen=%d\n", actlen);
797 UHSO_HEXDUMP(buf, 17);
799 if (index < 0 || index > 16) {
800 UHSO_DPRINTF(0, "Index %d out of range\n", index);
804 UHSO_DPRINTF(1, "index=%d, type=%x[%s]\n", index, buf[index],
805 uhso_port_type[(int)uhso_port_map[(int)buf[index]]]);
807 if (buf[index] >= uhso_port_map_max)
810 port = uhso_port_map[(int)buf[index]];
813 case UHSO_PORT_TYPE_NETWORK:
814 return (UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
815 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK, port));
816 case UHSO_PORT_TYPE_DIAG:
817 case UHSO_PORT_TYPE_DIAG2:
818 case UHSO_PORT_TYPE_GPS:
819 case UHSO_PORT_TYPE_GPSCTL:
820 case UHSO_PORT_TYPE_CTL:
821 case UHSO_PORT_TYPE_APP:
822 case UHSO_PORT_TYPE_APP2:
823 case UHSO_PORT_TYPE_MODEM:
824 return (UHSO_IFACE_SPEC(UHSO_IF_BULK,
825 UHSO_PORT_SERIAL, port));
826 case UHSO_PORT_TYPE_MSD:
828 case UHSO_PORT_TYPE_UNKNOWN:
837 * Returns the capabilities of interfaces for devices that don't
838 * support the automatic query.
839 * Returns a bit mask with the interface capabilities.
842 uhso_probe_iface_static(struct usb_device *udev, int index)
844 struct usb_config_descriptor *cd;
846 cd = usbd_get_config_descriptor(udev);
847 if (cd->bNumInterface <= 3) {
848 /* Cards with 3 or less interfaces */
851 return UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
852 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK,
853 UHSO_PORT_TYPE_NETWORK);
855 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
856 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG);
858 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
859 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_MODEM);
862 /* Cards with 4 interfaces */
865 return UHSO_IFACE_SPEC(UHSO_IF_NET | UHSO_IF_MUX,
866 UHSO_PORT_SERIAL | UHSO_PORT_NETWORK,
867 UHSO_PORT_TYPE_NETWORK);
869 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
870 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG2);
872 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
873 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_MODEM);
875 return UHSO_IFACE_SPEC(UHSO_IF_BULK,
876 UHSO_PORT_SERIAL, UHSO_PORT_TYPE_DIAG);
883 * Probes an interface for its particular capabilities and attaches if
884 * it's a supported interface.
887 uhso_probe_iface(struct uhso_softc *sc, int index,
888 int (*probe)(struct usb_device *, int))
890 struct usb_interface *iface;
893 UHSO_DPRINTF(1, "Probing for interface %d, probe_func=%p\n", index, probe);
895 type = probe(sc->sc_udev, index);
896 UHSO_DPRINTF(1, "Probe result %x\n", type);
901 iface = usbd_get_iface(sc->sc_udev, index);
903 if (UHSO_IFACE_PORT_TYPE(type) == UHSO_PORT_TYPE_NETWORK) {
904 error = uhso_attach_ifnet(sc, iface, type);
906 UHSO_DPRINTF(1, "uhso_attach_ifnet failed");
911 * If there is an additional interrupt endpoint on this
912 * interface then we most likely have a multiplexed serial port
915 if (iface->idesc->bNumEndpoints < 3) {
916 sc->sc_type = UHSO_IFACE_SPEC(
917 UHSO_IFACE_USB_TYPE(type) & ~UHSO_IF_MUX,
918 UHSO_IFACE_PORT(type) & ~UHSO_PORT_SERIAL,
919 UHSO_IFACE_PORT_TYPE(type));
923 UHSO_DPRINTF(1, "Trying to attach mux. serial\n");
924 error = uhso_attach_muxserial(sc, iface, type);
925 if (error == 0 && sc->sc_ttys > 0) {
926 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
927 sc->sc_ttys, sc, &uhso_ucom_callback, &sc->sc_mtx);
929 device_printf(sc->sc_dev, "ucom_attach failed\n");
932 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, sc->sc_dev);
934 mtx_lock(&sc->sc_mtx);
935 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
936 mtx_unlock(&sc->sc_mtx);
938 } else if ((UHSO_IFACE_USB_TYPE(type) & UHSO_IF_BULK) &&
939 UHSO_IFACE_PORT(type) & UHSO_PORT_SERIAL) {
941 error = uhso_attach_bulkserial(sc, iface, type);
945 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
946 sc->sc_ttys, sc, &uhso_ucom_callback, &sc->sc_mtx);
948 device_printf(sc->sc_dev, "ucom_attach failed\n");
951 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, sc->sc_dev);
954 UHSO_DPRINTF(0, "Unknown type %x\n", type);
962 uhso_radio_ctrl(struct uhso_softc *sc, int onoff)
964 struct usb_device_request req;
967 req.bmRequestType = UT_VENDOR;
968 req.bRequest = onoff ? 0x82 : 0x81;
969 USETW(req.wValue, 0);
970 USETW(req.wIndex, 0);
971 USETW(req.wLength, 0);
973 uerr = usbd_do_request(sc->sc_udev, NULL, &req, NULL);
975 device_printf(sc->sc_dev, "usbd_do_request_flags failed: %s\n",
983 uhso_radio_sysctl(SYSCTL_HANDLER_ARGS)
985 struct uhso_softc *sc = arg1;
988 radio = sc->sc_radio;
989 error = sysctl_handle_int(oidp, &radio, 0, req);
992 if (radio != sc->sc_radio) {
993 radio = radio != 0 ? 1 : 0;
994 error = uhso_radio_ctrl(sc, radio);
996 sc->sc_radio = radio;
1003 * Expands allocated memory to fit an additional TTY.
1004 * Two arrays are kept with matching indexes, one for ucom and one
1005 * for our private data.
1008 uhso_alloc_tty(struct uhso_softc *sc)
1012 sc->sc_tty = reallocf(sc->sc_tty, sizeof(struct uhso_tty) * sc->sc_ttys,
1013 M_USBDEV, M_WAITOK | M_ZERO);
1014 if (sc->sc_tty == NULL)
1017 sc->sc_ucom = reallocf(sc->sc_ucom,
1018 sizeof(struct ucom_softc) * sc->sc_ttys, M_USBDEV, M_WAITOK | M_ZERO);
1019 if (sc->sc_ucom == NULL)
1022 sc->sc_tty[sc->sc_ttys - 1].ht_sc = sc;
1024 UHSO_DPRINTF(1, "Allocated TTY %d\n", sc->sc_ttys - 1);
1025 return (sc->sc_ttys - 1);
1029 * Attach a multiplexed serial port
1030 * Data is read/written with requests on the default control pipe. An interrupt
1031 * endpoint returns when there is new data to be read.
1034 uhso_attach_muxserial(struct uhso_softc *sc, struct usb_interface *iface,
1037 struct usb_descriptor *desc;
1042 * The class specific interface (type 0x24) descriptor subtype field
1043 * contains a bitmask that specifies which (and how many) ports that
1044 * are available through this multiplexed serial port.
1046 desc = usbd_find_descriptor(sc->sc_udev, NULL,
1047 iface->idesc->bInterfaceNumber, UDESC_CS_INTERFACE, 0xff, 0, 0);
1049 UHSO_DPRINTF(0, "Failed to find UDESC_CS_INTERFACE\n");
1053 UHSO_DPRINTF(1, "Mux port mask %x\n", desc->bDescriptorSubtype);
1054 if (desc->bDescriptorSubtype == 0)
1058 * The bitmask is one octet, loop through the number of
1059 * bits that are set and create a TTY for each.
1061 for (i = 0; i < 8; i++) {
1063 if ((port & desc->bDescriptorSubtype) == port) {
1064 UHSO_DPRINTF(2, "Found mux port %x (%d)\n", port, i);
1065 tty = uhso_alloc_tty(sc);
1068 sc->sc_tty[tty].ht_muxport = i;
1069 uerr = usbd_transfer_setup(sc->sc_udev,
1070 &sc->sc_iface_index, sc->sc_tty[tty].ht_xfer,
1071 uhso_ctrl_config, UHSO_CTRL_MAX, sc, &sc->sc_mtx);
1073 device_printf(sc->sc_dev,
1074 "Failed to setup control pipe: %s\n",
1081 /* Setup the intr. endpoint */
1082 uerr = usbd_transfer_setup(sc->sc_udev,
1083 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1084 uhso_mux_config, 1, sc, &sc->sc_mtx);
1092 * Interrupt callback for the multiplexed serial port. Indicates
1093 * which serial port has data waiting.
1096 uhso_mux_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1098 struct usb_page_cache *pc;
1099 struct usb_page_search res;
1100 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1101 unsigned int i, mux;
1103 UHSO_DPRINTF(3, "status %d\n", USB_GET_STATE(xfer));
1105 switch (USB_GET_STATE(xfer)) {
1106 case USB_ST_TRANSFERRED:
1108 * The multiplexed port number can be found at the first byte.
1109 * It contains a bit mask, we transform this in to an integer.
1111 pc = usbd_xfer_get_frame(xfer, 0);
1112 usbd_get_page(pc, 0, &res);
1114 i = *((unsigned char *)res.buffer);
1120 UHSO_DPRINTF(3, "mux port %d (%d)\n", mux, i);
1121 if (mux > UHSO_MPORT_TYPE_NOMAX)
1124 /* Issue a read for this serial port */
1126 sc->sc_tty[mux].ht_xfer[UHSO_CTRL_READ],
1128 usbd_transfer_start(sc->sc_tty[mux].ht_xfer[UHSO_CTRL_READ]);
1133 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1134 usbd_transfer_submit(xfer);
1137 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1138 if (error == USB_ERR_CANCELLED)
1141 usbd_xfer_set_stall(xfer);
1147 uhso_mux_read_callback(struct usb_xfer *xfer, usb_error_t error)
1149 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1150 struct usb_page_cache *pc;
1151 struct usb_device_request req;
1152 struct uhso_tty *ht;
1155 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1157 UHSO_DPRINTF(3, "status %d\n", USB_GET_STATE(xfer));
1159 ht = usbd_xfer_get_priv(xfer);
1160 UHSO_DPRINTF(3, "ht=%p open=%d\n", ht, ht->ht_open);
1162 switch (USB_GET_STATE(xfer)) {
1163 case USB_ST_TRANSFERRED:
1164 /* Got data, send to ucom */
1165 pc = usbd_xfer_get_frame(xfer, 1);
1166 len = usbd_xfer_frame_len(xfer, 1);
1168 UHSO_DPRINTF(3, "got %d bytes on mux port %d\n", len,
1171 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1175 /* Deliver data if the TTY is open, discard otherwise */
1177 ucom_put_data(&sc->sc_ucom[ht->ht_muxport], pc, 0, len);
1181 memset(&req, 0, sizeof(struct usb_device_request));
1182 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1183 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
1184 USETW(req.wValue, 0);
1185 USETW(req.wIndex, ht->ht_muxport);
1186 USETW(req.wLength, 1024);
1188 pc = usbd_xfer_get_frame(xfer, 0);
1189 usbd_copy_in(pc, 0, &req, sizeof(req));
1191 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1192 usbd_xfer_set_frame_len(xfer, 1, 1024);
1193 usbd_xfer_set_frames(xfer, 2);
1194 usbd_transfer_submit(xfer);
1197 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1198 if (error == USB_ERR_CANCELLED)
1200 usbd_xfer_set_stall(xfer);
1206 uhso_mux_write_callback(struct usb_xfer *xfer, usb_error_t error)
1208 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1209 struct uhso_tty *ht;
1210 struct usb_page_cache *pc;
1211 struct usb_device_request req;
1213 struct usb_page_search res;
1215 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1217 ht = usbd_xfer_get_priv(xfer);
1218 UHSO_DPRINTF(3, "status=%d, using mux port %d\n",
1219 USB_GET_STATE(xfer), ht->ht_muxport);
1221 switch (USB_GET_STATE(xfer)) {
1222 case USB_ST_TRANSFERRED:
1223 UHSO_DPRINTF(3, "wrote %zd data bytes to muxport %d\n",
1224 actlen - sizeof(struct usb_device_request) ,
1229 pc = usbd_xfer_get_frame(xfer, 1);
1230 if (ucom_get_data(&sc->sc_ucom[ht->ht_muxport], pc,
1233 usbd_get_page(pc, 0, &res);
1235 memset(&req, 0, sizeof(struct usb_device_request));
1236 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1237 req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
1238 USETW(req.wValue, 0);
1239 USETW(req.wIndex, ht->ht_muxport);
1240 USETW(req.wLength, actlen);
1242 pc = usbd_xfer_get_frame(xfer, 0);
1243 usbd_copy_in(pc, 0, &req, sizeof(req));
1245 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1246 usbd_xfer_set_frame_len(xfer, 1, actlen);
1247 usbd_xfer_set_frames(xfer, 2);
1249 UHSO_DPRINTF(3, "Prepared %d bytes for transmit "
1250 "on muxport %d\n", actlen, ht->ht_muxport);
1252 usbd_transfer_submit(xfer);
1256 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1257 if (error == USB_ERR_CANCELLED)
1259 usbd_xfer_set_stall(xfer);
1265 uhso_attach_bulkserial(struct uhso_softc *sc, struct usb_interface *iface,
1271 /* Try attaching RD/WR/INTR first */
1272 uerr = usbd_transfer_setup(sc->sc_udev,
1273 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1274 uhso_bs_config, UHSO_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1276 /* Try only RD/WR */
1277 uerr = usbd_transfer_setup(sc->sc_udev,
1278 &iface->idesc->bInterfaceNumber, sc->sc_xfer,
1279 uhso_bs_config, UHSO_BULK_ENDPT_MAX - 1, sc, &sc->sc_mtx);
1282 UHSO_DPRINTF(0, "usbd_transfer_setup failed");
1286 tty = uhso_alloc_tty(sc);
1288 usbd_transfer_unsetup(sc->sc_xfer, UHSO_BULK_ENDPT_MAX);
1292 sc->sc_tty[tty].ht_muxport = -1;
1297 uhso_bs_read_callback(struct usb_xfer *xfer, usb_error_t error)
1299 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1300 struct usb_page_cache *pc;
1303 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1305 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1307 switch (USB_GET_STATE(xfer)) {
1308 case USB_ST_TRANSFERRED:
1309 pc = usbd_xfer_get_frame(xfer, 0);
1310 ucom_put_data(&sc->sc_ucom[0], pc, 0, actlen);
1314 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1315 usbd_transfer_submit(xfer);
1318 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1319 if (error == USB_ERR_CANCELLED)
1321 usbd_xfer_set_stall(xfer);
1327 uhso_bs_write_callback(struct usb_xfer *xfer, usb_error_t error)
1329 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1330 struct usb_page_cache *pc;
1333 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1335 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1337 switch (USB_GET_STATE(xfer)) {
1338 case USB_ST_TRANSFERRED:
1341 pc = usbd_xfer_get_frame(xfer, 0);
1342 if (ucom_get_data(&sc->sc_ucom[0], pc, 0, 8192, &actlen)) {
1343 usbd_xfer_set_frame_len(xfer, 0, actlen);
1344 usbd_transfer_submit(xfer);
1349 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1350 if (error == USB_ERR_CANCELLED)
1352 usbd_xfer_set_stall(xfer);
1358 uhso_bs_cfg(struct uhso_softc *sc)
1360 struct usb_device_request req;
1363 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1366 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1367 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
1368 USETW(req.wValue, sc->sc_line);
1369 USETW(req.wIndex, sc->sc_iface_no);
1370 USETW(req.wLength, 0);
1372 uerr = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom[0], &req, NULL, 0, 1000);
1374 device_printf(sc->sc_dev, "failed to set ctrl line state to "
1375 "0x%02x: %s\n", sc->sc_line, usbd_errstr(uerr));
1380 uhso_bs_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1382 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1383 struct usb_page_cache *pc;
1385 struct usb_cdc_notification cdc;
1387 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1388 UHSO_DPRINTF(3, "status %d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1390 switch (USB_GET_STATE(xfer)) {
1391 case USB_ST_TRANSFERRED:
1392 if (actlen < UCDC_NOTIFICATION_LENGTH) {
1393 UHSO_DPRINTF(0, "UCDC notification too short: %d\n", actlen);
1396 else if (actlen > (int)sizeof(struct usb_cdc_notification)) {
1397 UHSO_DPRINTF(0, "UCDC notification too large: %d\n", actlen);
1398 actlen = sizeof(struct usb_cdc_notification);
1401 pc = usbd_xfer_get_frame(xfer, 0);
1402 usbd_copy_out(pc, 0, &cdc, actlen);
1404 if (UGETW(cdc.wIndex) != sc->sc_iface_no) {
1405 UHSO_DPRINTF(0, "Interface mismatch, got %d expected %d\n",
1406 UGETW(cdc.wIndex), sc->sc_iface_no);
1410 if (cdc.bmRequestType == UCDC_NOTIFICATION &&
1411 cdc.bNotification == UCDC_N_SERIAL_STATE) {
1412 UHSO_DPRINTF(2, "notify = 0x%02x\n", cdc.data[0]);
1416 if (cdc.data[0] & UCDC_N_SERIAL_RI)
1417 sc->sc_msr |= SER_RI;
1418 if (cdc.data[0] & UCDC_N_SERIAL_DSR)
1419 sc->sc_msr |= SER_DSR;
1420 if (cdc.data[0] & UCDC_N_SERIAL_DCD)
1421 sc->sc_msr |= SER_DCD;
1423 ucom_status_change(&sc->sc_ucom[0]);
1428 if (error == USB_ERR_CANCELLED)
1430 usbd_xfer_set_stall(xfer);
1436 uhso_ucom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
1438 struct uhso_softc *sc = ucom->sc_parent;
1445 uhso_ucom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
1447 struct uhso_softc *sc = ucom->sc_parent;
1449 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1453 sc->sc_line |= UCDC_LINE_DTR;
1455 sc->sc_line &= ~UCDC_LINE_DTR;
1461 uhso_ucom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
1463 struct uhso_softc *sc = ucom->sc_parent;
1465 if (!(UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK))
1469 sc->sc_line |= UCDC_LINE_RTS;
1471 sc->sc_line &= ~UCDC_LINE_RTS;
1477 uhso_ucom_start_read(struct ucom_softc *ucom)
1479 struct uhso_softc *sc = ucom->sc_parent;
1481 UHSO_DPRINTF(3, "unit=%d, subunit=%d\n",
1482 ucom->sc_super->sc_unit, ucom->sc_subunit);
1484 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1485 sc->sc_tty[ucom->sc_subunit].ht_open = 1;
1486 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1488 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1489 sc->sc_tty[0].ht_open = 1;
1490 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_READ]);
1491 if (sc->sc_xfer[UHSO_BULK_ENDPT_INTR] != NULL)
1492 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_INTR]);
1497 uhso_ucom_stop_read(struct ucom_softc *ucom)
1500 struct uhso_softc *sc = ucom->sc_parent;
1502 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1503 sc->sc_tty[ucom->sc_subunit].ht_open = 0;
1505 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_READ]);
1507 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1508 sc->sc_tty[0].ht_open = 0;
1509 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_READ]);
1510 if (sc->sc_xfer[UHSO_BULK_ENDPT_INTR] != NULL)
1511 usbd_transfer_stop(sc->sc_xfer[UHSO_BULK_ENDPT_INTR]);
1516 uhso_ucom_start_write(struct ucom_softc *ucom)
1518 struct uhso_softc *sc = ucom->sc_parent;
1520 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1521 UHSO_DPRINTF(3, "local unit %d\n", ucom->sc_subunit);
1523 usbd_transfer_start(sc->sc_xfer[UHSO_MUX_ENDPT_INTR]);
1526 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE],
1527 &sc->sc_tty[ucom->sc_subunit]);
1528 usbd_transfer_start(
1529 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE]);
1532 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1533 usbd_transfer_start(sc->sc_xfer[UHSO_BULK_ENDPT_WRITE]);
1538 uhso_ucom_stop_write(struct ucom_softc *ucom)
1540 struct uhso_softc *sc = ucom->sc_parent;
1542 if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_MUX) {
1544 sc->sc_tty[ucom->sc_subunit].ht_xfer[UHSO_CTRL_WRITE]);
1546 else if (UHSO_IFACE_USB_TYPE(sc->sc_type) & UHSO_IF_BULK) {
1547 usbd_transfer_stop(sc->sc_xfer[UHSO_BULK_ENDPT_WRITE]);
1552 uhso_attach_ifnet(struct uhso_softc *sc, struct usb_interface *iface, int type)
1556 struct sysctl_ctx_list *sctx;
1557 struct sysctl_oid *soid;
1558 unsigned int devunit;
1560 uerr = usbd_transfer_setup(sc->sc_udev,
1561 &iface->idesc->bInterfaceNumber, sc->sc_if_xfer,
1562 uhso_ifnet_config, UHSO_IFNET_MAX, sc, &sc->sc_mtx);
1564 UHSO_DPRINTF(0, "usbd_transfer_setup failed: %s\n",
1569 sc->sc_ifp = ifp = if_alloc(IFT_OTHER);
1570 if (sc->sc_ifp == NULL) {
1571 device_printf(sc->sc_dev, "if_alloc() failed\n");
1575 callout_init_mtx(&sc->sc_c, &sc->sc_mtx, 0);
1576 mtx_lock(&sc->sc_mtx);
1577 callout_reset(&sc->sc_c, 1, uhso_if_rxflush, sc);
1578 mtx_unlock(&sc->sc_mtx);
1581 * We create our own unit numbers for ifnet devices because the
1582 * USB interface unit numbers can be at arbitrary positions yielding
1583 * odd looking device names.
1585 devunit = alloc_unr(uhso_ifnet_unit);
1587 if_initname(ifp, device_get_name(sc->sc_dev), devunit);
1588 ifp->if_mtu = UHSO_MAX_MTU;
1589 ifp->if_ioctl = uhso_if_ioctl;
1590 ifp->if_init = uhso_if_init;
1591 ifp->if_start = uhso_if_start;
1592 ifp->if_output = uhso_if_output;
1593 ifp->if_flags = IFF_BROADCAST | IFF_MULTICAST | IFF_NOARP;
1595 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
1596 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
1597 IFQ_SET_READY(&ifp->if_snd);
1600 bpfattach(ifp, DLT_RAW, 0);
1602 sctx = device_get_sysctl_ctx(sc->sc_dev);
1603 soid = device_get_sysctl_tree(sc->sc_dev);
1604 /* Unlocked read... */
1605 SYSCTL_ADD_STRING(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "netif",
1606 CTLFLAG_RD, ifp->if_xname, 0, "Attached network interface");
1612 uhso_ifnet_read_callback(struct usb_xfer *xfer, usb_error_t error)
1614 struct uhso_softc *sc = usbd_xfer_softc(xfer);
1616 struct usb_page_cache *pc;
1619 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1621 UHSO_DPRINTF(3, "status=%d, actlen=%d\n", USB_GET_STATE(xfer), actlen);
1623 switch (USB_GET_STATE(xfer)) {
1624 case USB_ST_TRANSFERRED:
1625 if (actlen > 0 && (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)) {
1626 pc = usbd_xfer_get_frame(xfer, 0);
1627 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
1628 usbd_copy_out(pc, 0, mtod(m, uint8_t *), actlen);
1629 m->m_pkthdr.len = m->m_len = actlen;
1630 /* Enqueue frame for further processing */
1631 _IF_ENQUEUE(&sc->sc_rxq, m);
1632 if (!callout_pending(&sc->sc_c) ||
1633 !callout_active(&sc->sc_c)) {
1634 callout_schedule(&sc->sc_c, 1);
1640 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1641 usbd_transfer_submit(xfer);
1644 UHSO_DPRINTF(0, "error: %s\n", usbd_errstr(error));
1645 if (error == USB_ERR_CANCELLED)
1647 usbd_xfer_set_stall(xfer);
1653 * Deferred RX processing, called with mutex locked.
1655 * Each frame we receive might contain several small ip-packets as well
1656 * as partial ip-packets. We need to separate/assemble them into individual
1657 * packets before sending them to the ip-layer.
1660 uhso_if_rxflush(void *arg)
1662 struct uhso_softc *sc = arg;
1663 struct ifnet *ifp = sc->sc_ifp;
1665 struct mbuf *m, *m0, *mwait;
1668 struct ip6_hdr *ip6;
1674 mwait = sc->sc_mwait;
1677 _IF_DEQUEUE(&sc->sc_rxq, m);
1680 UHSO_DPRINTF(3, "dequeue m=%p, len=%d\n", m, m->m_len);
1682 mtx_unlock(&sc->sc_mtx);
1684 /* Do we have a partial packet waiting? */
1685 if (mwait != NULL) {
1689 UHSO_DPRINTF(3, "partial m0=%p(%d), concat w/ m=%p(%d)\n",
1690 m0, m0->m_len, m, m->m_len);
1693 m = m_pullup(m0, sizeof(struct ip));
1695 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
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);
1725 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
1726 UHSO_HEXDUMP(cp, 4);
1729 mtx_lock(&sc->sc_mtx);
1734 UHSO_DPRINTF(0, "Zero IP length\n");
1735 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
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_WAITOK, 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);
1776 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
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:
1804 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
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);
1867 uhso_if_init(void *priv)
1869 struct uhso_softc *sc = priv;
1870 struct ifnet *ifp = sc->sc_ifp;
1872 mtx_lock(&sc->sc_mtx);
1875 ifp->if_flags |= IFF_UP;
1876 ifp->if_drv_flags |= IFF_DRV_RUNNING;
1877 mtx_unlock(&sc->sc_mtx);
1879 UHSO_DPRINTF(2, "ifnet initialized\n");
1883 uhso_if_output(struct ifnet *ifp, struct mbuf *m0, const struct sockaddr *dst,
1888 /* Only IPv4/6 support */
1889 if (dst->sa_family != AF_INET
1891 && dst->sa_family != AF_INET6
1894 return (EAFNOSUPPORT);
1897 error = (ifp->if_transmit)(ifp, m0);
1899 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
1902 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
1907 uhso_if_start(struct ifnet *ifp)
1909 struct uhso_softc *sc = ifp->if_softc;
1911 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
1912 UHSO_DPRINTF(1, "Not running\n");
1916 mtx_lock(&sc->sc_mtx);
1917 usbd_transfer_start(sc->sc_if_xfer[UHSO_IFNET_READ]);
1918 usbd_transfer_start(sc->sc_if_xfer[UHSO_IFNET_WRITE]);
1919 mtx_unlock(&sc->sc_mtx);
1920 UHSO_DPRINTF(3, "interface started\n");
1924 uhso_if_stop(struct uhso_softc *sc)
1927 usbd_transfer_stop(sc->sc_if_xfer[UHSO_IFNET_READ]);
1928 usbd_transfer_stop(sc->sc_if_xfer[UHSO_IFNET_WRITE]);
1929 sc->sc_ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);