1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2018 MediaTek Inc.
5 * Bluetooth support for MediaTek serial devices
7 * Author: Sean Wang <sean.wang@mediatek.com>
11 #include <asm/unaligned.h>
12 #include <linux/atomic.h>
13 #include <linux/clk.h>
14 #include <linux/firmware.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/iopoll.h>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
20 #include <linux/of_device.h>
21 #include <linux/pinctrl/consumer.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/serdev.h>
25 #include <linux/skbuff.h>
27 #include <net/bluetooth/bluetooth.h>
28 #include <net/bluetooth/hci_core.h>
34 #define FIRMWARE_MT7622 "/*(DEBLOBBED)*/"
35 #define FIRMWARE_MT7663 "/*(DEBLOBBED)*/"
36 #define FIRMWARE_MT7668 "/*(DEBLOBBED)*/"
38 #define MTK_STP_TLR_SIZE 2
40 #define BTMTKUART_TX_STATE_ACTIVE 1
41 #define BTMTKUART_TX_STATE_WAKEUP 2
42 #define BTMTKUART_TX_WAIT_VND_EVT 3
43 #define BTMTKUART_REQUIRED_WAKEUP 4
45 #define BTMTKUART_FLAG_STANDALONE_HW BIT(0)
48 MTK_WMT_PATCH_DWNLD = 0x1,
52 MTK_WMT_FUNC_CTRL = 0x6,
54 MTK_WMT_SEMAPHORE = 0x17,
59 BTMTK_WMT_PATCH_UNDONE,
63 BTMTK_WMT_ON_PROGRESS,
72 struct btmtkuart_data {
84 struct mtk_hci_wmt_cmd {
85 struct mtk_wmt_hdr hdr;
89 struct btmtk_hci_wmt_evt {
90 struct hci_event_hdr hhdr;
91 struct mtk_wmt_hdr whdr;
94 struct btmtk_hci_wmt_evt_funcc {
95 struct btmtk_hci_wmt_evt hwhdr;
99 struct btmtk_tci_sleep {
102 __le16 host_duration;
104 u8 time_compensation;
107 struct btmtk_hci_wmt_params {
115 struct btmtkuart_dev {
116 struct hci_dev *hdev;
117 struct serdev_device *serdev;
121 struct regulator *vcc;
122 struct gpio_desc *reset;
123 struct gpio_desc *boot;
124 struct pinctrl *pinctrl;
125 struct pinctrl_state *pins_runtime;
126 struct pinctrl_state *pins_boot;
127 speed_t desired_speed;
130 struct work_struct tx_work;
131 unsigned long tx_state;
132 struct sk_buff_head txq;
134 struct sk_buff *rx_skb;
135 struct sk_buff *evt_skb;
141 const struct btmtkuart_data *data;
144 #define btmtkuart_is_standalone(bdev) \
145 ((bdev)->data->flags & BTMTKUART_FLAG_STANDALONE_HW)
146 #define btmtkuart_is_builtin_soc(bdev) \
147 !((bdev)->data->flags & BTMTKUART_FLAG_STANDALONE_HW)
149 static int mtk_hci_wmt_sync(struct hci_dev *hdev,
150 struct btmtk_hci_wmt_params *wmt_params)
152 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
153 struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
154 u32 hlen, status = BTMTK_WMT_INVALID;
155 struct btmtk_hci_wmt_evt *wmt_evt;
156 struct mtk_hci_wmt_cmd wc;
157 struct mtk_wmt_hdr *hdr;
160 hlen = sizeof(*hdr) + wmt_params->dlen;
166 hdr = (struct mtk_wmt_hdr *)&wc;
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(BTMTKUART_TX_WAIT_VND_EVT, &bdev->tx_state);
175 err = __hci_cmd_send(hdev, 0xfc6f, hlen, &wc);
177 clear_bit(BTMTKUART_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 BTMTKUART_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, BTMTKUART_TX_WAIT_VND_EVT,
191 TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
193 bt_dev_err(hdev, "Execution of wmt command interrupted");
194 clear_bit(BTMTKUART_TX_WAIT_VND_EVT, &bdev->tx_state);
199 bt_dev_err(hdev, "Execution of wmt command timed out");
200 clear_bit(BTMTKUART_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 MTK_WMT_SEMAPHORE:
216 if (wmt_evt->whdr.flag == 2)
217 status = BTMTK_WMT_PATCH_UNDONE;
219 status = BTMTK_WMT_PATCH_DONE;
221 case MTK_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;
232 if (wmt_params->status)
233 *wmt_params->status = status;
236 kfree_skb(bdev->evt_skb);
237 bdev->evt_skb = NULL;
242 static int mtk_setup_firmware(struct hci_dev *hdev, const char *fwname)
244 struct btmtk_hci_wmt_params wmt_params;
245 const struct firmware *fw;
251 err = reject_firmware(&fw, fwname, &hdev->dev);
253 bt_dev_err(hdev, "Failed to load firmware file (%d)", err);
260 /* The size of patch header is 30 bytes, should be skip */
270 wmt_params.op = MTK_WMT_PATCH_DWNLD;
271 wmt_params.status = NULL;
273 while (fw_size > 0) {
274 dlen = min_t(int, 250, fw_size);
276 /* Tell device the position in sequence */
277 if (fw_size - dlen <= 0)
279 else if (fw_size < fw->size - 30)
282 wmt_params.flag = flag;
283 wmt_params.dlen = dlen;
284 wmt_params.data = fw_ptr;
286 err = mtk_hci_wmt_sync(hdev, &wmt_params);
288 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
297 wmt_params.op = MTK_WMT_RST;
300 wmt_params.data = NULL;
301 wmt_params.status = NULL;
303 /* Activate funciton the firmware providing to */
304 err = mtk_hci_wmt_sync(hdev, &wmt_params);
306 bt_dev_err(hdev, "Failed to send wmt rst (%d)", err);
310 /* Wait a few moments for firmware activation done */
311 usleep_range(10000, 12000);
314 release_firmware(fw);
318 static int btmtkuart_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
320 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
321 struct hci_event_hdr *hdr = (void *)skb->data;
324 /* Fix up the vendor event id with 0xff for vendor specific instead
325 * of 0xe4 so that event send via monitoring socket can be parsed
328 if (hdr->evt == 0xe4)
329 hdr->evt = HCI_EV_VENDOR;
331 /* When someone waits for the WMT event, the skb is being cloned
332 * and being processed the events from there then.
334 if (test_bit(BTMTKUART_TX_WAIT_VND_EVT, &bdev->tx_state)) {
335 bdev->evt_skb = skb_clone(skb, GFP_KERNEL);
336 if (!bdev->evt_skb) {
342 err = hci_recv_frame(hdev, skb);
346 if (hdr->evt == HCI_EV_VENDOR) {
347 if (test_and_clear_bit(BTMTKUART_TX_WAIT_VND_EVT,
349 /* Barrier to sync with other CPUs */
350 smp_mb__after_atomic();
351 wake_up_bit(&bdev->tx_state, BTMTKUART_TX_WAIT_VND_EVT);
358 kfree_skb(bdev->evt_skb);
359 bdev->evt_skb = NULL;
365 static const struct h4_recv_pkt mtk_recv_pkts[] = {
366 { H4_RECV_ACL, .recv = hci_recv_frame },
367 { H4_RECV_SCO, .recv = hci_recv_frame },
368 { H4_RECV_EVENT, .recv = btmtkuart_recv_event },
371 static void btmtkuart_tx_work(struct work_struct *work)
373 struct btmtkuart_dev *bdev = container_of(work, struct btmtkuart_dev,
375 struct serdev_device *serdev = bdev->serdev;
376 struct hci_dev *hdev = bdev->hdev;
379 clear_bit(BTMTKUART_TX_STATE_WAKEUP, &bdev->tx_state);
382 struct sk_buff *skb = skb_dequeue(&bdev->txq);
388 len = serdev_device_write_buf(serdev, skb->data,
390 hdev->stat.byte_tx += len;
394 skb_queue_head(&bdev->txq, skb);
398 switch (hci_skb_pkt_type(skb)) {
399 case HCI_COMMAND_PKT:
402 case HCI_ACLDATA_PKT:
405 case HCI_SCODATA_PKT:
413 if (!test_bit(BTMTKUART_TX_STATE_WAKEUP, &bdev->tx_state))
417 clear_bit(BTMTKUART_TX_STATE_ACTIVE, &bdev->tx_state);
420 static void btmtkuart_tx_wakeup(struct btmtkuart_dev *bdev)
422 if (test_and_set_bit(BTMTKUART_TX_STATE_ACTIVE, &bdev->tx_state))
423 set_bit(BTMTKUART_TX_STATE_WAKEUP, &bdev->tx_state);
425 schedule_work(&bdev->tx_work);
428 static const unsigned char *
429 mtk_stp_split(struct btmtkuart_dev *bdev, const unsigned char *data, int count,
432 struct mtk_stp_hdr *shdr;
434 /* The cursor is reset when all the data of STP is consumed out */
435 if (!bdev->stp_dlen && bdev->stp_cursor >= 6)
436 bdev->stp_cursor = 0;
438 /* Filling pad until all STP info is obtained */
439 while (bdev->stp_cursor < 6 && count > 0) {
440 bdev->stp_pad[bdev->stp_cursor] = *data;
446 /* Retrieve STP info and have a sanity check */
447 if (!bdev->stp_dlen && bdev->stp_cursor >= 6) {
448 shdr = (struct mtk_stp_hdr *)&bdev->stp_pad[2];
449 bdev->stp_dlen = be16_to_cpu(shdr->dlen) & 0x0fff;
451 /* Resync STP when unexpected data is being read */
452 if (shdr->prefix != 0x80 || bdev->stp_dlen > 2048) {
453 bt_dev_err(bdev->hdev, "stp format unexpect (%d, %d)",
454 shdr->prefix, bdev->stp_dlen);
455 bdev->stp_cursor = 2;
460 /* Directly quit when there's no data found for H4 can process */
464 /* Tranlate to how much the size of data H4 can handle so far */
465 *sz_h4 = min_t(int, count, bdev->stp_dlen);
467 /* Update the remaining size of STP packet */
468 bdev->stp_dlen -= *sz_h4;
470 /* Data points to STP payload which can be handled by H4 */
474 static void btmtkuart_recv(struct hci_dev *hdev, const u8 *data, size_t count)
476 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
477 const unsigned char *p_left = data, *p_h4;
478 int sz_left = count, sz_h4, adv;
481 while (sz_left > 0) {
482 /* The serial data received from MT7622 BT controller is
483 * at all time padded around with the STP header and tailer.
485 * A full STP packet is looking like
486 * -----------------------------------
487 * | STP header | H:4 | STP tailer |
488 * -----------------------------------
489 * but it doesn't guarantee to contain a full H:4 packet which
490 * means that it's possible for multiple STP packets forms a
491 * full H:4 packet that means extra STP header + length doesn't
492 * indicate a full H:4 frame, things can fragment. Whose length
493 * recorded in STP header just shows up the most length the
494 * H:4 engine can handle currently.
497 p_h4 = mtk_stp_split(bdev, p_left, sz_left, &sz_h4);
505 bdev->rx_skb = h4_recv_buf(bdev->hdev, bdev->rx_skb, p_h4,
506 sz_h4, mtk_recv_pkts,
507 ARRAY_SIZE(mtk_recv_pkts));
508 if (IS_ERR(bdev->rx_skb)) {
509 err = PTR_ERR(bdev->rx_skb);
510 bt_dev_err(bdev->hdev,
511 "Frame reassembly failed (%d)", err);
521 static int btmtkuart_receive_buf(struct serdev_device *serdev, const u8 *data,
524 struct btmtkuart_dev *bdev = serdev_device_get_drvdata(serdev);
526 btmtkuart_recv(bdev->hdev, data, count);
528 bdev->hdev->stat.byte_rx += count;
533 static void btmtkuart_write_wakeup(struct serdev_device *serdev)
535 struct btmtkuart_dev *bdev = serdev_device_get_drvdata(serdev);
537 btmtkuart_tx_wakeup(bdev);
540 static const struct serdev_device_ops btmtkuart_client_ops = {
541 .receive_buf = btmtkuart_receive_buf,
542 .write_wakeup = btmtkuart_write_wakeup,
545 static int btmtkuart_open(struct hci_dev *hdev)
547 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
551 err = serdev_device_open(bdev->serdev);
553 bt_dev_err(hdev, "Unable to open UART device %s",
554 dev_name(&bdev->serdev->dev));
558 if (btmtkuart_is_standalone(bdev)) {
559 if (bdev->curr_speed != bdev->desired_speed)
560 err = serdev_device_set_baudrate(bdev->serdev,
563 err = serdev_device_set_baudrate(bdev->serdev,
564 bdev->desired_speed);
567 bt_dev_err(hdev, "Unable to set baudrate UART device %s",
568 dev_name(&bdev->serdev->dev));
569 goto err_serdev_close;
572 serdev_device_set_flow_control(bdev->serdev, false);
575 bdev->stp_cursor = 2;
578 dev = &bdev->serdev->dev;
580 /* Enable the power domain and clock the device requires */
581 pm_runtime_enable(dev);
582 err = pm_runtime_get_sync(dev);
584 pm_runtime_put_noidle(dev);
585 goto err_disable_rpm;
588 err = clk_prepare_enable(bdev->clk);
595 pm_runtime_put_sync(dev);
597 pm_runtime_disable(dev);
599 serdev_device_close(bdev->serdev);
604 static int btmtkuart_close(struct hci_dev *hdev)
606 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
607 struct device *dev = &bdev->serdev->dev;
609 /* Shutdown the clock and power domain the device requires */
610 clk_disable_unprepare(bdev->clk);
611 pm_runtime_put_sync(dev);
612 pm_runtime_disable(dev);
614 serdev_device_close(bdev->serdev);
619 static int btmtkuart_flush(struct hci_dev *hdev)
621 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
623 /* Flush any pending characters */
624 serdev_device_write_flush(bdev->serdev);
625 skb_queue_purge(&bdev->txq);
627 cancel_work_sync(&bdev->tx_work);
629 kfree_skb(bdev->rx_skb);
632 bdev->stp_cursor = 2;
638 static int btmtkuart_func_query(struct hci_dev *hdev)
640 struct btmtk_hci_wmt_params wmt_params;
644 /* Query whether the function is enabled */
645 wmt_params.op = MTK_WMT_FUNC_CTRL;
647 wmt_params.dlen = sizeof(param);
648 wmt_params.data = ¶m;
649 wmt_params.status = &status;
651 err = mtk_hci_wmt_sync(hdev, &wmt_params);
653 bt_dev_err(hdev, "Failed to query function status (%d)", err);
660 static int btmtkuart_change_baudrate(struct hci_dev *hdev)
662 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
663 struct btmtk_hci_wmt_params wmt_params;
668 /* Indicate the device to enter the probe state the host is
669 * ready to change a new baudrate.
671 baudrate = cpu_to_le32(bdev->desired_speed);
672 wmt_params.op = MTK_WMT_HIF;
675 wmt_params.data = &baudrate;
676 wmt_params.status = NULL;
678 err = mtk_hci_wmt_sync(hdev, &wmt_params);
680 bt_dev_err(hdev, "Failed to device baudrate (%d)", err);
684 err = serdev_device_set_baudrate(bdev->serdev,
685 bdev->desired_speed);
687 bt_dev_err(hdev, "Failed to set up host baudrate (%d)",
692 serdev_device_set_flow_control(bdev->serdev, false);
694 /* Send a dummy byte 0xff to activate the new baudrate */
696 err = serdev_device_write_buf(bdev->serdev, ¶m, sizeof(param));
697 if (err < 0 || err < sizeof(param))
700 serdev_device_wait_until_sent(bdev->serdev, 0);
702 /* Wait some time for the device changing baudrate done */
703 usleep_range(20000, 22000);
705 /* Test the new baudrate */
706 wmt_params.op = MTK_WMT_TEST;
709 wmt_params.data = NULL;
710 wmt_params.status = NULL;
712 err = mtk_hci_wmt_sync(hdev, &wmt_params);
714 bt_dev_err(hdev, "Failed to test new baudrate (%d)",
719 bdev->curr_speed = bdev->desired_speed;
724 static int btmtkuart_setup(struct hci_dev *hdev)
726 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
727 struct btmtk_hci_wmt_params wmt_params;
728 ktime_t calltime, delta, rettime;
729 struct btmtk_tci_sleep tci_sleep;
730 unsigned long long duration;
735 calltime = ktime_get();
737 /* Wakeup MCUSYS is required for certain devices before we start to
740 if (test_bit(BTMTKUART_REQUIRED_WAKEUP, &bdev->tx_state)) {
741 wmt_params.op = MTK_WMT_WAKEUP;
744 wmt_params.data = NULL;
745 wmt_params.status = NULL;
747 err = mtk_hci_wmt_sync(hdev, &wmt_params);
749 bt_dev_err(hdev, "Failed to wakeup the chip (%d)", err);
753 clear_bit(BTMTKUART_REQUIRED_WAKEUP, &bdev->tx_state);
756 if (btmtkuart_is_standalone(bdev))
757 btmtkuart_change_baudrate(hdev);
759 /* Query whether the firmware is already download */
760 wmt_params.op = MTK_WMT_SEMAPHORE;
763 wmt_params.data = NULL;
764 wmt_params.status = &status;
766 err = mtk_hci_wmt_sync(hdev, &wmt_params);
768 bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
772 if (status == BTMTK_WMT_PATCH_DONE) {
773 bt_dev_info(hdev, "Firmware already downloaded");
774 goto ignore_setup_fw;
777 /* Setup a firmware which the device definitely requires */
778 err = mtk_setup_firmware(hdev, bdev->data->fwname);
783 /* Query whether the device is already enabled */
784 err = readx_poll_timeout(btmtkuart_func_query, hdev, status,
785 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
787 /* -ETIMEDOUT happens */
791 /* The other errors happen in btusb_mtk_func_query */
795 if (status == BTMTK_WMT_ON_DONE) {
796 bt_dev_info(hdev, "function already on");
800 /* Enable Bluetooth protocol */
801 wmt_params.op = MTK_WMT_FUNC_CTRL;
803 wmt_params.dlen = sizeof(param);
804 wmt_params.data = ¶m;
805 wmt_params.status = NULL;
807 err = mtk_hci_wmt_sync(hdev, &wmt_params);
809 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
814 /* Apply the low power environment setup */
815 tci_sleep.mode = 0x5;
816 tci_sleep.duration = cpu_to_le16(0x640);
817 tci_sleep.host_duration = cpu_to_le16(0x640);
818 tci_sleep.host_wakeup_pin = 0;
819 tci_sleep.time_compensation = 0;
821 skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
825 bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
830 rettime = ktime_get();
831 delta = ktime_sub(rettime, calltime);
832 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
834 bt_dev_info(hdev, "Device setup in %llu usecs", duration);
839 static int btmtkuart_shutdown(struct hci_dev *hdev)
841 struct btmtk_hci_wmt_params wmt_params;
845 /* Disable the device */
846 wmt_params.op = MTK_WMT_FUNC_CTRL;
848 wmt_params.dlen = sizeof(param);
849 wmt_params.data = ¶m;
850 wmt_params.status = NULL;
852 err = mtk_hci_wmt_sync(hdev, &wmt_params);
854 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
861 static int btmtkuart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
863 struct btmtkuart_dev *bdev = hci_get_drvdata(hdev);
864 struct mtk_stp_hdr *shdr;
865 int err, dlen, type = 0;
867 /* Prepend skb with frame type */
868 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
870 /* Make sure that there is enough rooms for STP header and trailer */
871 if (unlikely(skb_headroom(skb) < sizeof(*shdr)) ||
872 (skb_tailroom(skb) < MTK_STP_TLR_SIZE)) {
873 err = pskb_expand_head(skb, sizeof(*shdr), MTK_STP_TLR_SIZE,
879 /* Add the STP header */
881 shdr = skb_push(skb, sizeof(*shdr));
883 shdr->dlen = cpu_to_be16((dlen & 0x0fff) | (type << 12));
884 shdr->cs = 0; /* MT7622 doesn't care about checksum value */
886 /* Add the STP trailer */
887 skb_put_zero(skb, MTK_STP_TLR_SIZE);
889 skb_queue_tail(&bdev->txq, skb);
891 btmtkuart_tx_wakeup(bdev);
895 static int btmtkuart_parse_dt(struct serdev_device *serdev)
897 struct btmtkuart_dev *bdev = serdev_device_get_drvdata(serdev);
898 struct device_node *node = serdev->dev.of_node;
902 if (btmtkuart_is_standalone(bdev)) {
903 of_property_read_u32(node, "current-speed", &speed);
905 bdev->desired_speed = speed;
907 bdev->vcc = devm_regulator_get(&serdev->dev, "vcc");
908 if (IS_ERR(bdev->vcc)) {
909 err = PTR_ERR(bdev->vcc);
913 bdev->osc = devm_clk_get_optional(&serdev->dev, "osc");
914 if (IS_ERR(bdev->osc)) {
915 err = PTR_ERR(bdev->osc);
919 bdev->boot = devm_gpiod_get_optional(&serdev->dev, "boot",
921 if (IS_ERR(bdev->boot)) {
922 err = PTR_ERR(bdev->boot);
926 bdev->pinctrl = devm_pinctrl_get(&serdev->dev);
927 if (IS_ERR(bdev->pinctrl)) {
928 err = PTR_ERR(bdev->pinctrl);
932 bdev->pins_boot = pinctrl_lookup_state(bdev->pinctrl,
934 if (IS_ERR(bdev->pins_boot) && !bdev->boot) {
935 err = PTR_ERR(bdev->pins_boot);
936 dev_err(&serdev->dev,
937 "Should assign RXD to LOW at boot stage\n");
941 bdev->pins_runtime = pinctrl_lookup_state(bdev->pinctrl,
943 if (IS_ERR(bdev->pins_runtime)) {
944 err = PTR_ERR(bdev->pins_runtime);
948 bdev->reset = devm_gpiod_get_optional(&serdev->dev, "reset",
950 if (IS_ERR(bdev->reset)) {
951 err = PTR_ERR(bdev->reset);
954 } else if (btmtkuart_is_builtin_soc(bdev)) {
955 bdev->clk = devm_clk_get(&serdev->dev, "ref");
956 if (IS_ERR(bdev->clk))
957 return PTR_ERR(bdev->clk);
963 static int btmtkuart_probe(struct serdev_device *serdev)
965 struct btmtkuart_dev *bdev;
966 struct hci_dev *hdev;
969 bdev = devm_kzalloc(&serdev->dev, sizeof(*bdev), GFP_KERNEL);
973 bdev->data = of_device_get_match_data(&serdev->dev);
977 bdev->serdev = serdev;
978 serdev_device_set_drvdata(serdev, bdev);
980 serdev_device_set_client_ops(serdev, &btmtkuart_client_ops);
982 err = btmtkuart_parse_dt(serdev);
986 INIT_WORK(&bdev->tx_work, btmtkuart_tx_work);
987 skb_queue_head_init(&bdev->txq);
989 /* Initialize and register HCI device */
990 hdev = hci_alloc_dev();
992 dev_err(&serdev->dev, "Can't allocate HCI device\n");
998 hdev->bus = HCI_UART;
999 hci_set_drvdata(hdev, bdev);
1001 hdev->open = btmtkuart_open;
1002 hdev->close = btmtkuart_close;
1003 hdev->flush = btmtkuart_flush;
1004 hdev->setup = btmtkuart_setup;
1005 hdev->shutdown = btmtkuart_shutdown;
1006 hdev->send = btmtkuart_send_frame;
1007 SET_HCIDEV_DEV(hdev, &serdev->dev);
1009 hdev->manufacturer = 70;
1010 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
1012 if (btmtkuart_is_standalone(bdev)) {
1013 err = clk_prepare_enable(bdev->osc);
1015 goto err_hci_free_dev;
1018 gpiod_set_value_cansleep(bdev->boot, 1);
1020 /* Switch to the specific pin state for the booting
1023 pinctrl_select_state(bdev->pinctrl, bdev->pins_boot);
1027 err = regulator_enable(bdev->vcc);
1029 goto err_clk_disable_unprepare;
1031 /* Reset if the reset-gpios is available otherwise the board
1032 * -level design should be guaranteed.
1035 gpiod_set_value_cansleep(bdev->reset, 1);
1036 usleep_range(1000, 2000);
1037 gpiod_set_value_cansleep(bdev->reset, 0);
1040 /* Wait some time until device got ready and switch to the pin
1041 * mode the device requires for UART transfers.
1046 devm_gpiod_put(&serdev->dev, bdev->boot);
1048 pinctrl_select_state(bdev->pinctrl, bdev->pins_runtime);
1050 /* A standalone device doesn't depends on power domain on SoC,
1051 * so mark it as no callbacks.
1053 pm_runtime_no_callbacks(&serdev->dev);
1055 set_bit(BTMTKUART_REQUIRED_WAKEUP, &bdev->tx_state);
1058 err = hci_register_dev(hdev);
1060 dev_err(&serdev->dev, "Can't register HCI device\n");
1061 goto err_regulator_disable;
1066 err_regulator_disable:
1067 if (btmtkuart_is_standalone(bdev))
1068 regulator_disable(bdev->vcc);
1069 err_clk_disable_unprepare:
1070 if (btmtkuart_is_standalone(bdev))
1071 clk_disable_unprepare(bdev->osc);
1078 static void btmtkuart_remove(struct serdev_device *serdev)
1080 struct btmtkuart_dev *bdev = serdev_device_get_drvdata(serdev);
1081 struct hci_dev *hdev = bdev->hdev;
1083 if (btmtkuart_is_standalone(bdev)) {
1084 regulator_disable(bdev->vcc);
1085 clk_disable_unprepare(bdev->osc);
1088 hci_unregister_dev(hdev);
1092 static const struct btmtkuart_data mt7622_data = {
1093 .fwname = FIRMWARE_MT7622,
1096 static const struct btmtkuart_data mt7663_data = {
1097 .flags = BTMTKUART_FLAG_STANDALONE_HW,
1098 .fwname = FIRMWARE_MT7663,
1101 static const struct btmtkuart_data mt7668_data = {
1102 .flags = BTMTKUART_FLAG_STANDALONE_HW,
1103 .fwname = FIRMWARE_MT7668,
1107 static const struct of_device_id mtk_of_match_table[] = {
1108 { .compatible = "mediatek,mt7622-bluetooth", .data = &mt7622_data},
1109 { .compatible = "mediatek,mt7663u-bluetooth", .data = &mt7663_data},
1110 { .compatible = "mediatek,mt7668u-bluetooth", .data = &mt7668_data},
1113 MODULE_DEVICE_TABLE(of, mtk_of_match_table);
1116 static struct serdev_device_driver btmtkuart_driver = {
1117 .probe = btmtkuart_probe,
1118 .remove = btmtkuart_remove,
1120 .name = "btmtkuart",
1121 .of_match_table = of_match_ptr(mtk_of_match_table),
1125 module_serdev_device_driver(btmtkuart_driver);
1127 MODULE_AUTHOR("Sean Wang <sean.wang@mediatek.com>");
1128 MODULE_DESCRIPTION("MediaTek Bluetooth Serial driver ver " VERSION);
1129 MODULE_VERSION(VERSION);
1130 MODULE_LICENSE("GPL");