2 * Marvell Bluetooth driver
4 * Copyright (C) 2009, Marvell International Ltd.
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.
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.
21 #include <linux/module.h>
23 #include <net/bluetooth/bluetooth.h>
24 #include <net/bluetooth/hci_core.h>
25 #include <linux/mmc/sdio_func.h>
27 #include "btmrvl_drv.h"
28 #include "btmrvl_sdio.h"
33 * This function is called by interface specific interrupt handler.
34 * It updates Power Save & Host Sleep states, and wakes up the main
37 void btmrvl_interrupt(struct btmrvl_private *priv)
39 priv->adapter->ps_state = PS_AWAKE;
41 priv->adapter->wakeup_tries = 0;
43 priv->adapter->int_count++;
45 if (priv->adapter->hs_state == HS_ACTIVATED) {
46 BT_DBG("BT: HS DEACTIVATED in ISR!");
47 priv->adapter->hs_state = HS_DEACTIVATED;
50 wake_up_interruptible(&priv->main_thread.wait_q);
52 EXPORT_SYMBOL_GPL(btmrvl_interrupt);
54 bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb)
56 struct hci_event_hdr *hdr = (void *) skb->data;
58 if (hdr->evt == HCI_EV_CMD_COMPLETE) {
59 struct hci_ev_cmd_complete *ec;
62 ec = (void *) (skb->data + HCI_EVENT_HDR_SIZE);
63 opcode = __le16_to_cpu(ec->opcode);
65 if (priv->btmrvl_dev.sendcmdflag) {
66 priv->btmrvl_dev.sendcmdflag = false;
67 priv->adapter->cmd_complete = true;
68 wake_up_interruptible(&priv->adapter->cmd_wait_q);
70 if (hci_opcode_ogf(opcode) == 0x3F) {
71 BT_DBG("vendor event skipped: opcode=%#4.4x",
81 EXPORT_SYMBOL_GPL(btmrvl_check_evtpkt);
83 int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb)
85 struct btmrvl_adapter *adapter = priv->adapter;
86 struct btmrvl_event *event;
89 event = (struct btmrvl_event *) skb->data;
90 if (event->ec != 0xff) {
91 BT_DBG("Not Marvell Event=%x", event->ec);
96 switch (event->data[0]) {
97 case BT_EVENT_AUTO_SLEEP_MODE:
98 if (!event->data[2]) {
99 if (event->data[1] == BT_PS_ENABLE)
104 (adapter->psmode) ? "Enable" : "Disable");
106 BT_DBG("PS Mode command failed");
110 case BT_EVENT_HOST_SLEEP_CONFIG:
112 BT_DBG("gpio=%x, gap=%x", event->data[1],
115 BT_DBG("HSCFG command failed");
118 case BT_EVENT_HOST_SLEEP_ENABLE:
119 if (!event->data[1]) {
120 adapter->hs_state = HS_ACTIVATED;
122 adapter->ps_state = PS_SLEEP;
123 wake_up_interruptible(&adapter->event_hs_wait_q);
124 BT_DBG("HS ACTIVATED!");
126 BT_DBG("HS Enable failed");
130 case BT_EVENT_MODULE_CFG_REQ:
131 if (priv->btmrvl_dev.sendcmdflag &&
132 event->data[1] == MODULE_BRINGUP_REQ) {
134 ((event->data[2] == MODULE_BROUGHT_UP) ||
135 (event->data[2] == MODULE_ALREADY_UP)) ?
136 "Bring-up succeed" : "Bring-up failed");
138 if (event->length > 3 && event->data[3])
139 priv->btmrvl_dev.dev_type = HCI_AMP;
141 priv->btmrvl_dev.dev_type = HCI_BREDR;
143 BT_DBG("dev_type: %d", priv->btmrvl_dev.dev_type);
144 } else if (priv->btmrvl_dev.sendcmdflag &&
145 event->data[1] == MODULE_SHUTDOWN_REQ) {
146 BT_DBG("EVENT:%s", (event->data[2]) ?
147 "Shutdown failed" : "Shutdown succeed");
149 BT_DBG("BT_CMD_MODULE_CFG_REQ resp for APP");
154 case BT_EVENT_POWER_STATE:
155 if (event->data[1] == BT_PS_SLEEP)
156 adapter->ps_state = PS_SLEEP;
158 (adapter->ps_state) ? "PS_SLEEP" : "PS_AWAKE");
162 BT_DBG("Unknown Event=%d", event->data[0]);
173 EXPORT_SYMBOL_GPL(btmrvl_process_event);
175 static int btmrvl_send_sync_cmd(struct btmrvl_private *priv, u16 opcode,
176 const void *param, u8 len)
179 struct hci_command_hdr *hdr;
181 if (priv->surprise_removed) {
182 BT_ERR("Card is removed");
186 skb = bt_skb_alloc(HCI_COMMAND_HDR_SIZE + len, GFP_ATOMIC);
188 BT_ERR("No free skb");
192 hdr = (struct hci_command_hdr *)skb_put(skb, HCI_COMMAND_HDR_SIZE);
193 hdr->opcode = cpu_to_le16(opcode);
197 memcpy(skb_put(skb, len), param, len);
199 bt_cb(skb)->pkt_type = MRVL_VENDOR_PKT;
201 skb_queue_head(&priv->adapter->tx_queue, skb);
203 priv->btmrvl_dev.sendcmdflag = true;
205 priv->adapter->cmd_complete = false;
207 wake_up_interruptible(&priv->main_thread.wait_q);
209 if (!wait_event_interruptible_timeout(priv->adapter->cmd_wait_q,
210 priv->adapter->cmd_complete ||
211 priv->surprise_removed,
212 WAIT_UNTIL_CMD_RESP))
215 if (priv->surprise_removed)
221 int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd)
225 ret = btmrvl_send_sync_cmd(priv, BT_CMD_MODULE_CFG_REQ, &subcmd, 1);
227 BT_ERR("module_cfg_cmd(%x) failed", subcmd);
231 EXPORT_SYMBOL_GPL(btmrvl_send_module_cfg_cmd);
233 int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd)
235 struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
238 if (!card->support_pscan_win_report)
241 ret = btmrvl_send_sync_cmd(priv, BT_CMD_PSCAN_WIN_REPORT_ENABLE,
244 BT_ERR("PSCAN_WIN_REPORT_ENABLE command failed: %#x", ret);
248 EXPORT_SYMBOL_GPL(btmrvl_pscan_window_reporting);
250 int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv)
255 param[0] = (priv->btmrvl_dev.gpio_gap & 0xff00) >> 8;
256 param[1] = (u8) (priv->btmrvl_dev.gpio_gap & 0x00ff);
258 BT_DBG("Sending HSCFG Command, gpio=0x%x, gap=0x%x",
261 ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_CONFIG, param, 2);
263 BT_ERR("HSCFG command failed");
267 EXPORT_SYMBOL_GPL(btmrvl_send_hscfg_cmd);
269 int btmrvl_enable_ps(struct btmrvl_private *priv)
274 if (priv->btmrvl_dev.psmode)
275 param = BT_PS_ENABLE;
277 param = BT_PS_DISABLE;
279 ret = btmrvl_send_sync_cmd(priv, BT_CMD_AUTO_SLEEP_MODE, ¶m, 1);
281 BT_ERR("PSMODE command failed");
285 EXPORT_SYMBOL_GPL(btmrvl_enable_ps);
287 int btmrvl_enable_hs(struct btmrvl_private *priv)
289 struct btmrvl_adapter *adapter = priv->adapter;
292 ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_ENABLE, NULL, 0);
294 BT_ERR("Host sleep enable command failed");
298 ret = wait_event_interruptible_timeout(adapter->event_hs_wait_q,
300 priv->surprise_removed,
301 WAIT_UNTIL_HS_STATE_CHANGED);
302 if (ret < 0 || priv->surprise_removed) {
303 BT_ERR("event_hs_wait_q terminated (%d): %d,%d,%d",
304 ret, adapter->hs_state, adapter->ps_state,
305 adapter->wakeup_tries);
307 BT_ERR("hs_enable timeout: %d,%d,%d", adapter->hs_state,
308 adapter->ps_state, adapter->wakeup_tries);
311 BT_DBG("host sleep enabled: %d,%d,%d", adapter->hs_state,
312 adapter->ps_state, adapter->wakeup_tries);
318 EXPORT_SYMBOL_GPL(btmrvl_enable_hs);
320 int btmrvl_prepare_command(struct btmrvl_private *priv)
324 if (priv->btmrvl_dev.hscfgcmd) {
325 priv->btmrvl_dev.hscfgcmd = 0;
326 btmrvl_send_hscfg_cmd(priv);
329 if (priv->btmrvl_dev.pscmd) {
330 priv->btmrvl_dev.pscmd = 0;
331 btmrvl_enable_ps(priv);
334 if (priv->btmrvl_dev.hscmd) {
335 priv->btmrvl_dev.hscmd = 0;
337 if (priv->btmrvl_dev.hsmode) {
338 ret = btmrvl_enable_hs(priv);
340 ret = priv->hw_wakeup_firmware(priv);
341 priv->adapter->hs_state = HS_DEACTIVATED;
342 BT_DBG("BT: HS DEACTIVATED due to host activity!");
349 void btmrvl_firmware_dump(struct btmrvl_private *priv)
351 if (priv->firmware_dump)
352 priv->firmware_dump(priv);
355 static int btmrvl_tx_pkt(struct btmrvl_private *priv, struct sk_buff *skb)
359 if (!skb || !skb->data)
362 if (!skb->len || ((skb->len + BTM_HEADER_LEN) > BTM_UPLD_SIZE)) {
363 BT_ERR("Tx Error: Bad skb length %d : %d",
364 skb->len, BTM_UPLD_SIZE);
368 if (skb_headroom(skb) < BTM_HEADER_LEN) {
369 struct sk_buff *tmp = skb;
371 skb = skb_realloc_headroom(skb, BTM_HEADER_LEN);
373 BT_ERR("Tx Error: realloc_headroom failed %d",
382 skb_push(skb, BTM_HEADER_LEN);
384 /* header type: byte[3]
385 * HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor
386 * header length: byte[2][1][0]
389 skb->data[0] = (skb->len & 0x0000ff);
390 skb->data[1] = (skb->len & 0x00ff00) >> 8;
391 skb->data[2] = (skb->len & 0xff0000) >> 16;
392 skb->data[3] = bt_cb(skb)->pkt_type;
394 if (priv->hw_host_to_card)
395 ret = priv->hw_host_to_card(priv, skb->data, skb->len);
400 static void btmrvl_init_adapter(struct btmrvl_private *priv)
404 skb_queue_head_init(&priv->adapter->tx_queue);
406 priv->adapter->ps_state = PS_AWAKE;
408 buf_size = ALIGN_SZ(SDIO_BLOCK_SIZE, BTSDIO_DMA_ALIGN);
409 priv->adapter->hw_regs_buf = kzalloc(buf_size, GFP_KERNEL);
410 if (!priv->adapter->hw_regs_buf) {
411 priv->adapter->hw_regs = NULL;
412 BT_ERR("Unable to allocate buffer for hw_regs.");
414 priv->adapter->hw_regs =
415 (u8 *)ALIGN_ADDR(priv->adapter->hw_regs_buf,
417 BT_DBG("hw_regs_buf=%p hw_regs=%p",
418 priv->adapter->hw_regs_buf, priv->adapter->hw_regs);
421 init_waitqueue_head(&priv->adapter->cmd_wait_q);
422 init_waitqueue_head(&priv->adapter->event_hs_wait_q);
425 static void btmrvl_free_adapter(struct btmrvl_private *priv)
427 skb_queue_purge(&priv->adapter->tx_queue);
429 kfree(priv->adapter->hw_regs_buf);
430 kfree(priv->adapter);
432 priv->adapter = NULL;
435 static int btmrvl_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
437 struct btmrvl_private *priv = hci_get_drvdata(hdev);
439 BT_DBG("type=%d, len=%d", skb->pkt_type, skb->len);
441 if (!test_bit(HCI_RUNNING, &hdev->flags)) {
442 BT_ERR("Failed testing HCI_RUNING, flags=%lx", hdev->flags);
443 print_hex_dump_bytes("data: ", DUMP_PREFIX_OFFSET,
444 skb->data, skb->len);
448 switch (bt_cb(skb)->pkt_type) {
449 case HCI_COMMAND_PKT:
453 case HCI_ACLDATA_PKT:
457 case HCI_SCODATA_PKT:
462 skb_queue_tail(&priv->adapter->tx_queue, skb);
464 wake_up_interruptible(&priv->main_thread.wait_q);
469 static int btmrvl_flush(struct hci_dev *hdev)
471 struct btmrvl_private *priv = hci_get_drvdata(hdev);
473 skb_queue_purge(&priv->adapter->tx_queue);
478 static int btmrvl_close(struct hci_dev *hdev)
480 struct btmrvl_private *priv = hci_get_drvdata(hdev);
482 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
485 skb_queue_purge(&priv->adapter->tx_queue);
490 static int btmrvl_open(struct hci_dev *hdev)
492 set_bit(HCI_RUNNING, &hdev->flags);
497 static int btmrvl_download_cal_data(struct btmrvl_private *priv,
507 print_hex_dump_bytes("Calibration data: ",
508 DUMP_PREFIX_OFFSET, data, BT_CAL_HDR_LEN + len);
510 ret = btmrvl_send_sync_cmd(priv, BT_CMD_LOAD_CONFIG_DATA, data,
511 BT_CAL_HDR_LEN + len);
513 BT_ERR("Failed to download caibration data");
518 static int btmrvl_check_device_tree(struct btmrvl_private *priv)
520 struct device_node *dt_node;
521 u8 cal_data[BT_CAL_HDR_LEN + BT_CAL_DATA_SIZE];
525 for_each_compatible_node(dt_node, NULL, "btmrvl,cfgdata") {
526 ret = of_property_read_u32(dt_node, "btmrvl,gpio-gap", &val);
528 priv->btmrvl_dev.gpio_gap = val;
530 ret = of_property_read_u8_array(dt_node, "btmrvl,cal-data",
531 cal_data + BT_CAL_HDR_LEN,
536 BT_DBG("Use cal data from device tree");
537 ret = btmrvl_download_cal_data(priv, cal_data,
540 BT_ERR("Fail to download calibrate data");
548 static int btmrvl_setup(struct hci_dev *hdev)
550 struct btmrvl_private *priv = hci_get_drvdata(hdev);
553 ret = btmrvl_send_module_cfg_cmd(priv, MODULE_BRINGUP_REQ);
557 priv->btmrvl_dev.gpio_gap = 0xffff;
559 btmrvl_check_device_tree(priv);
561 btmrvl_pscan_window_reporting(priv, 0x01);
563 priv->btmrvl_dev.psmode = 1;
564 btmrvl_enable_ps(priv);
566 btmrvl_send_hscfg_cmd(priv);
571 static int btmrvl_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
577 buf[0] = MRVL_VENDOR_PKT;
578 buf[1] = sizeof(bdaddr_t);
579 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
581 skb = __hci_cmd_sync(hdev, BT_CMD_SET_BDADDR, sizeof(buf), buf,
585 BT_ERR("%s: changing btmrvl device address failed (%ld)",
595 * This function handles the event generated by firmware, rx data
596 * received from firmware, and tx data sent from kernel.
598 static int btmrvl_service_main_thread(void *data)
600 struct btmrvl_thread *thread = data;
601 struct btmrvl_private *priv = thread->priv;
602 struct btmrvl_adapter *adapter = priv->adapter;
607 init_waitqueue_entry(&wait, current);
610 add_wait_queue(&thread->wait_q, &wait);
612 set_current_state(TASK_INTERRUPTIBLE);
613 if (kthread_should_stop() || priv->surprise_removed) {
614 BT_DBG("main_thread: break from main thread");
618 if (adapter->wakeup_tries ||
619 ((!adapter->int_count) &&
620 (!priv->btmrvl_dev.tx_dnld_rdy ||
621 skb_queue_empty(&adapter->tx_queue)))) {
622 BT_DBG("main_thread is sleeping...");
626 set_current_state(TASK_RUNNING);
628 remove_wait_queue(&thread->wait_q, &wait);
630 BT_DBG("main_thread woke up");
632 if (kthread_should_stop() || priv->surprise_removed) {
633 BT_DBG("main_thread: break from main thread");
637 spin_lock_irqsave(&priv->driver_lock, flags);
638 if (adapter->int_count) {
639 adapter->int_count = 0;
640 spin_unlock_irqrestore(&priv->driver_lock, flags);
641 priv->hw_process_int_status(priv);
642 } else if (adapter->ps_state == PS_SLEEP &&
643 !skb_queue_empty(&adapter->tx_queue)) {
644 spin_unlock_irqrestore(&priv->driver_lock, flags);
645 adapter->wakeup_tries++;
646 priv->hw_wakeup_firmware(priv);
649 spin_unlock_irqrestore(&priv->driver_lock, flags);
652 if (adapter->ps_state == PS_SLEEP)
655 if (!priv->btmrvl_dev.tx_dnld_rdy)
658 skb = skb_dequeue(&adapter->tx_queue);
660 if (btmrvl_tx_pkt(priv, skb))
661 priv->btmrvl_dev.hcidev->stat.err_tx++;
663 priv->btmrvl_dev.hcidev->stat.byte_tx += skb->len;
672 int btmrvl_register_hdev(struct btmrvl_private *priv)
674 struct hci_dev *hdev = NULL;
677 hdev = hci_alloc_dev();
679 BT_ERR("Can not allocate HCI device");
683 priv->btmrvl_dev.hcidev = hdev;
684 hci_set_drvdata(hdev, priv);
686 hdev->bus = HCI_SDIO;
687 hdev->open = btmrvl_open;
688 hdev->close = btmrvl_close;
689 hdev->flush = btmrvl_flush;
690 hdev->send = btmrvl_send_frame;
691 hdev->setup = btmrvl_setup;
692 hdev->set_bdaddr = btmrvl_set_bdaddr;
694 hdev->dev_type = priv->btmrvl_dev.dev_type;
696 ret = hci_register_dev(hdev);
698 BT_ERR("Can not register HCI device");
699 goto err_hci_register_dev;
702 #ifdef CONFIG_DEBUG_FS
703 btmrvl_debugfs_init(hdev);
708 err_hci_register_dev:
712 /* Stop the thread servicing the interrupts */
713 kthread_stop(priv->main_thread.task);
715 btmrvl_free_adapter(priv);
720 EXPORT_SYMBOL_GPL(btmrvl_register_hdev);
722 struct btmrvl_private *btmrvl_add_card(void *card)
724 struct btmrvl_private *priv;
726 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
728 BT_ERR("Can not allocate priv");
732 priv->adapter = kzalloc(sizeof(*priv->adapter), GFP_KERNEL);
733 if (!priv->adapter) {
734 BT_ERR("Allocate buffer for btmrvl_adapter failed!");
738 btmrvl_init_adapter(priv);
740 BT_DBG("Starting kthread...");
741 priv->main_thread.priv = priv;
742 spin_lock_init(&priv->driver_lock);
744 init_waitqueue_head(&priv->main_thread.wait_q);
745 priv->main_thread.task = kthread_run(btmrvl_service_main_thread,
746 &priv->main_thread, "btmrvl_main_service");
747 if (IS_ERR(priv->main_thread.task))
750 priv->btmrvl_dev.card = card;
751 priv->btmrvl_dev.tx_dnld_rdy = true;
756 btmrvl_free_adapter(priv);
764 EXPORT_SYMBOL_GPL(btmrvl_add_card);
766 int btmrvl_remove_card(struct btmrvl_private *priv)
768 struct hci_dev *hdev;
770 hdev = priv->btmrvl_dev.hcidev;
772 wake_up_interruptible(&priv->adapter->cmd_wait_q);
773 wake_up_interruptible(&priv->adapter->event_hs_wait_q);
775 kthread_stop(priv->main_thread.task);
777 #ifdef CONFIG_DEBUG_FS
778 btmrvl_debugfs_remove(hdev);
781 hci_unregister_dev(hdev);
785 priv->btmrvl_dev.hcidev = NULL;
787 btmrvl_free_adapter(priv);
793 EXPORT_SYMBOL_GPL(btmrvl_remove_card);
795 MODULE_AUTHOR("Marvell International Ltd.");
796 MODULE_DESCRIPTION("Marvell Bluetooth driver ver " VERSION);
797 MODULE_VERSION(VERSION);
798 MODULE_LICENSE("GPL v2");