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>
26 #include "btmrvl_drv.h"
31 * This function is called by interface specific interrupt handler.
32 * It updates Power Save & Host Sleep states, and wakes up the main
35 void btmrvl_interrupt(struct btmrvl_private *priv)
37 priv->adapter->ps_state = PS_AWAKE;
39 priv->adapter->wakeup_tries = 0;
41 priv->adapter->int_count++;
43 wake_up_interruptible(&priv->main_thread.wait_q);
45 EXPORT_SYMBOL_GPL(btmrvl_interrupt);
47 bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb)
49 struct hci_event_hdr *hdr = (void *) skb->data;
51 if (hdr->evt == HCI_EV_CMD_COMPLETE) {
52 struct hci_ev_cmd_complete *ec;
55 ec = (void *) (skb->data + HCI_EVENT_HDR_SIZE);
56 opcode = __le16_to_cpu(ec->opcode);
57 ocf = hci_opcode_ocf(opcode);
58 ogf = hci_opcode_ogf(opcode);
60 if (priv->btmrvl_dev.sendcmdflag) {
61 priv->btmrvl_dev.sendcmdflag = false;
62 priv->adapter->cmd_complete = true;
63 wake_up_interruptible(&priv->adapter->cmd_wait_q);
67 BT_DBG("vendor event skipped: ogf 0x%4.4x ocf 0x%4.4x",
76 EXPORT_SYMBOL_GPL(btmrvl_check_evtpkt);
78 int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb)
80 struct btmrvl_adapter *adapter = priv->adapter;
81 struct btmrvl_event *event;
84 event = (struct btmrvl_event *) skb->data;
85 if (event->ec != 0xff) {
86 BT_DBG("Not Marvell Event=%x", event->ec);
91 switch (event->data[0]) {
92 case BT_CMD_AUTO_SLEEP_MODE:
93 if (!event->data[2]) {
94 if (event->data[1] == BT_PS_ENABLE)
99 (adapter->psmode) ? "Enable" : "Disable");
101 BT_DBG("PS Mode command failed");
105 case BT_CMD_HOST_SLEEP_CONFIG:
107 BT_DBG("gpio=%x, gap=%x", event->data[1],
110 BT_DBG("HSCFG command failed");
113 case BT_CMD_HOST_SLEEP_ENABLE:
114 if (!event->data[1]) {
115 adapter->hs_state = HS_ACTIVATED;
117 adapter->ps_state = PS_SLEEP;
118 BT_DBG("HS ACTIVATED!");
120 BT_DBG("HS Enable failed");
124 case BT_CMD_MODULE_CFG_REQ:
125 if (priv->btmrvl_dev.sendcmdflag &&
126 event->data[1] == MODULE_BRINGUP_REQ) {
128 ((event->data[2] == MODULE_BROUGHT_UP) ||
129 (event->data[2] == MODULE_ALREADY_UP)) ?
130 "Bring-up succeed" : "Bring-up failed");
132 if (event->length > 3 && event->data[3])
133 priv->btmrvl_dev.dev_type = HCI_AMP;
135 priv->btmrvl_dev.dev_type = HCI_BREDR;
137 BT_DBG("dev_type: %d", priv->btmrvl_dev.dev_type);
138 } else if (priv->btmrvl_dev.sendcmdflag &&
139 event->data[1] == MODULE_SHUTDOWN_REQ) {
140 BT_DBG("EVENT:%s", (event->data[2]) ?
141 "Shutdown failed" : "Shutdown succeed");
143 BT_DBG("BT_CMD_MODULE_CFG_REQ resp for APP");
148 case BT_EVENT_POWER_STATE:
149 if (event->data[1] == BT_PS_SLEEP)
150 adapter->ps_state = PS_SLEEP;
152 (adapter->ps_state) ? "PS_SLEEP" : "PS_AWAKE");
156 BT_DBG("Unknown Event=%d", event->data[0]);
167 EXPORT_SYMBOL_GPL(btmrvl_process_event);
169 static int btmrvl_send_sync_cmd(struct btmrvl_private *priv, u16 cmd_no,
170 const void *param, u8 len)
173 struct hci_command_hdr *hdr;
175 skb = bt_skb_alloc(HCI_COMMAND_HDR_SIZE + len, GFP_ATOMIC);
177 BT_ERR("No free skb");
181 hdr = (struct hci_command_hdr *)skb_put(skb, HCI_COMMAND_HDR_SIZE);
182 hdr->opcode = cpu_to_le16(hci_opcode_pack(OGF, cmd_no));
186 memcpy(skb_put(skb, len), param, len);
188 bt_cb(skb)->pkt_type = MRVL_VENDOR_PKT;
190 skb->dev = (void *) priv->btmrvl_dev.hcidev;
191 skb_queue_head(&priv->adapter->tx_queue, skb);
193 priv->btmrvl_dev.sendcmdflag = true;
195 priv->adapter->cmd_complete = false;
197 wake_up_interruptible(&priv->main_thread.wait_q);
199 if (!wait_event_interruptible_timeout(priv->adapter->cmd_wait_q,
200 priv->adapter->cmd_complete,
201 msecs_to_jiffies(WAIT_UNTIL_CMD_RESP)))
207 int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, int subcmd)
211 ret = btmrvl_send_sync_cmd(priv, BT_CMD_MODULE_CFG_REQ, &subcmd, 1);
213 BT_ERR("module_cfg_cmd(%x) failed\n", subcmd);
217 EXPORT_SYMBOL_GPL(btmrvl_send_module_cfg_cmd);
219 int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv)
224 param[0] = (priv->btmrvl_dev.gpio_gap & 0xff00) >> 8;
225 param[1] = (u8) (priv->btmrvl_dev.gpio_gap & 0x00ff);
227 BT_DBG("Sending HSCFG Command, gpio=0x%x, gap=0x%x",
230 ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_CONFIG, param, 2);
232 BT_ERR("HSCFG command failed\n");
236 EXPORT_SYMBOL_GPL(btmrvl_send_hscfg_cmd);
238 int btmrvl_enable_ps(struct btmrvl_private *priv)
243 if (priv->btmrvl_dev.psmode)
244 param = BT_PS_ENABLE;
246 param = BT_PS_DISABLE;
248 ret = btmrvl_send_sync_cmd(priv, BT_CMD_AUTO_SLEEP_MODE, ¶m, 1);
250 BT_ERR("PSMODE command failed\n");
254 EXPORT_SYMBOL_GPL(btmrvl_enable_ps);
256 int btmrvl_enable_hs(struct btmrvl_private *priv)
260 ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_ENABLE, NULL, 0);
262 BT_ERR("Host sleep enable command failed\n");
266 EXPORT_SYMBOL_GPL(btmrvl_enable_hs);
268 int btmrvl_prepare_command(struct btmrvl_private *priv)
272 if (priv->btmrvl_dev.hscfgcmd) {
273 priv->btmrvl_dev.hscfgcmd = 0;
274 btmrvl_send_hscfg_cmd(priv);
277 if (priv->btmrvl_dev.pscmd) {
278 priv->btmrvl_dev.pscmd = 0;
279 btmrvl_enable_ps(priv);
282 if (priv->btmrvl_dev.hscmd) {
283 priv->btmrvl_dev.hscmd = 0;
285 if (priv->btmrvl_dev.hsmode) {
286 ret = btmrvl_enable_hs(priv);
288 ret = priv->hw_wakeup_firmware(priv);
289 priv->adapter->hs_state = HS_DEACTIVATED;
296 static int btmrvl_tx_pkt(struct btmrvl_private *priv, struct sk_buff *skb)
300 if (!skb || !skb->data)
303 if (!skb->len || ((skb->len + BTM_HEADER_LEN) > BTM_UPLD_SIZE)) {
304 BT_ERR("Tx Error: Bad skb length %d : %d",
305 skb->len, BTM_UPLD_SIZE);
309 if (skb_headroom(skb) < BTM_HEADER_LEN) {
310 struct sk_buff *tmp = skb;
312 skb = skb_realloc_headroom(skb, BTM_HEADER_LEN);
314 BT_ERR("Tx Error: realloc_headroom failed %d",
323 skb_push(skb, BTM_HEADER_LEN);
325 /* header type: byte[3]
326 * HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor
327 * header length: byte[2][1][0]
330 skb->data[0] = (skb->len & 0x0000ff);
331 skb->data[1] = (skb->len & 0x00ff00) >> 8;
332 skb->data[2] = (skb->len & 0xff0000) >> 16;
333 skb->data[3] = bt_cb(skb)->pkt_type;
335 if (priv->hw_host_to_card)
336 ret = priv->hw_host_to_card(priv, skb->data, skb->len);
341 static void btmrvl_init_adapter(struct btmrvl_private *priv)
343 skb_queue_head_init(&priv->adapter->tx_queue);
345 priv->adapter->ps_state = PS_AWAKE;
347 init_waitqueue_head(&priv->adapter->cmd_wait_q);
350 static void btmrvl_free_adapter(struct btmrvl_private *priv)
352 skb_queue_purge(&priv->adapter->tx_queue);
354 kfree(priv->adapter);
356 priv->adapter = NULL;
359 static int btmrvl_ioctl(struct hci_dev *hdev,
360 unsigned int cmd, unsigned long arg)
365 static int btmrvl_send_frame(struct sk_buff *skb)
367 struct hci_dev *hdev = (struct hci_dev *) skb->dev;
368 struct btmrvl_private *priv = NULL;
370 BT_DBG("type=%d, len=%d", skb->pkt_type, skb->len);
373 BT_ERR("Frame for unknown HCI device");
377 priv = hci_get_drvdata(hdev);
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);
386 switch (bt_cb(skb)->pkt_type) {
387 case HCI_COMMAND_PKT:
391 case HCI_ACLDATA_PKT:
395 case HCI_SCODATA_PKT:
400 skb_queue_tail(&priv->adapter->tx_queue, skb);
402 wake_up_interruptible(&priv->main_thread.wait_q);
407 static int btmrvl_flush(struct hci_dev *hdev)
409 struct btmrvl_private *priv = hci_get_drvdata(hdev);
411 skb_queue_purge(&priv->adapter->tx_queue);
416 static int btmrvl_close(struct hci_dev *hdev)
418 struct btmrvl_private *priv = hci_get_drvdata(hdev);
420 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
423 skb_queue_purge(&priv->adapter->tx_queue);
428 static int btmrvl_open(struct hci_dev *hdev)
430 set_bit(HCI_RUNNING, &hdev->flags);
436 * This function parses provided calibration data input. It should contain
437 * hex bytes separated by space or new line character. Here is an example.
438 * 00 1C 01 37 FF FF FF FF 02 04 7F 01
439 * CE BA 00 00 00 2D C6 C0 00 00 00 00
442 static int btmrvl_parse_cal_cfg(const u8 *src, u32 len, u8 *dst, u32 dst_size)
450 while ((s - src) <= len - 2) {
457 if ((d - dst) >= dst_size) {
458 BT_ERR("calibration data file too big!!!");
464 ret = kstrtou8(tmp, 16, d++);
479 static int btmrvl_load_cal_data(struct btmrvl_private *priv,
483 u8 data[BT_CMD_DATA_SIZE];
488 data[3] = BT_CMD_DATA_SIZE - 4;
490 /* Swap cal-data bytes. Each four bytes are swapped. Considering 4
491 * byte SDIO header offset, mapping of input and output bytes will be
492 * {3, 2, 1, 0} -> {0+4, 1+4, 2+4, 3+4},
493 * {7, 6, 5, 4} -> {4+4, 5+4, 6+4, 7+4} */
494 for (i = 4; i < BT_CMD_DATA_SIZE; i++)
495 data[i] = config_data[(i / 4) * 8 - 1 - i];
497 print_hex_dump_bytes("Calibration data: ",
498 DUMP_PREFIX_OFFSET, data, BT_CMD_DATA_SIZE);
500 ret = btmrvl_send_sync_cmd(priv, BT_CMD_LOAD_CONFIG_DATA, data,
503 BT_ERR("Failed to download caibration data\n");
509 btmrvl_process_cal_cfg(struct btmrvl_private *priv, u8 *data, u32 size)
511 u8 cal_data[BT_CAL_DATA_SIZE];
514 ret = btmrvl_parse_cal_cfg(data, size, cal_data, sizeof(cal_data));
518 ret = btmrvl_load_cal_data(priv, cal_data);
520 BT_ERR("Fail to load calibrate data");
527 static int btmrvl_cal_data_config(struct btmrvl_private *priv)
529 const struct firmware *cfg;
531 const char *cal_data = priv->btmrvl_dev.cal_data;
536 ret = request_firmware(&cfg, cal_data, priv->btmrvl_dev.dev);
538 BT_DBG("Failed to get %s file, skipping cal data download",
543 ret = btmrvl_process_cal_cfg(priv, (u8 *)cfg->data, cfg->size);
544 release_firmware(cfg);
548 static int btmrvl_setup(struct hci_dev *hdev)
550 struct btmrvl_private *priv = hci_get_drvdata(hdev);
552 btmrvl_send_module_cfg_cmd(priv, MODULE_BRINGUP_REQ);
554 if (btmrvl_cal_data_config(priv))
555 BT_ERR("Set cal data failed");
557 priv->btmrvl_dev.psmode = 1;
558 btmrvl_enable_ps(priv);
560 priv->btmrvl_dev.gpio_gap = 0xffff;
561 btmrvl_send_hscfg_cmd(priv);
567 * This function handles the event generated by firmware, rx data
568 * received from firmware, and tx data sent from kernel.
570 static int btmrvl_service_main_thread(void *data)
572 struct btmrvl_thread *thread = data;
573 struct btmrvl_private *priv = thread->priv;
574 struct btmrvl_adapter *adapter = priv->adapter;
579 init_waitqueue_entry(&wait, current);
582 add_wait_queue(&thread->wait_q, &wait);
584 set_current_state(TASK_INTERRUPTIBLE);
585 if (kthread_should_stop()) {
586 BT_DBG("main_thread: break from main thread");
590 if (adapter->wakeup_tries ||
591 ((!adapter->int_count) &&
592 (!priv->btmrvl_dev.tx_dnld_rdy ||
593 skb_queue_empty(&adapter->tx_queue)))) {
594 BT_DBG("main_thread is sleeping...");
598 set_current_state(TASK_RUNNING);
600 remove_wait_queue(&thread->wait_q, &wait);
602 BT_DBG("main_thread woke up");
604 spin_lock_irqsave(&priv->driver_lock, flags);
605 if (adapter->int_count) {
606 adapter->int_count = 0;
607 spin_unlock_irqrestore(&priv->driver_lock, flags);
608 priv->hw_process_int_status(priv);
609 } else if (adapter->ps_state == PS_SLEEP &&
610 !skb_queue_empty(&adapter->tx_queue)) {
611 spin_unlock_irqrestore(&priv->driver_lock, flags);
612 adapter->wakeup_tries++;
613 priv->hw_wakeup_firmware(priv);
616 spin_unlock_irqrestore(&priv->driver_lock, flags);
619 if (adapter->ps_state == PS_SLEEP)
622 if (!priv->btmrvl_dev.tx_dnld_rdy)
625 skb = skb_dequeue(&adapter->tx_queue);
627 if (btmrvl_tx_pkt(priv, skb))
628 priv->btmrvl_dev.hcidev->stat.err_tx++;
630 priv->btmrvl_dev.hcidev->stat.byte_tx += skb->len;
639 int btmrvl_register_hdev(struct btmrvl_private *priv)
641 struct hci_dev *hdev = NULL;
644 hdev = hci_alloc_dev();
646 BT_ERR("Can not allocate HCI device");
650 priv->btmrvl_dev.hcidev = hdev;
651 hci_set_drvdata(hdev, priv);
653 hdev->bus = HCI_SDIO;
654 hdev->open = btmrvl_open;
655 hdev->close = btmrvl_close;
656 hdev->flush = btmrvl_flush;
657 hdev->send = btmrvl_send_frame;
658 hdev->ioctl = btmrvl_ioctl;
659 hdev->setup = btmrvl_setup;
661 hdev->dev_type = priv->btmrvl_dev.dev_type;
663 ret = hci_register_dev(hdev);
665 BT_ERR("Can not register HCI device");
666 goto err_hci_register_dev;
669 #ifdef CONFIG_DEBUG_FS
670 btmrvl_debugfs_init(hdev);
675 err_hci_register_dev:
679 /* Stop the thread servicing the interrupts */
680 kthread_stop(priv->main_thread.task);
682 btmrvl_free_adapter(priv);
687 EXPORT_SYMBOL_GPL(btmrvl_register_hdev);
689 struct btmrvl_private *btmrvl_add_card(void *card)
691 struct btmrvl_private *priv;
693 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
695 BT_ERR("Can not allocate priv");
699 priv->adapter = kzalloc(sizeof(*priv->adapter), GFP_KERNEL);
700 if (!priv->adapter) {
701 BT_ERR("Allocate buffer for btmrvl_adapter failed!");
705 btmrvl_init_adapter(priv);
707 BT_DBG("Starting kthread...");
708 priv->main_thread.priv = priv;
709 spin_lock_init(&priv->driver_lock);
711 init_waitqueue_head(&priv->main_thread.wait_q);
712 priv->main_thread.task = kthread_run(btmrvl_service_main_thread,
713 &priv->main_thread, "btmrvl_main_service");
715 priv->btmrvl_dev.card = card;
716 priv->btmrvl_dev.tx_dnld_rdy = true;
726 EXPORT_SYMBOL_GPL(btmrvl_add_card);
728 int btmrvl_remove_card(struct btmrvl_private *priv)
730 struct hci_dev *hdev;
732 hdev = priv->btmrvl_dev.hcidev;
734 wake_up_interruptible(&priv->adapter->cmd_wait_q);
736 kthread_stop(priv->main_thread.task);
738 #ifdef CONFIG_DEBUG_FS
739 btmrvl_debugfs_remove(hdev);
742 hci_unregister_dev(hdev);
746 priv->btmrvl_dev.hcidev = NULL;
748 btmrvl_free_adapter(priv);
754 EXPORT_SYMBOL_GPL(btmrvl_remove_card);
756 MODULE_AUTHOR("Marvell International Ltd.");
757 MODULE_DESCRIPTION("Marvell Bluetooth driver ver " VERSION);
758 MODULE_VERSION(VERSION);
759 MODULE_LICENSE("GPL v2");