1 /** 2 * Marvell Bluetooth driver 3 * 4 * Copyright (C) 2009, Marvell International Ltd. 5 * 6 * This software file (the "File") is distributed by Marvell International 7 * Ltd. under the terms of the GNU General Public License Version 2, June 1991 8 * (the "License"). You may use, redistribute and/or modify this File in 9 * accordance with the terms and conditions of the License, a copy of which 10 * is available by writing to the Free Software Foundation, Inc., 11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the 12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt. 13 * 14 * 15 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE 17 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about 18 * this warranty disclaimer. 19 **/ 20 21 #include <linux/module.h> 22 #include <linux/of.h> 23 #include <net/bluetooth/bluetooth.h> 24 #include <net/bluetooth/hci_core.h> 25 26 #include "btmrvl_drv.h" 27 #include "btmrvl_sdio.h" 28 29 #define VERSION "1.0" 30 31 /* 32 * This function is called by interface specific interrupt handler. 33 * It updates Power Save & Host Sleep states, and wakes up the main 34 * thread. 35 */ 36 void btmrvl_interrupt(struct btmrvl_private *priv) 37 { 38 priv->adapter->ps_state = PS_AWAKE; 39 40 priv->adapter->wakeup_tries = 0; 41 42 priv->adapter->int_count++; 43 44 wake_up_interruptible(&priv->main_thread.wait_q); 45 } 46 EXPORT_SYMBOL_GPL(btmrvl_interrupt); 47 48 bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb) 49 { 50 struct hci_event_hdr *hdr = (void *) skb->data; 51 52 if (hdr->evt == HCI_EV_CMD_COMPLETE) { 53 struct hci_ev_cmd_complete *ec; 54 u16 opcode; 55 56 ec = (void *) (skb->data + HCI_EVENT_HDR_SIZE); 57 opcode = __le16_to_cpu(ec->opcode); 58 59 if (priv->btmrvl_dev.sendcmdflag) { 60 priv->btmrvl_dev.sendcmdflag = false; 61 priv->adapter->cmd_complete = true; 62 wake_up_interruptible(&priv->adapter->cmd_wait_q); 63 64 if (hci_opcode_ogf(opcode) == 0x3F) { 65 BT_DBG("vendor event skipped: opcode=%#4.4x", 66 opcode); 67 kfree_skb(skb); 68 return false; 69 } 70 } 71 } 72 73 return true; 74 } 75 EXPORT_SYMBOL_GPL(btmrvl_check_evtpkt); 76 77 int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb) 78 { 79 struct btmrvl_adapter *adapter = priv->adapter; 80 struct btmrvl_event *event; 81 int ret = 0; 82 83 event = (struct btmrvl_event *) skb->data; 84 if (event->ec != 0xff) { 85 BT_DBG("Not Marvell Event=%x", event->ec); 86 ret = -EINVAL; 87 goto exit; 88 } 89 90 switch (event->data[0]) { 91 case BT_EVENT_AUTO_SLEEP_MODE: 92 if (!event->data[2]) { 93 if (event->data[1] == BT_PS_ENABLE) 94 adapter->psmode = 1; 95 else 96 adapter->psmode = 0; 97 BT_DBG("PS Mode:%s", 98 (adapter->psmode) ? "Enable" : "Disable"); 99 } else { 100 BT_DBG("PS Mode command failed"); 101 } 102 break; 103 104 case BT_EVENT_HOST_SLEEP_CONFIG: 105 if (!event->data[3]) 106 BT_DBG("gpio=%x, gap=%x", event->data[1], 107 event->data[2]); 108 else 109 BT_DBG("HSCFG command failed"); 110 break; 111 112 case BT_EVENT_HOST_SLEEP_ENABLE: 113 if (!event->data[1]) { 114 adapter->hs_state = HS_ACTIVATED; 115 if (adapter->psmode) 116 adapter->ps_state = PS_SLEEP; 117 BT_DBG("HS ACTIVATED!"); 118 } else { 119 BT_DBG("HS Enable failed"); 120 } 121 break; 122 123 case BT_EVENT_MODULE_CFG_REQ: 124 if (priv->btmrvl_dev.sendcmdflag && 125 event->data[1] == MODULE_BRINGUP_REQ) { 126 BT_DBG("EVENT:%s", 127 ((event->data[2] == MODULE_BROUGHT_UP) || 128 (event->data[2] == MODULE_ALREADY_UP)) ? 129 "Bring-up succeed" : "Bring-up failed"); 130 131 if (event->length > 3 && event->data[3]) 132 priv->btmrvl_dev.dev_type = HCI_AMP; 133 else 134 priv->btmrvl_dev.dev_type = HCI_BREDR; 135 136 BT_DBG("dev_type: %d", priv->btmrvl_dev.dev_type); 137 } else if (priv->btmrvl_dev.sendcmdflag && 138 event->data[1] == MODULE_SHUTDOWN_REQ) { 139 BT_DBG("EVENT:%s", (event->data[2]) ? 140 "Shutdown failed" : "Shutdown succeed"); 141 } else { 142 BT_DBG("BT_CMD_MODULE_CFG_REQ resp for APP"); 143 ret = -EINVAL; 144 } 145 break; 146 147 case BT_EVENT_POWER_STATE: 148 if (event->data[1] == BT_PS_SLEEP) 149 adapter->ps_state = PS_SLEEP; 150 BT_DBG("EVENT:%s", 151 (adapter->ps_state) ? "PS_SLEEP" : "PS_AWAKE"); 152 break; 153 154 default: 155 BT_DBG("Unknown Event=%d", event->data[0]); 156 ret = -EINVAL; 157 break; 158 } 159 160 exit: 161 if (!ret) 162 kfree_skb(skb); 163 164 return ret; 165 } 166 EXPORT_SYMBOL_GPL(btmrvl_process_event); 167 168 static int btmrvl_send_sync_cmd(struct btmrvl_private *priv, u16 opcode, 169 const void *param, u8 len) 170 { 171 struct sk_buff *skb; 172 struct hci_command_hdr *hdr; 173 174 skb = bt_skb_alloc(HCI_COMMAND_HDR_SIZE + len, GFP_ATOMIC); 175 if (skb == NULL) { 176 BT_ERR("No free skb"); 177 return -ENOMEM; 178 } 179 180 hdr = (struct hci_command_hdr *)skb_put(skb, HCI_COMMAND_HDR_SIZE); 181 hdr->opcode = cpu_to_le16(opcode); 182 hdr->plen = len; 183 184 if (len) 185 memcpy(skb_put(skb, len), param, len); 186 187 bt_cb(skb)->pkt_type = MRVL_VENDOR_PKT; 188 189 skb_queue_head(&priv->adapter->tx_queue, skb); 190 191 priv->btmrvl_dev.sendcmdflag = true; 192 193 priv->adapter->cmd_complete = false; 194 195 wake_up_interruptible(&priv->main_thread.wait_q); 196 197 if (!wait_event_interruptible_timeout(priv->adapter->cmd_wait_q, 198 priv->adapter->cmd_complete, 199 msecs_to_jiffies(WAIT_UNTIL_CMD_RESP))) 200 return -ETIMEDOUT; 201 202 return 0; 203 } 204 205 int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd) 206 { 207 int ret; 208 209 ret = btmrvl_send_sync_cmd(priv, BT_CMD_MODULE_CFG_REQ, &subcmd, 1); 210 if (ret) 211 BT_ERR("module_cfg_cmd(%x) failed\n", subcmd); 212 213 return ret; 214 } 215 EXPORT_SYMBOL_GPL(btmrvl_send_module_cfg_cmd); 216 217 int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv) 218 { 219 int ret; 220 u8 param[2]; 221 222 param[0] = (priv->btmrvl_dev.gpio_gap & 0xff00) >> 8; 223 param[1] = (u8) (priv->btmrvl_dev.gpio_gap & 0x00ff); 224 225 BT_DBG("Sending HSCFG Command, gpio=0x%x, gap=0x%x", 226 param[0], param[1]); 227 228 ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_CONFIG, param, 2); 229 if (ret) 230 BT_ERR("HSCFG command failed\n"); 231 232 return ret; 233 } 234 EXPORT_SYMBOL_GPL(btmrvl_send_hscfg_cmd); 235 236 int btmrvl_enable_ps(struct btmrvl_private *priv) 237 { 238 int ret; 239 u8 param; 240 241 if (priv->btmrvl_dev.psmode) 242 param = BT_PS_ENABLE; 243 else 244 param = BT_PS_DISABLE; 245 246 ret = btmrvl_send_sync_cmd(priv, BT_CMD_AUTO_SLEEP_MODE, ¶m, 1); 247 if (ret) 248 BT_ERR("PSMODE command failed\n"); 249 250 return 0; 251 } 252 EXPORT_SYMBOL_GPL(btmrvl_enable_ps); 253 254 int btmrvl_enable_hs(struct btmrvl_private *priv) 255 { 256 int ret; 257 258 ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_ENABLE, NULL, 0); 259 if (ret) 260 BT_ERR("Host sleep enable command failed\n"); 261 262 return ret; 263 } 264 EXPORT_SYMBOL_GPL(btmrvl_enable_hs); 265 266 int btmrvl_prepare_command(struct btmrvl_private *priv) 267 { 268 int ret = 0; 269 270 if (priv->btmrvl_dev.hscfgcmd) { 271 priv->btmrvl_dev.hscfgcmd = 0; 272 btmrvl_send_hscfg_cmd(priv); 273 } 274 275 if (priv->btmrvl_dev.pscmd) { 276 priv->btmrvl_dev.pscmd = 0; 277 btmrvl_enable_ps(priv); 278 } 279 280 if (priv->btmrvl_dev.hscmd) { 281 priv->btmrvl_dev.hscmd = 0; 282 283 if (priv->btmrvl_dev.hsmode) { 284 ret = btmrvl_enable_hs(priv); 285 } else { 286 ret = priv->hw_wakeup_firmware(priv); 287 priv->adapter->hs_state = HS_DEACTIVATED; 288 } 289 } 290 291 return ret; 292 } 293 294 static int btmrvl_tx_pkt(struct btmrvl_private *priv, struct sk_buff *skb) 295 { 296 int ret = 0; 297 298 if (!skb || !skb->data) 299 return -EINVAL; 300 301 if (!skb->len || ((skb->len + BTM_HEADER_LEN) > BTM_UPLD_SIZE)) { 302 BT_ERR("Tx Error: Bad skb length %d : %d", 303 skb->len, BTM_UPLD_SIZE); 304 return -EINVAL; 305 } 306 307 if (skb_headroom(skb) < BTM_HEADER_LEN) { 308 struct sk_buff *tmp = skb; 309 310 skb = skb_realloc_headroom(skb, BTM_HEADER_LEN); 311 if (!skb) { 312 BT_ERR("Tx Error: realloc_headroom failed %d", 313 BTM_HEADER_LEN); 314 skb = tmp; 315 return -EINVAL; 316 } 317 318 kfree_skb(tmp); 319 } 320 321 skb_push(skb, BTM_HEADER_LEN); 322 323 /* header type: byte[3] 324 * HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor 325 * header length: byte[2][1][0] 326 */ 327 328 skb->data[0] = (skb->len & 0x0000ff); 329 skb->data[1] = (skb->len & 0x00ff00) >> 8; 330 skb->data[2] = (skb->len & 0xff0000) >> 16; 331 skb->data[3] = bt_cb(skb)->pkt_type; 332 333 if (priv->hw_host_to_card) 334 ret = priv->hw_host_to_card(priv, skb->data, skb->len); 335 336 return ret; 337 } 338 339 static void btmrvl_init_adapter(struct btmrvl_private *priv) 340 { 341 int buf_size; 342 343 skb_queue_head_init(&priv->adapter->tx_queue); 344 345 priv->adapter->ps_state = PS_AWAKE; 346 347 buf_size = ALIGN_SZ(SDIO_BLOCK_SIZE, BTSDIO_DMA_ALIGN); 348 priv->adapter->hw_regs_buf = kzalloc(buf_size, GFP_KERNEL); 349 if (!priv->adapter->hw_regs_buf) { 350 priv->adapter->hw_regs = NULL; 351 BT_ERR("Unable to allocate buffer for hw_regs."); 352 } else { 353 priv->adapter->hw_regs = 354 (u8 *)ALIGN_ADDR(priv->adapter->hw_regs_buf, 355 BTSDIO_DMA_ALIGN); 356 BT_DBG("hw_regs_buf=%p hw_regs=%p", 357 priv->adapter->hw_regs_buf, priv->adapter->hw_regs); 358 } 359 360 init_waitqueue_head(&priv->adapter->cmd_wait_q); 361 } 362 363 static void btmrvl_free_adapter(struct btmrvl_private *priv) 364 { 365 skb_queue_purge(&priv->adapter->tx_queue); 366 367 kfree(priv->adapter->hw_regs_buf); 368 kfree(priv->adapter); 369 370 priv->adapter = NULL; 371 } 372 373 static int btmrvl_send_frame(struct hci_dev *hdev, struct sk_buff *skb) 374 { 375 struct btmrvl_private *priv = hci_get_drvdata(hdev); 376 377 BT_DBG("type=%d, len=%d", skb->pkt_type, skb->len); 378 379 if (!test_bit(HCI_RUNNING, &hdev->flags)) { 380 BT_ERR("Failed testing HCI_RUNING, flags=%lx", hdev->flags); 381 print_hex_dump_bytes("data: ", DUMP_PREFIX_OFFSET, 382 skb->data, skb->len); 383 return -EBUSY; 384 } 385 386 switch (bt_cb(skb)->pkt_type) { 387 case HCI_COMMAND_PKT: 388 hdev->stat.cmd_tx++; 389 break; 390 391 case HCI_ACLDATA_PKT: 392 hdev->stat.acl_tx++; 393 break; 394 395 case HCI_SCODATA_PKT: 396 hdev->stat.sco_tx++; 397 break; 398 } 399 400 skb_queue_tail(&priv->adapter->tx_queue, skb); 401 402 wake_up_interruptible(&priv->main_thread.wait_q); 403 404 return 0; 405 } 406 407 static int btmrvl_flush(struct hci_dev *hdev) 408 { 409 struct btmrvl_private *priv = hci_get_drvdata(hdev); 410 411 skb_queue_purge(&priv->adapter->tx_queue); 412 413 return 0; 414 } 415 416 static int btmrvl_close(struct hci_dev *hdev) 417 { 418 struct btmrvl_private *priv = hci_get_drvdata(hdev); 419 420 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags)) 421 return 0; 422 423 skb_queue_purge(&priv->adapter->tx_queue); 424 425 return 0; 426 } 427 428 static int btmrvl_open(struct hci_dev *hdev) 429 { 430 set_bit(HCI_RUNNING, &hdev->flags); 431 432 return 0; 433 } 434 435 static int btmrvl_download_cal_data(struct btmrvl_private *priv, 436 u8 *data, int len) 437 { 438 int ret; 439 440 data[0] = 0x00; 441 data[1] = 0x00; 442 data[2] = 0x00; 443 data[3] = len; 444 445 print_hex_dump_bytes("Calibration data: ", 446 DUMP_PREFIX_OFFSET, data, BT_CAL_HDR_LEN + len); 447 448 ret = btmrvl_send_sync_cmd(priv, BT_CMD_LOAD_CONFIG_DATA, data, 449 BT_CAL_HDR_LEN + len); 450 if (ret) 451 BT_ERR("Failed to download caibration data\n"); 452 453 return 0; 454 } 455 456 static int btmrvl_cal_data_dt(struct btmrvl_private *priv) 457 { 458 struct device_node *dt_node; 459 u8 cal_data[BT_CAL_HDR_LEN + BT_CAL_DATA_SIZE]; 460 const char name[] = "btmrvl_caldata"; 461 const char property[] = "btmrvl,caldata"; 462 int ret; 463 464 dt_node = of_find_node_by_name(NULL, name); 465 if (!dt_node) 466 return -ENODEV; 467 468 ret = of_property_read_u8_array(dt_node, property, 469 cal_data + BT_CAL_HDR_LEN, 470 BT_CAL_DATA_SIZE); 471 if (ret) 472 return ret; 473 474 BT_DBG("Use cal data from device tree"); 475 ret = btmrvl_download_cal_data(priv, cal_data, BT_CAL_DATA_SIZE); 476 if (ret) { 477 BT_ERR("Fail to download calibrate data"); 478 return ret; 479 } 480 481 return 0; 482 } 483 484 static int btmrvl_setup(struct hci_dev *hdev) 485 { 486 struct btmrvl_private *priv = hci_get_drvdata(hdev); 487 488 btmrvl_send_module_cfg_cmd(priv, MODULE_BRINGUP_REQ); 489 490 btmrvl_cal_data_dt(priv); 491 492 priv->btmrvl_dev.psmode = 1; 493 btmrvl_enable_ps(priv); 494 495 priv->btmrvl_dev.gpio_gap = 0xffff; 496 btmrvl_send_hscfg_cmd(priv); 497 498 return 0; 499 } 500 501 /* 502 * This function handles the event generated by firmware, rx data 503 * received from firmware, and tx data sent from kernel. 504 */ 505 static int btmrvl_service_main_thread(void *data) 506 { 507 struct btmrvl_thread *thread = data; 508 struct btmrvl_private *priv = thread->priv; 509 struct btmrvl_adapter *adapter = priv->adapter; 510 wait_queue_t wait; 511 struct sk_buff *skb; 512 ulong flags; 513 514 init_waitqueue_entry(&wait, current); 515 516 for (;;) { 517 add_wait_queue(&thread->wait_q, &wait); 518 519 set_current_state(TASK_INTERRUPTIBLE); 520 if (kthread_should_stop()) { 521 BT_DBG("main_thread: break from main thread"); 522 break; 523 } 524 525 if (adapter->wakeup_tries || 526 ((!adapter->int_count) && 527 (!priv->btmrvl_dev.tx_dnld_rdy || 528 skb_queue_empty(&adapter->tx_queue)))) { 529 BT_DBG("main_thread is sleeping..."); 530 schedule(); 531 } 532 533 set_current_state(TASK_RUNNING); 534 535 remove_wait_queue(&thread->wait_q, &wait); 536 537 BT_DBG("main_thread woke up"); 538 539 spin_lock_irqsave(&priv->driver_lock, flags); 540 if (adapter->int_count) { 541 adapter->int_count = 0; 542 spin_unlock_irqrestore(&priv->driver_lock, flags); 543 priv->hw_process_int_status(priv); 544 } else if (adapter->ps_state == PS_SLEEP && 545 !skb_queue_empty(&adapter->tx_queue)) { 546 spin_unlock_irqrestore(&priv->driver_lock, flags); 547 adapter->wakeup_tries++; 548 priv->hw_wakeup_firmware(priv); 549 continue; 550 } else { 551 spin_unlock_irqrestore(&priv->driver_lock, flags); 552 } 553 554 if (adapter->ps_state == PS_SLEEP) 555 continue; 556 557 if (!priv->btmrvl_dev.tx_dnld_rdy) 558 continue; 559 560 skb = skb_dequeue(&adapter->tx_queue); 561 if (skb) { 562 if (btmrvl_tx_pkt(priv, skb)) 563 priv->btmrvl_dev.hcidev->stat.err_tx++; 564 else 565 priv->btmrvl_dev.hcidev->stat.byte_tx += skb->len; 566 567 kfree_skb(skb); 568 } 569 } 570 571 return 0; 572 } 573 574 int btmrvl_register_hdev(struct btmrvl_private *priv) 575 { 576 struct hci_dev *hdev = NULL; 577 int ret; 578 579 hdev = hci_alloc_dev(); 580 if (!hdev) { 581 BT_ERR("Can not allocate HCI device"); 582 goto err_hdev; 583 } 584 585 priv->btmrvl_dev.hcidev = hdev; 586 hci_set_drvdata(hdev, priv); 587 588 hdev->bus = HCI_SDIO; 589 hdev->open = btmrvl_open; 590 hdev->close = btmrvl_close; 591 hdev->flush = btmrvl_flush; 592 hdev->send = btmrvl_send_frame; 593 hdev->setup = btmrvl_setup; 594 595 hdev->dev_type = priv->btmrvl_dev.dev_type; 596 597 ret = hci_register_dev(hdev); 598 if (ret < 0) { 599 BT_ERR("Can not register HCI device"); 600 goto err_hci_register_dev; 601 } 602 603 #ifdef CONFIG_DEBUG_FS 604 btmrvl_debugfs_init(hdev); 605 #endif 606 607 return 0; 608 609 err_hci_register_dev: 610 hci_free_dev(hdev); 611 612 err_hdev: 613 /* Stop the thread servicing the interrupts */ 614 kthread_stop(priv->main_thread.task); 615 616 btmrvl_free_adapter(priv); 617 kfree(priv); 618 619 return -ENOMEM; 620 } 621 EXPORT_SYMBOL_GPL(btmrvl_register_hdev); 622 623 struct btmrvl_private *btmrvl_add_card(void *card) 624 { 625 struct btmrvl_private *priv; 626 627 priv = kzalloc(sizeof(*priv), GFP_KERNEL); 628 if (!priv) { 629 BT_ERR("Can not allocate priv"); 630 goto err_priv; 631 } 632 633 priv->adapter = kzalloc(sizeof(*priv->adapter), GFP_KERNEL); 634 if (!priv->adapter) { 635 BT_ERR("Allocate buffer for btmrvl_adapter failed!"); 636 goto err_adapter; 637 } 638 639 btmrvl_init_adapter(priv); 640 641 BT_DBG("Starting kthread..."); 642 priv->main_thread.priv = priv; 643 spin_lock_init(&priv->driver_lock); 644 645 init_waitqueue_head(&priv->main_thread.wait_q); 646 priv->main_thread.task = kthread_run(btmrvl_service_main_thread, 647 &priv->main_thread, "btmrvl_main_service"); 648 649 priv->btmrvl_dev.card = card; 650 priv->btmrvl_dev.tx_dnld_rdy = true; 651 652 return priv; 653 654 err_adapter: 655 kfree(priv); 656 657 err_priv: 658 return NULL; 659 } 660 EXPORT_SYMBOL_GPL(btmrvl_add_card); 661 662 int btmrvl_remove_card(struct btmrvl_private *priv) 663 { 664 struct hci_dev *hdev; 665 666 hdev = priv->btmrvl_dev.hcidev; 667 668 wake_up_interruptible(&priv->adapter->cmd_wait_q); 669 670 kthread_stop(priv->main_thread.task); 671 672 #ifdef CONFIG_DEBUG_FS 673 btmrvl_debugfs_remove(hdev); 674 #endif 675 676 hci_unregister_dev(hdev); 677 678 hci_free_dev(hdev); 679 680 priv->btmrvl_dev.hcidev = NULL; 681 682 btmrvl_free_adapter(priv); 683 684 kfree(priv); 685 686 return 0; 687 } 688 EXPORT_SYMBOL_GPL(btmrvl_remove_card); 689 690 MODULE_AUTHOR("Marvell International Ltd."); 691 MODULE_DESCRIPTION("Marvell Bluetooth driver ver " VERSION); 692 MODULE_VERSION(VERSION); 693 MODULE_LICENSE("GPL v2"); 694