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 200
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,
79 enum qca_capabilities {
80 QCA_CAP_WIDEBAND_SPEECH = BIT(0),
81 QCA_CAP_VALID_LE_STATES = BIT(1),
84 /* HCI_IBS transmit side sleep protocol states */
91 /* HCI_IBS receive side sleep protocol states */
97 /* HCI_IBS transmit and receive side clock state vote */
98 enum hci_ibs_clock_state_vote {
99 HCI_IBS_VOTE_STATS_UPDATE,
100 HCI_IBS_TX_VOTE_CLOCK_ON,
101 HCI_IBS_TX_VOTE_CLOCK_OFF,
102 HCI_IBS_RX_VOTE_CLOCK_ON,
103 HCI_IBS_RX_VOTE_CLOCK_OFF,
106 /* Controller memory dump states */
107 enum qca_memdump_states {
109 QCA_MEMDUMP_COLLECTING,
110 QCA_MEMDUMP_COLLECTED,
114 struct qca_memdump_data {
115 char *memdump_buf_head;
116 char *memdump_buf_tail;
122 struct qca_memdump_event_hdr {
131 struct qca_dump_size {
137 struct sk_buff *rx_skb;
138 struct sk_buff_head txq;
139 struct sk_buff_head tx_wait_q; /* HCI_IBS wait queue */
140 struct sk_buff_head rx_memdump_q; /* Memdump wait queue */
141 spinlock_t hci_ibs_lock; /* HCI_IBS state lock */
142 u8 tx_ibs_state; /* HCI_IBS transmit side power state*/
143 u8 rx_ibs_state; /* HCI_IBS receive side power state */
144 bool tx_vote; /* Clock must be on for TX */
145 bool rx_vote; /* Clock must be on for RX */
146 struct timer_list tx_idle_timer;
148 struct timer_list wake_retrans_timer;
150 struct workqueue_struct *workqueue;
151 struct work_struct ws_awake_rx;
152 struct work_struct ws_awake_device;
153 struct work_struct ws_rx_vote_off;
154 struct work_struct ws_tx_vote_off;
155 struct work_struct ctrl_memdump_evt;
156 struct delayed_work ctrl_memdump_timeout;
157 struct qca_memdump_data *qca_memdump;
159 struct completion drop_ev_comp;
160 wait_queue_head_t suspend_wait_q;
161 enum qca_memdump_states memdump_state;
162 struct mutex hci_memdump_lock;
164 /* For debugging purpose */
182 enum qca_speed_type {
188 * Voltage regulator information required for configuring the
189 * QCA Bluetooth chipset
193 unsigned int load_uA;
196 struct qca_device_data {
197 enum qca_btsoc_type soc_type;
198 struct qca_vreg *vregs;
200 uint32_t capabilities;
204 * Platform data for the QCA Bluetooth power driver.
208 struct regulator_bulk_data *vreg_bulk;
214 struct hci_uart serdev_hu;
215 struct gpio_desc *bt_en;
217 enum qca_btsoc_type btsoc_type;
218 struct qca_power *bt_power;
221 const char *firmware_name;
224 static int qca_regulator_enable(struct qca_serdev *qcadev);
225 static void qca_regulator_disable(struct qca_serdev *qcadev);
226 static void qca_power_shutdown(struct hci_uart *hu);
227 static int qca_power_off(struct hci_dev *hdev);
228 static void qca_controller_memdump(struct work_struct *work);
230 static enum qca_btsoc_type qca_soc_type(struct hci_uart *hu)
232 enum qca_btsoc_type soc_type;
235 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
237 soc_type = qsd->btsoc_type;
245 static const char *qca_get_firmware_name(struct hci_uart *hu)
248 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
250 return qsd->firmware_name;
256 static void __serial_clock_on(struct tty_struct *tty)
258 /* TODO: Some chipset requires to enable UART clock on client
259 * side to save power consumption or manual work is required.
260 * Please put your code to control UART clock here if needed
264 static void __serial_clock_off(struct tty_struct *tty)
266 /* TODO: Some chipset requires to disable UART clock on client
267 * side to save power consumption or manual work is required.
268 * Please put your code to control UART clock off here if needed
272 /* serial_clock_vote needs to be called with the ibs lock held */
273 static void serial_clock_vote(unsigned long vote, struct hci_uart *hu)
275 struct qca_data *qca = hu->priv;
278 bool old_vote = (qca->tx_vote | qca->rx_vote);
282 case HCI_IBS_VOTE_STATS_UPDATE:
283 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
286 qca->vote_off_ms += diff;
288 qca->vote_on_ms += diff;
291 case HCI_IBS_TX_VOTE_CLOCK_ON:
296 case HCI_IBS_RX_VOTE_CLOCK_ON:
301 case HCI_IBS_TX_VOTE_CLOCK_OFF:
302 qca->tx_vote = false;
306 case HCI_IBS_RX_VOTE_CLOCK_OFF:
307 qca->rx_vote = false;
312 BT_ERR("Voting irregularity");
316 new_vote = qca->rx_vote | qca->tx_vote;
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:
478 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
482 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
485 static void hci_ibs_wake_retrans_timeout(struct timer_list *t)
487 struct qca_data *qca = from_timer(qca, t, wake_retrans_timer);
488 struct hci_uart *hu = qca->hu;
489 unsigned long flags, retrans_delay;
490 bool retransmit = false;
492 BT_DBG("hu %p wake retransmit timeout in %d state",
493 hu, qca->tx_ibs_state);
495 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
496 flags, SINGLE_DEPTH_NESTING);
498 /* Don't retransmit the HCI_IBS_WAKE_IND when suspending. */
499 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
500 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
504 switch (qca->tx_ibs_state) {
505 case HCI_IBS_TX_WAKING:
506 /* No WAKE_ACK, retransmit WAKE */
508 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0) {
509 BT_ERR("Failed to acknowledge device wake up");
512 qca->ibs_sent_wakes++;
513 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
514 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
517 case HCI_IBS_TX_ASLEEP:
518 case HCI_IBS_TX_AWAKE:
520 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
524 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
527 hci_uart_tx_wakeup(hu);
531 static void qca_controller_memdump_timeout(struct work_struct *work)
533 struct qca_data *qca = container_of(work, struct qca_data,
534 ctrl_memdump_timeout.work);
535 struct hci_uart *hu = qca->hu;
537 mutex_lock(&qca->hci_memdump_lock);
538 if (test_bit(QCA_MEMDUMP_COLLECTION, &qca->flags)) {
539 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
540 if (!test_bit(QCA_HW_ERROR_EVENT, &qca->flags)) {
541 /* Inject hw error event to reset the device
544 hci_reset_dev(hu->hdev);
548 mutex_unlock(&qca->hci_memdump_lock);
552 /* Initialize protocol */
553 static int qca_open(struct hci_uart *hu)
555 struct qca_serdev *qcadev;
556 struct qca_data *qca;
558 BT_DBG("hu %p qca_open", hu);
560 if (!hci_uart_has_flow_control(hu))
563 qca = kzalloc(sizeof(struct qca_data), GFP_KERNEL);
567 skb_queue_head_init(&qca->txq);
568 skb_queue_head_init(&qca->tx_wait_q);
569 skb_queue_head_init(&qca->rx_memdump_q);
570 spin_lock_init(&qca->hci_ibs_lock);
571 mutex_init(&qca->hci_memdump_lock);
572 qca->workqueue = alloc_ordered_workqueue("qca_wq", 0);
573 if (!qca->workqueue) {
574 BT_ERR("QCA Workqueue not initialized properly");
579 INIT_WORK(&qca->ws_awake_rx, qca_wq_awake_rx);
580 INIT_WORK(&qca->ws_awake_device, qca_wq_awake_device);
581 INIT_WORK(&qca->ws_rx_vote_off, qca_wq_serial_rx_clock_vote_off);
582 INIT_WORK(&qca->ws_tx_vote_off, qca_wq_serial_tx_clock_vote_off);
583 INIT_WORK(&qca->ctrl_memdump_evt, qca_controller_memdump);
584 INIT_DELAYED_WORK(&qca->ctrl_memdump_timeout,
585 qca_controller_memdump_timeout);
586 init_waitqueue_head(&qca->suspend_wait_q);
589 init_completion(&qca->drop_ev_comp);
591 /* Assume we start with both sides asleep -- extra wakes OK */
592 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
593 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
595 qca->vote_last_jif = jiffies;
600 qcadev = serdev_device_get_drvdata(hu->serdev);
602 if (qca_is_wcn399x(qcadev->btsoc_type))
603 hu->init_speed = qcadev->init_speed;
605 if (qcadev->oper_speed)
606 hu->oper_speed = qcadev->oper_speed;
609 timer_setup(&qca->wake_retrans_timer, hci_ibs_wake_retrans_timeout, 0);
610 qca->wake_retrans = IBS_WAKE_RETRANS_TIMEOUT_MS;
612 timer_setup(&qca->tx_idle_timer, hci_ibs_tx_idle_timeout, 0);
613 qca->tx_idle_delay = IBS_HOST_TX_IDLE_TIMEOUT_MS;
615 BT_DBG("HCI_UART_QCA open, tx_idle_delay=%u, wake_retrans=%u",
616 qca->tx_idle_delay, qca->wake_retrans);
621 static void qca_debugfs_init(struct hci_dev *hdev)
623 struct hci_uart *hu = hci_get_drvdata(hdev);
624 struct qca_data *qca = hu->priv;
625 struct dentry *ibs_dir;
631 ibs_dir = debugfs_create_dir("ibs", hdev->debugfs);
635 debugfs_create_u8("tx_ibs_state", mode, ibs_dir, &qca->tx_ibs_state);
636 debugfs_create_u8("rx_ibs_state", mode, ibs_dir, &qca->rx_ibs_state);
637 debugfs_create_u64("ibs_sent_sleeps", mode, ibs_dir,
638 &qca->ibs_sent_slps);
639 debugfs_create_u64("ibs_sent_wakes", mode, ibs_dir,
640 &qca->ibs_sent_wakes);
641 debugfs_create_u64("ibs_sent_wake_acks", mode, ibs_dir,
642 &qca->ibs_sent_wacks);
643 debugfs_create_u64("ibs_recv_sleeps", mode, ibs_dir,
644 &qca->ibs_recv_slps);
645 debugfs_create_u64("ibs_recv_wakes", mode, ibs_dir,
646 &qca->ibs_recv_wakes);
647 debugfs_create_u64("ibs_recv_wake_acks", mode, ibs_dir,
648 &qca->ibs_recv_wacks);
649 debugfs_create_bool("tx_vote", mode, ibs_dir, &qca->tx_vote);
650 debugfs_create_u64("tx_votes_on", mode, ibs_dir, &qca->tx_votes_on);
651 debugfs_create_u64("tx_votes_off", mode, ibs_dir, &qca->tx_votes_off);
652 debugfs_create_bool("rx_vote", mode, ibs_dir, &qca->rx_vote);
653 debugfs_create_u64("rx_votes_on", mode, ibs_dir, &qca->rx_votes_on);
654 debugfs_create_u64("rx_votes_off", mode, ibs_dir, &qca->rx_votes_off);
655 debugfs_create_u64("votes_on", mode, ibs_dir, &qca->votes_on);
656 debugfs_create_u64("votes_off", mode, ibs_dir, &qca->votes_off);
657 debugfs_create_u32("vote_on_ms", mode, ibs_dir, &qca->vote_on_ms);
658 debugfs_create_u32("vote_off_ms", mode, ibs_dir, &qca->vote_off_ms);
661 mode = S_IRUGO | S_IWUSR;
662 debugfs_create_u32("wake_retrans", mode, ibs_dir, &qca->wake_retrans);
663 debugfs_create_u32("tx_idle_delay", mode, ibs_dir,
664 &qca->tx_idle_delay);
667 /* Flush protocol data */
668 static int qca_flush(struct hci_uart *hu)
670 struct qca_data *qca = hu->priv;
672 BT_DBG("hu %p qca flush", hu);
674 skb_queue_purge(&qca->tx_wait_q);
675 skb_queue_purge(&qca->txq);
681 static int qca_close(struct hci_uart *hu)
683 struct qca_data *qca = hu->priv;
685 BT_DBG("hu %p qca close", hu);
687 serial_clock_vote(HCI_IBS_VOTE_STATS_UPDATE, hu);
689 skb_queue_purge(&qca->tx_wait_q);
690 skb_queue_purge(&qca->txq);
691 skb_queue_purge(&qca->rx_memdump_q);
692 destroy_workqueue(qca->workqueue);
693 del_timer_sync(&qca->tx_idle_timer);
694 del_timer_sync(&qca->wake_retrans_timer);
697 kfree_skb(qca->rx_skb);
706 /* Called upon a wake-up-indication from the device.
708 static void device_want_to_wakeup(struct hci_uart *hu)
711 struct qca_data *qca = hu->priv;
713 BT_DBG("hu %p want to wake up", hu);
715 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
717 qca->ibs_recv_wakes++;
719 /* Don't wake the rx up when suspending. */
720 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
721 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
725 switch (qca->rx_ibs_state) {
726 case HCI_IBS_RX_ASLEEP:
727 /* Make sure clock is on - we may have turned clock off since
728 * receiving the wake up indicator awake rx clock.
730 queue_work(qca->workqueue, &qca->ws_awake_rx);
731 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
734 case HCI_IBS_RX_AWAKE:
735 /* Always acknowledge device wake up,
736 * sending IBS message doesn't count as TX ON.
738 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0) {
739 BT_ERR("Failed to acknowledge device wake up");
742 qca->ibs_sent_wacks++;
746 /* Any other state is illegal */
747 BT_ERR("Received HCI_IBS_WAKE_IND in rx state %d",
752 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
754 /* Actually send the packets */
755 hci_uart_tx_wakeup(hu);
758 /* Called upon a sleep-indication from the device.
760 static void device_want_to_sleep(struct hci_uart *hu)
763 struct qca_data *qca = hu->priv;
765 BT_DBG("hu %p want to sleep in %d state", hu, qca->rx_ibs_state);
767 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
769 qca->ibs_recv_slps++;
771 switch (qca->rx_ibs_state) {
772 case HCI_IBS_RX_AWAKE:
774 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
775 /* Vote off rx clock under workqueue */
776 queue_work(qca->workqueue, &qca->ws_rx_vote_off);
779 case HCI_IBS_RX_ASLEEP:
783 /* Any other state is illegal */
784 BT_ERR("Received HCI_IBS_SLEEP_IND in rx state %d",
789 wake_up_interruptible(&qca->suspend_wait_q);
791 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
794 /* Called upon wake-up-acknowledgement from the device
796 static void device_woke_up(struct hci_uart *hu)
798 unsigned long flags, idle_delay;
799 struct qca_data *qca = hu->priv;
800 struct sk_buff *skb = NULL;
802 BT_DBG("hu %p woke up", hu);
804 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
806 qca->ibs_recv_wacks++;
808 /* Don't react to the wake-up-acknowledgment when suspending. */
809 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
810 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
814 switch (qca->tx_ibs_state) {
815 case HCI_IBS_TX_AWAKE:
816 /* Expect one if we send 2 WAKEs */
817 BT_DBG("Received HCI_IBS_WAKE_ACK in tx state %d",
821 case HCI_IBS_TX_WAKING:
822 /* Send pending packets */
823 while ((skb = skb_dequeue(&qca->tx_wait_q)))
824 skb_queue_tail(&qca->txq, skb);
826 /* Switch timers and change state to HCI_IBS_TX_AWAKE */
827 del_timer(&qca->wake_retrans_timer);
828 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
829 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
830 qca->tx_ibs_state = HCI_IBS_TX_AWAKE;
833 case HCI_IBS_TX_ASLEEP:
835 BT_ERR("Received HCI_IBS_WAKE_ACK in tx state %d",
840 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
842 /* Actually send the packets */
843 hci_uart_tx_wakeup(hu);
846 /* Enqueue frame for transmittion (padding, crc, etc) may be called from
847 * two simultaneous tasklets.
849 static int qca_enqueue(struct hci_uart *hu, struct sk_buff *skb)
851 unsigned long flags = 0, idle_delay;
852 struct qca_data *qca = hu->priv;
854 BT_DBG("hu %p qca enq skb %p tx_ibs_state %d", hu, skb,
857 if (test_bit(QCA_SSR_TRIGGERED, &qca->flags)) {
858 /* As SSR is in progress, ignore the packets */
859 bt_dev_dbg(hu->hdev, "SSR is in progress");
864 /* Prepend skb with frame type */
865 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
867 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
869 /* Don't go to sleep in middle of patch download or
870 * Out-Of-Band(GPIOs control) sleep is selected.
871 * Don't wake the device up when suspending.
873 if (!test_bit(QCA_IBS_ENABLED, &qca->flags) ||
874 test_bit(QCA_SUSPENDING, &qca->flags)) {
875 skb_queue_tail(&qca->txq, skb);
876 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
880 /* Act according to current state */
881 switch (qca->tx_ibs_state) {
882 case HCI_IBS_TX_AWAKE:
883 BT_DBG("Device awake, sending normally");
884 skb_queue_tail(&qca->txq, skb);
885 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
886 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
889 case HCI_IBS_TX_ASLEEP:
890 BT_DBG("Device asleep, waking up and queueing packet");
891 /* Save packet for later */
892 skb_queue_tail(&qca->tx_wait_q, skb);
894 qca->tx_ibs_state = HCI_IBS_TX_WAKING;
895 /* Schedule a work queue to wake up device */
896 queue_work(qca->workqueue, &qca->ws_awake_device);
899 case HCI_IBS_TX_WAKING:
900 BT_DBG("Device waking up, queueing packet");
901 /* Transient state; just keep packet for later */
902 skb_queue_tail(&qca->tx_wait_q, skb);
906 BT_ERR("Illegal tx state: %d (losing packet)",
912 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
917 static int qca_ibs_sleep_ind(struct hci_dev *hdev, struct sk_buff *skb)
919 struct hci_uart *hu = hci_get_drvdata(hdev);
921 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_SLEEP_IND);
923 device_want_to_sleep(hu);
929 static int qca_ibs_wake_ind(struct hci_dev *hdev, struct sk_buff *skb)
931 struct hci_uart *hu = hci_get_drvdata(hdev);
933 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_IND);
935 device_want_to_wakeup(hu);
941 static int qca_ibs_wake_ack(struct hci_dev *hdev, struct sk_buff *skb)
943 struct hci_uart *hu = hci_get_drvdata(hdev);
945 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_ACK);
953 static int qca_recv_acl_data(struct hci_dev *hdev, struct sk_buff *skb)
955 /* We receive debug logs from chip as an ACL packets.
956 * Instead of sending the data to ACL to decode the
957 * received data, we are pushing them to the above layers
958 * as a diagnostic packet.
960 if (get_unaligned_le16(skb->data) == QCA_DEBUG_HANDLE)
961 return hci_recv_diag(hdev, skb);
963 return hci_recv_frame(hdev, skb);
966 static void qca_controller_memdump(struct work_struct *work)
968 struct qca_data *qca = container_of(work, struct qca_data,
970 struct hci_uart *hu = qca->hu;
972 struct qca_memdump_event_hdr *cmd_hdr;
973 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
974 struct qca_dump_size *dump;
976 char nullBuff[QCA_DUMP_PACKET_SIZE] = { 0 };
980 enum qca_btsoc_type soc_type = qca_soc_type(hu);
982 while ((skb = skb_dequeue(&qca->rx_memdump_q))) {
984 mutex_lock(&qca->hci_memdump_lock);
985 /* Skip processing the received packets if timeout detected
986 * or memdump collection completed.
988 if (qca->memdump_state == QCA_MEMDUMP_TIMEOUT ||
989 qca->memdump_state == QCA_MEMDUMP_COLLECTED) {
990 mutex_unlock(&qca->hci_memdump_lock);
995 qca_memdump = kzalloc(sizeof(struct qca_memdump_data),
998 mutex_unlock(&qca->hci_memdump_lock);
1002 qca->qca_memdump = qca_memdump;
1005 qca->memdump_state = QCA_MEMDUMP_COLLECTING;
1006 cmd_hdr = (void *) skb->data;
1007 seq_no = __le16_to_cpu(cmd_hdr->seq_no);
1008 skb_pull(skb, sizeof(struct qca_memdump_event_hdr));
1012 /* This is the first frame of memdump packet from
1013 * the controller, Disable IBS to recevie dump
1014 * with out any interruption, ideally time required for
1015 * the controller to send the dump is 8 seconds. let us
1016 * start timer to handle this asynchronous activity.
1018 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1019 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1020 dump = (void *) skb->data;
1021 dump_size = __le32_to_cpu(dump->dump_size);
1023 bt_dev_err(hu->hdev, "Rx invalid memdump size");
1026 qca->qca_memdump = NULL;
1027 mutex_unlock(&qca->hci_memdump_lock);
1031 bt_dev_info(hu->hdev, "QCA collecting dump of size:%u",
1033 queue_delayed_work(qca->workqueue,
1034 &qca->ctrl_memdump_timeout,
1035 msecs_to_jiffies(MEMDUMP_TIMEOUT_MS)
1038 skb_pull(skb, sizeof(dump_size));
1039 memdump_buf = vmalloc(dump_size);
1040 qca_memdump->ram_dump_size = dump_size;
1041 qca_memdump->memdump_buf_head = memdump_buf;
1042 qca_memdump->memdump_buf_tail = memdump_buf;
1045 memdump_buf = qca_memdump->memdump_buf_tail;
1047 /* If sequence no 0 is missed then there is no point in
1048 * accepting the other sequences.
1051 bt_dev_err(hu->hdev, "QCA: Discarding other packets");
1054 qca->qca_memdump = NULL;
1055 mutex_unlock(&qca->hci_memdump_lock);
1059 /* There could be chance of missing some packets from
1060 * the controller. In such cases let us store the dummy
1061 * packets in the buffer.
1063 /* For QCA6390, controller does not lost packets but
1064 * sequence number field of packat sometimes has error
1065 * bits, so skip this checking for missing packet.
1067 while ((seq_no > qca_memdump->current_seq_no + 1) &&
1068 (soc_type != QCA_QCA6390) &&
1069 seq_no != QCA_LAST_SEQUENCE_NUM) {
1070 bt_dev_err(hu->hdev, "QCA controller missed packet:%d",
1071 qca_memdump->current_seq_no);
1072 rx_size = qca_memdump->received_dump;
1073 rx_size += QCA_DUMP_PACKET_SIZE;
1074 if (rx_size > qca_memdump->ram_dump_size) {
1075 bt_dev_err(hu->hdev,
1076 "QCA memdump received %d, no space for missed packet",
1077 qca_memdump->received_dump);
1080 memcpy(memdump_buf, nullBuff, QCA_DUMP_PACKET_SIZE);
1081 memdump_buf = memdump_buf + QCA_DUMP_PACKET_SIZE;
1082 qca_memdump->received_dump += QCA_DUMP_PACKET_SIZE;
1083 qca_memdump->current_seq_no++;
1086 rx_size = qca_memdump->received_dump + skb->len;
1087 if (rx_size <= qca_memdump->ram_dump_size) {
1088 if ((seq_no != QCA_LAST_SEQUENCE_NUM) &&
1089 (seq_no != qca_memdump->current_seq_no))
1090 bt_dev_err(hu->hdev,
1091 "QCA memdump unexpected packet %d",
1093 bt_dev_dbg(hu->hdev,
1094 "QCA memdump packet %d with length %d",
1096 memcpy(memdump_buf, (unsigned char *)skb->data,
1098 memdump_buf = memdump_buf + skb->len;
1099 qca_memdump->memdump_buf_tail = memdump_buf;
1100 qca_memdump->current_seq_no = seq_no + 1;
1101 qca_memdump->received_dump += skb->len;
1103 bt_dev_err(hu->hdev,
1104 "QCA memdump received %d, no space for packet %d",
1105 qca_memdump->received_dump, seq_no);
1107 qca->qca_memdump = qca_memdump;
1109 if (seq_no == QCA_LAST_SEQUENCE_NUM) {
1110 bt_dev_info(hu->hdev,
1111 "QCA memdump Done, received %d, total %d",
1112 qca_memdump->received_dump,
1113 qca_memdump->ram_dump_size);
1114 memdump_buf = qca_memdump->memdump_buf_head;
1115 dev_coredumpv(&hu->serdev->dev, memdump_buf,
1116 qca_memdump->received_dump, GFP_KERNEL);
1117 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1118 kfree(qca->qca_memdump);
1119 qca->qca_memdump = NULL;
1120 qca->memdump_state = QCA_MEMDUMP_COLLECTED;
1121 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1124 mutex_unlock(&qca->hci_memdump_lock);
1129 static int qca_controller_memdump_event(struct hci_dev *hdev,
1130 struct sk_buff *skb)
1132 struct hci_uart *hu = hci_get_drvdata(hdev);
1133 struct qca_data *qca = hu->priv;
1135 set_bit(QCA_SSR_TRIGGERED, &qca->flags);
1136 skb_queue_tail(&qca->rx_memdump_q, skb);
1137 queue_work(qca->workqueue, &qca->ctrl_memdump_evt);
1142 static int qca_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
1144 struct hci_uart *hu = hci_get_drvdata(hdev);
1145 struct qca_data *qca = hu->priv;
1147 if (test_bit(QCA_DROP_VENDOR_EVENT, &qca->flags)) {
1148 struct hci_event_hdr *hdr = (void *)skb->data;
1150 /* For the WCN3990 the vendor command for a baudrate change
1151 * isn't sent as synchronous HCI command, because the
1152 * controller sends the corresponding vendor event with the
1153 * new baudrate. The event is received and properly decoded
1154 * after changing the baudrate of the host port. It needs to
1155 * be dropped, otherwise it can be misinterpreted as
1156 * response to a later firmware download command (also a
1160 if (hdr->evt == HCI_EV_VENDOR)
1161 complete(&qca->drop_ev_comp);
1167 /* We receive chip memory dump as an event packet, With a dedicated
1168 * handler followed by a hardware error event. When this event is
1169 * received we store dump into a file before closing hci. This
1170 * dump will help in triaging the issues.
1172 if ((skb->data[0] == HCI_VENDOR_PKT) &&
1173 (get_unaligned_be16(skb->data + 2) == QCA_SSR_DUMP_HANDLE))
1174 return qca_controller_memdump_event(hdev, skb);
1176 return hci_recv_frame(hdev, skb);
1179 #define QCA_IBS_SLEEP_IND_EVENT \
1180 .type = HCI_IBS_SLEEP_IND, \
1184 .maxlen = HCI_MAX_IBS_SIZE
1186 #define QCA_IBS_WAKE_IND_EVENT \
1187 .type = HCI_IBS_WAKE_IND, \
1191 .maxlen = HCI_MAX_IBS_SIZE
1193 #define QCA_IBS_WAKE_ACK_EVENT \
1194 .type = HCI_IBS_WAKE_ACK, \
1198 .maxlen = HCI_MAX_IBS_SIZE
1200 static const struct h4_recv_pkt qca_recv_pkts[] = {
1201 { H4_RECV_ACL, .recv = qca_recv_acl_data },
1202 { H4_RECV_SCO, .recv = hci_recv_frame },
1203 { H4_RECV_EVENT, .recv = qca_recv_event },
1204 { QCA_IBS_WAKE_IND_EVENT, .recv = qca_ibs_wake_ind },
1205 { QCA_IBS_WAKE_ACK_EVENT, .recv = qca_ibs_wake_ack },
1206 { QCA_IBS_SLEEP_IND_EVENT, .recv = qca_ibs_sleep_ind },
1209 static int qca_recv(struct hci_uart *hu, const void *data, int count)
1211 struct qca_data *qca = hu->priv;
1213 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
1216 qca->rx_skb = h4_recv_buf(hu->hdev, qca->rx_skb, data, count,
1217 qca_recv_pkts, ARRAY_SIZE(qca_recv_pkts));
1218 if (IS_ERR(qca->rx_skb)) {
1219 int err = PTR_ERR(qca->rx_skb);
1220 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
1228 static struct sk_buff *qca_dequeue(struct hci_uart *hu)
1230 struct qca_data *qca = hu->priv;
1232 return skb_dequeue(&qca->txq);
1235 static uint8_t qca_get_baudrate_value(int speed)
1239 return QCA_BAUDRATE_9600;
1241 return QCA_BAUDRATE_19200;
1243 return QCA_BAUDRATE_38400;
1245 return QCA_BAUDRATE_57600;
1247 return QCA_BAUDRATE_115200;
1249 return QCA_BAUDRATE_230400;
1251 return QCA_BAUDRATE_460800;
1253 return QCA_BAUDRATE_500000;
1255 return QCA_BAUDRATE_921600;
1257 return QCA_BAUDRATE_1000000;
1259 return QCA_BAUDRATE_2000000;
1261 return QCA_BAUDRATE_3000000;
1263 return QCA_BAUDRATE_3200000;
1265 return QCA_BAUDRATE_3500000;
1267 return QCA_BAUDRATE_115200;
1271 static int qca_set_baudrate(struct hci_dev *hdev, uint8_t baudrate)
1273 struct hci_uart *hu = hci_get_drvdata(hdev);
1274 struct qca_data *qca = hu->priv;
1275 struct sk_buff *skb;
1276 u8 cmd[] = { 0x01, 0x48, 0xFC, 0x01, 0x00 };
1278 if (baudrate > QCA_BAUDRATE_3200000)
1283 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
1285 bt_dev_err(hdev, "Failed to allocate baudrate packet");
1289 /* Assign commands to change baudrate and packet type. */
1290 skb_put_data(skb, cmd, sizeof(cmd));
1291 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1293 skb_queue_tail(&qca->txq, skb);
1294 hci_uart_tx_wakeup(hu);
1296 /* Wait for the baudrate change request to be sent */
1298 while (!skb_queue_empty(&qca->txq))
1299 usleep_range(100, 200);
1302 serdev_device_wait_until_sent(hu->serdev,
1303 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1305 /* Give the controller time to process the request */
1306 if (qca_is_wcn399x(qca_soc_type(hu)))
1314 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
1317 serdev_device_set_baudrate(hu->serdev, speed);
1319 hci_uart_set_baudrate(hu, speed);
1322 static int qca_send_power_pulse(struct hci_uart *hu, bool on)
1325 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
1326 u8 cmd = on ? QCA_WCN3990_POWERON_PULSE : QCA_WCN3990_POWEROFF_PULSE;
1328 /* These power pulses are single byte command which are sent
1329 * at required baudrate to wcn3990. On wcn3990, we have an external
1330 * circuit at Tx pin which decodes the pulse sent at specific baudrate.
1331 * For example, wcn3990 supports RF COEX antenna for both Wi-Fi/BT
1332 * and also we use the same power inputs to turn on and off for
1333 * Wi-Fi/BT. Powering up the power sources will not enable BT, until
1334 * we send a power on pulse at 115200 bps. This algorithm will help to
1335 * save power. Disabling hardware flow control is mandatory while
1336 * sending power pulses to SoC.
1338 bt_dev_dbg(hu->hdev, "sending power pulse %02x to controller", cmd);
1340 serdev_device_write_flush(hu->serdev);
1341 hci_uart_set_flow_control(hu, true);
1342 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1344 bt_dev_err(hu->hdev, "failed to send power pulse %02x", cmd);
1348 serdev_device_wait_until_sent(hu->serdev, timeout);
1349 hci_uart_set_flow_control(hu, false);
1351 /* Give to controller time to boot/shutdown */
1360 static unsigned int qca_get_speed(struct hci_uart *hu,
1361 enum qca_speed_type speed_type)
1363 unsigned int speed = 0;
1365 if (speed_type == QCA_INIT_SPEED) {
1367 speed = hu->init_speed;
1368 else if (hu->proto->init_speed)
1369 speed = hu->proto->init_speed;
1372 speed = hu->oper_speed;
1373 else if (hu->proto->oper_speed)
1374 speed = hu->proto->oper_speed;
1380 static int qca_check_speeds(struct hci_uart *hu)
1382 if (qca_is_wcn399x(qca_soc_type(hu))) {
1383 if (!qca_get_speed(hu, QCA_INIT_SPEED) &&
1384 !qca_get_speed(hu, QCA_OPER_SPEED))
1387 if (!qca_get_speed(hu, QCA_INIT_SPEED) ||
1388 !qca_get_speed(hu, QCA_OPER_SPEED))
1395 static int qca_set_speed(struct hci_uart *hu, enum qca_speed_type speed_type)
1397 unsigned int speed, qca_baudrate;
1398 struct qca_data *qca = hu->priv;
1401 if (speed_type == QCA_INIT_SPEED) {
1402 speed = qca_get_speed(hu, QCA_INIT_SPEED);
1404 host_set_baudrate(hu, speed);
1406 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1408 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1412 /* Disable flow control for wcn3990 to deassert RTS while
1413 * changing the baudrate of chip and host.
1415 if (qca_is_wcn399x(soc_type))
1416 hci_uart_set_flow_control(hu, true);
1418 if (soc_type == QCA_WCN3990) {
1419 reinit_completion(&qca->drop_ev_comp);
1420 set_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1423 qca_baudrate = qca_get_baudrate_value(speed);
1424 bt_dev_dbg(hu->hdev, "Set UART speed to %d", speed);
1425 ret = qca_set_baudrate(hu->hdev, qca_baudrate);
1429 host_set_baudrate(hu, speed);
1432 if (qca_is_wcn399x(soc_type))
1433 hci_uart_set_flow_control(hu, false);
1435 if (soc_type == QCA_WCN3990) {
1436 /* Wait for the controller to send the vendor event
1437 * for the baudrate change command.
1439 if (!wait_for_completion_timeout(&qca->drop_ev_comp,
1440 msecs_to_jiffies(100))) {
1441 bt_dev_err(hu->hdev,
1442 "Failed to change controller baudrate\n");
1446 clear_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1453 static int qca_send_crashbuffer(struct hci_uart *hu)
1455 struct qca_data *qca = hu->priv;
1456 struct sk_buff *skb;
1458 skb = bt_skb_alloc(QCA_CRASHBYTE_PACKET_LEN, GFP_KERNEL);
1460 bt_dev_err(hu->hdev, "Failed to allocate memory for skb packet");
1464 /* We forcefully crash the controller, by sending 0xfb byte for
1465 * 1024 times. We also might have chance of losing data, To be
1466 * on safer side we send 1096 bytes to the SoC.
1468 memset(skb_put(skb, QCA_CRASHBYTE_PACKET_LEN), QCA_MEMDUMP_BYTE,
1469 QCA_CRASHBYTE_PACKET_LEN);
1470 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1471 bt_dev_info(hu->hdev, "crash the soc to collect controller dump");
1472 skb_queue_tail(&qca->txq, skb);
1473 hci_uart_tx_wakeup(hu);
1478 static void qca_wait_for_dump_collection(struct hci_dev *hdev)
1480 struct hci_uart *hu = hci_get_drvdata(hdev);
1481 struct qca_data *qca = hu->priv;
1483 wait_on_bit_timeout(&qca->flags, QCA_MEMDUMP_COLLECTION,
1484 TASK_UNINTERRUPTIBLE, MEMDUMP_TIMEOUT_MS);
1486 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1489 static void qca_hw_error(struct hci_dev *hdev, u8 code)
1491 struct hci_uart *hu = hci_get_drvdata(hdev);
1492 struct qca_data *qca = hu->priv;
1494 set_bit(QCA_SSR_TRIGGERED, &qca->flags);
1495 set_bit(QCA_HW_ERROR_EVENT, &qca->flags);
1496 bt_dev_info(hdev, "mem_dump_status: %d", qca->memdump_state);
1498 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1499 /* If hardware error event received for other than QCA
1500 * soc memory dump event, then we need to crash the SOC
1501 * and wait here for 8 seconds to get the dump packets.
1502 * This will block main thread to be on hold until we
1505 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1506 qca_send_crashbuffer(hu);
1507 qca_wait_for_dump_collection(hdev);
1508 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1509 /* Let us wait here until memory dump collected or
1510 * memory dump timer expired.
1512 bt_dev_info(hdev, "waiting for dump to complete");
1513 qca_wait_for_dump_collection(hdev);
1516 mutex_lock(&qca->hci_memdump_lock);
1517 if (qca->memdump_state != QCA_MEMDUMP_COLLECTED) {
1518 bt_dev_err(hu->hdev, "clearing allocated memory due to memdump timeout");
1519 if (qca->qca_memdump) {
1520 vfree(qca->qca_memdump->memdump_buf_head);
1521 kfree(qca->qca_memdump);
1522 qca->qca_memdump = NULL;
1524 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1525 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1527 mutex_unlock(&qca->hci_memdump_lock);
1529 if (qca->memdump_state == QCA_MEMDUMP_TIMEOUT ||
1530 qca->memdump_state == QCA_MEMDUMP_COLLECTED) {
1531 cancel_work_sync(&qca->ctrl_memdump_evt);
1532 skb_queue_purge(&qca->rx_memdump_q);
1535 clear_bit(QCA_HW_ERROR_EVENT, &qca->flags);
1538 static void qca_cmd_timeout(struct hci_dev *hdev)
1540 struct hci_uart *hu = hci_get_drvdata(hdev);
1541 struct qca_data *qca = hu->priv;
1543 set_bit(QCA_SSR_TRIGGERED, &qca->flags);
1544 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1545 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1546 qca_send_crashbuffer(hu);
1547 qca_wait_for_dump_collection(hdev);
1548 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1549 /* Let us wait here until memory dump collected or
1550 * memory dump timer expired.
1552 bt_dev_info(hdev, "waiting for dump to complete");
1553 qca_wait_for_dump_collection(hdev);
1556 mutex_lock(&qca->hci_memdump_lock);
1557 if (qca->memdump_state != QCA_MEMDUMP_COLLECTED) {
1558 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1559 if (!test_bit(QCA_HW_ERROR_EVENT, &qca->flags)) {
1560 /* Inject hw error event to reset the device
1563 hci_reset_dev(hu->hdev);
1566 mutex_unlock(&qca->hci_memdump_lock);
1569 static int qca_wcn3990_init(struct hci_uart *hu)
1571 struct qca_serdev *qcadev;
1574 /* Check for vregs status, may be hci down has turned
1575 * off the voltage regulator.
1577 qcadev = serdev_device_get_drvdata(hu->serdev);
1578 if (!qcadev->bt_power->vregs_on) {
1579 serdev_device_close(hu->serdev);
1580 ret = qca_regulator_enable(qcadev);
1584 ret = serdev_device_open(hu->serdev);
1586 bt_dev_err(hu->hdev, "failed to open port");
1591 /* Forcefully enable wcn3990 to enter in to boot mode. */
1592 host_set_baudrate(hu, 2400);
1593 ret = qca_send_power_pulse(hu, false);
1597 qca_set_speed(hu, QCA_INIT_SPEED);
1598 ret = qca_send_power_pulse(hu, true);
1602 /* Now the device is in ready state to communicate with host.
1603 * To sync host with device we need to reopen port.
1604 * Without this, we will have RTS and CTS synchronization
1607 serdev_device_close(hu->serdev);
1608 ret = serdev_device_open(hu->serdev);
1610 bt_dev_err(hu->hdev, "failed to open port");
1614 hci_uart_set_flow_control(hu, false);
1619 static int qca_power_on(struct hci_dev *hdev)
1621 struct hci_uart *hu = hci_get_drvdata(hdev);
1622 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1623 struct qca_serdev *qcadev;
1626 /* Non-serdev device usually is powered by external power
1627 * and don't need additional action in driver for power on
1632 if (qca_is_wcn399x(soc_type)) {
1633 ret = qca_wcn3990_init(hu);
1635 qcadev = serdev_device_get_drvdata(hu->serdev);
1636 if (qcadev->bt_en) {
1637 gpiod_set_value_cansleep(qcadev->bt_en, 1);
1638 /* Controller needs time to bootup. */
1646 static int qca_setup(struct hci_uart *hu)
1648 struct hci_dev *hdev = hu->hdev;
1649 struct qca_data *qca = hu->priv;
1650 unsigned int speed, qca_baudrate = QCA_BAUDRATE_115200;
1651 unsigned int retries = 0;
1652 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1653 const char *firmware_name = qca_get_firmware_name(hu);
1657 ret = qca_check_speeds(hu);
1661 /* Patch downloading has to be done without IBS mode */
1662 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1664 /* Enable controller to do both LE scan and BR/EDR inquiry
1667 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1669 bt_dev_info(hdev, "setting up %s",
1670 qca_is_wcn399x(soc_type) ? "wcn399x" : "ROME/QCA6390");
1672 qca->memdump_state = QCA_MEMDUMP_IDLE;
1675 ret = qca_power_on(hdev);
1679 clear_bit(QCA_SSR_TRIGGERED, &qca->flags);
1681 if (qca_is_wcn399x(soc_type)) {
1682 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hdev->quirks);
1684 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1688 qca_set_speed(hu, QCA_INIT_SPEED);
1691 /* Setup user speed if needed */
1692 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1694 ret = qca_set_speed(hu, QCA_OPER_SPEED);
1698 qca_baudrate = qca_get_baudrate_value(speed);
1701 if (!qca_is_wcn399x(soc_type)) {
1702 /* Get QCA version information */
1703 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1708 bt_dev_info(hdev, "QCA controller version 0x%08x", soc_ver);
1709 /* Setup patch / NVM configurations */
1710 ret = qca_uart_setup(hdev, qca_baudrate, soc_type, soc_ver,
1713 set_bit(QCA_IBS_ENABLED, &qca->flags);
1714 qca_debugfs_init(hdev);
1715 hu->hdev->hw_error = qca_hw_error;
1716 hu->hdev->cmd_timeout = qca_cmd_timeout;
1717 } else if (ret == -ENOENT) {
1718 /* No patch/nvm-config found, run with original fw/config */
1720 } else if (ret == -EAGAIN) {
1722 * Userspace firmware loader will return -EAGAIN in case no
1723 * patch/nvm-config is found, so run with original fw/config.
1727 if (retries < MAX_INIT_RETRIES) {
1728 qca_power_shutdown(hu);
1730 serdev_device_close(hu->serdev);
1731 ret = serdev_device_open(hu->serdev);
1733 bt_dev_err(hdev, "failed to open port");
1743 if (soc_type == QCA_ROME)
1744 hu->hdev->set_bdaddr = qca_set_bdaddr_rome;
1746 hu->hdev->set_bdaddr = qca_set_bdaddr;
1751 static const struct hci_uart_proto qca_proto = {
1755 .init_speed = 115200,
1756 .oper_speed = 3000000,
1762 .enqueue = qca_enqueue,
1763 .dequeue = qca_dequeue,
1766 static const struct qca_device_data qca_soc_data_wcn3990 = {
1767 .soc_type = QCA_WCN3990,
1768 .vregs = (struct qca_vreg []) {
1771 { "vddrf", 300000 },
1772 { "vddch0", 450000 },
1777 static const struct qca_device_data qca_soc_data_wcn3991 = {
1778 .soc_type = QCA_WCN3991,
1779 .vregs = (struct qca_vreg []) {
1782 { "vddrf", 300000 },
1783 { "vddch0", 450000 },
1786 .capabilities = QCA_CAP_WIDEBAND_SPEECH | QCA_CAP_VALID_LE_STATES,
1789 static const struct qca_device_data qca_soc_data_wcn3998 = {
1790 .soc_type = QCA_WCN3998,
1791 .vregs = (struct qca_vreg []) {
1794 { "vddrf", 300000 },
1795 { "vddch0", 450000 },
1800 static const struct qca_device_data qca_soc_data_qca6390 = {
1801 .soc_type = QCA_QCA6390,
1805 static void qca_power_shutdown(struct hci_uart *hu)
1807 struct qca_serdev *qcadev;
1808 struct qca_data *qca = hu->priv;
1809 unsigned long flags;
1810 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1812 /* From this point we go into power off state. But serial port is
1813 * still open, stop queueing the IBS data and flush all the buffered
1816 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
1817 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1819 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
1821 /* Non-serdev device usually is powered by external power
1822 * and don't need additional action in driver for power down
1827 qcadev = serdev_device_get_drvdata(hu->serdev);
1829 if (qca_is_wcn399x(soc_type)) {
1830 host_set_baudrate(hu, 2400);
1831 qca_send_power_pulse(hu, false);
1832 qca_regulator_disable(qcadev);
1833 } else if (qcadev->bt_en) {
1834 gpiod_set_value_cansleep(qcadev->bt_en, 0);
1838 static int qca_power_off(struct hci_dev *hdev)
1840 struct hci_uart *hu = hci_get_drvdata(hdev);
1841 struct qca_data *qca = hu->priv;
1842 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1844 hu->hdev->hw_error = NULL;
1845 hu->hdev->cmd_timeout = NULL;
1847 del_timer_sync(&qca->wake_retrans_timer);
1848 del_timer_sync(&qca->tx_idle_timer);
1850 /* Stop sending shutdown command if soc crashes. */
1851 if (soc_type != QCA_ROME
1852 && qca->memdump_state == QCA_MEMDUMP_IDLE) {
1853 qca_send_pre_shutdown_cmd(hdev);
1854 usleep_range(8000, 10000);
1857 qca_power_shutdown(hu);
1861 static int qca_regulator_enable(struct qca_serdev *qcadev)
1863 struct qca_power *power = qcadev->bt_power;
1866 /* Already enabled */
1867 if (power->vregs_on)
1870 BT_DBG("enabling %d regulators)", power->num_vregs);
1872 ret = regulator_bulk_enable(power->num_vregs, power->vreg_bulk);
1876 power->vregs_on = true;
1878 ret = clk_prepare_enable(qcadev->susclk);
1880 qca_regulator_disable(qcadev);
1885 static void qca_regulator_disable(struct qca_serdev *qcadev)
1887 struct qca_power *power;
1892 power = qcadev->bt_power;
1894 /* Already disabled? */
1895 if (!power->vregs_on)
1898 regulator_bulk_disable(power->num_vregs, power->vreg_bulk);
1899 power->vregs_on = false;
1901 clk_disable_unprepare(qcadev->susclk);
1904 static int qca_init_regulators(struct qca_power *qca,
1905 const struct qca_vreg *vregs, size_t num_vregs)
1907 struct regulator_bulk_data *bulk;
1911 bulk = devm_kcalloc(qca->dev, num_vregs, sizeof(*bulk), GFP_KERNEL);
1915 for (i = 0; i < num_vregs; i++)
1916 bulk[i].supply = vregs[i].name;
1918 ret = devm_regulator_bulk_get(qca->dev, num_vregs, bulk);
1922 for (i = 0; i < num_vregs; i++) {
1923 ret = regulator_set_load(bulk[i].consumer, vregs[i].load_uA);
1928 qca->vreg_bulk = bulk;
1929 qca->num_vregs = num_vregs;
1934 static int qca_serdev_probe(struct serdev_device *serdev)
1936 struct qca_serdev *qcadev;
1937 struct hci_dev *hdev;
1938 const struct qca_device_data *data;
1940 bool power_ctrl_enabled = true;
1942 qcadev = devm_kzalloc(&serdev->dev, sizeof(*qcadev), GFP_KERNEL);
1946 qcadev->serdev_hu.serdev = serdev;
1947 data = device_get_match_data(&serdev->dev);
1948 serdev_device_set_drvdata(serdev, qcadev);
1949 device_property_read_string(&serdev->dev, "firmware-name",
1950 &qcadev->firmware_name);
1951 device_property_read_u32(&serdev->dev, "max-speed",
1952 &qcadev->oper_speed);
1953 if (!qcadev->oper_speed)
1954 BT_DBG("UART will pick default operating speed");
1956 if (data && qca_is_wcn399x(data->soc_type)) {
1957 qcadev->btsoc_type = data->soc_type;
1958 qcadev->bt_power = devm_kzalloc(&serdev->dev,
1959 sizeof(struct qca_power),
1961 if (!qcadev->bt_power)
1964 qcadev->bt_power->dev = &serdev->dev;
1965 err = qca_init_regulators(qcadev->bt_power, data->vregs,
1968 BT_ERR("Failed to init regulators:%d", err);
1972 qcadev->bt_power->vregs_on = false;
1974 qcadev->susclk = devm_clk_get_optional(&serdev->dev, NULL);
1975 if (IS_ERR(qcadev->susclk)) {
1976 dev_err(&serdev->dev, "failed to acquire clk\n");
1977 return PTR_ERR(qcadev->susclk);
1980 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1982 BT_ERR("wcn3990 serdev registration failed");
1987 qcadev->btsoc_type = data->soc_type;
1989 qcadev->btsoc_type = QCA_ROME;
1991 qcadev->bt_en = devm_gpiod_get_optional(&serdev->dev, "enable",
1993 if (IS_ERR_OR_NULL(qcadev->bt_en)) {
1994 dev_warn(&serdev->dev, "failed to acquire enable gpio\n");
1995 power_ctrl_enabled = false;
1998 qcadev->susclk = devm_clk_get_optional(&serdev->dev, NULL);
1999 if (IS_ERR(qcadev->susclk)) {
2000 dev_warn(&serdev->dev, "failed to acquire clk\n");
2001 return PTR_ERR(qcadev->susclk);
2003 err = clk_set_rate(qcadev->susclk, SUSCLK_RATE_32KHZ);
2007 err = clk_prepare_enable(qcadev->susclk);
2011 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
2013 BT_ERR("Rome serdev registration failed");
2014 clk_disable_unprepare(qcadev->susclk);
2019 hdev = qcadev->serdev_hu.hdev;
2021 if (power_ctrl_enabled) {
2022 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
2023 hdev->shutdown = qca_power_off;
2027 /* Wideband speech support must be set per driver since it can't
2028 * be queried via hci. Same with the valid le states quirk.
2030 if (data->capabilities & QCA_CAP_WIDEBAND_SPEECH)
2031 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED,
2034 if (data->capabilities & QCA_CAP_VALID_LE_STATES)
2035 set_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks);
2041 static void qca_serdev_remove(struct serdev_device *serdev)
2043 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2044 struct qca_power *power = qcadev->bt_power;
2046 if (qca_is_wcn399x(qcadev->btsoc_type) && power->vregs_on)
2047 qca_power_shutdown(&qcadev->serdev_hu);
2048 else if (qcadev->susclk)
2049 clk_disable_unprepare(qcadev->susclk);
2051 hci_uart_unregister_device(&qcadev->serdev_hu);
2054 static void qca_serdev_shutdown(struct device *dev)
2057 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
2058 struct serdev_device *serdev = to_serdev_device(dev);
2059 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2060 const u8 ibs_wake_cmd[] = { 0xFD };
2061 const u8 edl_reset_soc_cmd[] = { 0x01, 0x00, 0xFC, 0x01, 0x05 };
2063 if (qcadev->btsoc_type == QCA_QCA6390) {
2064 serdev_device_write_flush(serdev);
2065 ret = serdev_device_write_buf(serdev, ibs_wake_cmd,
2066 sizeof(ibs_wake_cmd));
2068 BT_ERR("QCA send IBS_WAKE_IND error: %d", ret);
2071 serdev_device_wait_until_sent(serdev, timeout);
2072 usleep_range(8000, 10000);
2074 serdev_device_write_flush(serdev);
2075 ret = serdev_device_write_buf(serdev, edl_reset_soc_cmd,
2076 sizeof(edl_reset_soc_cmd));
2078 BT_ERR("QCA send EDL_RESET_REQ error: %d", ret);
2081 serdev_device_wait_until_sent(serdev, timeout);
2082 usleep_range(8000, 10000);
2086 static int __maybe_unused qca_suspend(struct device *dev)
2088 struct serdev_device *serdev = to_serdev_device(dev);
2089 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2090 struct hci_uart *hu = &qcadev->serdev_hu;
2091 struct qca_data *qca = hu->priv;
2092 unsigned long flags;
2093 bool tx_pending = false;
2097 set_bit(QCA_SUSPENDING, &qca->flags);
2099 /* Device is downloading patch or doesn't support in-band sleep. */
2100 if (!test_bit(QCA_IBS_ENABLED, &qca->flags))
2103 cancel_work_sync(&qca->ws_awake_device);
2104 cancel_work_sync(&qca->ws_awake_rx);
2106 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
2107 flags, SINGLE_DEPTH_NESTING);
2109 switch (qca->tx_ibs_state) {
2110 case HCI_IBS_TX_WAKING:
2111 del_timer(&qca->wake_retrans_timer);
2113 case HCI_IBS_TX_AWAKE:
2114 del_timer(&qca->tx_idle_timer);
2116 serdev_device_write_flush(hu->serdev);
2117 cmd = HCI_IBS_SLEEP_IND;
2118 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
2121 BT_ERR("Failed to send SLEEP to device");
2125 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
2126 qca->ibs_sent_slps++;
2130 case HCI_IBS_TX_ASLEEP:
2134 BT_ERR("Spurious tx state %d", qca->tx_ibs_state);
2139 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
2145 serdev_device_wait_until_sent(hu->serdev,
2146 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
2147 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_OFF, hu);
2150 /* Wait for HCI_IBS_SLEEP_IND sent by device to indicate its Tx is going
2151 * to sleep, so that the packet does not wake the system later.
2153 ret = wait_event_interruptible_timeout(qca->suspend_wait_q,
2154 qca->rx_ibs_state == HCI_IBS_RX_ASLEEP,
2155 msecs_to_jiffies(IBS_BTSOC_TX_IDLE_TIMEOUT_MS));
2164 clear_bit(QCA_SUSPENDING, &qca->flags);
2169 static int __maybe_unused qca_resume(struct device *dev)
2171 struct serdev_device *serdev = to_serdev_device(dev);
2172 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2173 struct hci_uart *hu = &qcadev->serdev_hu;
2174 struct qca_data *qca = hu->priv;
2176 clear_bit(QCA_SUSPENDING, &qca->flags);
2181 static SIMPLE_DEV_PM_OPS(qca_pm_ops, qca_suspend, qca_resume);
2184 static const struct of_device_id qca_bluetooth_of_match[] = {
2185 { .compatible = "qcom,qca6174-bt" },
2186 { .compatible = "qcom,qca6390-bt", .data = &qca_soc_data_qca6390},
2187 { .compatible = "qcom,qca9377-bt" },
2188 { .compatible = "qcom,wcn3990-bt", .data = &qca_soc_data_wcn3990},
2189 { .compatible = "qcom,wcn3991-bt", .data = &qca_soc_data_wcn3991},
2190 { .compatible = "qcom,wcn3998-bt", .data = &qca_soc_data_wcn3998},
2193 MODULE_DEVICE_TABLE(of, qca_bluetooth_of_match);
2197 static const struct acpi_device_id qca_bluetooth_acpi_match[] = {
2198 { "QCOM6390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2199 { "DLA16390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2200 { "DLB16390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2201 { "DLB26390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2204 MODULE_DEVICE_TABLE(acpi, qca_bluetooth_acpi_match);
2208 static struct serdev_device_driver qca_serdev_driver = {
2209 .probe = qca_serdev_probe,
2210 .remove = qca_serdev_remove,
2212 .name = "hci_uart_qca",
2213 .of_match_table = of_match_ptr(qca_bluetooth_of_match),
2214 .acpi_match_table = ACPI_PTR(qca_bluetooth_acpi_match),
2215 .shutdown = qca_serdev_shutdown,
2220 int __init qca_init(void)
2222 serdev_device_driver_register(&qca_serdev_driver);
2224 return hci_uart_register_proto(&qca_proto);
2227 int __exit qca_deinit(void)
2229 serdev_device_driver_unregister(&qca_serdev_driver);
2231 return hci_uart_unregister_proto(&qca_proto);