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