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>
29 #include <linux/acpi.h>
30 #include <linux/platform_device.h>
31 #include <linux/pwrseq/consumer.h>
32 #include <linux/regulator/consumer.h>
33 #include <linux/serdev.h>
34 #include <linux/string_choices.h>
35 #include <linux/mutex.h>
36 #include <linux/unaligned.h>
38 #include <net/bluetooth/bluetooth.h>
39 #include <net/bluetooth/hci_core.h>
44 /* HCI_IBS protocol messages */
45 #define HCI_IBS_SLEEP_IND 0xFE
46 #define HCI_IBS_WAKE_IND 0xFD
47 #define HCI_IBS_WAKE_ACK 0xFC
48 #define HCI_MAX_IBS_SIZE 10
50 #define IBS_WAKE_RETRANS_TIMEOUT_MS 100
51 #define IBS_BTSOC_TX_IDLE_TIMEOUT_MS 200
52 #define IBS_HOST_TX_IDLE_TIMEOUT_MS 2000
53 #define CMD_TRANS_TIMEOUT_MS 100
54 #define MEMDUMP_TIMEOUT_MS 8000
55 #define IBS_DISABLE_SSR_TIMEOUT_MS \
56 (MEMDUMP_TIMEOUT_MS + FW_DOWNLOAD_TIMEOUT_MS)
57 #define FW_DOWNLOAD_TIMEOUT_MS 3000
60 #define SUSCLK_RATE_32KHZ 32768
62 /* Controller debug log header */
63 #define QCA_DEBUG_HANDLE 0x2EDC
65 /* max retry count when init fails */
66 #define MAX_INIT_RETRIES 3
68 /* Controller dump header */
69 #define QCA_SSR_DUMP_HANDLE 0x0108
70 #define QCA_DUMP_PACKET_SIZE 255
71 #define QCA_LAST_SEQUENCE_NUM 0xFFFF
72 #define QCA_CRASHBYTE_PACKET_LEN 1096
73 #define QCA_MEMDUMP_BYTE 0xFB
77 QCA_DROP_VENDOR_EVENT,
79 QCA_MEMDUMP_COLLECTION,
87 enum qca_capabilities {
88 QCA_CAP_WIDEBAND_SPEECH = BIT(0),
89 QCA_CAP_VALID_LE_STATES = BIT(1),
92 /* HCI_IBS transmit side sleep protocol states */
99 /* HCI_IBS receive side sleep protocol states */
105 /* HCI_IBS transmit and receive side clock state vote */
106 enum hci_ibs_clock_state_vote {
107 HCI_IBS_VOTE_STATS_UPDATE,
108 HCI_IBS_TX_VOTE_CLOCK_ON,
109 HCI_IBS_TX_VOTE_CLOCK_OFF,
110 HCI_IBS_RX_VOTE_CLOCK_ON,
111 HCI_IBS_RX_VOTE_CLOCK_OFF,
114 /* Controller memory dump states */
115 enum qca_memdump_states {
117 QCA_MEMDUMP_COLLECTING,
118 QCA_MEMDUMP_COLLECTED,
122 struct qca_memdump_info {
128 struct qca_memdump_event_hdr {
137 struct qca_dump_size {
143 struct sk_buff *rx_skb;
144 struct sk_buff_head txq;
145 struct sk_buff_head tx_wait_q; /* HCI_IBS wait queue */
146 struct sk_buff_head rx_memdump_q; /* Memdump wait queue */
147 spinlock_t hci_ibs_lock; /* HCI_IBS state lock */
148 u8 tx_ibs_state; /* HCI_IBS transmit side power state*/
149 u8 rx_ibs_state; /* HCI_IBS receive side power state */
150 bool tx_vote; /* Clock must be on for TX */
151 bool rx_vote; /* Clock must be on for RX */
152 struct timer_list tx_idle_timer;
154 struct timer_list wake_retrans_timer;
156 struct workqueue_struct *workqueue;
157 struct work_struct ws_awake_rx;
158 struct work_struct ws_awake_device;
159 struct work_struct ws_rx_vote_off;
160 struct work_struct ws_tx_vote_off;
161 struct work_struct ctrl_memdump_evt;
162 struct delayed_work ctrl_memdump_timeout;
163 struct qca_memdump_info *qca_memdump;
165 struct completion drop_ev_comp;
166 wait_queue_head_t suspend_wait_q;
167 enum qca_memdump_states memdump_state;
168 struct mutex hci_memdump_lock;
172 /* For debugging purpose */
190 enum qca_speed_type {
196 * Voltage regulator information required for configuring the
197 * QCA Bluetooth chipset
201 unsigned int load_uA;
204 struct qca_device_data {
205 enum qca_btsoc_type soc_type;
206 struct qca_vreg *vregs;
208 uint32_t capabilities;
212 * Platform data for the QCA Bluetooth power driver.
216 struct regulator_bulk_data *vreg_bulk;
219 struct pwrseq_desc *pwrseq;
223 struct hci_uart serdev_hu;
224 struct gpio_desc *bt_en;
225 struct gpio_desc *sw_ctrl;
227 enum qca_btsoc_type btsoc_type;
228 struct qca_power *bt_power;
231 bool bdaddr_property_broken;
232 const char *firmware_name[2];
235 static int qca_regulator_enable(struct qca_serdev *qcadev);
236 static void qca_regulator_disable(struct qca_serdev *qcadev);
237 static void qca_power_shutdown(struct hci_uart *hu);
238 static int qca_power_off(struct hci_dev *hdev);
239 static void qca_controller_memdump(struct work_struct *work);
240 static void qca_dmp_hdr(struct hci_dev *hdev, struct sk_buff *skb);
242 static enum qca_btsoc_type qca_soc_type(struct hci_uart *hu)
244 enum qca_btsoc_type soc_type;
247 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
249 soc_type = qsd->btsoc_type;
257 static const char *qca_get_firmware_name(struct hci_uart *hu)
260 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
262 return qsd->firmware_name[0];
268 static const char *qca_get_rampatch_name(struct hci_uart *hu)
271 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
273 return qsd->firmware_name[1];
279 static void __serial_clock_on(struct tty_struct *tty)
281 /* TODO: Some chipset requires to enable UART clock on client
282 * side to save power consumption or manual work is required.
283 * Please put your code to control UART clock here if needed
287 static void __serial_clock_off(struct tty_struct *tty)
289 /* TODO: Some chipset requires to disable UART clock on client
290 * side to save power consumption or manual work is required.
291 * Please put your code to control UART clock off here if needed
295 /* serial_clock_vote needs to be called with the ibs lock held */
296 static void serial_clock_vote(unsigned long vote, struct hci_uart *hu)
298 struct qca_data *qca = hu->priv;
301 bool old_vote = (qca->tx_vote | qca->rx_vote);
305 case HCI_IBS_VOTE_STATS_UPDATE:
306 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
309 qca->vote_off_ms += diff;
311 qca->vote_on_ms += diff;
314 case HCI_IBS_TX_VOTE_CLOCK_ON:
319 case HCI_IBS_RX_VOTE_CLOCK_ON:
324 case HCI_IBS_TX_VOTE_CLOCK_OFF:
325 qca->tx_vote = false;
329 case HCI_IBS_RX_VOTE_CLOCK_OFF:
330 qca->rx_vote = false;
335 BT_ERR("Voting irregularity");
339 new_vote = qca->rx_vote | qca->tx_vote;
341 if (new_vote != old_vote) {
343 __serial_clock_on(hu->tty);
345 __serial_clock_off(hu->tty);
347 BT_DBG("Vote serial clock %s(%s)", str_true_false(new_vote),
348 str_true_false(vote));
350 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
354 qca->vote_off_ms += diff;
357 qca->vote_on_ms += diff;
359 qca->vote_last_jif = jiffies;
363 /* Builds and sends an HCI_IBS command packet.
364 * These are very simple packets with only 1 cmd byte.
366 static int send_hci_ibs_cmd(u8 cmd, struct hci_uart *hu)
369 struct sk_buff *skb = NULL;
370 struct qca_data *qca = hu->priv;
372 BT_DBG("hu %p send hci ibs cmd 0x%x", hu, cmd);
374 skb = bt_skb_alloc(1, GFP_ATOMIC);
376 BT_ERR("Failed to allocate memory for HCI_IBS packet");
380 /* Assign HCI_IBS type */
381 skb_put_u8(skb, cmd);
383 skb_queue_tail(&qca->txq, skb);
388 static void qca_wq_awake_device(struct work_struct *work)
390 struct qca_data *qca = container_of(work, struct qca_data,
392 struct hci_uart *hu = qca->hu;
393 unsigned long retrans_delay;
396 BT_DBG("hu %p wq awake device", hu);
398 /* Vote for serial clock */
399 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_ON, hu);
401 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
403 /* Send wake indication to device */
404 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0)
405 BT_ERR("Failed to send WAKE to device");
407 qca->ibs_sent_wakes++;
409 /* Start retransmit timer */
410 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
411 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
413 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
415 /* Actually send the packets */
416 hci_uart_tx_wakeup(hu);
419 static void qca_wq_awake_rx(struct work_struct *work)
421 struct qca_data *qca = container_of(work, struct qca_data,
423 struct hci_uart *hu = qca->hu;
426 BT_DBG("hu %p wq awake rx", hu);
428 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_ON, hu);
430 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
431 qca->rx_ibs_state = HCI_IBS_RX_AWAKE;
433 /* Always acknowledge device wake up,
434 * sending IBS message doesn't count as TX ON.
436 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0)
437 BT_ERR("Failed to acknowledge device wake up");
439 qca->ibs_sent_wacks++;
441 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
443 /* Actually send the packets */
444 hci_uart_tx_wakeup(hu);
447 static void qca_wq_serial_rx_clock_vote_off(struct work_struct *work)
449 struct qca_data *qca = container_of(work, struct qca_data,
451 struct hci_uart *hu = qca->hu;
453 BT_DBG("hu %p rx clock vote off", hu);
455 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_OFF, hu);
458 static void qca_wq_serial_tx_clock_vote_off(struct work_struct *work)
460 struct qca_data *qca = container_of(work, struct qca_data,
462 struct hci_uart *hu = qca->hu;
464 BT_DBG("hu %p tx clock vote off", hu);
466 /* Run HCI tx handling unlocked */
467 hci_uart_tx_wakeup(hu);
469 /* Now that message queued to tty driver, vote for tty clocks off.
470 * It is up to the tty driver to pend the clocks off until tx done.
472 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_OFF, hu);
475 static void hci_ibs_tx_idle_timeout(struct timer_list *t)
477 struct qca_data *qca = timer_container_of(qca, t, tx_idle_timer);
478 struct hci_uart *hu = qca->hu;
481 BT_DBG("hu %p idle timeout in %d state", hu, qca->tx_ibs_state);
483 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
484 flags, SINGLE_DEPTH_NESTING);
486 switch (qca->tx_ibs_state) {
487 case HCI_IBS_TX_AWAKE:
488 /* TX_IDLE, go to SLEEP */
489 if (send_hci_ibs_cmd(HCI_IBS_SLEEP_IND, hu) < 0) {
490 BT_ERR("Failed to send SLEEP to device");
493 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
494 qca->ibs_sent_slps++;
495 queue_work(qca->workqueue, &qca->ws_tx_vote_off);
498 case HCI_IBS_TX_ASLEEP:
499 case HCI_IBS_TX_WAKING:
501 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
505 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
508 static void hci_ibs_wake_retrans_timeout(struct timer_list *t)
510 struct qca_data *qca = timer_container_of(qca, t, wake_retrans_timer);
511 struct hci_uart *hu = qca->hu;
512 unsigned long flags, retrans_delay;
513 bool retransmit = false;
515 BT_DBG("hu %p wake retransmit timeout in %d state",
516 hu, qca->tx_ibs_state);
518 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
519 flags, SINGLE_DEPTH_NESTING);
521 /* Don't retransmit the HCI_IBS_WAKE_IND when suspending. */
522 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
523 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
527 switch (qca->tx_ibs_state) {
528 case HCI_IBS_TX_WAKING:
529 /* No WAKE_ACK, retransmit WAKE */
531 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0) {
532 BT_ERR("Failed to acknowledge device wake up");
535 qca->ibs_sent_wakes++;
536 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
537 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
540 case HCI_IBS_TX_ASLEEP:
541 case HCI_IBS_TX_AWAKE:
543 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
547 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
550 hci_uart_tx_wakeup(hu);
554 static void qca_controller_memdump_timeout(struct work_struct *work)
556 struct qca_data *qca = container_of(work, struct qca_data,
557 ctrl_memdump_timeout.work);
558 struct hci_uart *hu = qca->hu;
560 mutex_lock(&qca->hci_memdump_lock);
561 if (test_bit(QCA_MEMDUMP_COLLECTION, &qca->flags)) {
562 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
563 if (!test_bit(QCA_HW_ERROR_EVENT, &qca->flags)) {
564 /* Inject hw error event to reset the device
567 hci_reset_dev(hu->hdev);
571 mutex_unlock(&qca->hci_memdump_lock);
575 /* Initialize protocol */
576 static int qca_open(struct hci_uart *hu)
578 struct qca_serdev *qcadev;
579 struct qca_data *qca;
581 BT_DBG("hu %p qca_open", hu);
583 if (!hci_uart_has_flow_control(hu))
586 qca = kzalloc(sizeof(*qca), GFP_KERNEL);
590 skb_queue_head_init(&qca->txq);
591 skb_queue_head_init(&qca->tx_wait_q);
592 skb_queue_head_init(&qca->rx_memdump_q);
593 spin_lock_init(&qca->hci_ibs_lock);
594 mutex_init(&qca->hci_memdump_lock);
595 qca->workqueue = alloc_ordered_workqueue("qca_wq", 0);
596 if (!qca->workqueue) {
597 BT_ERR("QCA Workqueue not initialized properly");
602 INIT_WORK(&qca->ws_awake_rx, qca_wq_awake_rx);
603 INIT_WORK(&qca->ws_awake_device, qca_wq_awake_device);
604 INIT_WORK(&qca->ws_rx_vote_off, qca_wq_serial_rx_clock_vote_off);
605 INIT_WORK(&qca->ws_tx_vote_off, qca_wq_serial_tx_clock_vote_off);
606 INIT_WORK(&qca->ctrl_memdump_evt, qca_controller_memdump);
607 INIT_DELAYED_WORK(&qca->ctrl_memdump_timeout,
608 qca_controller_memdump_timeout);
609 init_waitqueue_head(&qca->suspend_wait_q);
612 init_completion(&qca->drop_ev_comp);
614 /* Assume we start with both sides asleep -- extra wakes OK */
615 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
616 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
618 qca->vote_last_jif = jiffies;
623 qcadev = serdev_device_get_drvdata(hu->serdev);
625 switch (qcadev->btsoc_type) {
632 hu->init_speed = qcadev->init_speed;
639 if (qcadev->oper_speed)
640 hu->oper_speed = qcadev->oper_speed;
643 timer_setup(&qca->wake_retrans_timer, hci_ibs_wake_retrans_timeout, 0);
644 qca->wake_retrans = IBS_WAKE_RETRANS_TIMEOUT_MS;
646 timer_setup(&qca->tx_idle_timer, hci_ibs_tx_idle_timeout, 0);
647 qca->tx_idle_delay = IBS_HOST_TX_IDLE_TIMEOUT_MS;
649 BT_DBG("HCI_UART_QCA open, tx_idle_delay=%u, wake_retrans=%u",
650 qca->tx_idle_delay, qca->wake_retrans);
655 static void qca_debugfs_init(struct hci_dev *hdev)
657 struct hci_uart *hu = hci_get_drvdata(hdev);
658 struct qca_data *qca = hu->priv;
659 struct dentry *ibs_dir;
665 if (test_and_set_bit(QCA_DEBUGFS_CREATED, &qca->flags))
668 ibs_dir = debugfs_create_dir("ibs", hdev->debugfs);
672 debugfs_create_u8("tx_ibs_state", mode, ibs_dir, &qca->tx_ibs_state);
673 debugfs_create_u8("rx_ibs_state", mode, ibs_dir, &qca->rx_ibs_state);
674 debugfs_create_u64("ibs_sent_sleeps", mode, ibs_dir,
675 &qca->ibs_sent_slps);
676 debugfs_create_u64("ibs_sent_wakes", mode, ibs_dir,
677 &qca->ibs_sent_wakes);
678 debugfs_create_u64("ibs_sent_wake_acks", mode, ibs_dir,
679 &qca->ibs_sent_wacks);
680 debugfs_create_u64("ibs_recv_sleeps", mode, ibs_dir,
681 &qca->ibs_recv_slps);
682 debugfs_create_u64("ibs_recv_wakes", mode, ibs_dir,
683 &qca->ibs_recv_wakes);
684 debugfs_create_u64("ibs_recv_wake_acks", mode, ibs_dir,
685 &qca->ibs_recv_wacks);
686 debugfs_create_bool("tx_vote", mode, ibs_dir, &qca->tx_vote);
687 debugfs_create_u64("tx_votes_on", mode, ibs_dir, &qca->tx_votes_on);
688 debugfs_create_u64("tx_votes_off", mode, ibs_dir, &qca->tx_votes_off);
689 debugfs_create_bool("rx_vote", mode, ibs_dir, &qca->rx_vote);
690 debugfs_create_u64("rx_votes_on", mode, ibs_dir, &qca->rx_votes_on);
691 debugfs_create_u64("rx_votes_off", mode, ibs_dir, &qca->rx_votes_off);
692 debugfs_create_u64("votes_on", mode, ibs_dir, &qca->votes_on);
693 debugfs_create_u64("votes_off", mode, ibs_dir, &qca->votes_off);
694 debugfs_create_u32("vote_on_ms", mode, ibs_dir, &qca->vote_on_ms);
695 debugfs_create_u32("vote_off_ms", mode, ibs_dir, &qca->vote_off_ms);
699 debugfs_create_u32("wake_retrans", mode, ibs_dir, &qca->wake_retrans);
700 debugfs_create_u32("tx_idle_delay", mode, ibs_dir,
701 &qca->tx_idle_delay);
704 /* Flush protocol data */
705 static int qca_flush(struct hci_uart *hu)
707 struct qca_data *qca = hu->priv;
709 BT_DBG("hu %p qca flush", hu);
711 skb_queue_purge(&qca->tx_wait_q);
712 skb_queue_purge(&qca->txq);
718 static int qca_close(struct hci_uart *hu)
720 struct qca_data *qca = hu->priv;
722 BT_DBG("hu %p qca close", hu);
724 serial_clock_vote(HCI_IBS_VOTE_STATS_UPDATE, hu);
726 skb_queue_purge(&qca->tx_wait_q);
727 skb_queue_purge(&qca->txq);
728 skb_queue_purge(&qca->rx_memdump_q);
730 * Shut the timers down so they can't be rearmed when
731 * destroy_workqueue() drains pending work which in turn might try
732 * to arm a timer. After shutdown rearm attempts are silently
733 * ignored by the timer core code.
735 timer_shutdown_sync(&qca->tx_idle_timer);
736 timer_shutdown_sync(&qca->wake_retrans_timer);
737 destroy_workqueue(qca->workqueue);
740 kfree_skb(qca->rx_skb);
749 /* Called upon a wake-up-indication from the device.
751 static void device_want_to_wakeup(struct hci_uart *hu)
754 struct qca_data *qca = hu->priv;
756 BT_DBG("hu %p want to wake up", hu);
758 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
760 qca->ibs_recv_wakes++;
762 /* Don't wake the rx up when suspending. */
763 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
764 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
768 switch (qca->rx_ibs_state) {
769 case HCI_IBS_RX_ASLEEP:
770 /* Make sure clock is on - we may have turned clock off since
771 * receiving the wake up indicator awake rx clock.
773 queue_work(qca->workqueue, &qca->ws_awake_rx);
774 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
777 case HCI_IBS_RX_AWAKE:
778 /* Always acknowledge device wake up,
779 * sending IBS message doesn't count as TX ON.
781 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0) {
782 BT_ERR("Failed to acknowledge device wake up");
785 qca->ibs_sent_wacks++;
789 /* Any other state is illegal */
790 BT_ERR("Received HCI_IBS_WAKE_IND in rx state %d",
795 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
797 /* Actually send the packets */
798 hci_uart_tx_wakeup(hu);
801 /* Called upon a sleep-indication from the device.
803 static void device_want_to_sleep(struct hci_uart *hu)
806 struct qca_data *qca = hu->priv;
808 BT_DBG("hu %p want to sleep in %d state", hu, qca->rx_ibs_state);
810 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
812 qca->ibs_recv_slps++;
814 switch (qca->rx_ibs_state) {
815 case HCI_IBS_RX_AWAKE:
817 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
818 /* Vote off rx clock under workqueue */
819 queue_work(qca->workqueue, &qca->ws_rx_vote_off);
822 case HCI_IBS_RX_ASLEEP:
826 /* Any other state is illegal */
827 BT_ERR("Received HCI_IBS_SLEEP_IND in rx state %d",
832 wake_up_interruptible(&qca->suspend_wait_q);
834 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
837 /* Called upon wake-up-acknowledgement from the device
839 static void device_woke_up(struct hci_uart *hu)
841 unsigned long flags, idle_delay;
842 struct qca_data *qca = hu->priv;
843 struct sk_buff *skb = NULL;
845 BT_DBG("hu %p woke up", hu);
847 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
849 qca->ibs_recv_wacks++;
851 /* Don't react to the wake-up-acknowledgment when suspending. */
852 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
853 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
857 switch (qca->tx_ibs_state) {
858 case HCI_IBS_TX_AWAKE:
859 /* Expect one if we send 2 WAKEs */
860 BT_DBG("Received HCI_IBS_WAKE_ACK in tx state %d",
864 case HCI_IBS_TX_WAKING:
865 /* Send pending packets */
866 while ((skb = skb_dequeue(&qca->tx_wait_q)))
867 skb_queue_tail(&qca->txq, skb);
869 /* Switch timers and change state to HCI_IBS_TX_AWAKE */
870 timer_delete(&qca->wake_retrans_timer);
871 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
872 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
873 qca->tx_ibs_state = HCI_IBS_TX_AWAKE;
876 case HCI_IBS_TX_ASLEEP:
878 BT_ERR("Received HCI_IBS_WAKE_ACK in tx state %d",
883 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
885 /* Actually send the packets */
886 hci_uart_tx_wakeup(hu);
889 /* Enqueue frame for transmission (padding, crc, etc) may be called from
890 * two simultaneous tasklets.
892 static int qca_enqueue(struct hci_uart *hu, struct sk_buff *skb)
894 unsigned long flags = 0, idle_delay;
895 struct qca_data *qca = hu->priv;
897 BT_DBG("hu %p qca enq skb %p tx_ibs_state %d", hu, skb,
900 if (test_bit(QCA_SSR_TRIGGERED, &qca->flags)) {
901 /* As SSR is in progress, ignore the packets */
902 bt_dev_dbg(hu->hdev, "SSR is in progress");
907 /* Prepend skb with frame type */
908 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
910 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
912 /* Don't go to sleep in middle of patch download or
913 * Out-Of-Band(GPIOs control) sleep is selected.
914 * Don't wake the device up when suspending.
916 if (test_bit(QCA_IBS_DISABLED, &qca->flags) ||
917 test_bit(QCA_SUSPENDING, &qca->flags)) {
918 skb_queue_tail(&qca->txq, skb);
919 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
923 /* Act according to current state */
924 switch (qca->tx_ibs_state) {
925 case HCI_IBS_TX_AWAKE:
926 BT_DBG("Device awake, sending normally");
927 skb_queue_tail(&qca->txq, skb);
928 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
929 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
932 case HCI_IBS_TX_ASLEEP:
933 BT_DBG("Device asleep, waking up and queueing packet");
934 /* Save packet for later */
935 skb_queue_tail(&qca->tx_wait_q, skb);
937 qca->tx_ibs_state = HCI_IBS_TX_WAKING;
938 /* Schedule a work queue to wake up device */
939 queue_work(qca->workqueue, &qca->ws_awake_device);
942 case HCI_IBS_TX_WAKING:
943 BT_DBG("Device waking up, queueing packet");
944 /* Transient state; just keep packet for later */
945 skb_queue_tail(&qca->tx_wait_q, skb);
949 BT_ERR("Illegal tx state: %d (losing packet)",
951 dev_kfree_skb_irq(skb);
955 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
960 static int qca_ibs_sleep_ind(struct hci_dev *hdev, struct sk_buff *skb)
962 struct hci_uart *hu = hci_get_drvdata(hdev);
964 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_SLEEP_IND);
966 device_want_to_sleep(hu);
972 static int qca_ibs_wake_ind(struct hci_dev *hdev, struct sk_buff *skb)
974 struct hci_uart *hu = hci_get_drvdata(hdev);
976 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_IND);
978 device_want_to_wakeup(hu);
984 static int qca_ibs_wake_ack(struct hci_dev *hdev, struct sk_buff *skb)
986 struct hci_uart *hu = hci_get_drvdata(hdev);
988 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_ACK);
996 static int qca_recv_acl_data(struct hci_dev *hdev, struct sk_buff *skb)
998 /* We receive debug logs from chip as an ACL packets.
999 * Instead of sending the data to ACL to decode the
1000 * received data, we are pushing them to the above layers
1001 * as a diagnostic packet.
1003 if (get_unaligned_le16(skb->data) == QCA_DEBUG_HANDLE)
1004 return hci_recv_diag(hdev, skb);
1006 return hci_recv_frame(hdev, skb);
1009 static void qca_dmp_hdr(struct hci_dev *hdev, struct sk_buff *skb)
1011 struct hci_uart *hu = hci_get_drvdata(hdev);
1012 struct qca_data *qca = hu->priv;
1015 snprintf(buf, sizeof(buf), "Controller Name: 0x%x\n",
1016 qca->controller_id);
1017 skb_put_data(skb, buf, strlen(buf));
1019 snprintf(buf, sizeof(buf), "Firmware Version: 0x%x\n",
1021 skb_put_data(skb, buf, strlen(buf));
1023 snprintf(buf, sizeof(buf), "Vendor:Qualcomm\n");
1024 skb_put_data(skb, buf, strlen(buf));
1026 snprintf(buf, sizeof(buf), "Driver: %s\n",
1027 hu->serdev->dev.driver->name);
1028 skb_put_data(skb, buf, strlen(buf));
1031 static void qca_controller_memdump(struct work_struct *work)
1033 struct qca_data *qca = container_of(work, struct qca_data,
1035 struct hci_uart *hu = qca->hu;
1036 struct sk_buff *skb;
1037 struct qca_memdump_event_hdr *cmd_hdr;
1038 struct qca_memdump_info *qca_memdump = qca->qca_memdump;
1039 struct qca_dump_size *dump;
1043 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1045 while ((skb = skb_dequeue(&qca->rx_memdump_q))) {
1047 mutex_lock(&qca->hci_memdump_lock);
1048 /* Skip processing the received packets if timeout detected
1049 * or memdump collection completed.
1051 if (qca->memdump_state == QCA_MEMDUMP_TIMEOUT ||
1052 qca->memdump_state == QCA_MEMDUMP_COLLECTED) {
1053 mutex_unlock(&qca->hci_memdump_lock);
1058 qca_memdump = kzalloc(sizeof(*qca_memdump), GFP_ATOMIC);
1060 mutex_unlock(&qca->hci_memdump_lock);
1064 qca->qca_memdump = qca_memdump;
1067 qca->memdump_state = QCA_MEMDUMP_COLLECTING;
1068 cmd_hdr = (void *) skb->data;
1069 seq_no = __le16_to_cpu(cmd_hdr->seq_no);
1070 skb_pull(skb, sizeof(struct qca_memdump_event_hdr));
1074 /* This is the first frame of memdump packet from
1075 * the controller, Disable IBS to receive dump
1076 * with out any interruption, ideally time required for
1077 * the controller to send the dump is 8 seconds. let us
1078 * start timer to handle this asynchronous activity.
1080 set_bit(QCA_IBS_DISABLED, &qca->flags);
1081 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1082 dump = (void *) skb->data;
1083 qca_memdump->ram_dump_size = __le32_to_cpu(dump->dump_size);
1084 if (!(qca_memdump->ram_dump_size)) {
1085 bt_dev_err(hu->hdev, "Rx invalid memdump size");
1088 mutex_unlock(&qca->hci_memdump_lock);
1092 queue_delayed_work(qca->workqueue,
1093 &qca->ctrl_memdump_timeout,
1094 msecs_to_jiffies(MEMDUMP_TIMEOUT_MS));
1095 skb_pull(skb, sizeof(qca_memdump->ram_dump_size));
1096 qca_memdump->current_seq_no = 0;
1097 qca_memdump->received_dump = 0;
1098 ret = hci_devcd_init(hu->hdev, qca_memdump->ram_dump_size);
1099 bt_dev_info(hu->hdev, "hci_devcd_init Return:%d",
1102 kfree(qca->qca_memdump);
1103 qca->qca_memdump = NULL;
1104 qca->memdump_state = QCA_MEMDUMP_COLLECTED;
1105 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1106 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1107 clear_bit(QCA_IBS_DISABLED, &qca->flags);
1108 mutex_unlock(&qca->hci_memdump_lock);
1112 bt_dev_info(hu->hdev, "QCA collecting dump of size:%u",
1113 qca_memdump->ram_dump_size);
1117 /* If sequence no 0 is missed then there is no point in
1118 * accepting the other sequences.
1120 if (!test_bit(QCA_MEMDUMP_COLLECTION, &qca->flags)) {
1121 bt_dev_err(hu->hdev, "QCA: Discarding other packets");
1124 mutex_unlock(&qca->hci_memdump_lock);
1127 /* There could be chance of missing some packets from
1128 * the controller. In such cases let us store the dummy
1129 * packets in the buffer.
1131 /* For QCA6390, controller does not lost packets but
1132 * sequence number field of packet sometimes has error
1133 * bits, so skip this checking for missing packet.
1135 while ((seq_no > qca_memdump->current_seq_no + 1) &&
1136 (soc_type != QCA_QCA6390) &&
1137 seq_no != QCA_LAST_SEQUENCE_NUM) {
1138 bt_dev_err(hu->hdev, "QCA controller missed packet:%d",
1139 qca_memdump->current_seq_no);
1140 rx_size = qca_memdump->received_dump;
1141 rx_size += QCA_DUMP_PACKET_SIZE;
1142 if (rx_size > qca_memdump->ram_dump_size) {
1143 bt_dev_err(hu->hdev,
1144 "QCA memdump received %d, no space for missed packet",
1145 qca_memdump->received_dump);
1148 hci_devcd_append_pattern(hu->hdev, 0x00,
1149 QCA_DUMP_PACKET_SIZE);
1150 qca_memdump->received_dump += QCA_DUMP_PACKET_SIZE;
1151 qca_memdump->current_seq_no++;
1154 rx_size = qca_memdump->received_dump + skb->len;
1155 if (rx_size <= qca_memdump->ram_dump_size) {
1156 if ((seq_no != QCA_LAST_SEQUENCE_NUM) &&
1157 (seq_no != qca_memdump->current_seq_no)) {
1158 bt_dev_err(hu->hdev,
1159 "QCA memdump unexpected packet %d",
1162 bt_dev_dbg(hu->hdev,
1163 "QCA memdump packet %d with length %d",
1165 hci_devcd_append(hu->hdev, skb);
1166 qca_memdump->current_seq_no += 1;
1167 qca_memdump->received_dump = rx_size;
1169 bt_dev_err(hu->hdev,
1170 "QCA memdump received no space for packet %d",
1171 qca_memdump->current_seq_no);
1174 if (seq_no == QCA_LAST_SEQUENCE_NUM) {
1175 bt_dev_info(hu->hdev,
1176 "QCA memdump Done, received %d, total %d",
1177 qca_memdump->received_dump,
1178 qca_memdump->ram_dump_size);
1179 hci_devcd_complete(hu->hdev);
1180 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1181 kfree(qca->qca_memdump);
1182 qca->qca_memdump = NULL;
1183 qca->memdump_state = QCA_MEMDUMP_COLLECTED;
1184 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1187 mutex_unlock(&qca->hci_memdump_lock);
1192 static int qca_controller_memdump_event(struct hci_dev *hdev,
1193 struct sk_buff *skb)
1195 struct hci_uart *hu = hci_get_drvdata(hdev);
1196 struct qca_data *qca = hu->priv;
1198 set_bit(QCA_SSR_TRIGGERED, &qca->flags);
1199 skb_queue_tail(&qca->rx_memdump_q, skb);
1200 queue_work(qca->workqueue, &qca->ctrl_memdump_evt);
1205 static int qca_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
1207 struct hci_uart *hu = hci_get_drvdata(hdev);
1208 struct qca_data *qca = hu->priv;
1210 if (test_bit(QCA_DROP_VENDOR_EVENT, &qca->flags)) {
1211 struct hci_event_hdr *hdr = (void *)skb->data;
1213 /* For the WCN3990 the vendor command for a baudrate change
1214 * isn't sent as synchronous HCI command, because the
1215 * controller sends the corresponding vendor event with the
1216 * new baudrate. The event is received and properly decoded
1217 * after changing the baudrate of the host port. It needs to
1218 * be dropped, otherwise it can be misinterpreted as
1219 * response to a later firmware download command (also a
1223 if (hdr->evt == HCI_EV_VENDOR)
1224 complete(&qca->drop_ev_comp);
1230 /* We receive chip memory dump as an event packet, With a dedicated
1231 * handler followed by a hardware error event. When this event is
1232 * received we store dump into a file before closing hci. This
1233 * dump will help in triaging the issues.
1235 if ((skb->data[0] == HCI_VENDOR_PKT) &&
1236 (get_unaligned_be16(skb->data + 2) == QCA_SSR_DUMP_HANDLE))
1237 return qca_controller_memdump_event(hdev, skb);
1239 return hci_recv_frame(hdev, skb);
1242 #define QCA_IBS_SLEEP_IND_EVENT \
1243 .type = HCI_IBS_SLEEP_IND, \
1247 .maxlen = HCI_MAX_IBS_SIZE
1249 #define QCA_IBS_WAKE_IND_EVENT \
1250 .type = HCI_IBS_WAKE_IND, \
1254 .maxlen = HCI_MAX_IBS_SIZE
1256 #define QCA_IBS_WAKE_ACK_EVENT \
1257 .type = HCI_IBS_WAKE_ACK, \
1261 .maxlen = HCI_MAX_IBS_SIZE
1263 static const struct h4_recv_pkt qca_recv_pkts[] = {
1264 { H4_RECV_ACL, .recv = qca_recv_acl_data },
1265 { H4_RECV_SCO, .recv = hci_recv_frame },
1266 { H4_RECV_EVENT, .recv = qca_recv_event },
1267 { QCA_IBS_WAKE_IND_EVENT, .recv = qca_ibs_wake_ind },
1268 { QCA_IBS_WAKE_ACK_EVENT, .recv = qca_ibs_wake_ack },
1269 { QCA_IBS_SLEEP_IND_EVENT, .recv = qca_ibs_sleep_ind },
1272 static int qca_recv(struct hci_uart *hu, const void *data, int count)
1274 struct qca_data *qca = hu->priv;
1276 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
1279 qca->rx_skb = h4_recv_buf(hu->hdev, qca->rx_skb, data, count,
1280 qca_recv_pkts, ARRAY_SIZE(qca_recv_pkts));
1281 if (IS_ERR(qca->rx_skb)) {
1282 int err = PTR_ERR(qca->rx_skb);
1283 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
1291 static struct sk_buff *qca_dequeue(struct hci_uart *hu)
1293 struct qca_data *qca = hu->priv;
1295 return skb_dequeue(&qca->txq);
1298 static uint8_t qca_get_baudrate_value(int speed)
1302 return QCA_BAUDRATE_9600;
1304 return QCA_BAUDRATE_19200;
1306 return QCA_BAUDRATE_38400;
1308 return QCA_BAUDRATE_57600;
1310 return QCA_BAUDRATE_115200;
1312 return QCA_BAUDRATE_230400;
1314 return QCA_BAUDRATE_460800;
1316 return QCA_BAUDRATE_500000;
1318 return QCA_BAUDRATE_921600;
1320 return QCA_BAUDRATE_1000000;
1322 return QCA_BAUDRATE_2000000;
1324 return QCA_BAUDRATE_3000000;
1326 return QCA_BAUDRATE_3200000;
1328 return QCA_BAUDRATE_3500000;
1330 return QCA_BAUDRATE_115200;
1334 static int qca_set_baudrate(struct hci_dev *hdev, uint8_t baudrate)
1336 struct hci_uart *hu = hci_get_drvdata(hdev);
1337 struct qca_data *qca = hu->priv;
1338 struct sk_buff *skb;
1339 u8 cmd[] = { 0x01, 0x48, 0xFC, 0x01, 0x00 };
1341 if (baudrate > QCA_BAUDRATE_3200000)
1346 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
1348 bt_dev_err(hdev, "Failed to allocate baudrate packet");
1352 /* Assign commands to change baudrate and packet type. */
1353 skb_put_data(skb, cmd, sizeof(cmd));
1354 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1356 skb_queue_tail(&qca->txq, skb);
1357 hci_uart_tx_wakeup(hu);
1359 /* Wait for the baudrate change request to be sent */
1361 while (!skb_queue_empty(&qca->txq))
1362 usleep_range(100, 200);
1365 serdev_device_wait_until_sent(hu->serdev,
1366 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1368 /* Give the controller time to process the request */
1369 switch (qca_soc_type(hu)) {
1378 usleep_range(1000, 10000);
1388 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
1391 serdev_device_set_baudrate(hu->serdev, speed);
1393 hci_uart_set_baudrate(hu, speed);
1396 static int qca_send_power_pulse(struct hci_uart *hu, bool on)
1399 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
1400 u8 cmd = on ? QCA_WCN3990_POWERON_PULSE : QCA_WCN3990_POWEROFF_PULSE;
1402 /* These power pulses are single byte command which are sent
1403 * at required baudrate to wcn3990. On wcn3990, we have an external
1404 * circuit at Tx pin which decodes the pulse sent at specific baudrate.
1405 * For example, wcn3990 supports RF COEX antenna for both Wi-Fi/BT
1406 * and also we use the same power inputs to turn on and off for
1407 * Wi-Fi/BT. Powering up the power sources will not enable BT, until
1408 * we send a power on pulse at 115200 bps. This algorithm will help to
1409 * save power. Disabling hardware flow control is mandatory while
1410 * sending power pulses to SoC.
1412 bt_dev_dbg(hu->hdev, "sending power pulse %02x to controller", cmd);
1414 serdev_device_write_flush(hu->serdev);
1415 hci_uart_set_flow_control(hu, true);
1416 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1418 bt_dev_err(hu->hdev, "failed to send power pulse %02x", cmd);
1422 serdev_device_wait_until_sent(hu->serdev, timeout);
1423 hci_uart_set_flow_control(hu, false);
1425 /* Give to controller time to boot/shutdown */
1429 usleep_range(1000, 10000);
1434 static unsigned int qca_get_speed(struct hci_uart *hu,
1435 enum qca_speed_type speed_type)
1437 unsigned int speed = 0;
1439 if (speed_type == QCA_INIT_SPEED) {
1441 speed = hu->init_speed;
1442 else if (hu->proto->init_speed)
1443 speed = hu->proto->init_speed;
1446 speed = hu->oper_speed;
1447 else if (hu->proto->oper_speed)
1448 speed = hu->proto->oper_speed;
1454 static int qca_check_speeds(struct hci_uart *hu)
1456 switch (qca_soc_type(hu)) {
1465 if (!qca_get_speed(hu, QCA_INIT_SPEED) &&
1466 !qca_get_speed(hu, QCA_OPER_SPEED))
1471 if (!qca_get_speed(hu, QCA_INIT_SPEED) ||
1472 !qca_get_speed(hu, QCA_OPER_SPEED))
1479 static int qca_set_speed(struct hci_uart *hu, enum qca_speed_type speed_type)
1481 unsigned int speed, qca_baudrate;
1482 struct qca_data *qca = hu->priv;
1485 if (speed_type == QCA_INIT_SPEED) {
1486 speed = qca_get_speed(hu, QCA_INIT_SPEED);
1488 host_set_baudrate(hu, speed);
1490 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1492 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1496 /* Disable flow control for wcn3990 to deassert RTS while
1497 * changing the baudrate of chip and host.
1508 hci_uart_set_flow_control(hu, true);
1517 reinit_completion(&qca->drop_ev_comp);
1518 set_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1525 qca_baudrate = qca_get_baudrate_value(speed);
1526 bt_dev_dbg(hu->hdev, "Set UART speed to %d", speed);
1527 ret = qca_set_baudrate(hu->hdev, qca_baudrate);
1531 host_set_baudrate(hu, speed);
1543 hci_uart_set_flow_control(hu, false);
1552 /* Wait for the controller to send the vendor event
1553 * for the baudrate change command.
1555 if (!wait_for_completion_timeout(&qca->drop_ev_comp,
1556 msecs_to_jiffies(100))) {
1557 bt_dev_err(hu->hdev,
1558 "Failed to change controller baudrate\n");
1562 clear_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1573 static int qca_send_crashbuffer(struct hci_uart *hu)
1575 struct qca_data *qca = hu->priv;
1576 struct sk_buff *skb;
1578 skb = bt_skb_alloc(QCA_CRASHBYTE_PACKET_LEN, GFP_KERNEL);
1580 bt_dev_err(hu->hdev, "Failed to allocate memory for skb packet");
1584 /* We forcefully crash the controller, by sending 0xfb byte for
1585 * 1024 times. We also might have chance of losing data, To be
1586 * on safer side we send 1096 bytes to the SoC.
1588 memset(skb_put(skb, QCA_CRASHBYTE_PACKET_LEN), QCA_MEMDUMP_BYTE,
1589 QCA_CRASHBYTE_PACKET_LEN);
1590 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1591 bt_dev_info(hu->hdev, "crash the soc to collect controller dump");
1592 skb_queue_tail(&qca->txq, skb);
1593 hci_uart_tx_wakeup(hu);
1598 static void qca_wait_for_dump_collection(struct hci_dev *hdev)
1600 struct hci_uart *hu = hci_get_drvdata(hdev);
1601 struct qca_data *qca = hu->priv;
1603 wait_on_bit_timeout(&qca->flags, QCA_MEMDUMP_COLLECTION,
1604 TASK_UNINTERRUPTIBLE, MEMDUMP_TIMEOUT_MS);
1606 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1609 static void qca_hw_error(struct hci_dev *hdev, u8 code)
1611 struct hci_uart *hu = hci_get_drvdata(hdev);
1612 struct qca_data *qca = hu->priv;
1614 set_bit(QCA_SSR_TRIGGERED, &qca->flags);
1615 set_bit(QCA_HW_ERROR_EVENT, &qca->flags);
1616 bt_dev_info(hdev, "mem_dump_status: %d", qca->memdump_state);
1618 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1619 /* If hardware error event received for other than QCA
1620 * soc memory dump event, then we need to crash the SOC
1621 * and wait here for 8 seconds to get the dump packets.
1622 * This will block main thread to be on hold until we
1625 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1626 qca_send_crashbuffer(hu);
1627 qca_wait_for_dump_collection(hdev);
1628 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1629 /* Let us wait here until memory dump collected or
1630 * memory dump timer expired.
1632 bt_dev_info(hdev, "waiting for dump to complete");
1633 qca_wait_for_dump_collection(hdev);
1636 mutex_lock(&qca->hci_memdump_lock);
1637 if (qca->memdump_state != QCA_MEMDUMP_COLLECTED) {
1638 bt_dev_err(hu->hdev, "clearing allocated memory due to memdump timeout");
1639 hci_devcd_abort(hu->hdev);
1640 if (qca->qca_memdump) {
1641 kfree(qca->qca_memdump);
1642 qca->qca_memdump = NULL;
1644 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1645 cancel_delayed_work(&qca->ctrl_memdump_timeout);
1647 mutex_unlock(&qca->hci_memdump_lock);
1649 if (qca->memdump_state == QCA_MEMDUMP_TIMEOUT ||
1650 qca->memdump_state == QCA_MEMDUMP_COLLECTED) {
1651 cancel_work_sync(&qca->ctrl_memdump_evt);
1652 skb_queue_purge(&qca->rx_memdump_q);
1655 clear_bit(QCA_HW_ERROR_EVENT, &qca->flags);
1658 static void qca_reset(struct hci_dev *hdev)
1660 struct hci_uart *hu = hci_get_drvdata(hdev);
1661 struct qca_data *qca = hu->priv;
1663 set_bit(QCA_SSR_TRIGGERED, &qca->flags);
1664 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1665 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1666 qca_send_crashbuffer(hu);
1667 qca_wait_for_dump_collection(hdev);
1668 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1669 /* Let us wait here until memory dump collected or
1670 * memory dump timer expired.
1672 bt_dev_info(hdev, "waiting for dump to complete");
1673 qca_wait_for_dump_collection(hdev);
1676 mutex_lock(&qca->hci_memdump_lock);
1677 if (qca->memdump_state != QCA_MEMDUMP_COLLECTED) {
1678 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1679 if (!test_bit(QCA_HW_ERROR_EVENT, &qca->flags)) {
1680 /* Inject hw error event to reset the device
1683 hci_reset_dev(hu->hdev);
1686 mutex_unlock(&qca->hci_memdump_lock);
1689 static bool qca_wakeup(struct hci_dev *hdev)
1691 struct hci_uart *hu = hci_get_drvdata(hdev);
1697 /* BT SoC attached through the serial bus is handled by the serdev driver.
1698 * So we need to use the device handle of the serdev driver to get the
1699 * status of device may wakeup.
1701 wakeup = device_may_wakeup(&hu->serdev->ctrl->dev);
1702 bt_dev_dbg(hu->hdev, "wakeup status : %d", wakeup);
1707 static int qca_port_reopen(struct hci_uart *hu)
1711 /* Now the device is in ready state to communicate with host.
1712 * To sync host with device we need to reopen port.
1713 * Without this, we will have RTS and CTS synchronization
1716 serdev_device_close(hu->serdev);
1717 ret = serdev_device_open(hu->serdev);
1719 bt_dev_err(hu->hdev, "failed to open port");
1723 hci_uart_set_flow_control(hu, false);
1728 static int qca_regulator_init(struct hci_uart *hu)
1730 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1731 struct qca_serdev *qcadev;
1735 /* Check for vregs status, may be hci down has turned
1736 * off the voltage regulator.
1738 qcadev = serdev_device_get_drvdata(hu->serdev);
1740 if (!qcadev->bt_power->vregs_on) {
1741 serdev_device_close(hu->serdev);
1742 ret = qca_regulator_enable(qcadev);
1746 ret = serdev_device_open(hu->serdev);
1748 bt_dev_err(hu->hdev, "failed to open port");
1759 /* Forcefully enable wcn399x to enter in to boot mode. */
1760 host_set_baudrate(hu, 2400);
1761 ret = qca_send_power_pulse(hu, false);
1770 /* For wcn6750 need to enable gpio bt_en */
1771 if (qcadev->bt_en) {
1772 gpiod_set_value_cansleep(qcadev->bt_en, 0);
1774 gpiod_set_value_cansleep(qcadev->bt_en, 1);
1776 if (qcadev->sw_ctrl) {
1777 sw_ctrl_state = gpiod_get_value_cansleep(qcadev->sw_ctrl);
1778 bt_dev_dbg(hu->hdev, "SW_CTRL is %d", sw_ctrl_state);
1782 qca_set_speed(hu, QCA_INIT_SPEED);
1790 ret = qca_send_power_pulse(hu, true);
1799 return qca_port_reopen(hu);
1802 static int qca_power_on(struct hci_dev *hdev)
1804 struct hci_uart *hu = hci_get_drvdata(hdev);
1805 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1806 struct qca_serdev *qcadev;
1807 struct qca_data *qca = hu->priv;
1810 /* Non-serdev device usually is powered by external power
1811 * and don't need additional action in driver for power on
1826 ret = qca_regulator_init(hu);
1830 qcadev = serdev_device_get_drvdata(hu->serdev);
1831 if (qcadev->bt_en) {
1832 gpiod_set_value_cansleep(qcadev->bt_en, 1);
1833 /* Controller needs time to bootup. */
1838 clear_bit(QCA_BT_OFF, &qca->flags);
1842 static void hci_coredump_qca(struct hci_dev *hdev)
1845 static const u8 param[] = { 0x26 };
1847 err = __hci_cmd_send(hdev, 0xfc0c, 1, param);
1849 bt_dev_err(hdev, "%s: trigger crash failed (%d)", __func__, err);
1852 static int qca_get_data_path_id(struct hci_dev *hdev, __u8 *data_path_id)
1854 /* QCA uses 1 as non-HCI data path id for HFP */
1859 static int qca_configure_hfp_offload(struct hci_dev *hdev)
1861 bt_dev_info(hdev, "HFP non-HCI data transport is supported");
1862 hdev->get_data_path_id = qca_get_data_path_id;
1863 /* Do not need to send HCI_Configure_Data_Path to configure non-HCI
1864 * data transport path for QCA controllers, so set below field as NULL.
1866 hdev->get_codec_config_data = NULL;
1870 static int qca_setup(struct hci_uart *hu)
1872 struct hci_dev *hdev = hu->hdev;
1873 struct qca_data *qca = hu->priv;
1874 unsigned int speed, qca_baudrate = QCA_BAUDRATE_115200;
1875 unsigned int retries = 0;
1876 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1877 const char *firmware_name = qca_get_firmware_name(hu);
1878 const char *rampatch_name = qca_get_rampatch_name(hu);
1880 struct qca_btsoc_version ver;
1881 struct qca_serdev *qcadev;
1882 const char *soc_name;
1884 ret = qca_check_speeds(hu);
1888 clear_bit(QCA_ROM_FW, &qca->flags);
1889 /* Patch downloading has to be done without IBS mode */
1890 set_bit(QCA_IBS_DISABLED, &qca->flags);
1892 /* Enable controller to do both LE scan and BR/EDR inquiry
1895 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1899 soc_name = "qca2066";
1907 soc_name = "wcn399x";
1911 soc_name = "wcn6750";
1915 soc_name = "wcn6855";
1919 soc_name = "wcn7850";
1923 soc_name = "ROME/QCA6390";
1925 bt_dev_info(hdev, "setting up %s", soc_name);
1927 qca->memdump_state = QCA_MEMDUMP_IDLE;
1930 ret = qca_power_on(hdev);
1934 clear_bit(QCA_SSR_TRIGGERED, &qca->flags);
1945 qcadev = serdev_device_get_drvdata(hu->serdev);
1946 if (qcadev->bdaddr_property_broken)
1947 set_bit(HCI_QUIRK_BDADDR_PROPERTY_BROKEN, &hdev->quirks);
1949 hci_set_aosp_capable(hdev);
1951 ret = qca_read_soc_version(hdev, &ver, soc_type);
1957 qca_set_speed(hu, QCA_INIT_SPEED);
1960 /* Setup user speed if needed */
1961 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1963 ret = qca_set_speed(hu, QCA_OPER_SPEED);
1967 qca_baudrate = qca_get_baudrate_value(speed);
1982 /* Get QCA version information */
1983 ret = qca_read_soc_version(hdev, &ver, soc_type);
1988 /* Setup patch / NVM configurations */
1989 ret = qca_uart_setup(hdev, qca_baudrate, soc_type, ver,
1990 firmware_name, rampatch_name);
1992 clear_bit(QCA_IBS_DISABLED, &qca->flags);
1993 qca_debugfs_init(hdev);
1994 hu->hdev->hw_error = qca_hw_error;
1995 hu->hdev->reset = qca_reset;
1997 if (device_can_wakeup(hu->serdev->ctrl->dev.parent))
1998 hu->hdev->wakeup = qca_wakeup;
2000 } else if (ret == -ENOENT) {
2001 /* No patch/nvm-config found, run with original fw/config */
2002 set_bit(QCA_ROM_FW, &qca->flags);
2004 } else if (ret == -EAGAIN) {
2006 * Userspace firmware loader will return -EAGAIN in case no
2007 * patch/nvm-config is found, so run with original fw/config.
2009 set_bit(QCA_ROM_FW, &qca->flags);
2014 if (ret && retries < MAX_INIT_RETRIES) {
2015 bt_dev_warn(hdev, "Retry BT power ON:%d", retries);
2016 qca_power_shutdown(hu);
2018 serdev_device_close(hu->serdev);
2019 ret = serdev_device_open(hu->serdev);
2021 bt_dev_err(hdev, "failed to open port");
2030 if (soc_type == QCA_ROME)
2031 hu->hdev->set_bdaddr = qca_set_bdaddr_rome;
2033 hu->hdev->set_bdaddr = qca_set_bdaddr;
2035 if (soc_type == QCA_QCA2066)
2036 qca_configure_hfp_offload(hdev);
2038 qca->fw_version = le16_to_cpu(ver.patch_ver);
2039 qca->controller_id = le16_to_cpu(ver.rom_ver);
2040 hci_devcd_register(hdev, hci_coredump_qca, qca_dmp_hdr, NULL);
2045 static const struct hci_uart_proto qca_proto = {
2049 .init_speed = 115200,
2050 .oper_speed = 3000000,
2056 .enqueue = qca_enqueue,
2057 .dequeue = qca_dequeue,
2060 static const struct qca_device_data qca_soc_data_wcn3950 __maybe_unused = {
2061 .soc_type = QCA_WCN3950,
2062 .vregs = (struct qca_vreg []) {
2065 { "vddrf", 155000 },
2066 { "vddch0", 585000 },
2071 static const struct qca_device_data qca_soc_data_wcn3988 __maybe_unused = {
2072 .soc_type = QCA_WCN3988,
2073 .vregs = (struct qca_vreg []) {
2076 { "vddrf", 300000 },
2077 { "vddch0", 450000 },
2082 static const struct qca_device_data qca_soc_data_wcn3990 __maybe_unused = {
2083 .soc_type = QCA_WCN3990,
2084 .vregs = (struct qca_vreg []) {
2087 { "vddrf", 300000 },
2088 { "vddch0", 450000 },
2093 static const struct qca_device_data qca_soc_data_wcn3991 __maybe_unused = {
2094 .soc_type = QCA_WCN3991,
2095 .vregs = (struct qca_vreg []) {
2098 { "vddrf", 300000 },
2099 { "vddch0", 450000 },
2102 .capabilities = QCA_CAP_WIDEBAND_SPEECH | QCA_CAP_VALID_LE_STATES,
2105 static const struct qca_device_data qca_soc_data_wcn3998 __maybe_unused = {
2106 .soc_type = QCA_WCN3998,
2107 .vregs = (struct qca_vreg []) {
2110 { "vddrf", 300000 },
2111 { "vddch0", 450000 },
2116 static const struct qca_device_data qca_soc_data_qca2066 __maybe_unused = {
2117 .soc_type = QCA_QCA2066,
2119 .capabilities = QCA_CAP_WIDEBAND_SPEECH | QCA_CAP_VALID_LE_STATES,
2122 static const struct qca_device_data qca_soc_data_qca6390 __maybe_unused = {
2123 .soc_type = QCA_QCA6390,
2127 static const struct qca_device_data qca_soc_data_wcn6750 __maybe_unused = {
2128 .soc_type = QCA_WCN6750,
2129 .vregs = (struct qca_vreg []) {
2131 { "vddaon", 26000 },
2132 { "vddbtcxmx", 126000 },
2133 { "vddrfacmn", 12500 },
2134 { "vddrfa0p8", 102000 },
2135 { "vddrfa1p7", 302000 },
2136 { "vddrfa1p2", 257000 },
2137 { "vddrfa2p2", 1700000 },
2141 .capabilities = QCA_CAP_WIDEBAND_SPEECH | QCA_CAP_VALID_LE_STATES,
2144 static const struct qca_device_data qca_soc_data_wcn6855 __maybe_unused = {
2145 .soc_type = QCA_WCN6855,
2146 .vregs = (struct qca_vreg []) {
2148 { "vddbtcxmx", 126000 },
2149 { "vddrfacmn", 12500 },
2150 { "vddrfa0p8", 102000 },
2151 { "vddrfa1p7", 302000 },
2152 { "vddrfa1p2", 257000 },
2155 .capabilities = QCA_CAP_WIDEBAND_SPEECH | QCA_CAP_VALID_LE_STATES,
2158 static const struct qca_device_data qca_soc_data_wcn7850 __maybe_unused = {
2159 .soc_type = QCA_WCN7850,
2160 .vregs = (struct qca_vreg []) {
2162 { "vddaon", 26000 },
2163 { "vdddig", 126000 },
2164 { "vddrfa0p8", 102000 },
2165 { "vddrfa1p2", 257000 },
2166 { "vddrfa1p9", 302000 },
2169 .capabilities = QCA_CAP_WIDEBAND_SPEECH | QCA_CAP_VALID_LE_STATES,
2172 static void qca_power_shutdown(struct hci_uart *hu)
2174 struct qca_serdev *qcadev;
2175 struct qca_data *qca = hu->priv;
2176 unsigned long flags;
2177 enum qca_btsoc_type soc_type = qca_soc_type(hu);
2179 struct qca_power *power;
2181 /* From this point we go into power off state. But serial port is
2182 * still open, stop queueing the IBS data and flush all the buffered
2185 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
2186 set_bit(QCA_IBS_DISABLED, &qca->flags);
2188 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
2190 /* Non-serdev device usually is powered by external power
2191 * and don't need additional action in driver for power down
2196 qcadev = serdev_device_get_drvdata(hu->serdev);
2197 power = qcadev->bt_power;
2199 if (power && power->pwrseq) {
2200 pwrseq_power_off(power->pwrseq);
2201 set_bit(QCA_BT_OFF, &qca->flags);
2210 host_set_baudrate(hu, 2400);
2211 qca_send_power_pulse(hu, false);
2212 qca_regulator_disable(qcadev);
2217 gpiod_set_value_cansleep(qcadev->bt_en, 0);
2219 qca_regulator_disable(qcadev);
2220 if (qcadev->sw_ctrl) {
2221 sw_ctrl_state = gpiod_get_value_cansleep(qcadev->sw_ctrl);
2222 bt_dev_dbg(hu->hdev, "SW_CTRL is %d", sw_ctrl_state);
2227 gpiod_set_value_cansleep(qcadev->bt_en, 0);
2230 set_bit(QCA_BT_OFF, &qca->flags);
2233 static int qca_power_off(struct hci_dev *hdev)
2235 struct hci_uart *hu = hci_get_drvdata(hdev);
2236 struct qca_data *qca = hu->priv;
2237 enum qca_btsoc_type soc_type = qca_soc_type(hu);
2239 hu->hdev->hw_error = NULL;
2240 hu->hdev->reset = NULL;
2242 timer_delete_sync(&qca->wake_retrans_timer);
2243 timer_delete_sync(&qca->tx_idle_timer);
2245 /* Stop sending shutdown command if soc crashes. */
2246 if (soc_type != QCA_ROME
2247 && qca->memdump_state == QCA_MEMDUMP_IDLE) {
2248 qca_send_pre_shutdown_cmd(hdev);
2249 usleep_range(8000, 10000);
2252 qca_power_shutdown(hu);
2256 static int qca_regulator_enable(struct qca_serdev *qcadev)
2258 struct qca_power *power = qcadev->bt_power;
2262 return pwrseq_power_on(power->pwrseq);
2264 /* Already enabled */
2265 if (power->vregs_on)
2268 BT_DBG("enabling %d regulators)", power->num_vregs);
2270 ret = regulator_bulk_enable(power->num_vregs, power->vreg_bulk);
2274 power->vregs_on = true;
2276 ret = clk_prepare_enable(qcadev->susclk);
2278 qca_regulator_disable(qcadev);
2283 static void qca_regulator_disable(struct qca_serdev *qcadev)
2285 struct qca_power *power;
2290 power = qcadev->bt_power;
2292 /* Already disabled? */
2293 if (!power->vregs_on)
2296 regulator_bulk_disable(power->num_vregs, power->vreg_bulk);
2297 power->vregs_on = false;
2299 clk_disable_unprepare(qcadev->susclk);
2302 static int qca_init_regulators(struct qca_power *qca,
2303 const struct qca_vreg *vregs, size_t num_vregs)
2305 struct regulator_bulk_data *bulk;
2309 bulk = devm_kcalloc(qca->dev, num_vregs, sizeof(*bulk), GFP_KERNEL);
2313 for (i = 0; i < num_vregs; i++)
2314 bulk[i].supply = vregs[i].name;
2316 ret = devm_regulator_bulk_get(qca->dev, num_vregs, bulk);
2320 for (i = 0; i < num_vregs; i++) {
2321 ret = regulator_set_load(bulk[i].consumer, vregs[i].load_uA);
2326 qca->vreg_bulk = bulk;
2327 qca->num_vregs = num_vregs;
2332 static int qca_serdev_probe(struct serdev_device *serdev)
2334 struct qca_serdev *qcadev;
2335 struct hci_dev *hdev;
2336 const struct qca_device_data *data;
2338 bool power_ctrl_enabled = true;
2340 qcadev = devm_kzalloc(&serdev->dev, sizeof(*qcadev), GFP_KERNEL);
2344 qcadev->serdev_hu.serdev = serdev;
2345 data = device_get_match_data(&serdev->dev);
2346 serdev_device_set_drvdata(serdev, qcadev);
2347 device_property_read_string_array(&serdev->dev, "firmware-name",
2348 qcadev->firmware_name, ARRAY_SIZE(qcadev->firmware_name));
2349 device_property_read_u32(&serdev->dev, "max-speed",
2350 &qcadev->oper_speed);
2351 if (!qcadev->oper_speed)
2352 BT_DBG("UART will pick default operating speed");
2354 qcadev->bdaddr_property_broken = device_property_read_bool(&serdev->dev,
2355 "qcom,local-bd-address-broken");
2358 qcadev->btsoc_type = data->soc_type;
2360 qcadev->btsoc_type = QCA_ROME;
2362 switch (qcadev->btsoc_type) {
2372 qcadev->bt_power = devm_kzalloc(&serdev->dev,
2373 sizeof(struct qca_power),
2375 if (!qcadev->bt_power)
2382 switch (qcadev->btsoc_type) {
2386 if (!device_property_present(&serdev->dev, "enable-gpios")) {
2388 * Backward compatibility with old DT sources. If the
2389 * node doesn't have the 'enable-gpios' property then
2390 * let's use the power sequencer. Otherwise, let's
2391 * drive everything ourselves.
2393 qcadev->bt_power->pwrseq = devm_pwrseq_get(&serdev->dev,
2397 * Some modules have BT_EN enabled via a hardware pull-up,
2398 * meaning it is not defined in the DTS and is not controlled
2399 * through the power sequence. In such cases, fall through
2400 * to follow the legacy flow.
2402 if (IS_ERR(qcadev->bt_power->pwrseq))
2403 qcadev->bt_power->pwrseq = NULL;
2413 qcadev->bt_power->dev = &serdev->dev;
2414 err = qca_init_regulators(qcadev->bt_power, data->vregs,
2417 BT_ERR("Failed to init regulators:%d", err);
2421 qcadev->bt_power->vregs_on = false;
2423 qcadev->bt_en = devm_gpiod_get_optional(&serdev->dev, "enable",
2425 if (IS_ERR(qcadev->bt_en))
2426 return dev_err_probe(&serdev->dev,
2427 PTR_ERR(qcadev->bt_en),
2428 "failed to acquire BT_EN gpio\n");
2430 if (!qcadev->bt_en &&
2431 (data->soc_type == QCA_WCN6750 ||
2432 data->soc_type == QCA_WCN6855))
2433 power_ctrl_enabled = false;
2435 qcadev->sw_ctrl = devm_gpiod_get_optional(&serdev->dev, "swctrl",
2437 if (IS_ERR(qcadev->sw_ctrl) &&
2438 (data->soc_type == QCA_WCN6750 ||
2439 data->soc_type == QCA_WCN6855 ||
2440 data->soc_type == QCA_WCN7850)) {
2441 dev_err(&serdev->dev, "failed to acquire SW_CTRL gpio\n");
2442 return PTR_ERR(qcadev->sw_ctrl);
2445 qcadev->susclk = devm_clk_get_optional(&serdev->dev, NULL);
2446 if (IS_ERR(qcadev->susclk)) {
2447 dev_err(&serdev->dev, "failed to acquire clk\n");
2448 return PTR_ERR(qcadev->susclk);
2453 if (dev_of_node(&serdev->dev)) {
2454 qcadev->bt_power->pwrseq = devm_pwrseq_get(&serdev->dev,
2456 if (IS_ERR(qcadev->bt_power->pwrseq))
2457 return PTR_ERR(qcadev->bt_power->pwrseq);
2463 qcadev->bt_en = devm_gpiod_get_optional(&serdev->dev, "enable",
2465 if (IS_ERR(qcadev->bt_en)) {
2466 dev_err(&serdev->dev, "failed to acquire enable gpio\n");
2467 return PTR_ERR(qcadev->bt_en);
2471 power_ctrl_enabled = false;
2473 qcadev->susclk = devm_clk_get_optional_enabled_with_rate(
2474 &serdev->dev, NULL, SUSCLK_RATE_32KHZ);
2475 if (IS_ERR(qcadev->susclk)) {
2476 dev_warn(&serdev->dev, "failed to acquire clk\n");
2477 return PTR_ERR(qcadev->susclk);
2481 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
2483 BT_ERR("serdev registration failed");
2487 hdev = qcadev->serdev_hu.hdev;
2489 if (power_ctrl_enabled) {
2490 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
2491 hdev->shutdown = qca_power_off;
2495 /* Wideband speech support must be set per driver since it can't
2496 * be queried via hci. Same with the valid le states quirk.
2498 if (data->capabilities & QCA_CAP_WIDEBAND_SPEECH)
2499 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED,
2502 if (!(data->capabilities & QCA_CAP_VALID_LE_STATES))
2503 set_bit(HCI_QUIRK_BROKEN_LE_STATES, &hdev->quirks);
2509 static void qca_serdev_remove(struct serdev_device *serdev)
2511 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2512 struct qca_power *power = qcadev->bt_power;
2514 switch (qcadev->btsoc_type) {
2522 if (power->vregs_on)
2523 qca_power_shutdown(&qcadev->serdev_hu);
2529 hci_uart_unregister_device(&qcadev->serdev_hu);
2532 static void qca_serdev_shutdown(struct device *dev)
2535 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
2536 struct serdev_device *serdev = to_serdev_device(dev);
2537 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2538 struct hci_uart *hu = &qcadev->serdev_hu;
2539 struct hci_dev *hdev = hu->hdev;
2540 const u8 ibs_wake_cmd[] = { 0xFD };
2541 const u8 edl_reset_soc_cmd[] = { 0x01, 0x00, 0xFC, 0x01, 0x05 };
2543 if (qcadev->btsoc_type == QCA_QCA6390) {
2544 /* The purpose of sending the VSC is to reset SOC into a initial
2545 * state and the state will ensure next hdev->setup() success.
2546 * if HCI_QUIRK_NON_PERSISTENT_SETUP is set, it means that
2547 * hdev->setup() can do its job regardless of SoC state, so
2548 * don't need to send the VSC.
2549 * if HCI_SETUP is set, it means that hdev->setup() was never
2550 * invoked and the SOC is already in the initial state, so
2551 * don't also need to send the VSC.
2553 if (test_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks) ||
2554 hci_dev_test_flag(hdev, HCI_SETUP))
2557 /* The serdev must be in open state when control logic arrives
2558 * here, so also fix the use-after-free issue caused by that
2559 * the serdev is flushed or wrote after it is closed.
2561 serdev_device_write_flush(serdev);
2562 ret = serdev_device_write_buf(serdev, ibs_wake_cmd,
2563 sizeof(ibs_wake_cmd));
2565 BT_ERR("QCA send IBS_WAKE_IND error: %d", ret);
2568 serdev_device_wait_until_sent(serdev, timeout);
2569 usleep_range(8000, 10000);
2571 serdev_device_write_flush(serdev);
2572 ret = serdev_device_write_buf(serdev, edl_reset_soc_cmd,
2573 sizeof(edl_reset_soc_cmd));
2575 BT_ERR("QCA send EDL_RESET_REQ error: %d", ret);
2578 serdev_device_wait_until_sent(serdev, timeout);
2579 usleep_range(8000, 10000);
2583 static int __maybe_unused qca_suspend(struct device *dev)
2585 struct serdev_device *serdev = to_serdev_device(dev);
2586 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2587 struct hci_uart *hu = &qcadev->serdev_hu;
2588 struct qca_data *qca = hu->priv;
2589 unsigned long flags;
2590 bool tx_pending = false;
2593 u32 wait_timeout = 0;
2595 set_bit(QCA_SUSPENDING, &qca->flags);
2597 /* if BT SoC is running with default firmware then it does not
2598 * support in-band sleep
2600 if (test_bit(QCA_ROM_FW, &qca->flags))
2603 /* During SSR after memory dump collection, controller will be
2604 * powered off and then powered on.If controller is powered off
2605 * during SSR then we should wait until SSR is completed.
2607 if (test_bit(QCA_BT_OFF, &qca->flags) &&
2608 !test_bit(QCA_SSR_TRIGGERED, &qca->flags))
2611 if (test_bit(QCA_IBS_DISABLED, &qca->flags) ||
2612 test_bit(QCA_SSR_TRIGGERED, &qca->flags)) {
2613 wait_timeout = test_bit(QCA_SSR_TRIGGERED, &qca->flags) ?
2614 IBS_DISABLE_SSR_TIMEOUT_MS :
2615 FW_DOWNLOAD_TIMEOUT_MS;
2617 /* QCA_IBS_DISABLED flag is set to true, During FW download
2618 * and during memory dump collection. It is reset to false,
2619 * After FW download complete.
2621 wait_on_bit_timeout(&qca->flags, QCA_IBS_DISABLED,
2622 TASK_UNINTERRUPTIBLE, msecs_to_jiffies(wait_timeout));
2624 if (test_bit(QCA_IBS_DISABLED, &qca->flags)) {
2625 bt_dev_err(hu->hdev, "SSR or FW download time out");
2631 cancel_work_sync(&qca->ws_awake_device);
2632 cancel_work_sync(&qca->ws_awake_rx);
2634 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
2635 flags, SINGLE_DEPTH_NESTING);
2637 switch (qca->tx_ibs_state) {
2638 case HCI_IBS_TX_WAKING:
2639 timer_delete(&qca->wake_retrans_timer);
2641 case HCI_IBS_TX_AWAKE:
2642 timer_delete(&qca->tx_idle_timer);
2644 serdev_device_write_flush(hu->serdev);
2645 cmd = HCI_IBS_SLEEP_IND;
2646 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
2649 BT_ERR("Failed to send SLEEP to device");
2653 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
2654 qca->ibs_sent_slps++;
2658 case HCI_IBS_TX_ASLEEP:
2662 BT_ERR("Spurious tx state %d", qca->tx_ibs_state);
2667 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
2673 serdev_device_wait_until_sent(hu->serdev,
2674 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
2675 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_OFF, hu);
2678 /* Wait for HCI_IBS_SLEEP_IND sent by device to indicate its Tx is going
2679 * to sleep, so that the packet does not wake the system later.
2681 ret = wait_event_interruptible_timeout(qca->suspend_wait_q,
2682 qca->rx_ibs_state == HCI_IBS_RX_ASLEEP,
2683 msecs_to_jiffies(IBS_BTSOC_TX_IDLE_TIMEOUT_MS));
2692 clear_bit(QCA_SUSPENDING, &qca->flags);
2697 static int __maybe_unused qca_resume(struct device *dev)
2699 struct serdev_device *serdev = to_serdev_device(dev);
2700 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2701 struct hci_uart *hu = &qcadev->serdev_hu;
2702 struct qca_data *qca = hu->priv;
2704 clear_bit(QCA_SUSPENDING, &qca->flags);
2709 static SIMPLE_DEV_PM_OPS(qca_pm_ops, qca_suspend, qca_resume);
2712 static const struct of_device_id qca_bluetooth_of_match[] = {
2713 { .compatible = "qcom,qca2066-bt", .data = &qca_soc_data_qca2066},
2714 { .compatible = "qcom,qca6174-bt" },
2715 { .compatible = "qcom,qca6390-bt", .data = &qca_soc_data_qca6390},
2716 { .compatible = "qcom,qca9377-bt" },
2717 { .compatible = "qcom,wcn3950-bt", .data = &qca_soc_data_wcn3950},
2718 { .compatible = "qcom,wcn3988-bt", .data = &qca_soc_data_wcn3988},
2719 { .compatible = "qcom,wcn3990-bt", .data = &qca_soc_data_wcn3990},
2720 { .compatible = "qcom,wcn3991-bt", .data = &qca_soc_data_wcn3991},
2721 { .compatible = "qcom,wcn3998-bt", .data = &qca_soc_data_wcn3998},
2722 { .compatible = "qcom,wcn6750-bt", .data = &qca_soc_data_wcn6750},
2723 { .compatible = "qcom,wcn6855-bt", .data = &qca_soc_data_wcn6855},
2724 { .compatible = "qcom,wcn7850-bt", .data = &qca_soc_data_wcn7850},
2727 MODULE_DEVICE_TABLE(of, qca_bluetooth_of_match);
2731 static const struct acpi_device_id qca_bluetooth_acpi_match[] = {
2732 { "QCOM2066", (kernel_ulong_t)&qca_soc_data_qca2066 },
2733 { "QCOM6390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2734 { "DLA16390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2735 { "DLB16390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2736 { "DLB26390", (kernel_ulong_t)&qca_soc_data_qca6390 },
2739 MODULE_DEVICE_TABLE(acpi, qca_bluetooth_acpi_match);
2742 #ifdef CONFIG_DEV_COREDUMP
2743 static void hciqca_coredump(struct device *dev)
2745 struct serdev_device *serdev = to_serdev_device(dev);
2746 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
2747 struct hci_uart *hu = &qcadev->serdev_hu;
2748 struct hci_dev *hdev = hu->hdev;
2750 if (hdev->dump.coredump)
2751 hdev->dump.coredump(hdev);
2755 static struct serdev_device_driver qca_serdev_driver = {
2756 .probe = qca_serdev_probe,
2757 .remove = qca_serdev_remove,
2759 .name = "hci_uart_qca",
2760 .of_match_table = of_match_ptr(qca_bluetooth_of_match),
2761 .acpi_match_table = ACPI_PTR(qca_bluetooth_acpi_match),
2762 .shutdown = qca_serdev_shutdown,
2764 #ifdef CONFIG_DEV_COREDUMP
2765 .coredump = hciqca_coredump,
2770 int __init qca_init(void)
2772 serdev_device_driver_register(&qca_serdev_driver);
2774 return hci_uart_register_proto(&qca_proto);
2777 int __exit qca_deinit(void)
2779 serdev_device_driver_unregister(&qca_serdev_driver);
2781 return hci_uart_unregister_proto(&qca_proto);