sys/netgraph/bluetooth/drivers/ubt/ng_ubt.c

   1 /*
   2  * ng_ubt.c
   3  */
   4
   5 /*-
   6  * Copyright (c) 2001-2009 Maksim Yevmenkin <m_evmenkin@yahoo.com>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $Id: ng_ubt.c,v 1.16 2003/10/10 19:15:06 max Exp $
  31  * $FreeBSD$
  32  */
  33
  34 /*
  35  * NOTE: ng_ubt2 driver has a split personality. On one side it is
  36  * a USB device driver and on the other it is a Netgraph node. This
  37  * driver will *NOT* create traditional /dev/ enties, only Netgraph
  38  * node.
  39  *
  40  * NOTE ON LOCKS USED: ng_ubt2 drives uses 2 locks (mutexes)
  41  *
  42  * 1) sc_if_mtx - lock for device's interface #0 and #1. This lock is used
  43  *    by USB for any USB request going over device's interface #0 and #1,
  44  *    i.e. interrupt, control, bulk and isoc. transfers.
  45  *
  46  * 2) sc_ng_mtx - this lock is used to protect shared (between USB, Netgraph
  47  *    and Taskqueue) data, such as outgoing mbuf queues, task flags and hook
  48  *    pointer. This lock *SHOULD NOT* be grabbed for a long time. In fact,
  49  *    think of it as a spin lock.
  50  *
  51  * NOTE ON LOCKING STRATEGY: ng_ubt2 driver operates in 3 different contexts.
  52  *
  53  * 1) USB context. This is where all the USB related stuff happens. All
  54  *    callbacks run in this context. All callbacks are called (by USB) with
  55  *    appropriate interface lock held. It is (generally) allowed to grab
  56  *    any additional locks.
  57  *
  58  * 2) Netgraph context. This is where all the Netgraph related stuff happens.
  59  *    Since we mark node as WRITER, the Netgraph node will be "locked" (from
  60  *    Netgraph point of view). Any variable that is only modified from the
  61  *    Netgraph context does not require any additonal locking. It is generally
  62  *    *NOT* allowed to grab *ANY* additional locks. Whatever you do, *DO NOT*
  63  *    grab any lock in the Netgraph context that could cause de-scheduling of
  64  *    the Netgraph thread for significant amount of time. In fact, the only
  65  *    lock that is allowed in the Netgraph context is the sc_ng_mtx lock.
  66  *    Also make sure that any code that is called from the Netgraph context
  67  *    follows the rule above.
  68  *
  69  * 3) Taskqueue context. This is where ubt_task runs. Since we are generally
  70  *    NOT allowed to grab any lock that could cause de-scheduling in the
  71  *    Netgraph context, and, USB requires us to grab interface lock before
  72  *    doing things with transfers, it is safer to transition from the Netgraph
  73  *    context to the Taskqueue context before we can call into USB subsystem.
  74  *
  75  * So, to put everything together, the rules are as follows.
  76  *      It is OK to call from the USB context or the Taskqueue context into
  77  * the Netgraph context (i.e. call NG_SEND_xxx functions). In other words
  78  * it is allowed to call into the Netgraph context with locks held.
  79  *      Is it *NOT* OK to call from the Netgraph context into the USB context,
  80  * because USB requires us to grab interface locks, and, it is safer to
  81  * avoid it. So, to make things safer we set task flags to indicate which
  82  * actions we want to perform and schedule ubt_task which would run in the
  83  * Taskqueue context.
  84  *      Is is OK to call from the Taskqueue context into the USB context,
  85  * and, ubt_task does just that (i.e. grabs appropriate interface locks
  86  * before calling into USB).
  87  *      Access to the outgoing queues, task flags and hook pointer is
  88  * controlled by the sc_ng_mtx lock. It is an unavoidable evil. Again,
  89  * sc_ng_mtx should really be a spin lock (and it is very likely to an
  90  * equivalent of spin lock due to adaptive nature of FreeBSD mutexes).
  91  *      All USB callbacks accept softc pointer as a private data. USB ensures
  92  * that this pointer is valid.
  93  */
  94
  95 #include <sys/stdint.h>
  96 #include <sys/stddef.h>
  97 #include <sys/param.h>
  98 #include <sys/queue.h>
  99 #include <sys/types.h>
 100 #include <sys/systm.h>
 101 #include <sys/kernel.h>
 102 #include <sys/bus.h>
 103 #include <sys/module.h>
 104 #include <sys/lock.h>
 105 #include <sys/mutex.h>
 106 #include <sys/condvar.h>
 107 #include <sys/sysctl.h>
 108 #include <sys/sx.h>
 109 #include <sys/unistd.h>
 110 #include <sys/callout.h>
 111 #include <sys/malloc.h>
 112 #include <sys/priv.h>
 113
 114 #include "usbdevs.h"
 115 #include <dev/usb/usb.h>
 116 #include <dev/usb/usbdi.h>
 117 #include <dev/usb/usbdi_util.h>
 118
 119 #define USB_DEBUG_VAR usb_debug
 120 #include <dev/usb/usb_debug.h>
 121 #include <dev/usb/usb_busdma.h>
 122
 123 #include <sys/mbuf.h>
 124 #include <sys/taskqueue.h>
 125
 126 #include <netgraph/ng_message.h>
 127 #include <netgraph/netgraph.h>
 128 #include <netgraph/ng_parse.h>
 129 #include <netgraph/bluetooth/include/ng_bluetooth.h>
 130 #include <netgraph/bluetooth/include/ng_hci.h>
 131 #include <netgraph/bluetooth/include/ng_ubt.h>
 132 #include <netgraph/bluetooth/drivers/ubt/ng_ubt_var.h>
 133
 134 static int              ubt_modevent(module_t, int, void *);
 135 static device_probe_t   ubt_probe;
 136 static device_attach_t  ubt_attach;
 137 static device_detach_t  ubt_detach;
 138
 139 static void             ubt_task_schedule(ubt_softc_p, int);
 140 static task_fn_t        ubt_task;
 141
 142 #define ubt_xfer_start(sc, i)   usbd_transfer_start((sc)->sc_xfer[(i)])
 143
 144 /* Netgraph methods */
 145 static ng_constructor_t ng_ubt_constructor;
 146 static ng_shutdown_t    ng_ubt_shutdown;
 147 static ng_newhook_t     ng_ubt_newhook;
 148 static ng_connect_t     ng_ubt_connect;
 149 static ng_disconnect_t  ng_ubt_disconnect;
 150 static ng_rcvmsg_t      ng_ubt_rcvmsg;
 151 static ng_rcvdata_t     ng_ubt_rcvdata;
 152
 153 /* Queue length */
 154 static const struct ng_parse_struct_field       ng_ubt_node_qlen_type_fields[] =
 155 {
 156         { "queue", &ng_parse_int32_type, },
 157         { "qlen",  &ng_parse_int32_type, },
 158         { NULL, }
 159 };
 160 static const struct ng_parse_type               ng_ubt_node_qlen_type =
 161 {
 162         &ng_parse_struct_type,
 163         &ng_ubt_node_qlen_type_fields
 164 };
 165
 166 /* Stat info */
 167 static const struct ng_parse_struct_field       ng_ubt_node_stat_type_fields[] =
 168 {
 169         { "pckts_recv", &ng_parse_uint32_type, },
 170         { "bytes_recv", &ng_parse_uint32_type, },
 171         { "pckts_sent", &ng_parse_uint32_type, },
 172         { "bytes_sent", &ng_parse_uint32_type, },
 173         { "oerrors",    &ng_parse_uint32_type, },
 174         { "ierrors",    &ng_parse_uint32_type, },
 175         { NULL, }
 176 };
 177 static const struct ng_parse_type               ng_ubt_node_stat_type =
 178 {
 179         &ng_parse_struct_type,
 180         &ng_ubt_node_stat_type_fields
 181 };
 182
 183 /* Netgraph node command list */
 184 static const struct ng_cmdlist                  ng_ubt_cmdlist[] =
 185 {
 186         {
 187                 NGM_UBT_COOKIE,
 188                 NGM_UBT_NODE_SET_DEBUG,
 189                 "set_debug",
 190                 &ng_parse_uint16_type,
 191                 NULL
 192         },
 193         {
 194                 NGM_UBT_COOKIE,
 195                 NGM_UBT_NODE_GET_DEBUG,
 196                 "get_debug",
 197                 NULL,
 198                 &ng_parse_uint16_type
 199         },
 200         {
 201                 NGM_UBT_COOKIE,
 202                 NGM_UBT_NODE_SET_QLEN,
 203                 "set_qlen",
 204                 &ng_ubt_node_qlen_type,
 205                 NULL
 206         },
 207         {
 208                 NGM_UBT_COOKIE,
 209                 NGM_UBT_NODE_GET_QLEN,
 210                 "get_qlen",
 211                 &ng_ubt_node_qlen_type,
 212                 &ng_ubt_node_qlen_type
 213         },
 214         {
 215                 NGM_UBT_COOKIE,
 216                 NGM_UBT_NODE_GET_STAT,
 217                 "get_stat",
 218                 NULL,
 219                 &ng_ubt_node_stat_type
 220         },
 221         {
 222                 NGM_UBT_COOKIE,
 223                 NGM_UBT_NODE_RESET_STAT,
 224                 "reset_stat",
 225                 NULL,
 226                 NULL
 227         },
 228         { 0, }
 229 };
 230
 231 /* Netgraph node type */
 232 static struct ng_type   typestruct =
 233 {
 234         .version =      NG_ABI_VERSION,
 235         .name =         NG_UBT_NODE_TYPE,
 236         .constructor =  ng_ubt_constructor,
 237         .rcvmsg =       ng_ubt_rcvmsg,
 238         .shutdown =     ng_ubt_shutdown,
 239         .newhook =      ng_ubt_newhook,
 240         .connect =      ng_ubt_connect,
 241         .rcvdata =      ng_ubt_rcvdata,
 242         .disconnect =   ng_ubt_disconnect,
 243         .cmdlist =      ng_ubt_cmdlist
 244 };
 245
 246 /****************************************************************************
 247  ****************************************************************************
 248  **                              USB specific
 249  ****************************************************************************
 250  ****************************************************************************/
 251
 252 /* USB methods */
 253 static usb_callback_t   ubt_ctrl_write_callback;
 254 static usb_callback_t   ubt_intr_read_callback;
 255 static usb_callback_t   ubt_bulk_read_callback;
 256 static usb_callback_t   ubt_bulk_write_callback;
 257 static usb_callback_t   ubt_isoc_read_callback;
 258 static usb_callback_t   ubt_isoc_write_callback;
 259
 260 static int              ubt_fwd_mbuf_up(ubt_softc_p, struct mbuf **);
 261 static int              ubt_isoc_read_one_frame(struct usb_xfer *, int);
 262
 263 /*
 264  * USB config
 265  *
 266  * The following desribes usb transfers that could be submitted on USB device.
 267  *
 268  * Interface 0 on the USB device must present the following endpoints
 269  *      1) Interrupt endpoint to receive HCI events
 270  *      2) Bulk IN endpoint to receive ACL data
 271  *      3) Bulk OUT endpoint to send ACL data
 272  *
 273  * Interface 1 on the USB device must present the following endpoints
 274  *      1) Isochronous IN endpoint to receive SCO data
 275  *      2) Isochronous OUT endpoint to send SCO data
 276  */
 277
 278 static const struct usb_config          ubt_config[UBT_N_TRANSFER] =
 279 {
 280         /*
 281          * Interface #0
 282          */
 283
 284         /* Outgoing bulk transfer - ACL packets */
 285         [UBT_IF_0_BULK_DT_WR] = {
 286                 .type =         UE_BULK,
 287                 .endpoint =     UE_ADDR_ANY,
 288                 .direction =    UE_DIR_OUT,
 289                 .if_index =     0,
 290                 .bufsize =      UBT_BULK_WRITE_BUFFER_SIZE,
 291                 .flags =        { .pipe_bof = 1, .force_short_xfer = 1, },
 292                 .callback =     &ubt_bulk_write_callback,
 293         },
 294         /* Incoming bulk transfer - ACL packets */
 295         [UBT_IF_0_BULK_DT_RD] = {
 296                 .type =         UE_BULK,
 297                 .endpoint =     UE_ADDR_ANY,
 298                 .direction =    UE_DIR_IN,
 299                 .if_index =     0,
 300                 .bufsize =      UBT_BULK_READ_BUFFER_SIZE,
 301                 .flags =        { .pipe_bof = 1, .short_xfer_ok = 1, },
 302                 .callback =     &ubt_bulk_read_callback,
 303         },
 304         /* Incoming interrupt transfer - HCI events */
 305         [UBT_IF_0_INTR_DT_RD] = {
 306                 .type =         UE_INTERRUPT,
 307                 .endpoint =     UE_ADDR_ANY,
 308                 .direction =    UE_DIR_IN,
 309                 .if_index =     0,
 310                 .flags =        { .pipe_bof = 1, .short_xfer_ok = 1, },
 311                 .bufsize =      UBT_INTR_BUFFER_SIZE,
 312                 .callback =     &ubt_intr_read_callback,
 313         },
 314         /* Outgoing control transfer - HCI commands */
 315         [UBT_IF_0_CTRL_DT_WR] = {
 316                 .type =         UE_CONTROL,
 317                 .endpoint =     0x00,   /* control pipe */
 318                 .direction =    UE_DIR_ANY,
 319                 .if_index =     0,
 320                 .bufsize =      UBT_CTRL_BUFFER_SIZE,
 321                 .callback =     &ubt_ctrl_write_callback,
 322                 .timeout =      5000,   /* 5 seconds */
 323         },
 324
 325         /*
 326          * Interface #1
 327          */
 328
 329         /* Incoming isochronous transfer #1 - SCO packets */
 330         [UBT_IF_1_ISOC_DT_RD1] = {
 331                 .type =         UE_ISOCHRONOUS,
 332                 .endpoint =     UE_ADDR_ANY,
 333                 .direction =    UE_DIR_IN,
 334                 .if_index =     1,
 335                 .bufsize =      0,      /* use "wMaxPacketSize * frames" */
 336                 .frames =       UBT_ISOC_NFRAMES,
 337                 .flags =        { .short_xfer_ok = 1, },
 338                 .callback =     &ubt_isoc_read_callback,
 339         },
 340         /* Incoming isochronous transfer #2 - SCO packets */
 341         [UBT_IF_1_ISOC_DT_RD2] = {
 342                 .type =         UE_ISOCHRONOUS,
 343                 .endpoint =     UE_ADDR_ANY,
 344                 .direction =    UE_DIR_IN,
 345                 .if_index =     1,
 346                 .bufsize =      0,      /* use "wMaxPacketSize * frames" */
 347                 .frames =       UBT_ISOC_NFRAMES,
 348                 .flags =        { .short_xfer_ok = 1, },
 349                 .callback =     &ubt_isoc_read_callback,
 350         },
 351         /* Outgoing isochronous transfer #1 - SCO packets */
 352         [UBT_IF_1_ISOC_DT_WR1] = {
 353                 .type =         UE_ISOCHRONOUS,
 354                 .endpoint =     UE_ADDR_ANY,
 355                 .direction =    UE_DIR_OUT,
 356                 .if_index =     1,
 357                 .bufsize =      0,      /* use "wMaxPacketSize * frames" */
 358                 .frames =       UBT_ISOC_NFRAMES,
 359                 .flags =        { .short_xfer_ok = 1, },
 360                 .callback =     &ubt_isoc_write_callback,
 361         },
 362         /* Outgoing isochronous transfer #2 - SCO packets */
 363         [UBT_IF_1_ISOC_DT_WR2] = {
 364                 .type =         UE_ISOCHRONOUS,
 365                 .endpoint =     UE_ADDR_ANY,
 366                 .direction =    UE_DIR_OUT,
 367                 .if_index =     1,
 368                 .bufsize =      0,      /* use "wMaxPacketSize * frames" */
 369                 .frames =       UBT_ISOC_NFRAMES,
 370                 .flags =        { .short_xfer_ok = 1, },
 371                 .callback =     &ubt_isoc_write_callback,
 372         },
 373 };
 374
 375 /*
 376  * If for some reason device should not be attached then put
 377  * VendorID/ProductID pair into the list below. The format is
 378  * as follows:
 379  *
 380  *      { USB_VPI(VENDOR_ID, PRODUCT_ID, 0) },
 381  *
 382  * where VENDOR_ID and PRODUCT_ID are hex numbers.
 383  */
 384
 385 static const STRUCT_USB_HOST_ID ubt_ignore_devs[] =
 386 {
 387         /* AVM USB Bluetooth-Adapter BlueFritz! v1.0 */
 388         { USB_VPI(USB_VENDOR_AVM, 0x2200, 0) },
 389 };
 390
 391 /* List of supported bluetooth devices */
 392 static const STRUCT_USB_HOST_ID ubt_devs[] =
 393 {
 394         /* Generic Bluetooth class devices */
 395         { USB_IFACE_CLASS(UDCLASS_WIRELESS),
 396           USB_IFACE_SUBCLASS(UDSUBCLASS_RF),
 397           USB_IFACE_PROTOCOL(UDPROTO_BLUETOOTH) },
 398
 399         /* AVM USB Bluetooth-Adapter BlueFritz! v2.0 */
 400         { USB_VPI(USB_VENDOR_AVM, 0x3800, 0) },
 401
 402         /* Broadcom USB dongles, mostly BCM20702 and BCM20702A0 */
 403         { USB_VENDOR(USB_VENDOR_BROADCOM),
 404           USB_IFACE_CLASS(UICLASS_VENDOR),
 405           USB_IFACE_SUBCLASS(UDSUBCLASS_RF),
 406           USB_IFACE_PROTOCOL(UDPROTO_BLUETOOTH) },
 407 };
 408
 409 /*
 410  * Probe for a USB Bluetooth device.
 411  * USB context.
 412  */
 413
 414 static int
 415 ubt_probe(device_t dev)
 416 {
 417         struct usb_attach_arg   *uaa = device_get_ivars(dev);
 418         int error;
 419
 420         if (uaa->usb_mode != USB_MODE_HOST)
 421                 return (ENXIO);
 422
 423         if (uaa->info.bIfaceIndex != 0)
 424                 return (ENXIO);
 425
 426         if (usbd_lookup_id_by_uaa(ubt_ignore_devs,
 427                         sizeof(ubt_ignore_devs), uaa) == 0)
 428                 return (ENXIO);
 429
 430         error = usbd_lookup_id_by_uaa(ubt_devs, sizeof(ubt_devs), uaa);
 431         if (error == 0)
 432                 return (BUS_PROBE_GENERIC);
 433         return (error);
 434 } /* ubt_probe */
 435
 436 /*
 437  * Attach the device.
 438  * USB context.
 439  */
 440
 441 static int
 442 ubt_attach(device_t dev)
 443 {
 444         struct usb_attach_arg           *uaa = device_get_ivars(dev);
 445         struct ubt_softc                *sc = device_get_softc(dev);
 446         struct usb_endpoint_descriptor  *ed;
 447         struct usb_interface_descriptor *id;
 448         uint16_t                        wMaxPacketSize;
 449         uint8_t                         alt_index, i, j;
 450         uint8_t                         iface_index[2] = { 0, 1 };
 451
 452         device_set_usb_desc(dev);
 453
 454         sc->sc_dev = dev;
 455         sc->sc_debug = NG_UBT_WARN_LEVEL;
 456
 457         /*
 458          * Create Netgraph node
 459          */
 460
 461         if (ng_make_node_common(&typestruct, &sc->sc_node) != 0) {
 462                 UBT_ALERT(sc, "could not create Netgraph node\n");
 463                 return (ENXIO);
 464         }
 465
 466         /* Name Netgraph node */
 467         if (ng_name_node(sc->sc_node, device_get_nameunit(dev)) != 0) {
 468                 UBT_ALERT(sc, "could not name Netgraph node\n");
 469                 NG_NODE_UNREF(sc->sc_node);
 470                 return (ENXIO);
 471         }
 472         NG_NODE_SET_PRIVATE(sc->sc_node, sc);
 473         NG_NODE_FORCE_WRITER(sc->sc_node);
 474
 475         /*
 476          * Initialize device softc structure
 477          */
 478
 479         /* initialize locks */
 480         mtx_init(&sc->sc_ng_mtx, "ubt ng", NULL, MTX_DEF);
 481         mtx_init(&sc->sc_if_mtx, "ubt if", NULL, MTX_DEF | MTX_RECURSE);
 482
 483         /* initialize packet queues */
 484         NG_BT_MBUFQ_INIT(&sc->sc_cmdq, UBT_DEFAULT_QLEN);
 485         NG_BT_MBUFQ_INIT(&sc->sc_aclq, UBT_DEFAULT_QLEN);
 486         NG_BT_MBUFQ_INIT(&sc->sc_scoq, UBT_DEFAULT_QLEN);
 487
 488         /* initialize glue task */
 489         TASK_INIT(&sc->sc_task, 0, ubt_task, sc);
 490
 491         /*
 492          * Configure Bluetooth USB device. Discover all required USB
 493          * interfaces and endpoints.
 494          *
 495          * USB device must present two interfaces:
 496          * 1) Interface 0 that has 3 endpoints
 497          *      1) Interrupt endpoint to receive HCI events
 498          *      2) Bulk IN endpoint to receive ACL data
 499          *      3) Bulk OUT endpoint to send ACL data
 500          *
 501          * 2) Interface 1 then has 2 endpoints
 502          *      1) Isochronous IN endpoint to receive SCO data
 503          *      2) Isochronous OUT endpoint to send SCO data
 504          *
 505          * Interface 1 (with isochronous endpoints) has several alternate
 506          * configurations with different packet size.
 507          */
 508
 509         /*
 510          * For interface #1 search alternate settings, and find
 511          * the descriptor with the largest wMaxPacketSize
 512          */
 513
 514         wMaxPacketSize = 0;
 515         alt_index = 0;
 516         i = 0;
 517         j = 0;
 518         ed = NULL;
 519
 520         /*
 521          * Search through all the descriptors looking for the largest
 522          * packet size:
 523          */
 524         while ((ed = (struct usb_endpoint_descriptor *)usb_desc_foreach(
 525             usbd_get_config_descriptor(uaa->device),
 526             (struct usb_descriptor *)ed))) {
 527
 528                 if ((ed->bDescriptorType == UDESC_INTERFACE) &&
 529                     (ed->bLength >= sizeof(*id))) {
 530                         id = (struct usb_interface_descriptor *)ed;
 531                         i = id->bInterfaceNumber;
 532                         j = id->bAlternateSetting;
 533                 }
 534
 535                 if ((ed->bDescriptorType == UDESC_ENDPOINT) &&
 536                     (ed->bLength >= sizeof(*ed)) &&
 537                     (i == 1)) {
 538                         uint16_t temp;
 539
 540                         temp = UGETW(ed->wMaxPacketSize);
 541                         if (temp > wMaxPacketSize) {
 542                                 wMaxPacketSize = temp;
 543                                 alt_index = j;
 544                         }
 545                 }
 546         }
 547
 548         /* Set alt configuration on interface #1 only if we found it */
 549         if (wMaxPacketSize > 0 &&
 550             usbd_set_alt_interface_index(uaa->device, 1, alt_index)) {
 551                 UBT_ALERT(sc, "could not set alternate setting %d " \
 552                         "for interface 1!\n", alt_index);
 553                 goto detach;
 554         }
 555
 556         /* Setup transfers for both interfaces */
 557         if (usbd_transfer_setup(uaa->device, iface_index, sc->sc_xfer,
 558                         ubt_config, UBT_N_TRANSFER, sc, &sc->sc_if_mtx)) {
 559                 UBT_ALERT(sc, "could not allocate transfers\n");
 560                 goto detach;
 561         }
 562
 563         /* Claim all interfaces on the device */
 564         for (i = 1; usbd_get_iface(uaa->device, i) != NULL; i ++)
 565                 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
 566
 567         return (0); /* success */
 568
 569 detach:
 570         ubt_detach(dev);
 571
 572         return (ENXIO);
 573 } /* ubt_attach */
 574
 575 /*
 576  * Detach the device.
 577  * USB context.
 578  */
 579
 580 int
 581 ubt_detach(device_t dev)
 582 {
 583         struct ubt_softc        *sc = device_get_softc(dev);
 584         node_p                  node = sc->sc_node;
 585
 586         /* Destroy Netgraph node */
 587         if (node != NULL) {
 588                 sc->sc_node = NULL;
 589                 NG_NODE_REALLY_DIE(node);
 590                 ng_rmnode_self(node);
 591         }
 592
 593         /* Make sure ubt_task in gone */
 594         taskqueue_drain(taskqueue_swi, &sc->sc_task);
 595
 596         /* Free USB transfers, if any */
 597         usbd_transfer_unsetup(sc->sc_xfer, UBT_N_TRANSFER);
 598
 599         /* Destroy queues */
 600         UBT_NG_LOCK(sc);
 601         NG_BT_MBUFQ_DESTROY(&sc->sc_cmdq);
 602         NG_BT_MBUFQ_DESTROY(&sc->sc_aclq);
 603         NG_BT_MBUFQ_DESTROY(&sc->sc_scoq);
 604         UBT_NG_UNLOCK(sc);
 605
 606         mtx_destroy(&sc->sc_if_mtx);
 607         mtx_destroy(&sc->sc_ng_mtx);
 608
 609         return (0);
 610 } /* ubt_detach */
 611
 612 /*
 613  * Called when outgoing control request (HCI command) has completed, i.e.
 614  * HCI command was sent to the device.
 615  * USB context.
 616  */
 617
 618 static void
 619 ubt_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
 620 {
 621         struct ubt_softc                *sc = usbd_xfer_softc(xfer);
 622         struct usb_device_request       req;
 623         struct mbuf                     *m;
 624         struct usb_page_cache           *pc;
 625         int                             actlen;
 626
 627         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 628
 629         switch (USB_GET_STATE(xfer)) {
 630         case USB_ST_TRANSFERRED:
 631                 UBT_INFO(sc, "sent %d bytes to control pipe\n", actlen);
 632                 UBT_STAT_BYTES_SENT(sc, actlen);
 633                 UBT_STAT_PCKTS_SENT(sc);
 634                 /* FALLTHROUGH */
 635
 636         case USB_ST_SETUP:
 637 send_next:
 638                 /* Get next command mbuf, if any */
 639                 UBT_NG_LOCK(sc);
 640                 NG_BT_MBUFQ_DEQUEUE(&sc->sc_cmdq, m);
 641                 UBT_NG_UNLOCK(sc);
 642
 643                 if (m == NULL) {
 644                         UBT_INFO(sc, "HCI command queue is empty\n");
 645                         break;  /* transfer complete */
 646                 }
 647
 648                 /* Initialize a USB control request and then schedule it */
 649                 bzero(&req, sizeof(req));
 650                 req.bmRequestType = UBT_HCI_REQUEST;
 651                 USETW(req.wLength, m->m_pkthdr.len);
 652
 653                 UBT_INFO(sc, "Sending control request, " \
 654                         "bmRequestType=0x%02x, wLength=%d\n",
 655                         req.bmRequestType, UGETW(req.wLength));
 656
 657                 pc = usbd_xfer_get_frame(xfer, 0);
 658                 usbd_copy_in(pc, 0, &req, sizeof(req));
 659                 pc = usbd_xfer_get_frame(xfer, 1);
 660                 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
 661
 662                 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
 663                 usbd_xfer_set_frame_len(xfer, 1, m->m_pkthdr.len);
 664                 usbd_xfer_set_frames(xfer, 2);
 665
 666                 NG_FREE_M(m);
 667
 668                 usbd_transfer_submit(xfer);
 669                 break;
 670
 671         default: /* Error */
 672                 if (error != USB_ERR_CANCELLED) {
 673                         UBT_WARN(sc, "control transfer failed: %s\n",
 674                                 usbd_errstr(error));
 675
 676                         UBT_STAT_OERROR(sc);
 677                         goto send_next;
 678                 }
 679
 680                 /* transfer cancelled */
 681                 break;
 682         }
 683 } /* ubt_ctrl_write_callback */
 684
 685 /*
 686  * Called when incoming interrupt transfer (HCI event) has completed, i.e.
 687  * HCI event was received from the device.
 688  * USB context.
 689  */
 690
 691 static void
 692 ubt_intr_read_callback(struct usb_xfer *xfer, usb_error_t error)
 693 {
 694         struct ubt_softc        *sc = usbd_xfer_softc(xfer);
 695         struct mbuf             *m;
 696         ng_hci_event_pkt_t      *hdr;
 697         struct usb_page_cache   *pc;
 698         int                     actlen;
 699
 700         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 701
 702         m = NULL;
 703
 704         switch (USB_GET_STATE(xfer)) {
 705         case USB_ST_TRANSFERRED:
 706                 /* Allocate a new mbuf */
 707                 MGETHDR(m, M_DONTWAIT, MT_DATA);
 708                 if (m == NULL) {
 709                         UBT_STAT_IERROR(sc);
 710                         goto submit_next;
 711                 }
 712
 713                 MCLGET(m, M_DONTWAIT);
 714                 if (!(m->m_flags & M_EXT)) {
 715                         UBT_STAT_IERROR(sc);
 716                         goto submit_next;
 717                 }
 718
 719                 /* Add HCI packet type */
 720                 *mtod(m, uint8_t *)= NG_HCI_EVENT_PKT;
 721                 m->m_pkthdr.len = m->m_len = 1;
 722
 723                 if (actlen > MCLBYTES - 1)
 724                         actlen = MCLBYTES - 1;
 725
 726                 pc = usbd_xfer_get_frame(xfer, 0);
 727                 usbd_copy_out(pc, 0, mtod(m, uint8_t *) + 1, actlen);
 728                 m->m_pkthdr.len += actlen;
 729                 m->m_len += actlen;
 730
 731                 UBT_INFO(sc, "got %d bytes from interrupt pipe\n",
 732                         actlen);
 733
 734                 /* Validate packet and send it up the stack */
 735                 if (m->m_pkthdr.len < (int)sizeof(*hdr)) {
 736                         UBT_INFO(sc, "HCI event packet is too short\n");
 737
 738                         UBT_STAT_IERROR(sc);
 739                         goto submit_next;
 740                 }
 741
 742                 hdr = mtod(m, ng_hci_event_pkt_t *);
 743                 if (hdr->length != (m->m_pkthdr.len - sizeof(*hdr))) {
 744                         UBT_ERR(sc, "Invalid HCI event packet size, " \
 745                                 "length=%d, pktlen=%d\n",
 746                                 hdr->length, m->m_pkthdr.len);
 747
 748                         UBT_STAT_IERROR(sc);
 749                         goto submit_next;
 750                 }
 751
 752                 UBT_INFO(sc, "got complete HCI event frame, pktlen=%d, " \
 753                         "length=%d\n", m->m_pkthdr.len, hdr->length);
 754
 755                 UBT_STAT_PCKTS_RECV(sc);
 756                 UBT_STAT_BYTES_RECV(sc, m->m_pkthdr.len);
 757
 758                 ubt_fwd_mbuf_up(sc, &m);
 759                 /* m == NULL at this point */
 760                 /* FALLTHROUGH */
 761
 762         case USB_ST_SETUP:
 763 submit_next:
 764                 NG_FREE_M(m); /* checks for m != NULL */
 765
 766                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 767                 usbd_transfer_submit(xfer);
 768                 break;
 769
 770         default: /* Error */
 771                 if (error != USB_ERR_CANCELLED) {
 772                         UBT_WARN(sc, "interrupt transfer failed: %s\n",
 773                                 usbd_errstr(error));
 774
 775                         /* Try to clear stall first */
 776                         usbd_xfer_set_stall(xfer);
 777                         goto submit_next;
 778                 }
 779                         /* transfer cancelled */
 780                 break;
 781         }
 782 } /* ubt_intr_read_callback */
 783
 784 /*
 785  * Called when incoming bulk transfer (ACL packet) has completed, i.e.
 786  * ACL packet was received from the device.
 787  * USB context.
 788  */
 789
 790 static void
 791 ubt_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
 792 {
 793         struct ubt_softc        *sc = usbd_xfer_softc(xfer);
 794         struct mbuf             *m;
 795         ng_hci_acldata_pkt_t    *hdr;
 796         struct usb_page_cache   *pc;
 797         int len;
 798         int actlen;
 799
 800         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 801
 802         m = NULL;
 803
 804         switch (USB_GET_STATE(xfer)) {
 805         case USB_ST_TRANSFERRED:
 806                 /* Allocate new mbuf */
 807                 MGETHDR(m, M_DONTWAIT, MT_DATA);
 808                 if (m == NULL) {
 809                         UBT_STAT_IERROR(sc);
 810                         goto submit_next;
 811                 }
 812
 813                 MCLGET(m, M_DONTWAIT);
 814                 if (!(m->m_flags & M_EXT)) {
 815                         UBT_STAT_IERROR(sc);
 816                         goto submit_next;
 817                 }
 818
 819                 /* Add HCI packet type */
 820                 *mtod(m, uint8_t *)= NG_HCI_ACL_DATA_PKT;
 821                 m->m_pkthdr.len = m->m_len = 1;
 822
 823                 if (actlen > MCLBYTES - 1)
 824                         actlen = MCLBYTES - 1;
 825
 826                 pc = usbd_xfer_get_frame(xfer, 0);
 827                 usbd_copy_out(pc, 0, mtod(m, uint8_t *) + 1, actlen);
 828                 m->m_pkthdr.len += actlen;
 829                 m->m_len += actlen;
 830
 831                 UBT_INFO(sc, "got %d bytes from bulk-in pipe\n",
 832                         actlen);
 833
 834                 /* Validate packet and send it up the stack */
 835                 if (m->m_pkthdr.len < (int)sizeof(*hdr)) {
 836                         UBT_INFO(sc, "HCI ACL packet is too short\n");
 837
 838                         UBT_STAT_IERROR(sc);
 839                         goto submit_next;
 840                 }
 841
 842                 hdr = mtod(m, ng_hci_acldata_pkt_t *);
 843                 len = le16toh(hdr->length);
 844                 if (len != (int)(m->m_pkthdr.len - sizeof(*hdr))) {
 845                         UBT_ERR(sc, "Invalid ACL packet size, length=%d, " \
 846                                 "pktlen=%d\n", len, m->m_pkthdr.len);
 847
 848                         UBT_STAT_IERROR(sc);
 849                         goto submit_next;
 850                 }
 851
 852                 UBT_INFO(sc, "got complete ACL data packet, pktlen=%d, " \
 853                         "length=%d\n", m->m_pkthdr.len, len);
 854
 855                 UBT_STAT_PCKTS_RECV(sc);
 856                 UBT_STAT_BYTES_RECV(sc, m->m_pkthdr.len);
 857
 858                 ubt_fwd_mbuf_up(sc, &m);
 859                 /* m == NULL at this point */
 860                 /* FALLTHOUGH */
 861
 862         case USB_ST_SETUP:
 863 submit_next:
 864                 NG_FREE_M(m); /* checks for m != NULL */
 865
 866                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 867                 usbd_transfer_submit(xfer);
 868                 break;
 869
 870         default: /* Error */
 871                 if (error != USB_ERR_CANCELLED) {
 872                         UBT_WARN(sc, "bulk-in transfer failed: %s\n",
 873                                 usbd_errstr(error));
 874
 875                         /* Try to clear stall first */
 876                         usbd_xfer_set_stall(xfer);
 877                         goto submit_next;
 878                 }
 879                         /* transfer cancelled */
 880                 break;
 881         }
 882 } /* ubt_bulk_read_callback */
 883
 884 /*
 885  * Called when outgoing bulk transfer (ACL packet) has completed, i.e.
 886  * ACL packet was sent to the device.
 887  * USB context.
 888  */
 889
 890 static void
 891 ubt_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
 892 {
 893         struct ubt_softc        *sc = usbd_xfer_softc(xfer);
 894         struct mbuf             *m;
 895         struct usb_page_cache   *pc;
 896         int                     actlen;
 897
 898         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
 899
 900         switch (USB_GET_STATE(xfer)) {
 901         case USB_ST_TRANSFERRED:
 902                 UBT_INFO(sc, "sent %d bytes to bulk-out pipe\n", actlen);
 903                 UBT_STAT_BYTES_SENT(sc, actlen);
 904                 UBT_STAT_PCKTS_SENT(sc);
 905                 /* FALLTHROUGH */
 906
 907         case USB_ST_SETUP:
 908 send_next:
 909                 /* Get next mbuf, if any */
 910                 UBT_NG_LOCK(sc);
 911                 NG_BT_MBUFQ_DEQUEUE(&sc->sc_aclq, m);
 912                 UBT_NG_UNLOCK(sc);
 913
 914                 if (m == NULL) {
 915                         UBT_INFO(sc, "ACL data queue is empty\n");
 916                         break; /* transfer completed */
 917                 }
 918
 919                 /*
 920                  * Copy ACL data frame back to a linear USB transfer buffer
 921                  * and schedule transfer
 922                  */
 923
 924                 pc = usbd_xfer_get_frame(xfer, 0);
 925                 usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
 926                 usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len);
 927
 928                 UBT_INFO(sc, "bulk-out transfer has been started, len=%d\n",
 929                         m->m_pkthdr.len);
 930
 931                 NG_FREE_M(m);
 932
 933                 usbd_transfer_submit(xfer);
 934                 break;
 935
 936         default: /* Error */
 937                 if (error != USB_ERR_CANCELLED) {
 938                         UBT_WARN(sc, "bulk-out transfer failed: %s\n",
 939                                 usbd_errstr(error));
 940
 941                         UBT_STAT_OERROR(sc);
 942
 943                         /* try to clear stall first */
 944                         usbd_xfer_set_stall(xfer);
 945                         goto send_next;
 946                 }
 947                         /* transfer cancelled */
 948                 break;
 949         }
 950 } /* ubt_bulk_write_callback */
 951
 952 /*
 953  * Called when incoming isoc transfer (SCO packet) has completed, i.e.
 954  * SCO packet was received from the device.
 955  * USB context.
 956  */
 957
 958 static void
 959 ubt_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
 960 {
 961         struct ubt_softc        *sc = usbd_xfer_softc(xfer);
 962         int                     n;
 963         int actlen, nframes;
 964
 965         usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
 966
 967         switch (USB_GET_STATE(xfer)) {
 968         case USB_ST_TRANSFERRED:
 969                 for (n = 0; n < nframes; n ++)
 970                         if (ubt_isoc_read_one_frame(xfer, n) < 0)
 971                                 break;
 972                 /* FALLTHROUGH */
 973
 974         case USB_ST_SETUP:
 975 read_next:
 976                 for (n = 0; n < nframes; n ++)
 977                         usbd_xfer_set_frame_len(xfer, n,
 978                             usbd_xfer_max_framelen(xfer));
 979
 980                 usbd_transfer_submit(xfer);
 981                 break;
 982
 983         default: /* Error */
 984                 if (error != USB_ERR_CANCELLED) {
 985                         UBT_STAT_IERROR(sc);
 986                         goto read_next;
 987                 }
 988
 989                 /* transfer cancelled */
 990                 break;
 991         }
 992 } /* ubt_isoc_read_callback */
 993
 994 /*
 995  * Helper function. Called from ubt_isoc_read_callback() to read
 996  * SCO data from one frame.
 997  * USB context.
 998  */
 999
1000 static int
1001 ubt_isoc_read_one_frame(struct usb_xfer *xfer, int frame_no)
1002 {
1003         struct ubt_softc        *sc = usbd_xfer_softc(xfer);
1004         struct usb_page_cache   *pc;
1005         struct mbuf             *m;
1006         int                     len, want, got, total;
1007
1008         /* Get existing SCO reassembly buffer */
1009         pc = usbd_xfer_get_frame(xfer, 0);
1010         m = sc->sc_isoc_in_buffer;
1011         total = usbd_xfer_frame_len(xfer, frame_no);
1012
1013         /* While we have data in the frame */
1014         while (total > 0) {
1015                 if (m == NULL) {
1016                         /* Start new reassembly buffer */
1017                         MGETHDR(m, M_DONTWAIT, MT_DATA);
1018                         if (m == NULL) {
1019                                 UBT_STAT_IERROR(sc);
1020                                 return (-1);    /* XXX out of sync! */
1021                         }
1022
1023                         MCLGET(m, M_DONTWAIT);
1024                         if (!(m->m_flags & M_EXT)) {
1025                                 UBT_STAT_IERROR(sc);
1026                                 NG_FREE_M(m);
1027                                 return (-1);    /* XXX out of sync! */
1028                         }
1029
1030                         /* Expect SCO header */
1031                         *mtod(m, uint8_t *) = NG_HCI_SCO_DATA_PKT;
1032                         m->m_pkthdr.len = m->m_len = got = 1;
1033                         want = sizeof(ng_hci_scodata_pkt_t);
1034                 } else {
1035                         /*
1036                          * Check if we have SCO header and if so
1037                          * adjust amount of data we want
1038                          */
1039                         got = m->m_pkthdr.len;
1040                         want = sizeof(ng_hci_scodata_pkt_t);
1041
1042                         if (got >= want)
1043                                 want += mtod(m, ng_hci_scodata_pkt_t *)->length;
1044                 }
1045
1046                 /* Append frame data to the SCO reassembly buffer */
1047                 len = total;
1048                 if (got + len > want)
1049                         len = want - got;
1050
1051                 usbd_copy_out(pc, frame_no * usbd_xfer_max_framelen(xfer),
1052                         mtod(m, uint8_t *) + m->m_pkthdr.len, len);
1053
1054                 m->m_pkthdr.len += len;
1055                 m->m_len += len;
1056                 total -= len;
1057
1058                 /* Check if we got everything we wanted, if not - continue */
1059                 if (got != want)
1060                         continue;
1061
1062                 /* If we got here then we got complete SCO frame */
1063                 UBT_INFO(sc, "got complete SCO data frame, pktlen=%d, " \
1064                         "length=%d\n", m->m_pkthdr.len,
1065                         mtod(m, ng_hci_scodata_pkt_t *)->length);
1066
1067                 UBT_STAT_PCKTS_RECV(sc);
1068                 UBT_STAT_BYTES_RECV(sc, m->m_pkthdr.len);
1069
1070                 ubt_fwd_mbuf_up(sc, &m);
1071                 /* m == NULL at this point */
1072         }
1073
1074         /* Put SCO reassembly buffer back */
1075         sc->sc_isoc_in_buffer = m;
1076
1077         return (0);
1078 } /* ubt_isoc_read_one_frame */
1079
1080 /*
1081  * Called when outgoing isoc transfer (SCO packet) has completed, i.e.
1082  * SCO packet was sent to the device.
1083  * USB context.
1084  */
1085
1086 static void
1087 ubt_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
1088 {
1089         struct ubt_softc        *sc = usbd_xfer_softc(xfer);
1090         struct usb_page_cache   *pc;
1091         struct mbuf             *m;
1092         int                     n, space, offset;
1093         int                     actlen, nframes;
1094
1095         usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
1096         pc = usbd_xfer_get_frame(xfer, 0);
1097
1098         switch (USB_GET_STATE(xfer)) {
1099         case USB_ST_TRANSFERRED:
1100                 UBT_INFO(sc, "sent %d bytes to isoc-out pipe\n", actlen);
1101                 UBT_STAT_BYTES_SENT(sc, actlen);
1102                 UBT_STAT_PCKTS_SENT(sc);
1103                 /* FALLTHROUGH */
1104
1105         case USB_ST_SETUP:
1106 send_next:
1107                 offset = 0;
1108                 space = usbd_xfer_max_framelen(xfer) * nframes;
1109                 m = NULL;
1110
1111                 while (space > 0) {
1112                         if (m == NULL) {
1113                                 UBT_NG_LOCK(sc);
1114                                 NG_BT_MBUFQ_DEQUEUE(&sc->sc_scoq, m);
1115                                 UBT_NG_UNLOCK(sc);
1116
1117                                 if (m == NULL)
1118                                         break;
1119                         }
1120
1121                         n = min(space, m->m_pkthdr.len);
1122                         if (n > 0) {
1123                                 usbd_m_copy_in(pc, offset, m,0, n);
1124                                 m_adj(m, n);
1125
1126                                 offset += n;
1127                                 space -= n;
1128                         }
1129
1130                         if (m->m_pkthdr.len == 0)
1131                                 NG_FREE_M(m); /* sets m = NULL */
1132                 }
1133
1134                 /* Put whatever is left from mbuf back on queue */
1135                 if (m != NULL) {
1136                         UBT_NG_LOCK(sc);
1137                         NG_BT_MBUFQ_PREPEND(&sc->sc_scoq, m);
1138                         UBT_NG_UNLOCK(sc);
1139                 }
1140
1141                 /*
1142                  * Calculate sizes for isoc frames.
1143                  * Note that offset could be 0 at this point (i.e. we have
1144                  * nothing to send). That is fine, as we have isoc. transfers
1145                  * going in both directions all the time. In this case it
1146                  * would be just empty isoc. transfer.
1147                  */
1148
1149                 for (n = 0; n < nframes; n ++) {
1150                         usbd_xfer_set_frame_len(xfer, n,
1151                             min(offset, usbd_xfer_max_framelen(xfer)));
1152                         offset -= usbd_xfer_frame_len(xfer, n);
1153                 }
1154
1155                 usbd_transfer_submit(xfer);
1156                 break;
1157
1158         default: /* Error */
1159                 if (error != USB_ERR_CANCELLED) {
1160                         UBT_STAT_OERROR(sc);
1161                         goto send_next;
1162                 }
1163
1164                 /* transfer cancelled */
1165                 break;
1166         }
1167 }
1168
1169 /*
1170  * Utility function to forward provided mbuf upstream (i.e. up the stack).
1171  * Modifies value of the mbuf pointer (sets it to NULL).
1172  * Save to call from any context.
1173  */
1174
1175 static int
1176 ubt_fwd_mbuf_up(ubt_softc_p sc, struct mbuf **m)
1177 {
1178         hook_p  hook;
1179         int     error;
1180
1181         /*
1182          * Close the race with Netgraph hook newhook/disconnect methods.
1183          * Save the hook pointer atomically. Two cases are possible:
1184          *
1185          * 1) The hook pointer is NULL. It means disconnect method got
1186          *    there first. In this case we are done.
1187          *
1188          * 2) The hook pointer is not NULL. It means that hook pointer
1189          *    could be either in valid or invalid (i.e. in the process
1190          *    of disconnect) state. In any case grab an extra reference
1191          *    to protect the hook pointer.
1192          *
1193          * It is ok to pass hook in invalid state to NG_SEND_DATA_ONLY() as
1194          * it checks for it. Drop extra reference after NG_SEND_DATA_ONLY().
1195          */
1196
1197         UBT_NG_LOCK(sc);
1198         if ((hook = sc->sc_hook) != NULL)
1199                 NG_HOOK_REF(hook);
1200         UBT_NG_UNLOCK(sc);
1201
1202         if (hook == NULL) {
1203                 NG_FREE_M(*m);
1204                 return (ENETDOWN);
1205         }
1206
1207         NG_SEND_DATA_ONLY(error, hook, *m);
1208         NG_HOOK_UNREF(hook);
1209
1210         if (error != 0)
1211                 UBT_STAT_IERROR(sc);
1212
1213         return (error);
1214 } /* ubt_fwd_mbuf_up */
1215
1216 /****************************************************************************
1217  ****************************************************************************
1218  **                                 Glue
1219  ****************************************************************************
1220  ****************************************************************************/
1221
1222 /*
1223  * Schedule glue task. Should be called with sc_ng_mtx held.
1224  * Netgraph context.
1225  */
1226
1227 static void
1228 ubt_task_schedule(ubt_softc_p sc, int action)
1229 {
1230         mtx_assert(&sc->sc_ng_mtx, MA_OWNED);
1231
1232         /*
1233          * Try to handle corner case when "start all" and "stop all"
1234          * actions can both be set before task is executed.
1235          *
1236          * The rules are
1237          *
1238          * sc_task_flags        action          new sc_task_flags
1239          * ------------------------------------------------------
1240          * 0                    start           start
1241          * 0                    stop            stop
1242          * start                start           start
1243          * start                stop            stop
1244          * stop                 start           stop|start
1245          * stop                 stop            stop
1246          * stop|start           start           stop|start
1247          * stop|start           stop            stop
1248          */
1249
1250         if (action != 0) {
1251                 if ((action & UBT_FLAG_T_STOP_ALL) != 0)
1252                         sc->sc_task_flags &= ~UBT_FLAG_T_START_ALL;
1253
1254                 sc->sc_task_flags |= action;
1255         }
1256
1257         if (sc->sc_task_flags & UBT_FLAG_T_PENDING)
1258                 return;
1259
1260         if (taskqueue_enqueue(taskqueue_swi, &sc->sc_task) == 0) {
1261                 sc->sc_task_flags |= UBT_FLAG_T_PENDING;
1262                 return;
1263         }
1264
1265         /* XXX: i think this should never happen */
1266 } /* ubt_task_schedule */
1267
1268 /*
1269  * Glue task. Examines sc_task_flags and does things depending on it.
1270  * Taskqueue context.
1271  */
1272
1273 static void
1274 ubt_task(void *context, int pending)
1275 {
1276         ubt_softc_p     sc = context;
1277         int             task_flags, i;
1278
1279         UBT_NG_LOCK(sc);
1280         task_flags = sc->sc_task_flags;
1281         sc->sc_task_flags = 0;
1282         UBT_NG_UNLOCK(sc);
1283
1284         /*
1285          * Stop all USB transfers synchronously.
1286          * Stop interface #0 and #1 transfers at the same time and in the
1287          * same loop. usbd_transfer_drain() will do appropriate locking.
1288          */
1289
1290         if (task_flags & UBT_FLAG_T_STOP_ALL)
1291                 for (i = 0; i < UBT_N_TRANSFER; i ++)
1292                         usbd_transfer_drain(sc->sc_xfer[i]);
1293
1294         /* Start incoming interrupt and bulk, and all isoc. USB transfers */
1295         if (task_flags & UBT_FLAG_T_START_ALL) {
1296                 /*
1297                  * Interface #0
1298                  */
1299
1300                 mtx_lock(&sc->sc_if_mtx);
1301
1302                 ubt_xfer_start(sc, UBT_IF_0_INTR_DT_RD);
1303                 ubt_xfer_start(sc, UBT_IF_0_BULK_DT_RD);
1304
1305                 /*
1306                  * Interface #1
1307                  * Start both read and write isoc. transfers by default.
1308                  * Get them going all the time even if we have nothing
1309                  * to send to avoid any delays.
1310                  */
1311
1312                 ubt_xfer_start(sc, UBT_IF_1_ISOC_DT_RD1);
1313                 ubt_xfer_start(sc, UBT_IF_1_ISOC_DT_RD2);
1314                 ubt_xfer_start(sc, UBT_IF_1_ISOC_DT_WR1);
1315                 ubt_xfer_start(sc, UBT_IF_1_ISOC_DT_WR2);
1316
1317                 mtx_unlock(&sc->sc_if_mtx);
1318         }
1319
1320         /* Start outgoing control transfer */
1321         if (task_flags & UBT_FLAG_T_START_CTRL) {
1322                 mtx_lock(&sc->sc_if_mtx);
1323                 ubt_xfer_start(sc, UBT_IF_0_CTRL_DT_WR);
1324                 mtx_unlock(&sc->sc_if_mtx);
1325         }
1326
1327         /* Start outgoing bulk transfer */
1328         if (task_flags & UBT_FLAG_T_START_BULK) {
1329                 mtx_lock(&sc->sc_if_mtx);
1330                 ubt_xfer_start(sc, UBT_IF_0_BULK_DT_WR);
1331                 mtx_unlock(&sc->sc_if_mtx);
1332         }
1333 } /* ubt_task */
1334
1335 /****************************************************************************
1336  ****************************************************************************
1337  **                        Netgraph specific
1338  ****************************************************************************
1339  ****************************************************************************/
1340
1341 /*
1342  * Netgraph node constructor. Do not allow to create node of this type.
1343  * Netgraph context.
1344  */
1345
1346 static int
1347 ng_ubt_constructor(node_p node)
1348 {
1349         return (EINVAL);
1350 } /* ng_ubt_constructor */
1351
1352 /*
1353  * Netgraph node destructor. Destroy node only when device has been detached.
1354  * Netgraph context.
1355  */
1356
1357 static int
1358 ng_ubt_shutdown(node_p node)
1359 {
1360         if (node->nd_flags & NGF_REALLY_DIE) {
1361                 /*
1362                  * We came here because the USB device is being
1363                  * detached, so stop being persistant.
1364                  */
1365                 NG_NODE_SET_PRIVATE(node, NULL);
1366                 NG_NODE_UNREF(node);
1367         } else
1368                 NG_NODE_REVIVE(node); /* tell ng_rmnode we are persisant */
1369
1370         return (0);
1371 } /* ng_ubt_shutdown */
1372
1373 /*
1374  * Create new hook. There can only be one.
1375  * Netgraph context.
1376  */
1377
1378 static int
1379 ng_ubt_newhook(node_p node, hook_p hook, char const *name)
1380 {
1381         struct ubt_softc        *sc = NG_NODE_PRIVATE(node);
1382
1383         if (strcmp(name, NG_UBT_HOOK) != 0)
1384                 return (EINVAL);
1385
1386         UBT_NG_LOCK(sc);
1387         if (sc->sc_hook != NULL) {
1388                 UBT_NG_UNLOCK(sc);
1389
1390                 return (EISCONN);
1391         }
1392
1393         sc->sc_hook = hook;
1394         UBT_NG_UNLOCK(sc);
1395
1396         return (0);
1397 } /* ng_ubt_newhook */
1398
1399 /*
1400  * Connect hook. Start incoming USB transfers.
1401  * Netgraph context.
1402  */
1403
1404 static int
1405 ng_ubt_connect(hook_p hook)
1406 {
1407         struct ubt_softc        *sc = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
1408
1409         NG_HOOK_FORCE_QUEUE(NG_HOOK_PEER(hook));
1410
1411         UBT_NG_LOCK(sc);
1412         ubt_task_schedule(sc, UBT_FLAG_T_START_ALL);
1413         UBT_NG_UNLOCK(sc);
1414
1415         return (0);
1416 } /* ng_ubt_connect */
1417
1418 /*
1419  * Disconnect hook.
1420  * Netgraph context.
1421  */
1422
1423 static int
1424 ng_ubt_disconnect(hook_p hook)
1425 {
1426         struct ubt_softc        *sc = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
1427
1428         UBT_NG_LOCK(sc);
1429
1430         if (hook != sc->sc_hook) {
1431                 UBT_NG_UNLOCK(sc);
1432
1433                 return (EINVAL);
1434         }
1435
1436         sc->sc_hook = NULL;
1437
1438         /* Kick off task to stop all USB xfers */
1439         ubt_task_schedule(sc, UBT_FLAG_T_STOP_ALL);
1440
1441         /* Drain queues */
1442         NG_BT_MBUFQ_DRAIN(&sc->sc_cmdq);
1443         NG_BT_MBUFQ_DRAIN(&sc->sc_aclq);
1444         NG_BT_MBUFQ_DRAIN(&sc->sc_scoq);
1445
1446         UBT_NG_UNLOCK(sc);
1447
1448         return (0);
1449 } /* ng_ubt_disconnect */
1450
1451 /*
1452  * Process control message.
1453  * Netgraph context.
1454  */
1455
1456 static int
1457 ng_ubt_rcvmsg(node_p node, item_p item, hook_p lasthook)
1458 {
1459         struct ubt_softc        *sc = NG_NODE_PRIVATE(node);
1460         struct ng_mesg          *msg, *rsp = NULL;
1461         struct ng_bt_mbufq      *q;
1462         int                     error = 0, queue, qlen;
1463
1464         NGI_GET_MSG(item, msg);
1465
1466         switch (msg->header.typecookie) {
1467         case NGM_GENERIC_COOKIE:
1468                 switch (msg->header.cmd) {
1469                 case NGM_TEXT_STATUS:
1470                         NG_MKRESPONSE(rsp, msg, NG_TEXTRESPONSE, M_NOWAIT);
1471                         if (rsp == NULL) {
1472                                 error = ENOMEM;
1473                                 break;
1474                         }
1475
1476                         snprintf(rsp->data, NG_TEXTRESPONSE,
1477                                 "Hook: %s\n" \
1478                                 "Task flags: %#x\n" \
1479                                 "Debug: %d\n" \
1480                                 "CMD queue: [have:%d,max:%d]\n" \
1481                                 "ACL queue: [have:%d,max:%d]\n" \
1482                                 "SCO queue: [have:%d,max:%d]",
1483                                 (sc->sc_hook != NULL) ? NG_UBT_HOOK : "",
1484                                 sc->sc_task_flags,
1485                                 sc->sc_debug,
1486                                 sc->sc_cmdq.len,
1487                                 sc->sc_cmdq.maxlen,
1488                                 sc->sc_aclq.len,
1489                                 sc->sc_aclq.maxlen,
1490                                 sc->sc_scoq.len,
1491                                 sc->sc_scoq.maxlen);
1492                         break;
1493
1494                 default:
1495                         error = EINVAL;
1496                         break;
1497                 }
1498                 break;
1499
1500         case NGM_UBT_COOKIE:
1501                 switch (msg->header.cmd) {
1502                 case NGM_UBT_NODE_SET_DEBUG:
1503                         if (msg->header.arglen != sizeof(ng_ubt_node_debug_ep)){
1504                                 error = EMSGSIZE;
1505                                 break;
1506                         }
1507
1508                         sc->sc_debug = *((ng_ubt_node_debug_ep *) (msg->data));
1509                         break;
1510
1511                 case NGM_UBT_NODE_GET_DEBUG:
1512                         NG_MKRESPONSE(rsp, msg, sizeof(ng_ubt_node_debug_ep),
1513                             M_NOWAIT);
1514                         if (rsp == NULL) {
1515                                 error = ENOMEM;
1516                                 break;
1517                         }
1518
1519                         *((ng_ubt_node_debug_ep *) (rsp->data)) = sc->sc_debug;
1520                         break;
1521
1522                 case NGM_UBT_NODE_SET_QLEN:
1523                         if (msg->header.arglen != sizeof(ng_ubt_node_qlen_ep)) {
1524                                 error = EMSGSIZE;
1525                                 break;
1526                         }
1527
1528                         queue = ((ng_ubt_node_qlen_ep *) (msg->data))->queue;
1529                         qlen = ((ng_ubt_node_qlen_ep *) (msg->data))->qlen;
1530
1531                         switch (queue) {
1532                         case NGM_UBT_NODE_QUEUE_CMD:
1533                                 q = &sc->sc_cmdq;
1534                                 break;
1535
1536                         case NGM_UBT_NODE_QUEUE_ACL:
1537                                 q = &sc->sc_aclq;
1538                                 break;
1539
1540                         case NGM_UBT_NODE_QUEUE_SCO:
1541                                 q = &sc->sc_scoq;
1542                                 break;
1543
1544                         default:
1545                                 error = EINVAL;
1546                                 goto done;
1547                                 /* NOT REACHED */
1548                         }
1549
1550                         q->maxlen = qlen;
1551                         break;
1552
1553                 case NGM_UBT_NODE_GET_QLEN:
1554                         if (msg->header.arglen != sizeof(ng_ubt_node_qlen_ep)) {
1555                                 error = EMSGSIZE;
1556                                 break;
1557                         }
1558
1559                         queue = ((ng_ubt_node_qlen_ep *) (msg->data))->queue;
1560
1561                         switch (queue) {
1562                         case NGM_UBT_NODE_QUEUE_CMD:
1563                                 q = &sc->sc_cmdq;
1564                                 break;
1565
1566                         case NGM_UBT_NODE_QUEUE_ACL:
1567                                 q = &sc->sc_aclq;
1568                                 break;
1569
1570                         case NGM_UBT_NODE_QUEUE_SCO:
1571                                 q = &sc->sc_scoq;
1572                                 break;
1573
1574                         default:
1575                                 error = EINVAL;
1576                                 goto done;
1577                                 /* NOT REACHED */
1578                         }
1579
1580                         NG_MKRESPONSE(rsp, msg, sizeof(ng_ubt_node_qlen_ep),
1581                                 M_NOWAIT);
1582                         if (rsp == NULL) {
1583                                 error = ENOMEM;
1584                                 break;
1585                         }
1586
1587                         ((ng_ubt_node_qlen_ep *) (rsp->data))->queue = queue;
1588                         ((ng_ubt_node_qlen_ep *) (rsp->data))->qlen = q->maxlen;
1589                         break;
1590
1591                 case NGM_UBT_NODE_GET_STAT:
1592                         NG_MKRESPONSE(rsp, msg, sizeof(ng_ubt_node_stat_ep),
1593                             M_NOWAIT);
1594                         if (rsp == NULL) {
1595                                 error = ENOMEM;
1596                                 break;
1597                         }
1598
1599                         bcopy(&sc->sc_stat, rsp->data,
1600                                 sizeof(ng_ubt_node_stat_ep));
1601                         break;
1602
1603                 case NGM_UBT_NODE_RESET_STAT:
1604                         UBT_STAT_RESET(sc);
1605                         break;
1606
1607                 default:
1608                         error = EINVAL;
1609                         break;
1610                 }
1611                 break;
1612
1613         default:
1614                 error = EINVAL;
1615                 break;
1616         }
1617 done:
1618         NG_RESPOND_MSG(error, node, item, rsp);
1619         NG_FREE_MSG(msg);
1620
1621         return (error);
1622 } /* ng_ubt_rcvmsg */
1623
1624 /*
1625  * Process data.
1626  * Netgraph context.
1627  */
1628
1629 static int
1630 ng_ubt_rcvdata(hook_p hook, item_p item)
1631 {
1632         struct ubt_softc        *sc = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
1633         struct mbuf             *m;
1634         struct ng_bt_mbufq      *q;
1635         int                     action, error = 0;
1636
1637         if (hook != sc->sc_hook) {
1638                 error = EINVAL;
1639                 goto done;
1640         }
1641
1642         /* Deatch mbuf and get HCI frame type */
1643         NGI_GET_M(item, m);
1644
1645         /*
1646          * Minimal size of the HCI frame is 4 bytes: 1 byte frame type,
1647          * 2 bytes connection handle and at least 1 byte of length.
1648          * Panic on data frame that has size smaller than 4 bytes (it
1649          * should not happen)
1650          */
1651
1652         if (m->m_pkthdr.len < 4)
1653                 panic("HCI frame size is too small! pktlen=%d\n",
1654                         m->m_pkthdr.len);
1655
1656         /* Process HCI frame */
1657         switch (*mtod(m, uint8_t *)) {  /* XXX call m_pullup ? */
1658         case NG_HCI_CMD_PKT:
1659                 if (m->m_pkthdr.len - 1 > (int)UBT_CTRL_BUFFER_SIZE)
1660                         panic("HCI command frame size is too big! " \
1661                                 "buffer size=%zd, packet len=%d\n",
1662                                 UBT_CTRL_BUFFER_SIZE, m->m_pkthdr.len);
1663
1664                 q = &sc->sc_cmdq;
1665                 action = UBT_FLAG_T_START_CTRL;
1666                 break;
1667
1668         case NG_HCI_ACL_DATA_PKT:
1669                 if (m->m_pkthdr.len - 1 > UBT_BULK_WRITE_BUFFER_SIZE)
1670                         panic("ACL data frame size is too big! " \
1671                                 "buffer size=%d, packet len=%d\n",
1672                                 UBT_BULK_WRITE_BUFFER_SIZE, m->m_pkthdr.len);
1673
1674                 q = &sc->sc_aclq;
1675                 action = UBT_FLAG_T_START_BULK;
1676                 break;
1677
1678         case NG_HCI_SCO_DATA_PKT:
1679                 q = &sc->sc_scoq;
1680                 action = 0;
1681                 break;
1682
1683         default:
1684                 UBT_ERR(sc, "Dropping unsupported HCI frame, type=0x%02x, " \
1685                         "pktlen=%d\n", *mtod(m, uint8_t *), m->m_pkthdr.len);
1686
1687                 NG_FREE_M(m);
1688                 error = EINVAL;
1689                 goto done;
1690                 /* NOT REACHED */
1691         }
1692
1693         UBT_NG_LOCK(sc);
1694         if (NG_BT_MBUFQ_FULL(q)) {
1695                 NG_BT_MBUFQ_DROP(q);
1696                 UBT_NG_UNLOCK(sc);
1697
1698                 UBT_ERR(sc, "Dropping HCI frame 0x%02x, len=%d. Queue full\n",
1699                         *mtod(m, uint8_t *), m->m_pkthdr.len);
1700
1701                 NG_FREE_M(m);
1702         } else {
1703                 /* Loose HCI packet type, enqueue mbuf and kick off task */
1704                 m_adj(m, sizeof(uint8_t));
1705                 NG_BT_MBUFQ_ENQUEUE(q, m);
1706                 ubt_task_schedule(sc, action);
1707                 UBT_NG_UNLOCK(sc);
1708         }
1709 done:
1710         NG_FREE_ITEM(item);
1711
1712         return (error);
1713 } /* ng_ubt_rcvdata */
1714
1715 /****************************************************************************
1716  ****************************************************************************
1717  **                              Module
1718  ****************************************************************************
1719  ****************************************************************************/
1720
1721 /*
1722  * Load/Unload the driver module
1723  */
1724
1725 static int
1726 ubt_modevent(module_t mod, int event, void *data)
1727 {
1728         int     error;
1729
1730         switch (event) {
1731         case MOD_LOAD:
1732                 error = ng_newtype(&typestruct);
1733                 if (error != 0)
1734                         printf("%s: Could not register Netgraph node type, " \
1735                                 "error=%d\n", NG_UBT_NODE_TYPE, error);
1736                 break;
1737
1738         case MOD_UNLOAD:
1739                 error = ng_rmtype(&typestruct);
1740                 break;
1741
1742         default:
1743                 error = EOPNOTSUPP;
1744                 break;
1745         }
1746
1747         return (error);
1748 } /* ubt_modevent */
1749
1750 static devclass_t       ubt_devclass;
1751
1752 static device_method_t  ubt_methods[] =
1753 {
1754         DEVMETHOD(device_probe, ubt_probe),
1755         DEVMETHOD(device_attach, ubt_attach),
1756         DEVMETHOD(device_detach, ubt_detach),
1757         DEVMETHOD_END
1758 };
1759
1760 static driver_t         ubt_driver =
1761 {
1762         .name =    "ubt",
1763         .methods = ubt_methods,
1764         .size =    sizeof(struct ubt_softc),
1765 };
1766
1767 DRIVER_MODULE(ng_ubt, uhub, ubt_driver, ubt_devclass, ubt_modevent, 0);
1768 MODULE_VERSION(ng_ubt, NG_BLUETOOTH_VERSION);
1769 MODULE_DEPEND(ng_ubt, netgraph, NG_ABI_VERSION, NG_ABI_VERSION, NG_ABI_VERSION);
1770 MODULE_DEPEND(ng_ubt, ng_hci, NG_BLUETOOTH_VERSION, NG_BLUETOOTH_VERSION, NG_BLUETOOTH_VERSION);
1771 MODULE_DEPEND(ng_ubt, usb, 1, 1, 1);
1772