1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2019 MediaTek Inc.
5 * Bluetooth support for MediaTek SDIO devices
7 * This file is written based on btsdio.c and btmtkuart.c.
13 #include <asm/unaligned.h>
14 #include <linux/atomic.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/init.h>
17 #include <linux/iopoll.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/skbuff.h>
24 #include <linux/mmc/host.h>
25 #include <linux/mmc/sdio_ids.h>
26 #include <linux/mmc/sdio_func.h>
28 #include <net/bluetooth/bluetooth.h>
29 #include <net/bluetooth/hci_core.h>
36 #define MTKBTSDIO_AUTOSUSPEND_DELAY 1000
38 static bool enable_autosuspend = true;
40 struct btmtksdio_data {
43 bool lp_mbox_supported;
46 static const struct btmtksdio_data mt7663_data = {
47 .fwname = FIRMWARE_MT7663,
49 .lp_mbox_supported = false,
52 static const struct btmtksdio_data mt7668_data = {
53 .fwname = FIRMWARE_MT7668,
55 .lp_mbox_supported = false,
58 static const struct btmtksdio_data mt7921_data = {
59 .fwname = FIRMWARE_MT7961,
61 .lp_mbox_supported = true,
64 static const struct sdio_device_id btmtksdio_table[] = {
65 {SDIO_DEVICE(SDIO_VENDOR_ID_MEDIATEK, SDIO_DEVICE_ID_MEDIATEK_MT7663),
66 .driver_data = (kernel_ulong_t)&mt7663_data },
67 {SDIO_DEVICE(SDIO_VENDOR_ID_MEDIATEK, SDIO_DEVICE_ID_MEDIATEK_MT7668),
68 .driver_data = (kernel_ulong_t)&mt7668_data },
69 {SDIO_DEVICE(SDIO_VENDOR_ID_MEDIATEK, SDIO_DEVICE_ID_MEDIATEK_MT7961),
70 .driver_data = (kernel_ulong_t)&mt7921_data },
71 { } /* Terminating entry */
73 MODULE_DEVICE_TABLE(sdio, btmtksdio_table);
75 #define MTK_REG_CHLPCR 0x4 /* W1S */
76 #define C_INT_EN_SET BIT(0)
77 #define C_INT_EN_CLR BIT(1)
78 #define C_FW_OWN_REQ_SET BIT(8) /* For write */
79 #define C_COM_DRV_OWN BIT(8) /* For read */
80 #define C_FW_OWN_REQ_CLR BIT(9)
82 #define MTK_REG_CSDIOCSR 0x8
83 #define SDIO_RE_INIT_EN BIT(0)
84 #define SDIO_INT_CTL BIT(2)
86 #define MTK_REG_CHCR 0xc
87 #define C_INT_CLR_CTRL BIT(1)
88 #define BT_RST_DONE BIT(8)
90 /* CHISR have the same bits field definition with CHIER */
91 #define MTK_REG_CHISR 0x10
92 #define MTK_REG_CHIER 0x14
93 #define FW_OWN_BACK_INT BIT(0)
94 #define RX_DONE_INT BIT(1)
95 #define TX_EMPTY BIT(2)
96 #define TX_FIFO_OVERFLOW BIT(8)
97 #define FW_MAILBOX_INT BIT(15)
98 #define INT_MASK GENMASK(15, 0)
99 #define RX_PKT_LEN GENMASK(31, 16)
101 #define MTK_REG_CSICR 0xc0
102 #define CSICR_CLR_MBOX_ACK BIT(0)
103 #define MTK_REG_PH2DSM0R 0xc4
104 #define PH2DSM0R_DRIVER_OWN BIT(0)
105 #define MTK_REG_PD2HRM0R 0xdc
106 #define PD2HRM0R_DRV_OWN BIT(0)
108 #define MTK_REG_CTDR 0x18
110 #define MTK_REG_CRDR 0x1c
112 #define MTK_REG_CRPLR 0x24
114 #define MTK_SDIO_BLOCK_SIZE 256
116 #define BTMTKSDIO_TX_WAIT_VND_EVT 1
117 #define BTMTKSDIO_HW_TX_READY 2
118 #define BTMTKSDIO_FUNC_ENABLED 3
119 #define BTMTKSDIO_PATCH_ENABLED 4
120 #define BTMTKSDIO_HW_RESET_ACTIVE 5
121 #define BTMTKSDIO_BT_WAKE_ENABLED 6
123 struct mtkbtsdio_hdr {
129 struct btmtksdio_dev {
130 struct hci_dev *hdev;
131 struct sdio_func *func;
134 struct work_struct txrx_work;
135 unsigned long tx_state;
136 struct sk_buff_head txq;
138 struct sk_buff *evt_skb;
140 const struct btmtksdio_data *data;
142 struct gpio_desc *reset;
145 static int mtk_hci_wmt_sync(struct hci_dev *hdev,
146 struct btmtk_hci_wmt_params *wmt_params)
148 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
149 struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
150 struct btmtk_hci_wmt_evt_reg *wmt_evt_reg;
151 u32 hlen, status = BTMTK_WMT_INVALID;
152 struct btmtk_hci_wmt_evt *wmt_evt;
153 struct btmtk_hci_wmt_cmd *wc;
154 struct btmtk_wmt_hdr *hdr;
157 /* Send the WMT command and wait until the WMT event returns */
158 hlen = sizeof(*hdr) + wmt_params->dlen;
162 wc = kzalloc(hlen, GFP_KERNEL);
168 hdr->op = wmt_params->op;
169 hdr->dlen = cpu_to_le16(wmt_params->dlen + 1);
170 hdr->flag = wmt_params->flag;
171 memcpy(wc->data, wmt_params->data, wmt_params->dlen);
173 set_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
175 err = __hci_cmd_send(hdev, 0xfc6f, hlen, wc);
177 clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
181 /* The vendor specific WMT commands are all answered by a vendor
182 * specific event and will not have the Command Status or Command
183 * Complete as with usual HCI command flow control.
185 * After sending the command, wait for BTMTKSDIO_TX_WAIT_VND_EVT
186 * state to be cleared. The driver specific event receive routine
187 * will clear that state and with that indicate completion of the
190 err = wait_on_bit_timeout(&bdev->tx_state, BTMTKSDIO_TX_WAIT_VND_EVT,
191 TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
193 bt_dev_err(hdev, "Execution of wmt command interrupted");
194 clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
199 bt_dev_err(hdev, "Execution of wmt command timed out");
200 clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
205 /* Parse and handle the return WMT event */
206 wmt_evt = (struct btmtk_hci_wmt_evt *)bdev->evt_skb->data;
207 if (wmt_evt->whdr.op != hdr->op) {
208 bt_dev_err(hdev, "Wrong op received %d expected %d",
209 wmt_evt->whdr.op, hdr->op);
214 switch (wmt_evt->whdr.op) {
215 case BTMTK_WMT_SEMAPHORE:
216 if (wmt_evt->whdr.flag == 2)
217 status = BTMTK_WMT_PATCH_UNDONE;
219 status = BTMTK_WMT_PATCH_DONE;
221 case BTMTK_WMT_FUNC_CTRL:
222 wmt_evt_funcc = (struct btmtk_hci_wmt_evt_funcc *)wmt_evt;
223 if (be16_to_cpu(wmt_evt_funcc->status) == 0x404)
224 status = BTMTK_WMT_ON_DONE;
225 else if (be16_to_cpu(wmt_evt_funcc->status) == 0x420)
226 status = BTMTK_WMT_ON_PROGRESS;
228 status = BTMTK_WMT_ON_UNDONE;
230 case BTMTK_WMT_PATCH_DWNLD:
231 if (wmt_evt->whdr.flag == 2)
232 status = BTMTK_WMT_PATCH_DONE;
233 else if (wmt_evt->whdr.flag == 1)
234 status = BTMTK_WMT_PATCH_PROGRESS;
236 status = BTMTK_WMT_PATCH_UNDONE;
238 case BTMTK_WMT_REGISTER:
239 wmt_evt_reg = (struct btmtk_hci_wmt_evt_reg *)wmt_evt;
240 if (le16_to_cpu(wmt_evt->whdr.dlen) == 12)
241 status = le32_to_cpu(wmt_evt_reg->val);
245 if (wmt_params->status)
246 *wmt_params->status = status;
249 kfree_skb(bdev->evt_skb);
250 bdev->evt_skb = NULL;
257 static int btmtksdio_tx_packet(struct btmtksdio_dev *bdev,
260 struct mtkbtsdio_hdr *sdio_hdr;
263 /* Make sure that there are enough rooms for SDIO header */
264 if (unlikely(skb_headroom(skb) < sizeof(*sdio_hdr))) {
265 err = pskb_expand_head(skb, sizeof(*sdio_hdr), 0,
271 /* Prepend MediaTek SDIO Specific Header */
272 skb_push(skb, sizeof(*sdio_hdr));
274 sdio_hdr = (void *)skb->data;
275 sdio_hdr->len = cpu_to_le16(skb->len);
276 sdio_hdr->reserved = cpu_to_le16(0);
277 sdio_hdr->bt_type = hci_skb_pkt_type(skb);
279 clear_bit(BTMTKSDIO_HW_TX_READY, &bdev->tx_state);
280 err = sdio_writesb(bdev->func, MTK_REG_CTDR, skb->data,
281 round_up(skb->len, MTK_SDIO_BLOCK_SIZE));
285 bdev->hdev->stat.byte_tx += skb->len;
292 skb_pull(skb, sizeof(*sdio_hdr));
297 static u32 btmtksdio_drv_own_query(struct btmtksdio_dev *bdev)
299 return sdio_readl(bdev->func, MTK_REG_CHLPCR, NULL);
302 static u32 btmtksdio_drv_own_query_79xx(struct btmtksdio_dev *bdev)
304 return sdio_readl(bdev->func, MTK_REG_PD2HRM0R, NULL);
307 static u32 btmtksdio_chcr_query(struct btmtksdio_dev *bdev)
309 return sdio_readl(bdev->func, MTK_REG_CHCR, NULL);
312 static int btmtksdio_fw_pmctrl(struct btmtksdio_dev *bdev)
317 sdio_claim_host(bdev->func);
319 if (bdev->data->lp_mbox_supported &&
320 test_bit(BTMTKSDIO_PATCH_ENABLED, &bdev->tx_state)) {
321 sdio_writel(bdev->func, CSICR_CLR_MBOX_ACK, MTK_REG_CSICR,
323 err = readx_poll_timeout(btmtksdio_drv_own_query_79xx, bdev,
324 status, !(status & PD2HRM0R_DRV_OWN),
327 bt_dev_err(bdev->hdev, "mailbox ACK not cleared");
332 /* Return ownership to the device */
333 sdio_writel(bdev->func, C_FW_OWN_REQ_SET, MTK_REG_CHLPCR, &err);
337 err = readx_poll_timeout(btmtksdio_drv_own_query, bdev, status,
338 !(status & C_COM_DRV_OWN), 2000, 1000000);
341 sdio_release_host(bdev->func);
344 bt_dev_err(bdev->hdev, "Cannot return ownership to device");
349 static int btmtksdio_drv_pmctrl(struct btmtksdio_dev *bdev)
354 sdio_claim_host(bdev->func);
356 /* Get ownership from the device */
357 sdio_writel(bdev->func, C_FW_OWN_REQ_CLR, MTK_REG_CHLPCR, &err);
361 err = readx_poll_timeout(btmtksdio_drv_own_query, bdev, status,
362 status & C_COM_DRV_OWN, 2000, 1000000);
364 if (!err && bdev->data->lp_mbox_supported &&
365 test_bit(BTMTKSDIO_PATCH_ENABLED, &bdev->tx_state))
366 err = readx_poll_timeout(btmtksdio_drv_own_query_79xx, bdev,
367 status, status & PD2HRM0R_DRV_OWN,
371 sdio_release_host(bdev->func);
374 bt_dev_err(bdev->hdev, "Cannot get ownership from device");
379 static int btmtksdio_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
381 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
382 struct hci_event_hdr *hdr = (void *)skb->data;
386 /* When someone waits for the WMT event, the skb is being cloned
387 * and being processed the events from there then.
389 if (test_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state)) {
390 bdev->evt_skb = skb_clone(skb, GFP_KERNEL);
391 if (!bdev->evt_skb) {
397 err = hci_recv_frame(hdev, skb);
401 if (evt == HCI_EV_WMT) {
402 if (test_and_clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT,
404 /* Barrier to sync with other CPUs */
405 smp_mb__after_atomic();
406 wake_up_bit(&bdev->tx_state, BTMTKSDIO_TX_WAIT_VND_EVT);
413 kfree_skb(bdev->evt_skb);
414 bdev->evt_skb = NULL;
420 static int btmtksdio_recv_acl(struct hci_dev *hdev, struct sk_buff *skb)
422 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
423 u16 handle = le16_to_cpu(hci_acl_hdr(skb)->handle);
427 /* Firmware dump from device: when the firmware hangs, the
428 * device can no longer suspend and thus disable auto-suspend.
430 pm_runtime_forbid(bdev->dev);
434 /* Firmware debug logging */
435 return hci_recv_diag(hdev, skb);
438 return hci_recv_frame(hdev, skb);
441 static const struct h4_recv_pkt mtk_recv_pkts[] = {
442 { H4_RECV_ACL, .recv = btmtksdio_recv_acl },
443 { H4_RECV_SCO, .recv = hci_recv_frame },
444 { H4_RECV_EVENT, .recv = btmtksdio_recv_event },
447 static int btmtksdio_rx_packet(struct btmtksdio_dev *bdev, u16 rx_size)
449 const struct h4_recv_pkt *pkts = mtk_recv_pkts;
450 int pkts_count = ARRAY_SIZE(mtk_recv_pkts);
451 struct mtkbtsdio_hdr *sdio_hdr;
452 int err, i, pad_size;
456 if (rx_size < sizeof(*sdio_hdr))
459 /* A SDIO packet is exactly containing a Bluetooth packet */
460 skb = bt_skb_alloc(rx_size, GFP_KERNEL);
464 skb_put(skb, rx_size);
466 err = sdio_readsb(bdev->func, skb->data, MTK_REG_CRDR, rx_size);
470 sdio_hdr = (void *)skb->data;
472 /* We assume the default error as -EILSEQ simply to make the error path
477 if (rx_size != le16_to_cpu(sdio_hdr->len)) {
478 bt_dev_err(bdev->hdev, "Rx size in sdio header is mismatched ");
482 hci_skb_pkt_type(skb) = sdio_hdr->bt_type;
484 /* Remove MediaTek SDIO header */
485 skb_pull(skb, sizeof(*sdio_hdr));
487 /* We have to dig into the packet to get payload size and then know how
488 * many padding bytes at the tail, these padding bytes should be removed
489 * before the packet is indicated to the core layer.
491 for (i = 0; i < pkts_count; i++) {
492 if (sdio_hdr->bt_type == (&pkts[i])->type)
496 if (i >= pkts_count) {
497 bt_dev_err(bdev->hdev, "Invalid bt type 0x%02x",
502 /* Remaining bytes cannot hold a header*/
503 if (skb->len < (&pkts[i])->hlen) {
504 bt_dev_err(bdev->hdev, "The size of bt header is mismatched");
508 switch ((&pkts[i])->lsize) {
510 dlen = skb->data[(&pkts[i])->loff];
513 dlen = get_unaligned_le16(skb->data +
520 pad_size = skb->len - (&pkts[i])->hlen - dlen;
522 /* Remaining bytes cannot hold a payload */
524 bt_dev_err(bdev->hdev, "The size of bt payload is mismatched");
528 /* Remove padding bytes */
529 skb_trim(skb, skb->len - pad_size);
532 (&pkts[i])->recv(bdev->hdev, skb);
534 bdev->hdev->stat.byte_rx += rx_size;
544 static void btmtksdio_txrx_work(struct work_struct *work)
546 struct btmtksdio_dev *bdev = container_of(work, struct btmtksdio_dev,
548 unsigned long txrx_timeout;
549 u32 int_status, rx_size;
553 pm_runtime_get_sync(bdev->dev);
555 sdio_claim_host(bdev->func);
557 /* Disable interrupt */
558 sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, NULL);
560 txrx_timeout = jiffies + 5 * HZ;
563 int_status = sdio_readl(bdev->func, MTK_REG_CHISR, NULL);
565 /* Ack an interrupt as soon as possible before any operation on
568 * Note that we don't ack any status during operations to avoid race
569 * condition between the host and the device such as it's possible to
570 * mistakenly ack RX_DONE for the next packet and then cause interrupts
571 * not be raised again but there is still pending data in the hardware
574 sdio_writel(bdev->func, int_status, MTK_REG_CHISR, NULL);
575 int_status &= INT_MASK;
577 if ((int_status & FW_MAILBOX_INT) &&
578 bdev->data->chipid == 0x7921) {
579 sdio_writel(bdev->func, PH2DSM0R_DRIVER_OWN,
580 MTK_REG_PH2DSM0R, NULL);
583 if (int_status & FW_OWN_BACK_INT)
584 bt_dev_dbg(bdev->hdev, "Get fw own back");
586 if (int_status & TX_EMPTY)
587 set_bit(BTMTKSDIO_HW_TX_READY, &bdev->tx_state);
589 else if (unlikely(int_status & TX_FIFO_OVERFLOW))
590 bt_dev_warn(bdev->hdev, "Tx fifo overflow");
592 if (test_bit(BTMTKSDIO_HW_TX_READY, &bdev->tx_state)) {
593 skb = skb_dequeue(&bdev->txq);
595 err = btmtksdio_tx_packet(bdev, skb);
597 bdev->hdev->stat.err_tx++;
598 skb_queue_head(&bdev->txq, skb);
603 if (int_status & RX_DONE_INT) {
604 rx_size = sdio_readl(bdev->func, MTK_REG_CRPLR, NULL);
605 rx_size = (rx_size & RX_PKT_LEN) >> 16;
606 if (btmtksdio_rx_packet(bdev, rx_size) < 0)
607 bdev->hdev->stat.err_rx++;
609 } while (int_status || time_is_before_jiffies(txrx_timeout));
611 /* Enable interrupt */
612 sdio_writel(bdev->func, C_INT_EN_SET, MTK_REG_CHLPCR, NULL);
614 sdio_release_host(bdev->func);
616 pm_runtime_mark_last_busy(bdev->dev);
617 pm_runtime_put_autosuspend(bdev->dev);
620 static void btmtksdio_interrupt(struct sdio_func *func)
622 struct btmtksdio_dev *bdev = sdio_get_drvdata(func);
624 if (test_bit(BTMTKSDIO_BT_WAKE_ENABLED, &bdev->tx_state)) {
625 if (bdev->hdev->suspended)
626 pm_wakeup_event(bdev->dev, 0);
627 clear_bit(BTMTKSDIO_BT_WAKE_ENABLED, &bdev->tx_state);
630 /* Disable interrupt */
631 sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, NULL);
633 schedule_work(&bdev->txrx_work);
636 static int btmtksdio_open(struct hci_dev *hdev)
638 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
642 sdio_claim_host(bdev->func);
644 err = sdio_enable_func(bdev->func);
646 goto err_release_host;
648 set_bit(BTMTKSDIO_FUNC_ENABLED, &bdev->tx_state);
650 err = btmtksdio_drv_pmctrl(bdev);
652 goto err_disable_func;
654 /* Disable interrupt & mask out all interrupt sources */
655 sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, &err);
657 goto err_disable_func;
659 sdio_writel(bdev->func, 0, MTK_REG_CHIER, &err);
661 goto err_disable_func;
663 err = sdio_claim_irq(bdev->func, btmtksdio_interrupt);
665 goto err_disable_func;
667 err = sdio_set_block_size(bdev->func, MTK_SDIO_BLOCK_SIZE);
669 goto err_release_irq;
671 /* SDIO CMD 5 allows the SDIO device back to idle state an
672 * synchronous interrupt is supported in SDIO 4-bit mode
674 val = sdio_readl(bdev->func, MTK_REG_CSDIOCSR, &err);
676 goto err_release_irq;
679 sdio_writel(bdev->func, val, MTK_REG_CSDIOCSR, &err);
681 goto err_release_irq;
683 /* Explitly set write-1-clear method */
684 val = sdio_readl(bdev->func, MTK_REG_CHCR, &err);
686 goto err_release_irq;
688 val |= C_INT_CLR_CTRL;
689 sdio_writel(bdev->func, val, MTK_REG_CHCR, &err);
691 goto err_release_irq;
693 /* Setup interrupt sources */
694 sdio_writel(bdev->func, RX_DONE_INT | TX_EMPTY | TX_FIFO_OVERFLOW,
695 MTK_REG_CHIER, &err);
697 goto err_release_irq;
699 /* Enable interrupt */
700 sdio_writel(bdev->func, C_INT_EN_SET, MTK_REG_CHLPCR, &err);
702 goto err_release_irq;
704 sdio_release_host(bdev->func);
709 sdio_release_irq(bdev->func);
712 sdio_disable_func(bdev->func);
715 sdio_release_host(bdev->func);
720 static int btmtksdio_close(struct hci_dev *hdev)
722 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
724 sdio_claim_host(bdev->func);
726 /* Disable interrupt */
727 sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, NULL);
729 sdio_release_irq(bdev->func);
731 cancel_work_sync(&bdev->txrx_work);
733 btmtksdio_fw_pmctrl(bdev);
735 clear_bit(BTMTKSDIO_FUNC_ENABLED, &bdev->tx_state);
736 sdio_disable_func(bdev->func);
738 sdio_release_host(bdev->func);
743 static int btmtksdio_flush(struct hci_dev *hdev)
745 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
747 skb_queue_purge(&bdev->txq);
749 cancel_work_sync(&bdev->txrx_work);
754 static int btmtksdio_func_query(struct hci_dev *hdev)
756 struct btmtk_hci_wmt_params wmt_params;
760 /* Query whether the function is enabled */
761 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
763 wmt_params.dlen = sizeof(param);
764 wmt_params.data = ¶m;
765 wmt_params.status = &status;
767 err = mtk_hci_wmt_sync(hdev, &wmt_params);
769 bt_dev_err(hdev, "Failed to query function status (%d)", err);
776 static int mt76xx_setup(struct hci_dev *hdev, const char *fwname)
778 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
779 struct btmtk_hci_wmt_params wmt_params;
780 struct btmtk_tci_sleep tci_sleep;
785 /* Query whether the firmware is already download */
786 wmt_params.op = BTMTK_WMT_SEMAPHORE;
789 wmt_params.data = NULL;
790 wmt_params.status = &status;
792 err = mtk_hci_wmt_sync(hdev, &wmt_params);
794 bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
798 if (status == BTMTK_WMT_PATCH_DONE) {
799 bt_dev_info(hdev, "Firmware already downloaded");
800 goto ignore_setup_fw;
803 /* Setup a firmware which the device definitely requires */
804 err = btmtk_setup_firmware(hdev, fwname, mtk_hci_wmt_sync);
809 /* Query whether the device is already enabled */
810 err = readx_poll_timeout(btmtksdio_func_query, hdev, status,
811 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
813 /* -ETIMEDOUT happens */
817 /* The other errors happen in btusb_mtk_func_query */
821 if (status == BTMTK_WMT_ON_DONE) {
822 bt_dev_info(hdev, "function already on");
826 /* Enable Bluetooth protocol */
827 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
829 wmt_params.dlen = sizeof(param);
830 wmt_params.data = ¶m;
831 wmt_params.status = NULL;
833 err = mtk_hci_wmt_sync(hdev, &wmt_params);
835 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
839 set_bit(BTMTKSDIO_PATCH_ENABLED, &bdev->tx_state);
842 /* Apply the low power environment setup */
843 tci_sleep.mode = 0x5;
844 tci_sleep.duration = cpu_to_le16(0x640);
845 tci_sleep.host_duration = cpu_to_le16(0x640);
846 tci_sleep.host_wakeup_pin = 0;
847 tci_sleep.time_compensation = 0;
849 skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
853 bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
861 static int mt79xx_setup(struct hci_dev *hdev, const char *fwname)
863 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
864 struct btmtk_hci_wmt_params wmt_params;
868 err = btmtk_setup_firmware_79xx(hdev, fwname, mtk_hci_wmt_sync);
870 bt_dev_err(hdev, "Failed to setup 79xx firmware (%d)", err);
874 err = btmtksdio_fw_pmctrl(bdev);
878 err = btmtksdio_drv_pmctrl(bdev);
882 /* Enable Bluetooth protocol */
883 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
885 wmt_params.dlen = sizeof(param);
886 wmt_params.data = ¶m;
887 wmt_params.status = NULL;
889 err = mtk_hci_wmt_sync(hdev, &wmt_params);
891 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
895 hci_set_msft_opcode(hdev, 0xFD30);
896 hci_set_aosp_capable(hdev);
897 set_bit(BTMTKSDIO_PATCH_ENABLED, &bdev->tx_state);
902 static int btmtksdio_mtk_reg_read(struct hci_dev *hdev, u32 reg, u32 *val)
904 struct btmtk_hci_wmt_params wmt_params;
905 struct reg_read_cmd reg_read = {
912 reg_read.addr = cpu_to_le32(reg);
913 wmt_params.op = BTMTK_WMT_REGISTER;
914 wmt_params.flag = BTMTK_WMT_REG_READ;
915 wmt_params.dlen = sizeof(reg_read);
916 wmt_params.data = ®_read;
917 wmt_params.status = &status;
919 err = mtk_hci_wmt_sync(hdev, &wmt_params);
921 bt_dev_err(hdev, "Failed to read reg (%d)", err);
930 static int btmtksdio_mtk_reg_write(struct hci_dev *hdev, u32 reg, u32 val, u32 mask)
932 struct btmtk_hci_wmt_params wmt_params;
933 const struct reg_write_cmd reg_write = {
936 .addr = cpu_to_le32(reg),
937 .data = cpu_to_le32(val),
938 .mask = cpu_to_le32(mask),
942 wmt_params.op = BTMTK_WMT_REGISTER;
943 wmt_params.flag = BTMTK_WMT_REG_WRITE;
944 wmt_params.dlen = sizeof(reg_write);
945 wmt_params.data = ®_write;
946 wmt_params.status = &status;
948 err = mtk_hci_wmt_sync(hdev, &wmt_params);
950 bt_dev_err(hdev, "Failed to write reg (%d)", err);
955 static int btmtksdio_get_data_path_id(struct hci_dev *hdev, __u8 *data_path_id)
957 /* uses 1 as data path id for all the usecases */
962 static int btmtksdio_get_codec_config_data(struct hci_dev *hdev,
963 __u8 link, struct bt_codec *codec,
964 __u8 *ven_len, __u8 **ven_data)
968 if (!ven_data || !ven_len)
974 if (link != ESCO_LINK) {
975 bt_dev_err(hdev, "Invalid link type(%u)", link);
979 *ven_data = kmalloc(sizeof(__u8), GFP_KERNEL);
985 /* supports only CVSD and mSBC offload codecs */
995 bt_dev_err(hdev, "Invalid codec id(%u)", codec->id);
998 /* codec and its capabilities are pre-defined to ids
999 * preset id = 0x00 represents CVSD codec with sampling rate 8K
1000 * preset id = 0x01 represents mSBC codec with sampling rate 16K
1002 *ven_len = sizeof(__u8);
1011 static int btmtksdio_sco_setting(struct hci_dev *hdev)
1013 const struct btmtk_sco sco_setting = {
1014 .clock_config = 0x49,
1015 .channel_format_config = 0x80,
1017 struct sk_buff *skb;
1021 /* Enable SCO over I2S/PCM for MediaTek chipset */
1022 skb = __hci_cmd_sync(hdev, 0xfc72, sizeof(sco_setting),
1023 &sco_setting, HCI_CMD_TIMEOUT);
1025 return PTR_ERR(skb);
1029 err = btmtksdio_mtk_reg_read(hdev, MT7921_PINMUX_0, &val);
1034 err = btmtksdio_mtk_reg_write(hdev, MT7921_PINMUX_0, val, ~0);
1038 err = btmtksdio_mtk_reg_read(hdev, MT7921_PINMUX_1, &val);
1043 err = btmtksdio_mtk_reg_write(hdev, MT7921_PINMUX_1, val, ~0);
1047 hdev->get_data_path_id = btmtksdio_get_data_path_id;
1048 hdev->get_codec_config_data = btmtksdio_get_codec_config_data;
1053 static int btmtksdio_reset_setting(struct hci_dev *hdev)
1058 err = btmtksdio_mtk_reg_read(hdev, MT7921_PINMUX_1, &val);
1062 val |= 0x20; /* set the pin (bit field 11:8) work as GPIO mode */
1063 err = btmtksdio_mtk_reg_write(hdev, MT7921_PINMUX_1, val, ~0);
1067 err = btmtksdio_mtk_reg_read(hdev, MT7921_BTSYS_RST, &val);
1071 val |= MT7921_BTSYS_RST_WITH_GPIO;
1072 return btmtksdio_mtk_reg_write(hdev, MT7921_BTSYS_RST, val, ~0);
1075 static int btmtksdio_setup(struct hci_dev *hdev)
1077 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
1078 ktime_t calltime, delta, rettime;
1079 unsigned long long duration;
1082 u32 fw_version = 0, val;
1084 calltime = ktime_get();
1085 set_bit(BTMTKSDIO_HW_TX_READY, &bdev->tx_state);
1087 switch (bdev->data->chipid) {
1089 if (test_bit(BTMTKSDIO_HW_RESET_ACTIVE, &bdev->tx_state)) {
1090 err = btmtksdio_mtk_reg_read(hdev, MT7921_DLSTATUS,
1095 val &= ~BT_DL_STATE;
1096 err = btmtksdio_mtk_reg_write(hdev, MT7921_DLSTATUS,
1101 btmtksdio_fw_pmctrl(bdev);
1103 btmtksdio_drv_pmctrl(bdev);
1105 clear_bit(BTMTKSDIO_HW_RESET_ACTIVE, &bdev->tx_state);
1108 err = btmtksdio_mtk_reg_read(hdev, 0x70010200, &dev_id);
1110 bt_dev_err(hdev, "Failed to get device id (%d)", err);
1114 err = btmtksdio_mtk_reg_read(hdev, 0x80021004, &fw_version);
1116 bt_dev_err(hdev, "Failed to get fw version (%d)", err);
1120 snprintf(fwname, sizeof(fwname),
1121 "mediatek/BT_RAM_CODE_MT%04x_1_%x_hdr.bin",
1122 dev_id & 0xffff, (fw_version & 0xff) + 1);
1123 err = mt79xx_setup(hdev, fwname);
1127 /* Enable SCO over I2S/PCM */
1128 err = btmtksdio_sco_setting(hdev);
1130 bt_dev_err(hdev, "Failed to enable SCO setting (%d)", err);
1134 /* Enable WBS with mSBC codec */
1135 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED, &hdev->quirks);
1137 /* Enable GPIO reset mechanism */
1139 err = btmtksdio_reset_setting(hdev);
1141 bt_dev_err(hdev, "Failed to enable Reset setting (%d)", err);
1142 devm_gpiod_put(bdev->dev, bdev->reset);
1147 /* Valid LE States quirk for MediaTek 7921 */
1148 set_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks);
1153 err = mt76xx_setup(hdev, bdev->data->fwname);
1161 rettime = ktime_get();
1162 delta = ktime_sub(rettime, calltime);
1163 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
1165 pm_runtime_set_autosuspend_delay(bdev->dev,
1166 MTKBTSDIO_AUTOSUSPEND_DELAY);
1167 pm_runtime_use_autosuspend(bdev->dev);
1169 err = pm_runtime_set_active(bdev->dev);
1173 /* Default forbid runtime auto suspend, that can be allowed by
1174 * enable_autosuspend flag or the PM runtime entry under sysfs.
1176 pm_runtime_forbid(bdev->dev);
1177 pm_runtime_enable(bdev->dev);
1179 if (enable_autosuspend)
1180 pm_runtime_allow(bdev->dev);
1182 bt_dev_info(hdev, "Device setup in %llu usecs", duration);
1187 static int btmtksdio_shutdown(struct hci_dev *hdev)
1189 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
1190 struct btmtk_hci_wmt_params wmt_params;
1194 /* Get back the state to be consistent with the state
1195 * in btmtksdio_setup.
1197 pm_runtime_get_sync(bdev->dev);
1199 /* wmt command only works until the reset is complete */
1200 if (test_bit(BTMTKSDIO_HW_RESET_ACTIVE, &bdev->tx_state))
1201 goto ignore_wmt_cmd;
1203 /* Disable the device */
1204 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
1205 wmt_params.flag = 0;
1206 wmt_params.dlen = sizeof(param);
1207 wmt_params.data = ¶m;
1208 wmt_params.status = NULL;
1210 err = mtk_hci_wmt_sync(hdev, &wmt_params);
1212 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
1217 pm_runtime_put_noidle(bdev->dev);
1218 pm_runtime_disable(bdev->dev);
1223 static int btmtksdio_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1225 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
1227 switch (hci_skb_pkt_type(skb)) {
1228 case HCI_COMMAND_PKT:
1229 hdev->stat.cmd_tx++;
1232 case HCI_ACLDATA_PKT:
1233 hdev->stat.acl_tx++;
1236 case HCI_SCODATA_PKT:
1237 hdev->stat.sco_tx++;
1244 skb_queue_tail(&bdev->txq, skb);
1246 schedule_work(&bdev->txrx_work);
1251 static void btmtksdio_cmd_timeout(struct hci_dev *hdev)
1253 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
1257 if (!bdev->reset || bdev->data->chipid != 0x7921)
1260 pm_runtime_get_sync(bdev->dev);
1262 if (test_and_set_bit(BTMTKSDIO_HW_RESET_ACTIVE, &bdev->tx_state))
1265 sdio_claim_host(bdev->func);
1267 sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, NULL);
1268 skb_queue_purge(&bdev->txq);
1269 cancel_work_sync(&bdev->txrx_work);
1271 gpiod_set_value_cansleep(bdev->reset, 1);
1273 gpiod_set_value_cansleep(bdev->reset, 0);
1275 err = readx_poll_timeout(btmtksdio_chcr_query, bdev, status,
1276 status & BT_RST_DONE, 100000, 2000000);
1278 bt_dev_err(hdev, "Failed to reset (%d)", err);
1282 clear_bit(BTMTKSDIO_PATCH_ENABLED, &bdev->tx_state);
1284 sdio_release_host(bdev->func);
1286 pm_runtime_put_noidle(bdev->dev);
1287 pm_runtime_disable(bdev->dev);
1289 hci_reset_dev(hdev);
1292 static bool btmtksdio_sdio_inband_wakeup(struct hci_dev *hdev)
1294 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
1296 return device_may_wakeup(bdev->dev);
1299 static bool btmtksdio_sdio_wakeup(struct hci_dev *hdev)
1301 struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
1302 bool may_wakeup = device_may_wakeup(bdev->dev);
1303 const struct btmtk_wakeon bt_awake = {
1307 .enable_delay = cpu_to_le16(0xc80),
1308 .wakeup_delay = cpu_to_le16(0x20),
1311 if (may_wakeup && bdev->data->chipid == 0x7921) {
1312 struct sk_buff *skb;
1314 skb = __hci_cmd_sync(hdev, 0xfc27, sizeof(bt_awake),
1315 &bt_awake, HCI_CMD_TIMEOUT);
1325 static int btmtksdio_probe(struct sdio_func *func,
1326 const struct sdio_device_id *id)
1328 struct btmtksdio_dev *bdev;
1329 struct hci_dev *hdev;
1332 bdev = devm_kzalloc(&func->dev, sizeof(*bdev), GFP_KERNEL);
1336 bdev->data = (void *)id->driver_data;
1340 bdev->dev = &func->dev;
1343 INIT_WORK(&bdev->txrx_work, btmtksdio_txrx_work);
1344 skb_queue_head_init(&bdev->txq);
1346 /* Initialize and register HCI device */
1347 hdev = hci_alloc_dev();
1349 dev_err(&func->dev, "Can't allocate HCI device\n");
1355 hdev->bus = HCI_SDIO;
1356 hci_set_drvdata(hdev, bdev);
1358 hdev->open = btmtksdio_open;
1359 hdev->close = btmtksdio_close;
1360 hdev->cmd_timeout = btmtksdio_cmd_timeout;
1361 hdev->flush = btmtksdio_flush;
1362 hdev->setup = btmtksdio_setup;
1363 hdev->shutdown = btmtksdio_shutdown;
1364 hdev->send = btmtksdio_send_frame;
1365 hdev->wakeup = btmtksdio_sdio_wakeup;
1367 * If SDIO controller supports wake on Bluetooth, sending a wakeon
1368 * command is not necessary.
1370 if (device_can_wakeup(func->card->host->parent))
1371 hdev->wakeup = btmtksdio_sdio_inband_wakeup;
1373 hdev->wakeup = btmtksdio_sdio_wakeup;
1374 hdev->set_bdaddr = btmtk_set_bdaddr;
1376 SET_HCIDEV_DEV(hdev, &func->dev);
1378 hdev->manufacturer = 70;
1379 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
1381 sdio_set_drvdata(func, bdev);
1383 err = hci_register_dev(hdev);
1385 dev_err(&func->dev, "Can't register HCI device\n");
1390 /* pm_runtime_enable would be done after the firmware is being
1391 * downloaded because the core layer probably already enables
1392 * runtime PM for this func such as the case host->caps &
1393 * MMC_CAP_POWER_OFF_CARD.
1395 if (pm_runtime_enabled(bdev->dev))
1396 pm_runtime_disable(bdev->dev);
1398 /* As explaination in drivers/mmc/core/sdio_bus.c tells us:
1399 * Unbound SDIO functions are always suspended.
1400 * During probe, the function is set active and the usage count
1401 * is incremented. If the driver supports runtime PM,
1402 * it should call pm_runtime_put_noidle() in its probe routine and
1403 * pm_runtime_get_noresume() in its remove routine.
1405 * So, put a pm_runtime_put_noidle here !
1407 pm_runtime_put_noidle(bdev->dev);
1409 err = device_init_wakeup(bdev->dev, true);
1411 bt_dev_err(hdev, "failed to initialize device wakeup");
1413 bdev->dev->of_node = of_find_compatible_node(NULL, NULL,
1414 "mediatek,mt7921s-bluetooth");
1415 bdev->reset = devm_gpiod_get_optional(bdev->dev, "reset",
1417 if (IS_ERR(bdev->reset))
1418 err = PTR_ERR(bdev->reset);
1423 static void btmtksdio_remove(struct sdio_func *func)
1425 struct btmtksdio_dev *bdev = sdio_get_drvdata(func);
1426 struct hci_dev *hdev;
1431 /* Be consistent the state in btmtksdio_probe */
1432 pm_runtime_get_noresume(bdev->dev);
1436 sdio_set_drvdata(func, NULL);
1437 hci_unregister_dev(hdev);
1442 static int btmtksdio_runtime_suspend(struct device *dev)
1444 struct sdio_func *func = dev_to_sdio_func(dev);
1445 struct btmtksdio_dev *bdev;
1448 bdev = sdio_get_drvdata(func);
1452 if (!test_bit(BTMTKSDIO_FUNC_ENABLED, &bdev->tx_state))
1455 sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
1457 err = btmtksdio_fw_pmctrl(bdev);
1459 bt_dev_dbg(bdev->hdev, "status (%d) return ownership to device", err);
1464 static int btmtksdio_system_suspend(struct device *dev)
1466 struct sdio_func *func = dev_to_sdio_func(dev);
1467 struct btmtksdio_dev *bdev;
1469 bdev = sdio_get_drvdata(func);
1473 if (!test_bit(BTMTKSDIO_FUNC_ENABLED, &bdev->tx_state))
1476 set_bit(BTMTKSDIO_BT_WAKE_ENABLED, &bdev->tx_state);
1478 return btmtksdio_runtime_suspend(dev);
1481 static int btmtksdio_runtime_resume(struct device *dev)
1483 struct sdio_func *func = dev_to_sdio_func(dev);
1484 struct btmtksdio_dev *bdev;
1487 bdev = sdio_get_drvdata(func);
1491 if (!test_bit(BTMTKSDIO_FUNC_ENABLED, &bdev->tx_state))
1494 err = btmtksdio_drv_pmctrl(bdev);
1496 bt_dev_dbg(bdev->hdev, "status (%d) get ownership from device", err);
1501 static int btmtksdio_system_resume(struct device *dev)
1503 return btmtksdio_runtime_resume(dev);
1506 static const struct dev_pm_ops btmtksdio_pm_ops = {
1507 SYSTEM_SLEEP_PM_OPS(btmtksdio_system_suspend, btmtksdio_system_resume)
1508 RUNTIME_PM_OPS(btmtksdio_runtime_suspend, btmtksdio_runtime_resume, NULL)
1511 #define BTMTKSDIO_PM_OPS (&btmtksdio_pm_ops)
1512 #else /* CONFIG_PM */
1513 #define BTMTKSDIO_PM_OPS NULL
1514 #endif /* CONFIG_PM */
1516 static struct sdio_driver btmtksdio_driver = {
1517 .name = "btmtksdio",
1518 .probe = btmtksdio_probe,
1519 .remove = btmtksdio_remove,
1520 .id_table = btmtksdio_table,
1522 .owner = THIS_MODULE,
1523 .pm = BTMTKSDIO_PM_OPS,
1527 module_sdio_driver(btmtksdio_driver);
1529 module_param(enable_autosuspend, bool, 0644);
1530 MODULE_PARM_DESC(enable_autosuspend, "Enable autosuspend by default");
1533 MODULE_DESCRIPTION("MediaTek Bluetooth SDIO driver ver " VERSION);
1534 MODULE_VERSION(VERSION);
1535 MODULE_LICENSE("GPL");