1 // SPDX-License-Identifier: GPL-2.0-only
3 * Bluetooth Software UART Qualcomm protocol
5 * HCI_IBS (HCI In-Band Sleep) is Qualcomm's power management
6 * protocol extension to H4.
8 * Copyright (C) 2007 Texas Instruments, Inc.
9 * Copyright (c) 2010, 2012, 2018 The Linux Foundation. All rights reserved.
12 * This file is based on hci_ll.c, which was...
13 * Written by Ohad Ben-Cohen <ohad@bencohen.org>
14 * which was in turn based on hci_h4.c, which was written
15 * by Maxim Krasnyansky and Marcel Holtmann.
18 #include <linux/kernel.h>
19 #include <linux/clk.h>
20 #include <linux/completion.h>
21 #include <linux/debugfs.h>
22 #include <linux/delay.h>
23 #include <linux/devcoredump.h>
24 #include <linux/device.h>
25 #include <linux/gpio/consumer.h>
26 #include <linux/mod_devicetable.h>
27 #include <linux/module.h>
28 #include <linux/of_device.h>
29 #include <linux/acpi.h>
30 #include <linux/platform_device.h>
31 #include <linux/regulator/consumer.h>
32 #include <linux/serdev.h>
33 #include <linux/mutex.h>
34 #include <asm/unaligned.h>
36 #include <net/bluetooth/bluetooth.h>
37 #include <net/bluetooth/hci_core.h>
42 /* HCI_IBS protocol messages */
43 #define HCI_IBS_SLEEP_IND 0xFE
44 #define HCI_IBS_WAKE_IND 0xFD
45 #define HCI_IBS_WAKE_ACK 0xFC
46 #define HCI_MAX_IBS_SIZE 10
48 #define IBS_WAKE_RETRANS_TIMEOUT_MS 100
49 #define IBS_BTSOC_TX_IDLE_TIMEOUT_MS 40
50 #define IBS_HOST_TX_IDLE_TIMEOUT_MS 2000
51 #define CMD_TRANS_TIMEOUT_MS 100
52 #define MEMDUMP_TIMEOUT_MS 8000
55 #define SUSCLK_RATE_32KHZ 32768
57 /* Controller debug log header */
58 #define QCA_DEBUG_HANDLE 0x2EDC
60 /* max retry count when init fails */
61 #define MAX_INIT_RETRIES 3
63 /* Controller dump header */
64 #define QCA_SSR_DUMP_HANDLE 0x0108
65 #define QCA_DUMP_PACKET_SIZE 255
66 #define QCA_LAST_SEQUENCE_NUM 0xFFFF
67 #define QCA_CRASHBYTE_PACKET_LEN 1096
68 #define QCA_MEMDUMP_BYTE 0xFB
72 QCA_DROP_VENDOR_EVENT,
74 QCA_MEMDUMP_COLLECTION,
78 enum qca_capabilities {
79 QCA_CAP_WIDEBAND_SPEECH = BIT(0),
82 /* HCI_IBS transmit side sleep protocol states */
89 /* HCI_IBS receive side sleep protocol states */
95 /* HCI_IBS transmit and receive side clock state vote */
96 enum hci_ibs_clock_state_vote {
97 HCI_IBS_VOTE_STATS_UPDATE,
98 HCI_IBS_TX_VOTE_CLOCK_ON,
99 HCI_IBS_TX_VOTE_CLOCK_OFF,
100 HCI_IBS_RX_VOTE_CLOCK_ON,
101 HCI_IBS_RX_VOTE_CLOCK_OFF,
104 /* Controller memory dump states */
105 enum qca_memdump_states {
107 QCA_MEMDUMP_COLLECTING,
108 QCA_MEMDUMP_COLLECTED,
112 struct qca_memdump_data {
113 char *memdump_buf_head;
114 char *memdump_buf_tail;
120 struct qca_memdump_event_hdr {
129 struct qca_dump_size {
135 struct sk_buff *rx_skb;
136 struct sk_buff_head txq;
137 struct sk_buff_head tx_wait_q; /* HCI_IBS wait queue */
138 struct sk_buff_head rx_memdump_q; /* Memdump wait queue */
139 spinlock_t hci_ibs_lock; /* HCI_IBS state lock */
140 u8 tx_ibs_state; /* HCI_IBS transmit side power state*/
141 u8 rx_ibs_state; /* HCI_IBS receive side power state */
142 bool tx_vote; /* Clock must be on for TX */
143 bool rx_vote; /* Clock must be on for RX */
144 struct timer_list tx_idle_timer;
146 struct timer_list wake_retrans_timer;
148 struct workqueue_struct *workqueue;
149 struct work_struct ws_awake_rx;
150 struct work_struct ws_awake_device;
151 struct work_struct ws_rx_vote_off;
152 struct work_struct ws_tx_vote_off;
153 struct work_struct ctrl_memdump_evt;
154 struct delayed_work ctrl_memdump_timeout;
155 struct qca_memdump_data *qca_memdump;
157 struct completion drop_ev_comp;
158 wait_queue_head_t suspend_wait_q;
159 enum qca_memdump_states memdump_state;
160 struct mutex hci_memdump_lock;
162 /* For debugging purpose */
180 enum qca_speed_type {
186 * Voltage regulator information required for configuring the
187 * QCA Bluetooth chipset
191 unsigned int load_uA;
194 struct qca_device_data {
195 enum qca_btsoc_type soc_type;
196 struct qca_vreg *vregs;
198 uint32_t capabilities;
202 * Platform data for the QCA Bluetooth power driver.
206 struct regulator_bulk_data *vreg_bulk;
212 struct hci_uart serdev_hu;
213 struct gpio_desc *bt_en;
215 enum qca_btsoc_type btsoc_type;
216 struct qca_power *bt_power;
219 const char *firmware_name;
222 static int qca_regulator_enable(struct qca_serdev *qcadev);
223 static void qca_regulator_disable(struct qca_serdev *qcadev);
224 static void qca_power_shutdown(struct hci_uart *hu);
225 static int qca_power_off(struct hci_dev *hdev);
226 static void qca_controller_memdump(struct work_struct *work);
228 static enum qca_btsoc_type qca_soc_type(struct hci_uart *hu)
230 enum qca_btsoc_type soc_type;
233 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
235 soc_type = qsd->btsoc_type;
243 static const char *qca_get_firmware_name(struct hci_uart *hu)
246 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
248 return qsd->firmware_name;
254 static void __serial_clock_on(struct tty_struct *tty)
256 /* TODO: Some chipset requires to enable UART clock on client
257 * side to save power consumption or manual work is required.
258 * Please put your code to control UART clock here if needed
262 static void __serial_clock_off(struct tty_struct *tty)
264 /* TODO: Some chipset requires to disable UART clock on client
265 * side to save power consumption or manual work is required.
266 * Please put your code to control UART clock off here if needed
270 /* serial_clock_vote needs to be called with the ibs lock held */
271 static void serial_clock_vote(unsigned long vote, struct hci_uart *hu)
273 struct qca_data *qca = hu->priv;
276 bool old_vote = (qca->tx_vote | qca->rx_vote);
280 case HCI_IBS_VOTE_STATS_UPDATE:
281 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
284 qca->vote_off_ms += diff;
286 qca->vote_on_ms += diff;
289 case HCI_IBS_TX_VOTE_CLOCK_ON:
295 case HCI_IBS_RX_VOTE_CLOCK_ON:
301 case HCI_IBS_TX_VOTE_CLOCK_OFF:
302 qca->tx_vote = false;
304 new_vote = qca->rx_vote | qca->tx_vote;
307 case HCI_IBS_RX_VOTE_CLOCK_OFF:
308 qca->rx_vote = false;
310 new_vote = qca->rx_vote | qca->tx_vote;
314 BT_ERR("Voting irregularity");
318 if (new_vote != old_vote) {
320 __serial_clock_on(hu->tty);
322 __serial_clock_off(hu->tty);
324 BT_DBG("Vote serial clock %s(%s)", new_vote ? "true" : "false",
325 vote ? "true" : "false");
327 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
331 qca->vote_off_ms += diff;
334 qca->vote_on_ms += diff;
336 qca->vote_last_jif = jiffies;
340 /* Builds and sends an HCI_IBS command packet.
341 * These are very simple packets with only 1 cmd byte.
343 static int send_hci_ibs_cmd(u8 cmd, struct hci_uart *hu)
346 struct sk_buff *skb = NULL;
347 struct qca_data *qca = hu->priv;
349 BT_DBG("hu %p send hci ibs cmd 0x%x", hu, cmd);
351 skb = bt_skb_alloc(1, GFP_ATOMIC);
353 BT_ERR("Failed to allocate memory for HCI_IBS packet");
357 /* Assign HCI_IBS type */
358 skb_put_u8(skb, cmd);
360 skb_queue_tail(&qca->txq, skb);
365 static void qca_wq_awake_device(struct work_struct *work)
367 struct qca_data *qca = container_of(work, struct qca_data,
369 struct hci_uart *hu = qca->hu;
370 unsigned long retrans_delay;
373 BT_DBG("hu %p wq awake device", hu);
375 /* Vote for serial clock */
376 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_ON, hu);
378 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
380 /* Send wake indication to device */
381 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0)
382 BT_ERR("Failed to send WAKE to device");
384 qca->ibs_sent_wakes++;
386 /* Start retransmit timer */
387 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
388 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
390 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
392 /* Actually send the packets */
393 hci_uart_tx_wakeup(hu);
396 static void qca_wq_awake_rx(struct work_struct *work)
398 struct qca_data *qca = container_of(work, struct qca_data,
400 struct hci_uart *hu = qca->hu;
403 BT_DBG("hu %p wq awake rx", hu);
405 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_ON, hu);
407 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
408 qca->rx_ibs_state = HCI_IBS_RX_AWAKE;
410 /* Always acknowledge device wake up,
411 * sending IBS message doesn't count as TX ON.
413 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0)
414 BT_ERR("Failed to acknowledge device wake up");
416 qca->ibs_sent_wacks++;
418 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
420 /* Actually send the packets */
421 hci_uart_tx_wakeup(hu);
424 static void qca_wq_serial_rx_clock_vote_off(struct work_struct *work)
426 struct qca_data *qca = container_of(work, struct qca_data,
428 struct hci_uart *hu = qca->hu;
430 BT_DBG("hu %p rx clock vote off", hu);
432 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_OFF, hu);
435 static void qca_wq_serial_tx_clock_vote_off(struct work_struct *work)
437 struct qca_data *qca = container_of(work, struct qca_data,
439 struct hci_uart *hu = qca->hu;
441 BT_DBG("hu %p tx clock vote off", hu);
443 /* Run HCI tx handling unlocked */
444 hci_uart_tx_wakeup(hu);
446 /* Now that message queued to tty driver, vote for tty clocks off.
447 * It is up to the tty driver to pend the clocks off until tx done.
449 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_OFF, hu);
452 static void hci_ibs_tx_idle_timeout(struct timer_list *t)
454 struct qca_data *qca = from_timer(qca, t, tx_idle_timer);
455 struct hci_uart *hu = qca->hu;
458 BT_DBG("hu %p idle timeout in %d state", hu, qca->tx_ibs_state);
460 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
461 flags, SINGLE_DEPTH_NESTING);
463 switch (qca->tx_ibs_state) {
464 case HCI_IBS_TX_AWAKE:
465 /* TX_IDLE, go to SLEEP */
466 if (send_hci_ibs_cmd(HCI_IBS_SLEEP_IND, hu) < 0) {
467 BT_ERR("Failed to send SLEEP to device");
470 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
471 qca->ibs_sent_slps++;
472 queue_work(qca->workqueue, &qca->ws_tx_vote_off);
475 case HCI_IBS_TX_ASLEEP:
476 case HCI_IBS_TX_WAKING:
480 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
484 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
487 static void hci_ibs_wake_retrans_timeout(struct timer_list *t)
489 struct qca_data *qca = from_timer(qca, t, wake_retrans_timer);
490 struct hci_uart *hu = qca->hu;
491 unsigned long flags, retrans_delay;
492 bool retransmit = false;
494 BT_DBG("hu %p wake retransmit timeout in %d state",
495 hu, qca->tx_ibs_state);
497 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
498 flags, SINGLE_DEPTH_NESTING);
500 /* Don't retransmit the HCI_IBS_WAKE_IND when suspending. */
501 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
502 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
506 switch (qca->tx_ibs_state) {
507 case HCI_IBS_TX_WAKING:
508 /* No WAKE_ACK, retransmit WAKE */
510 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0) {
511 BT_ERR("Failed to acknowledge device wake up");
514 qca->ibs_sent_wakes++;
515 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
516 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
519 case HCI_IBS_TX_ASLEEP:
520 case HCI_IBS_TX_AWAKE:
524 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
528 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
531 hci_uart_tx_wakeup(hu);
535 static void qca_controller_memdump_timeout(struct work_struct *work)
537 struct qca_data *qca = container_of(work, struct qca_data,
538 ctrl_memdump_timeout.work);
539 struct hci_uart *hu = qca->hu;
541 mutex_lock(&qca->hci_memdump_lock);
542 if (test_bit(QCA_MEMDUMP_COLLECTION, &qca->flags)) {
543 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
544 if (!test_bit(QCA_HW_ERROR_EVENT, &qca->flags)) {
545 /* Inject hw error event to reset the device
548 hci_reset_dev(hu->hdev);
552 mutex_unlock(&qca->hci_memdump_lock);
556 /* Initialize protocol */
557 static int qca_open(struct hci_uart *hu)
559 struct qca_serdev *qcadev;
560 struct qca_data *qca;
562 BT_DBG("hu %p qca_open", hu);
564 if (!hci_uart_has_flow_control(hu))
567 qca = kzalloc(sizeof(struct qca_data), GFP_KERNEL);
571 skb_queue_head_init(&qca->txq);
572 skb_queue_head_init(&qca->tx_wait_q);
573 skb_queue_head_init(&qca->rx_memdump_q);
574 spin_lock_init(&qca->hci_ibs_lock);
575 mutex_init(&qca->hci_memdump_lock);
576 qca->workqueue = alloc_ordered_workqueue("qca_wq", 0);
577 if (!qca->workqueue) {
578 BT_ERR("QCA Workqueue not initialized properly");
583 INIT_WORK(&qca->ws_awake_rx, qca_wq_awake_rx);
584 INIT_WORK(&qca->ws_awake_device, qca_wq_awake_device);
585 INIT_WORK(&qca->ws_rx_vote_off, qca_wq_serial_rx_clock_vote_off);
586 INIT_WORK(&qca->ws_tx_vote_off, qca_wq_serial_tx_clock_vote_off);
587 INIT_WORK(&qca->ctrl_memdump_evt, qca_controller_memdump);
588 INIT_DELAYED_WORK(&qca->ctrl_memdump_timeout,
589 qca_controller_memdump_timeout);
590 init_waitqueue_head(&qca->suspend_wait_q);
593 init_completion(&qca->drop_ev_comp);
595 /* Assume we start with both sides asleep -- extra wakes OK */
596 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
597 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
599 qca->vote_last_jif = jiffies;
604 qcadev = serdev_device_get_drvdata(hu->serdev);
606 if (qca_is_wcn399x(qcadev->btsoc_type))
607 hu->init_speed = qcadev->init_speed;
609 if (qcadev->oper_speed)
610 hu->oper_speed = qcadev->oper_speed;
613 timer_setup(&qca->wake_retrans_timer, hci_ibs_wake_retrans_timeout, 0);
614 qca->wake_retrans = IBS_WAKE_RETRANS_TIMEOUT_MS;
616 timer_setup(&qca->tx_idle_timer, hci_ibs_tx_idle_timeout, 0);
617 qca->tx_idle_delay = IBS_HOST_TX_IDLE_TIMEOUT_MS;
619 BT_DBG("HCI_UART_QCA open, tx_idle_delay=%u, wake_retrans=%u",
620 qca->tx_idle_delay, qca->wake_retrans);
625 static void qca_debugfs_init(struct hci_dev *hdev)
627 struct hci_uart *hu = hci_get_drvdata(hdev);
628 struct qca_data *qca = hu->priv;
629 struct dentry *ibs_dir;
635 ibs_dir = debugfs_create_dir("ibs", hdev->debugfs);
639 debugfs_create_u8("tx_ibs_state", mode, ibs_dir, &qca->tx_ibs_state);
640 debugfs_create_u8("rx_ibs_state", mode, ibs_dir, &qca->rx_ibs_state);
641 debugfs_create_u64("ibs_sent_sleeps", mode, ibs_dir,
642 &qca->ibs_sent_slps);
643 debugfs_create_u64("ibs_sent_wakes", mode, ibs_dir,
644 &qca->ibs_sent_wakes);
645 debugfs_create_u64("ibs_sent_wake_acks", mode, ibs_dir,
646 &qca->ibs_sent_wacks);
647 debugfs_create_u64("ibs_recv_sleeps", mode, ibs_dir,
648 &qca->ibs_recv_slps);
649 debugfs_create_u64("ibs_recv_wakes", mode, ibs_dir,
650 &qca->ibs_recv_wakes);
651 debugfs_create_u64("ibs_recv_wake_acks", mode, ibs_dir,
652 &qca->ibs_recv_wacks);
653 debugfs_create_bool("tx_vote", mode, ibs_dir, &qca->tx_vote);
654 debugfs_create_u64("tx_votes_on", mode, ibs_dir, &qca->tx_votes_on);
655 debugfs_create_u64("tx_votes_off", mode, ibs_dir, &qca->tx_votes_off);
656 debugfs_create_bool("rx_vote", mode, ibs_dir, &qca->rx_vote);
657 debugfs_create_u64("rx_votes_on", mode, ibs_dir, &qca->rx_votes_on);
658 debugfs_create_u64("rx_votes_off", mode, ibs_dir, &qca->rx_votes_off);
659 debugfs_create_u64("votes_on", mode, ibs_dir, &qca->votes_on);
660 debugfs_create_u64("votes_off", mode, ibs_dir, &qca->votes_off);
661 debugfs_create_u32("vote_on_ms", mode, ibs_dir, &qca->vote_on_ms);
662 debugfs_create_u32("vote_off_ms", mode, ibs_dir, &qca->vote_off_ms);
665 mode = S_IRUGO | S_IWUSR;
666 debugfs_create_u32("wake_retrans", mode, ibs_dir, &qca->wake_retrans);
667 debugfs_create_u32("tx_idle_delay", mode, ibs_dir,
668 &qca->tx_idle_delay);
671 /* Flush protocol data */
672 static int qca_flush(struct hci_uart *hu)
674 struct qca_data *qca = hu->priv;
676 BT_DBG("hu %p qca flush", hu);
678 skb_queue_purge(&qca->tx_wait_q);
679 skb_queue_purge(&qca->txq);
685 static int qca_close(struct hci_uart *hu)
687 struct qca_data *qca = hu->priv;
689 BT_DBG("hu %p qca close", hu);
691 serial_clock_vote(HCI_IBS_VOTE_STATS_UPDATE, hu);
693 skb_queue_purge(&qca->tx_wait_q);
694 skb_queue_purge(&qca->txq);
695 skb_queue_purge(&qca->rx_memdump_q);
696 del_timer(&qca->tx_idle_timer);
697 del_timer(&qca->wake_retrans_timer);
698 destroy_workqueue(qca->workqueue);
701 qca_power_shutdown(hu);
703 kfree_skb(qca->rx_skb);
712 /* Called upon a wake-up-indication from the device.
714 static void device_want_to_wakeup(struct hci_uart *hu)
717 struct qca_data *qca = hu->priv;
719 BT_DBG("hu %p want to wake up", hu);
721 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
723 qca->ibs_recv_wakes++;
725 /* Don't wake the rx up when suspending. */
726 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
727 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
731 switch (qca->rx_ibs_state) {
732 case HCI_IBS_RX_ASLEEP:
733 /* Make sure clock is on - we may have turned clock off since
734 * receiving the wake up indicator awake rx clock.
736 queue_work(qca->workqueue, &qca->ws_awake_rx);
737 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
740 case HCI_IBS_RX_AWAKE:
741 /* Always acknowledge device wake up,
742 * sending IBS message doesn't count as TX ON.
744 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0) {
745 BT_ERR("Failed to acknowledge device wake up");
748 qca->ibs_sent_wacks++;
752 /* Any other state is illegal */
753 BT_ERR("Received HCI_IBS_WAKE_IND in rx state %d",
758 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
760 /* Actually send the packets */
761 hci_uart_tx_wakeup(hu);
764 /* Called upon a sleep-indication from the device.
766 static void device_want_to_sleep(struct hci_uart *hu)
769 struct qca_data *qca = hu->priv;
771 BT_DBG("hu %p want to sleep in %d state", hu, qca->rx_ibs_state);
773 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
775 qca->ibs_recv_slps++;
777 switch (qca->rx_ibs_state) {
778 case HCI_IBS_RX_AWAKE:
780 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
781 /* Vote off rx clock under workqueue */
782 queue_work(qca->workqueue, &qca->ws_rx_vote_off);
785 case HCI_IBS_RX_ASLEEP:
789 /* Any other state is illegal */
790 BT_ERR("Received HCI_IBS_SLEEP_IND in rx state %d",
795 wake_up_interruptible(&qca->suspend_wait_q);
797 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
800 /* Called upon wake-up-acknowledgement from the device
802 static void device_woke_up(struct hci_uart *hu)
804 unsigned long flags, idle_delay;
805 struct qca_data *qca = hu->priv;
806 struct sk_buff *skb = NULL;
808 BT_DBG("hu %p woke up", hu);
810 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
812 qca->ibs_recv_wacks++;
814 /* Don't react to the wake-up-acknowledgment when suspending. */
815 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
816 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
820 switch (qca->tx_ibs_state) {
821 case HCI_IBS_TX_AWAKE:
822 /* Expect one if we send 2 WAKEs */
823 BT_DBG("Received HCI_IBS_WAKE_ACK in tx state %d",
827 case HCI_IBS_TX_WAKING:
828 /* Send pending packets */
829 while ((skb = skb_dequeue(&qca->tx_wait_q)))
830 skb_queue_tail(&qca->txq, skb);
832 /* Switch timers and change state to HCI_IBS_TX_AWAKE */
833 del_timer(&qca->wake_retrans_timer);
834 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
835 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
836 qca->tx_ibs_state = HCI_IBS_TX_AWAKE;
839 case HCI_IBS_TX_ASLEEP:
843 BT_ERR("Received HCI_IBS_WAKE_ACK in tx state %d",
848 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
850 /* Actually send the packets */
851 hci_uart_tx_wakeup(hu);
854 /* Enqueue frame for transmittion (padding, crc, etc) may be called from
855 * two simultaneous tasklets.
857 static int qca_enqueue(struct hci_uart *hu, struct sk_buff *skb)
859 unsigned long flags = 0, idle_delay;
860 struct qca_data *qca = hu->priv;
862 BT_DBG("hu %p qca enq skb %p tx_ibs_state %d", hu, skb,
865 /* Prepend skb with frame type */
866 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
868 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
870 /* Don't go to sleep in middle of patch download or
871 * Out-Of-Band(GPIOs control) sleep is selected.
872 * Don't wake the device up when suspending.
874 if (!test_bit(QCA_IBS_ENABLED, &qca->flags) ||
875 test_bit(QCA_SUSPENDING, &qca->flags)) {
876 skb_queue_tail(&qca->txq, skb);
877 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
881 /* Act according to current state */
882 switch (qca->tx_ibs_state) {
883 case HCI_IBS_TX_AWAKE:
884 BT_DBG("Device awake, sending normally");
885 skb_queue_tail(&qca->txq, skb);
886 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
887 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
890 case HCI_IBS_TX_ASLEEP:
891 BT_DBG("Device asleep, waking up and queueing packet");
892 /* Save packet for later */
893 skb_queue_tail(&qca->tx_wait_q, skb);
895 qca->tx_ibs_state = HCI_IBS_TX_WAKING;
896 /* Schedule a work queue to wake up device */
897 queue_work(qca->workqueue, &qca->ws_awake_device);
900 case HCI_IBS_TX_WAKING:
901 BT_DBG("Device waking up, queueing packet");
902 /* Transient state; just keep packet for later */
903 skb_queue_tail(&qca->tx_wait_q, skb);
907 BT_ERR("Illegal tx state: %d (losing packet)",
913 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
918 static int qca_ibs_sleep_ind(struct hci_dev *hdev, struct sk_buff *skb)
920 struct hci_uart *hu = hci_get_drvdata(hdev);
922 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_SLEEP_IND);
924 device_want_to_sleep(hu);
930 static int qca_ibs_wake_ind(struct hci_dev *hdev, struct sk_buff *skb)
932 struct hci_uart *hu = hci_get_drvdata(hdev);
934 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_IND);
936 device_want_to_wakeup(hu);
942 static int qca_ibs_wake_ack(struct hci_dev *hdev, struct sk_buff *skb)
944 struct hci_uart *hu = hci_get_drvdata(hdev);
946 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_ACK);
954 static int qca_recv_acl_data(struct hci_dev *hdev, struct sk_buff *skb)
956 /* We receive debug logs from chip as an ACL packets.
957 * Instead of sending the data to ACL to decode the
958 * received data, we are pushing them to the above layers
959 * as a diagnostic packet.
961 if (get_unaligned_le16(skb->data) == QCA_DEBUG_HANDLE)
962 return hci_recv_diag(hdev, skb);
964 return hci_recv_frame(hdev, skb);
967 static void qca_controller_memdump(struct work_struct *work)
969 struct qca_data *qca = container_of(work, struct qca_data,
971 struct hci_uart *hu = qca->hu;
973 struct qca_memdump_event_hdr *cmd_hdr;
974 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
975 struct qca_dump_size *dump;
977 char nullBuff[QCA_DUMP_PACKET_SIZE] = { 0 };
981 enum qca_btsoc_type soc_type = qca_soc_type(hu);
983 while ((skb = skb_dequeue(&qca->rx_memdump_q))) {
985 mutex_lock(&qca->hci_memdump_lock);
986 /* Skip processing the received packets if timeout detected. */
987 if (qca->memdump_state == QCA_MEMDUMP_TIMEOUT) {
988 mutex_unlock(&qca->hci_memdump_lock);
993 qca_memdump = kzalloc(sizeof(struct qca_memdump_data),
996 mutex_unlock(&qca->hci_memdump_lock);
1000 qca->qca_memdump = qca_memdump;
1003 qca->memdump_state = QCA_MEMDUMP_COLLECTING;
1004 cmd_hdr = (void *) skb->data;
1005 seq_no = __le16_to_cpu(cmd_hdr->seq_no);
1006 skb_pull(skb, sizeof(struct qca_memdump_event_hdr));
1010 /* This is the first frame of memdump packet from
1011 * the controller, Disable IBS to recevie dump
1012 * with out any interruption, ideally time required for
1013 * the controller to send the dump is 8 seconds. let us
1014 * start timer to handle this asynchronous activity.
1016 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1017 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1018 dump = (void *) skb->data;
1019 dump_size = __le32_to_cpu(dump->dump_size);
1021 bt_dev_err(hu->hdev, "Rx invalid memdump size");
1023 mutex_unlock(&qca->hci_memdump_lock);
1027 bt_dev_info(hu->hdev, "QCA collecting dump of size:%u",
1029 queue_delayed_work(qca->workqueue,
1030 &qca->ctrl_memdump_timeout,
1031 msecs_to_jiffies(MEMDUMP_TIMEOUT_MS)
1034 skb_pull(skb, sizeof(dump_size));
1035 memdump_buf = vmalloc(dump_size);
1036 qca_memdump->ram_dump_size = dump_size;
1037 qca_memdump->memdump_buf_head = memdump_buf;
1038 qca_memdump->memdump_buf_tail = memdump_buf;
1041 memdump_buf = qca_memdump->memdump_buf_tail;
1043 /* If sequence no 0 is missed then there is no point in
1044 * accepting the other sequences.
1047 bt_dev_err(hu->hdev, "QCA: Discarding other packets");
1050 qca->qca_memdump = NULL;
1051 mutex_unlock(&qca->hci_memdump_lock);
1055 /* There could be chance of missing some packets from
1056 * the controller. In such cases let us store the dummy
1057 * packets in the buffer.
1059 /* For QCA6390, controller does not lost packets but
1060 * sequence number field of packat sometimes has error
1061 * bits, so skip this checking for missing packet.
1063 while ((seq_no > qca_memdump->current_seq_no + 1) &&
1064 (soc_type != QCA_QCA6390) &&
1065 seq_no != QCA_LAST_SEQUENCE_NUM) {
1066 bt_dev_err(hu->hdev, "QCA controller missed packet:%d",
1067 qca_memdump->current_seq_no);
1068 rx_size = qca_memdump->received_dump;
1069 rx_size += QCA_DUMP_PACKET_SIZE;
1070 if (rx_size > qca_memdump->ram_dump_size) {
1071 bt_dev_err(hu->hdev,
1072 "QCA memdump received %d, no space for missed packet",
1073 qca_memdump->received_dump);
1076 memcpy(memdump_buf, nullBuff, QCA_DUMP_PACKET_SIZE);
1077 memdump_buf = memdump_buf + QCA_DUMP_PACKET_SIZE;
1078 qca_memdump->received_dump += QCA_DUMP_PACKET_SIZE;
1079 qca_memdump->current_seq_no++;
1082 rx_size = qca_memdump->received_dump + skb->len;
1083 if (rx_size <= qca_memdump->ram_dump_size) {
1084 if ((seq_no != QCA_LAST_SEQUENCE_NUM) &&
1085 (seq_no != qca_memdump->current_seq_no))
1086 bt_dev_err(hu->hdev,
1087 "QCA memdump unexpected packet %d",
1089 bt_dev_dbg(hu->hdev,
1090 "QCA memdump packet %d with length %d",
1092 memcpy(memdump_buf, (unsigned char *)skb->data,
1094 memdump_buf = memdump_buf + skb->len;
1095 qca_memdump->memdump_buf_tail = memdump_buf;
1096 qca_memdump->current_seq_no = seq_no + 1;
1097 qca_memdump->received_dump += skb->len;
1099 bt_dev_err(hu->hdev,
1100 "QCA memdump received %d, no space for packet %d",
1101 qca_memdump->received_dump, seq_no);
1103 qca->qca_memdump = qca_memdump;
1105 if (seq_no == QCA_LAST_SEQUENCE_NUM) {
1106 bt_dev_info(hu->hdev,
1107 "QCA memdump Done, received %d, total %d",
1108 qca_memdump->received_dump,
1109 qca_memdump->ram_dump_size);
1110 memdump_buf = qca_memdump->memdump_buf_head;
1111 dev_coredumpv(&hu->serdev->dev, memdump_buf,
1112 qca_memdump->received_dump, GFP_KERNEL);
1113 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1114 kfree(qca->qca_memdump);
1115 qca->qca_memdump = NULL;
1116 qca->memdump_state = QCA_MEMDUMP_COLLECTED;
1117 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1120 mutex_unlock(&qca->hci_memdump_lock);
1125 static int qca_controller_memdump_event(struct hci_dev *hdev,
1126 struct sk_buff *skb)
1128 struct hci_uart *hu = hci_get_drvdata(hdev);
1129 struct qca_data *qca = hu->priv;
1131 skb_queue_tail(&qca->rx_memdump_q, skb);
1132 queue_work(qca->workqueue, &qca->ctrl_memdump_evt);
1137 static int qca_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
1139 struct hci_uart *hu = hci_get_drvdata(hdev);
1140 struct qca_data *qca = hu->priv;
1142 if (test_bit(QCA_DROP_VENDOR_EVENT, &qca->flags)) {
1143 struct hci_event_hdr *hdr = (void *)skb->data;
1145 /* For the WCN3990 the vendor command for a baudrate change
1146 * isn't sent as synchronous HCI command, because the
1147 * controller sends the corresponding vendor event with the
1148 * new baudrate. The event is received and properly decoded
1149 * after changing the baudrate of the host port. It needs to
1150 * be dropped, otherwise it can be misinterpreted as
1151 * response to a later firmware download command (also a
1155 if (hdr->evt == HCI_EV_VENDOR)
1156 complete(&qca->drop_ev_comp);
1162 /* We receive chip memory dump as an event packet, With a dedicated
1163 * handler followed by a hardware error event. When this event is
1164 * received we store dump into a file before closing hci. This
1165 * dump will help in triaging the issues.
1167 if ((skb->data[0] == HCI_VENDOR_PKT) &&
1168 (get_unaligned_be16(skb->data + 2) == QCA_SSR_DUMP_HANDLE))
1169 return qca_controller_memdump_event(hdev, skb);
1171 return hci_recv_frame(hdev, skb);
1174 #define QCA_IBS_SLEEP_IND_EVENT \
1175 .type = HCI_IBS_SLEEP_IND, \
1179 .maxlen = HCI_MAX_IBS_SIZE
1181 #define QCA_IBS_WAKE_IND_EVENT \
1182 .type = HCI_IBS_WAKE_IND, \
1186 .maxlen = HCI_MAX_IBS_SIZE
1188 #define QCA_IBS_WAKE_ACK_EVENT \
1189 .type = HCI_IBS_WAKE_ACK, \
1193 .maxlen = HCI_MAX_IBS_SIZE
1195 static const struct h4_recv_pkt qca_recv_pkts[] = {
1196 { H4_RECV_ACL, .recv = qca_recv_acl_data },
1197 { H4_RECV_SCO, .recv = hci_recv_frame },
1198 { H4_RECV_EVENT, .recv = qca_recv_event },
1199 { QCA_IBS_WAKE_IND_EVENT, .recv = qca_ibs_wake_ind },
1200 { QCA_IBS_WAKE_ACK_EVENT, .recv = qca_ibs_wake_ack },
1201 { QCA_IBS_SLEEP_IND_EVENT, .recv = qca_ibs_sleep_ind },
1204 static int qca_recv(struct hci_uart *hu, const void *data, int count)
1206 struct qca_data *qca = hu->priv;
1208 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
1211 qca->rx_skb = h4_recv_buf(hu->hdev, qca->rx_skb, data, count,
1212 qca_recv_pkts, ARRAY_SIZE(qca_recv_pkts));
1213 if (IS_ERR(qca->rx_skb)) {
1214 int err = PTR_ERR(qca->rx_skb);
1215 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
1223 static struct sk_buff *qca_dequeue(struct hci_uart *hu)
1225 struct qca_data *qca = hu->priv;
1227 return skb_dequeue(&qca->txq);
1230 static uint8_t qca_get_baudrate_value(int speed)
1234 return QCA_BAUDRATE_9600;
1236 return QCA_BAUDRATE_19200;
1238 return QCA_BAUDRATE_38400;
1240 return QCA_BAUDRATE_57600;
1242 return QCA_BAUDRATE_115200;
1244 return QCA_BAUDRATE_230400;
1246 return QCA_BAUDRATE_460800;
1248 return QCA_BAUDRATE_500000;
1250 return QCA_BAUDRATE_921600;
1252 return QCA_BAUDRATE_1000000;
1254 return QCA_BAUDRATE_2000000;
1256 return QCA_BAUDRATE_3000000;
1258 return QCA_BAUDRATE_3200000;
1260 return QCA_BAUDRATE_3500000;
1262 return QCA_BAUDRATE_115200;
1266 static int qca_set_baudrate(struct hci_dev *hdev, uint8_t baudrate)
1268 struct hci_uart *hu = hci_get_drvdata(hdev);
1269 struct qca_data *qca = hu->priv;
1270 struct sk_buff *skb;
1271 u8 cmd[] = { 0x01, 0x48, 0xFC, 0x01, 0x00 };
1273 if (baudrate > QCA_BAUDRATE_3200000)
1278 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
1280 bt_dev_err(hdev, "Failed to allocate baudrate packet");
1284 /* Assign commands to change baudrate and packet type. */
1285 skb_put_data(skb, cmd, sizeof(cmd));
1286 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1288 skb_queue_tail(&qca->txq, skb);
1289 hci_uart_tx_wakeup(hu);
1291 /* Wait for the baudrate change request to be sent */
1293 while (!skb_queue_empty(&qca->txq))
1294 usleep_range(100, 200);
1297 serdev_device_wait_until_sent(hu->serdev,
1298 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1300 /* Give the controller time to process the request */
1301 if (qca_is_wcn399x(qca_soc_type(hu)))
1309 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
1312 serdev_device_set_baudrate(hu->serdev, speed);
1314 hci_uart_set_baudrate(hu, speed);
1317 static int qca_send_power_pulse(struct hci_uart *hu, bool on)
1320 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
1321 u8 cmd = on ? QCA_WCN3990_POWERON_PULSE : QCA_WCN3990_POWEROFF_PULSE;
1323 /* These power pulses are single byte command which are sent
1324 * at required baudrate to wcn3990. On wcn3990, we have an external
1325 * circuit at Tx pin which decodes the pulse sent at specific baudrate.
1326 * For example, wcn3990 supports RF COEX antenna for both Wi-Fi/BT
1327 * and also we use the same power inputs to turn on and off for
1328 * Wi-Fi/BT. Powering up the power sources will not enable BT, until
1329 * we send a power on pulse at 115200 bps. This algorithm will help to
1330 * save power. Disabling hardware flow control is mandatory while
1331 * sending power pulses to SoC.
1333 bt_dev_dbg(hu->hdev, "sending power pulse %02x to controller", cmd);
1335 serdev_device_write_flush(hu->serdev);
1336 hci_uart_set_flow_control(hu, true);
1337 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1339 bt_dev_err(hu->hdev, "failed to send power pulse %02x", cmd);
1343 serdev_device_wait_until_sent(hu->serdev, timeout);
1344 hci_uart_set_flow_control(hu, false);
1346 /* Give to controller time to boot/shutdown */
1355 static unsigned int qca_get_speed(struct hci_uart *hu,
1356 enum qca_speed_type speed_type)
1358 unsigned int speed = 0;
1360 if (speed_type == QCA_INIT_SPEED) {
1362 speed = hu->init_speed;
1363 else if (hu->proto->init_speed)
1364 speed = hu->proto->init_speed;
1367 speed = hu->oper_speed;
1368 else if (hu->proto->oper_speed)
1369 speed = hu->proto->oper_speed;
1375 static int qca_check_speeds(struct hci_uart *hu)
1377 if (qca_is_wcn399x(qca_soc_type(hu))) {
1378 if (!qca_get_speed(hu, QCA_INIT_SPEED) &&
1379 !qca_get_speed(hu, QCA_OPER_SPEED))
1382 if (!qca_get_speed(hu, QCA_INIT_SPEED) ||
1383 !qca_get_speed(hu, QCA_OPER_SPEED))
1390 static int qca_set_speed(struct hci_uart *hu, enum qca_speed_type speed_type)
1392 unsigned int speed, qca_baudrate;
1393 struct qca_data *qca = hu->priv;
1396 if (speed_type == QCA_INIT_SPEED) {
1397 speed = qca_get_speed(hu, QCA_INIT_SPEED);
1399 host_set_baudrate(hu, speed);
1401 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1403 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1407 /* Disable flow control for wcn3990 to deassert RTS while
1408 * changing the baudrate of chip and host.
1410 if (qca_is_wcn399x(soc_type))
1411 hci_uart_set_flow_control(hu, true);
1413 if (soc_type == QCA_WCN3990) {
1414 reinit_completion(&qca->drop_ev_comp);
1415 set_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1418 qca_baudrate = qca_get_baudrate_value(speed);
1419 bt_dev_dbg(hu->hdev, "Set UART speed to %d", speed);
1420 ret = qca_set_baudrate(hu->hdev, qca_baudrate);
1424 host_set_baudrate(hu, speed);
1427 if (qca_is_wcn399x(soc_type))
1428 hci_uart_set_flow_control(hu, false);
1430 if (soc_type == QCA_WCN3990) {
1431 /* Wait for the controller to send the vendor event
1432 * for the baudrate change command.
1434 if (!wait_for_completion_timeout(&qca->drop_ev_comp,
1435 msecs_to_jiffies(100))) {
1436 bt_dev_err(hu->hdev,
1437 "Failed to change controller baudrate\n");
1441 clear_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1448 static int qca_send_crashbuffer(struct hci_uart *hu)
1450 struct qca_data *qca = hu->priv;
1451 struct sk_buff *skb;
1453 skb = bt_skb_alloc(QCA_CRASHBYTE_PACKET_LEN, GFP_KERNEL);
1455 bt_dev_err(hu->hdev, "Failed to allocate memory for skb packet");
1459 /* We forcefully crash the controller, by sending 0xfb byte for
1460 * 1024 times. We also might have chance of losing data, To be
1461 * on safer side we send 1096 bytes to the SoC.
1463 memset(skb_put(skb, QCA_CRASHBYTE_PACKET_LEN), QCA_MEMDUMP_BYTE,
1464 QCA_CRASHBYTE_PACKET_LEN);
1465 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1466 bt_dev_info(hu->hdev, "crash the soc to collect controller dump");
1467 skb_queue_tail(&qca->txq, skb);
1468 hci_uart_tx_wakeup(hu);
1473 static void qca_wait_for_dump_collection(struct hci_dev *hdev)
1475 struct hci_uart *hu = hci_get_drvdata(hdev);
1476 struct qca_data *qca = hu->priv;
1478 wait_on_bit_timeout(&qca->flags, QCA_MEMDUMP_COLLECTION,
1479 TASK_UNINTERRUPTIBLE, MEMDUMP_TIMEOUT_MS);
1481 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1484 static void qca_hw_error(struct hci_dev *hdev, u8 code)
1486 struct hci_uart *hu = hci_get_drvdata(hdev);
1487 struct qca_data *qca = hu->priv;
1488 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
1489 char *memdump_buf = NULL;
1491 set_bit(QCA_HW_ERROR_EVENT, &qca->flags);
1492 bt_dev_info(hdev, "mem_dump_status: %d", qca->memdump_state);
1494 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1495 /* If hardware error event received for other than QCA
1496 * soc memory dump event, then we need to crash the SOC
1497 * and wait here for 8 seconds to get the dump packets.
1498 * This will block main thread to be on hold until we
1501 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1502 qca_send_crashbuffer(hu);
1503 qca_wait_for_dump_collection(hdev);
1504 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1505 /* Let us wait here until memory dump collected or
1506 * memory dump timer expired.
1508 bt_dev_info(hdev, "waiting for dump to complete");
1509 qca_wait_for_dump_collection(hdev);
1512 if (qca->memdump_state != QCA_MEMDUMP_COLLECTED) {
1513 bt_dev_err(hu->hdev, "clearing allocated memory due to memdump timeout");
1514 mutex_lock(&qca->hci_memdump_lock);
1516 memdump_buf = qca_memdump->memdump_buf_head;
1519 qca->qca_memdump = NULL;
1520 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1521 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1522 skb_queue_purge(&qca->rx_memdump_q);
1523 mutex_unlock(&qca->hci_memdump_lock);
1524 cancel_work_sync(&qca->ctrl_memdump_evt);
1527 clear_bit(QCA_HW_ERROR_EVENT, &qca->flags);
1530 static void qca_cmd_timeout(struct hci_dev *hdev)
1532 struct hci_uart *hu = hci_get_drvdata(hdev);
1533 struct qca_data *qca = hu->priv;
1535 if (qca->memdump_state == QCA_MEMDUMP_IDLE)
1536 qca_send_crashbuffer(hu);
1538 bt_dev_info(hdev, "Dump collection is in process");
1541 static int qca_wcn3990_init(struct hci_uart *hu)
1543 struct qca_serdev *qcadev;
1546 /* Check for vregs status, may be hci down has turned
1547 * off the voltage regulator.
1549 qcadev = serdev_device_get_drvdata(hu->serdev);
1550 if (!qcadev->bt_power->vregs_on) {
1551 serdev_device_close(hu->serdev);
1552 ret = qca_regulator_enable(qcadev);
1556 ret = serdev_device_open(hu->serdev);
1558 bt_dev_err(hu->hdev, "failed to open port");
1563 /* Forcefully enable wcn3990 to enter in to boot mode. */
1564 host_set_baudrate(hu, 2400);
1565 ret = qca_send_power_pulse(hu, false);
1569 qca_set_speed(hu, QCA_INIT_SPEED);
1570 ret = qca_send_power_pulse(hu, true);
1574 /* Now the device is in ready state to communicate with host.
1575 * To sync host with device we need to reopen port.
1576 * Without this, we will have RTS and CTS synchronization
1579 serdev_device_close(hu->serdev);
1580 ret = serdev_device_open(hu->serdev);
1582 bt_dev_err(hu->hdev, "failed to open port");
1586 hci_uart_set_flow_control(hu, false);
1591 static int qca_power_on(struct hci_dev *hdev)
1593 struct hci_uart *hu = hci_get_drvdata(hdev);
1594 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1595 struct qca_serdev *qcadev;
1598 /* Non-serdev device usually is powered by external power
1599 * and don't need additional action in driver for power on
1604 if (qca_is_wcn399x(soc_type)) {
1605 ret = qca_wcn3990_init(hu);
1607 qcadev = serdev_device_get_drvdata(hu->serdev);
1608 if (qcadev->bt_en) {
1609 gpiod_set_value_cansleep(qcadev->bt_en, 1);
1610 /* Controller needs time to bootup. */
1618 static int qca_setup(struct hci_uart *hu)
1620 struct hci_dev *hdev = hu->hdev;
1621 struct qca_data *qca = hu->priv;
1622 unsigned int speed, qca_baudrate = QCA_BAUDRATE_115200;
1623 unsigned int retries = 0;
1624 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1625 const char *firmware_name = qca_get_firmware_name(hu);
1629 ret = qca_check_speeds(hu);
1633 /* Patch downloading has to be done without IBS mode */
1634 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1636 /* Enable controller to do both LE scan and BR/EDR inquiry
1639 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1641 bt_dev_info(hdev, "setting up %s",
1642 qca_is_wcn399x(soc_type) ? "wcn399x" : "ROME/QCA6390");
1645 ret = qca_power_on(hdev);
1649 if (qca_is_wcn399x(soc_type)) {
1650 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hdev->quirks);
1652 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1656 qca_set_speed(hu, QCA_INIT_SPEED);
1659 /* Setup user speed if needed */
1660 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1662 ret = qca_set_speed(hu, QCA_OPER_SPEED);
1666 qca_baudrate = qca_get_baudrate_value(speed);
1669 if (!qca_is_wcn399x(soc_type)) {
1670 /* Get QCA version information */
1671 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1676 bt_dev_info(hdev, "QCA controller version 0x%08x", soc_ver);
1677 /* Setup patch / NVM configurations */
1678 ret = qca_uart_setup(hdev, qca_baudrate, soc_type, soc_ver,
1681 set_bit(QCA_IBS_ENABLED, &qca->flags);
1682 qca_debugfs_init(hdev);
1683 hu->hdev->hw_error = qca_hw_error;
1684 hu->hdev->cmd_timeout = qca_cmd_timeout;
1685 } else if (ret == -ENOENT) {
1686 /* No patch/nvm-config found, run with original fw/config */
1688 } else if (ret == -EAGAIN) {
1690 * Userspace firmware loader will return -EAGAIN in case no
1691 * patch/nvm-config is found, so run with original fw/config.
1695 if (retries < MAX_INIT_RETRIES) {
1696 qca_power_shutdown(hu);
1698 serdev_device_close(hu->serdev);
1699 ret = serdev_device_open(hu->serdev);
1701 bt_dev_err(hdev, "failed to open port");
1711 if (soc_type == QCA_ROME)
1712 hu->hdev->set_bdaddr = qca_set_bdaddr_rome;
1714 hu->hdev->set_bdaddr = qca_set_bdaddr;
1719 static const struct hci_uart_proto qca_proto = {
1723 .init_speed = 115200,
1724 .oper_speed = 3000000,
1730 .enqueue = qca_enqueue,
1731 .dequeue = qca_dequeue,
1734 static const struct qca_device_data qca_soc_data_wcn3990 = {
1735 .soc_type = QCA_WCN3990,
1736 .vregs = (struct qca_vreg []) {
1739 { "vddrf", 300000 },
1740 { "vddch0", 450000 },
1745 static const struct qca_device_data qca_soc_data_wcn3991 = {
1746 .soc_type = QCA_WCN3991,
1747 .vregs = (struct qca_vreg []) {
1750 { "vddrf", 300000 },
1751 { "vddch0", 450000 },
1754 .capabilities = QCA_CAP_WIDEBAND_SPEECH,
1757 static const struct qca_device_data qca_soc_data_wcn3998 = {
1758 .soc_type = QCA_WCN3998,
1759 .vregs = (struct qca_vreg []) {
1762 { "vddrf", 300000 },
1763 { "vddch0", 450000 },
1768 static const struct qca_device_data qca_soc_data_qca6390 = {
1769 .soc_type = QCA_QCA6390,
1773 static void qca_power_shutdown(struct hci_uart *hu)
1775 struct qca_serdev *qcadev;
1776 struct qca_data *qca = hu->priv;
1777 unsigned long flags;
1778 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1780 qcadev = serdev_device_get_drvdata(hu->serdev);
1782 /* From this point we go into power off state. But serial port is
1783 * still open, stop queueing the IBS data and flush all the buffered
1786 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
1787 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1789 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
1791 hu->hdev->hw_error = NULL;
1792 hu->hdev->cmd_timeout = NULL;
1794 /* Non-serdev device usually is powered by external power
1795 * and don't need additional action in driver for power down
1800 if (qca_is_wcn399x(soc_type)) {
1801 host_set_baudrate(hu, 2400);
1802 qca_send_power_pulse(hu, false);
1803 qca_regulator_disable(qcadev);
1804 } else if (qcadev->bt_en) {
1805 gpiod_set_value_cansleep(qcadev->bt_en, 0);
1809 static int qca_power_off(struct hci_dev *hdev)
1811 struct hci_uart *hu = hci_get_drvdata(hdev);
1812 struct qca_data *qca = hu->priv;
1813 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1815 /* Stop sending shutdown command if soc crashes. */
1816 if (soc_type != QCA_ROME
1817 && qca->memdump_state == QCA_MEMDUMP_IDLE) {
1818 qca_send_pre_shutdown_cmd(hdev);
1819 usleep_range(8000, 10000);
1822 qca->memdump_state = QCA_MEMDUMP_IDLE;
1823 qca_power_shutdown(hu);
1827 static int qca_regulator_enable(struct qca_serdev *qcadev)
1829 struct qca_power *power = qcadev->bt_power;
1832 /* Already enabled */
1833 if (power->vregs_on)
1836 BT_DBG("enabling %d regulators)", power->num_vregs);
1838 ret = regulator_bulk_enable(power->num_vregs, power->vreg_bulk);
1842 power->vregs_on = true;
1844 ret = clk_prepare_enable(qcadev->susclk);
1846 qca_regulator_disable(qcadev);
1851 static void qca_regulator_disable(struct qca_serdev *qcadev)
1853 struct qca_power *power;
1858 power = qcadev->bt_power;
1860 /* Already disabled? */
1861 if (!power->vregs_on)
1864 regulator_bulk_disable(power->num_vregs, power->vreg_bulk);
1865 power->vregs_on = false;
1867 clk_disable_unprepare(qcadev->susclk);
1870 static int qca_init_regulators(struct qca_power *qca,
1871 const struct qca_vreg *vregs, size_t num_vregs)
1873 struct regulator_bulk_data *bulk;
1877 bulk = devm_kcalloc(qca->dev, num_vregs, sizeof(*bulk), GFP_KERNEL);
1881 for (i = 0; i < num_vregs; i++)
1882 bulk[i].supply = vregs[i].name;
1884 ret = devm_regulator_bulk_get(qca->dev, num_vregs, bulk);
1888 for (i = 0; i < num_vregs; i++) {
1889 ret = regulator_set_load(bulk[i].consumer, vregs[i].load_uA);
1894 qca->vreg_bulk = bulk;
1895 qca->num_vregs = num_vregs;
1900 static int qca_serdev_probe(struct serdev_device *serdev)
1902 struct qca_serdev *qcadev;
1903 struct hci_dev *hdev;
1904 const struct qca_device_data *data;
1906 bool power_ctrl_enabled = true;
1908 qcadev = devm_kzalloc(&serdev->dev, sizeof(*qcadev), GFP_KERNEL);
1912 qcadev->serdev_hu.serdev = serdev;
1913 data = device_get_match_data(&serdev->dev);
1914 serdev_device_set_drvdata(serdev, qcadev);
1915 device_property_read_string(&serdev->dev, "firmware-name",
1916 &qcadev->firmware_name);
1917 device_property_read_u32(&serdev->dev, "max-speed",
1918 &qcadev->oper_speed);
1919 if (!qcadev->oper_speed)
1920 BT_DBG("UART will pick default operating speed");
1922 if (data && qca_is_wcn399x(data->soc_type)) {
1923 qcadev->btsoc_type = data->soc_type;
1924 qcadev->bt_power = devm_kzalloc(&serdev->dev,
1925 sizeof(struct qca_power),
1927 if (!qcadev->bt_power)
1930 qcadev->bt_power->dev = &serdev->dev;
1931 err = qca_init_regulators(qcadev->bt_power, data->vregs,
1934 BT_ERR("Failed to init regulators:%d", err);
1938 qcadev->bt_power->vregs_on = false;
1940 qcadev->susclk = devm_clk_get_optional(&serdev->dev, NULL);
1941 if (IS_ERR(qcadev->susclk)) {
1942 dev_err(&serdev->dev, "failed to acquire clk\n");
1943 return PTR_ERR(qcadev->susclk);
1946 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1948 BT_ERR("wcn3990 serdev registration failed");
1953 qcadev->btsoc_type = data->soc_type;
1955 qcadev->btsoc_type = QCA_ROME;
1957 qcadev->bt_en = devm_gpiod_get_optional(&serdev->dev, "enable",
1959 if (!qcadev->bt_en) {
1960 dev_warn(&serdev->dev, "failed to acquire enable gpio\n");
1961 power_ctrl_enabled = false;
1964 qcadev->susclk = devm_clk_get_optional(&serdev->dev, NULL);
1965 if (!qcadev->susclk) {
1966 dev_warn(&serdev->dev, "failed to acquire clk\n");
1968 err = clk_set_rate(qcadev->susclk, SUSCLK_RATE_32KHZ);
1972 err = clk_prepare_enable(qcadev->susclk);
1977 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1979 BT_ERR("Rome serdev registration failed");
1981 clk_disable_unprepare(qcadev->susclk);
1986 hdev = qcadev->serdev_hu.hdev;
1988 if (power_ctrl_enabled) {
1989 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
1990 hdev->shutdown = qca_power_off;
1993 /* Wideband speech support must be set per driver since it can't be
1996 if (data && (data->capabilities & QCA_CAP_WIDEBAND_SPEECH))
1997 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED, &hdev->quirks);
2002 static void qca_serdev_remove(struct serdev_device *serdev)
2004 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2006 if (qca_is_wcn399x(qcadev->btsoc_type))
2007 qca_power_shutdown(&qcadev->serdev_hu);
2008 else if (qcadev->susclk)
2009 clk_disable_unprepare(qcadev->susclk);
2011 hci_uart_unregister_device(&qcadev->serdev_hu);
2014 static void qca_serdev_shutdown(struct device *dev)
2017 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
2018 struct serdev_device *serdev = to_serdev_device(dev);
2019 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2020 const u8 ibs_wake_cmd[] = { 0xFD };
2021 const u8 edl_reset_soc_cmd[] = { 0x01, 0x00, 0xFC, 0x01, 0x05 };
2023 if (qcadev->btsoc_type == QCA_QCA6390) {
2024 serdev_device_write_flush(serdev);
2025 ret = serdev_device_write_buf(serdev, ibs_wake_cmd,
2026 sizeof(ibs_wake_cmd));
2028 BT_ERR("QCA send IBS_WAKE_IND error: %d", ret);
2031 serdev_device_wait_until_sent(serdev, timeout);
2032 usleep_range(8000, 10000);
2034 serdev_device_write_flush(serdev);
2035 ret = serdev_device_write_buf(serdev, edl_reset_soc_cmd,
2036 sizeof(edl_reset_soc_cmd));
2038 BT_ERR("QCA send EDL_RESET_REQ error: %d", ret);
2041 serdev_device_wait_until_sent(serdev, timeout);
2042 usleep_range(8000, 10000);
2046 static int __maybe_unused qca_suspend(struct device *dev)
2048 struct serdev_device *serdev = to_serdev_device(dev);
2049 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2050 struct hci_uart *hu = &qcadev->serdev_hu;
2051 struct qca_data *qca = hu->priv;
2052 unsigned long flags;
2056 set_bit(QCA_SUSPENDING, &qca->flags);
2058 /* Device is downloading patch or doesn't support in-band sleep. */
2059 if (!test_bit(QCA_IBS_ENABLED, &qca->flags))
2062 cancel_work_sync(&qca->ws_awake_device);
2063 cancel_work_sync(&qca->ws_awake_rx);
2065 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
2066 flags, SINGLE_DEPTH_NESTING);
2068 switch (qca->tx_ibs_state) {
2069 case HCI_IBS_TX_WAKING:
2070 del_timer(&qca->wake_retrans_timer);
2072 case HCI_IBS_TX_AWAKE:
2073 del_timer(&qca->tx_idle_timer);
2075 serdev_device_write_flush(hu->serdev);
2076 cmd = HCI_IBS_SLEEP_IND;
2077 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
2080 BT_ERR("Failed to send SLEEP to device");
2084 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
2085 qca->ibs_sent_slps++;
2087 qca_wq_serial_tx_clock_vote_off(&qca->ws_tx_vote_off);
2090 case HCI_IBS_TX_ASLEEP:
2094 BT_ERR("Spurious tx state %d", qca->tx_ibs_state);
2099 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
2104 serdev_device_wait_until_sent(hu->serdev,
2105 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
2107 /* Wait for HCI_IBS_SLEEP_IND sent by device to indicate its Tx is going
2108 * to sleep, so that the packet does not wake the system later.
2111 ret = wait_event_interruptible_timeout(qca->suspend_wait_q,
2112 qca->rx_ibs_state == HCI_IBS_RX_ASLEEP,
2113 msecs_to_jiffies(IBS_BTSOC_TX_IDLE_TIMEOUT_MS));
2122 clear_bit(QCA_SUSPENDING, &qca->flags);
2127 static int __maybe_unused qca_resume(struct device *dev)
2129 struct serdev_device *serdev = to_serdev_device(dev);
2130 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2131 struct hci_uart *hu = &qcadev->serdev_hu;
2132 struct qca_data *qca = hu->priv;
2134 clear_bit(QCA_SUSPENDING, &qca->flags);
2139 static SIMPLE_DEV_PM_OPS(qca_pm_ops, qca_suspend, qca_resume);
2142 static const struct of_device_id qca_bluetooth_of_match[] = {
2143 { .compatible = "qcom,qca6174-bt" },
2144 { .compatible = "qcom,qca6390-bt", .data = &qca_soc_data_qca6390},
2145 { .compatible = "qcom,qca9377-bt" },
2146 { .compatible = "qcom,wcn3990-bt", .data = &qca_soc_data_wcn3990},
2147 { .compatible = "qcom,wcn3991-bt", .data = &qca_soc_data_wcn3991},
2148 { .compatible = "qcom,wcn3998-bt", .data = &qca_soc_data_wcn3998},
2151 MODULE_DEVICE_TABLE(of, qca_bluetooth_of_match);
2155 static const struct acpi_device_id qca_bluetooth_acpi_match[] = {
2156 { "QCOM6390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2157 { "DLA16390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2158 { "DLB16390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2159 { "DLB26390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2162 MODULE_DEVICE_TABLE(acpi, qca_bluetooth_acpi_match);
2166 static struct serdev_device_driver qca_serdev_driver = {
2167 .probe = qca_serdev_probe,
2168 .remove = qca_serdev_remove,
2170 .name = "hci_uart_qca",
2171 .of_match_table = of_match_ptr(qca_bluetooth_of_match),
2172 .acpi_match_table = ACPI_PTR(qca_bluetooth_acpi_match),
2173 .shutdown = qca_serdev_shutdown,
2178 int __init qca_init(void)
2180 serdev_device_driver_register(&qca_serdev_driver);
2182 return hci_uart_register_proto(&qca_proto);
2185 int __exit qca_deinit(void)
2187 serdev_device_driver_unregister(&qca_serdev_driver);
2189 return hci_uart_unregister_proto(&qca_proto);