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/platform_device.h>
30 #include <linux/regulator/consumer.h>
31 #include <linux/serdev.h>
32 #include <asm/unaligned.h>
34 #include <net/bluetooth/bluetooth.h>
35 #include <net/bluetooth/hci_core.h>
40 /* HCI_IBS protocol messages */
41 #define HCI_IBS_SLEEP_IND 0xFE
42 #define HCI_IBS_WAKE_IND 0xFD
43 #define HCI_IBS_WAKE_ACK 0xFC
44 #define HCI_MAX_IBS_SIZE 10
46 #define IBS_WAKE_RETRANS_TIMEOUT_MS 100
47 #define IBS_BTSOC_TX_IDLE_TIMEOUT_MS 40
48 #define IBS_HOST_TX_IDLE_TIMEOUT_MS 2000
49 #define CMD_TRANS_TIMEOUT_MS 100
50 #define MEMDUMP_TIMEOUT_MS 8000
53 #define SUSCLK_RATE_32KHZ 32768
55 /* Controller debug log header */
56 #define QCA_DEBUG_HANDLE 0x2EDC
58 /* max retry count when init fails */
59 #define MAX_INIT_RETRIES 3
61 /* Controller dump header */
62 #define QCA_SSR_DUMP_HANDLE 0x0108
63 #define QCA_DUMP_PACKET_SIZE 255
64 #define QCA_LAST_SEQUENCE_NUM 0xFFFF
65 #define QCA_CRASHBYTE_PACKET_LEN 1096
66 #define QCA_MEMDUMP_BYTE 0xFB
70 QCA_DROP_VENDOR_EVENT,
72 QCA_MEMDUMP_COLLECTION
76 /* HCI_IBS transmit side sleep protocol states */
83 /* HCI_IBS receive side sleep protocol states */
89 /* HCI_IBS transmit and receive side clock state vote */
90 enum hci_ibs_clock_state_vote {
91 HCI_IBS_VOTE_STATS_UPDATE,
92 HCI_IBS_TX_VOTE_CLOCK_ON,
93 HCI_IBS_TX_VOTE_CLOCK_OFF,
94 HCI_IBS_RX_VOTE_CLOCK_ON,
95 HCI_IBS_RX_VOTE_CLOCK_OFF,
98 /* Controller memory dump states */
99 enum qca_memdump_states {
101 QCA_MEMDUMP_COLLECTING,
102 QCA_MEMDUMP_COLLECTED,
106 struct qca_memdump_data {
107 char *memdump_buf_head;
108 char *memdump_buf_tail;
113 struct qca_memdump_event_hdr {
122 struct qca_dump_size {
128 struct sk_buff *rx_skb;
129 struct sk_buff_head txq;
130 struct sk_buff_head tx_wait_q; /* HCI_IBS wait queue */
131 struct sk_buff_head rx_memdump_q; /* Memdump wait queue */
132 spinlock_t hci_ibs_lock; /* HCI_IBS state lock */
133 u8 tx_ibs_state; /* HCI_IBS transmit side power state*/
134 u8 rx_ibs_state; /* HCI_IBS receive side power state */
135 bool tx_vote; /* Clock must be on for TX */
136 bool rx_vote; /* Clock must be on for RX */
137 struct timer_list tx_idle_timer;
139 struct timer_list wake_retrans_timer;
141 struct timer_list memdump_timer;
142 struct workqueue_struct *workqueue;
143 struct work_struct ws_awake_rx;
144 struct work_struct ws_awake_device;
145 struct work_struct ws_rx_vote_off;
146 struct work_struct ws_tx_vote_off;
147 struct work_struct ctrl_memdump_evt;
148 struct qca_memdump_data *qca_memdump;
150 struct completion drop_ev_comp;
151 wait_queue_head_t suspend_wait_q;
152 enum qca_memdump_states memdump_state;
154 /* For debugging purpose */
172 enum qca_speed_type {
178 * Voltage regulator information required for configuring the
179 * QCA Bluetooth chipset
183 unsigned int load_uA;
186 struct qca_vreg_data {
187 enum qca_btsoc_type soc_type;
188 struct qca_vreg *vregs;
193 * Platform data for the QCA Bluetooth power driver.
197 struct regulator_bulk_data *vreg_bulk;
203 struct hci_uart serdev_hu;
204 struct gpio_desc *bt_en;
206 enum qca_btsoc_type btsoc_type;
207 struct qca_power *bt_power;
210 const char *firmware_name;
213 static int qca_regulator_enable(struct qca_serdev *qcadev);
214 static void qca_regulator_disable(struct qca_serdev *qcadev);
215 static void qca_power_shutdown(struct hci_uart *hu);
216 static int qca_power_off(struct hci_dev *hdev);
217 static void qca_controller_memdump(struct work_struct *work);
219 static enum qca_btsoc_type qca_soc_type(struct hci_uart *hu)
221 enum qca_btsoc_type soc_type;
224 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
226 soc_type = qsd->btsoc_type;
234 static const char *qca_get_firmware_name(struct hci_uart *hu)
237 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
239 return qsd->firmware_name;
245 static void __serial_clock_on(struct tty_struct *tty)
247 /* TODO: Some chipset requires to enable UART clock on client
248 * side to save power consumption or manual work is required.
249 * Please put your code to control UART clock here if needed
253 static void __serial_clock_off(struct tty_struct *tty)
255 /* TODO: Some chipset requires to disable UART clock on client
256 * side to save power consumption or manual work is required.
257 * Please put your code to control UART clock off here if needed
261 /* serial_clock_vote needs to be called with the ibs lock held */
262 static void serial_clock_vote(unsigned long vote, struct hci_uart *hu)
264 struct qca_data *qca = hu->priv;
267 bool old_vote = (qca->tx_vote | qca->rx_vote);
271 case HCI_IBS_VOTE_STATS_UPDATE:
272 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
275 qca->vote_off_ms += diff;
277 qca->vote_on_ms += diff;
280 case HCI_IBS_TX_VOTE_CLOCK_ON:
286 case HCI_IBS_RX_VOTE_CLOCK_ON:
292 case HCI_IBS_TX_VOTE_CLOCK_OFF:
293 qca->tx_vote = false;
295 new_vote = qca->rx_vote | qca->tx_vote;
298 case HCI_IBS_RX_VOTE_CLOCK_OFF:
299 qca->rx_vote = false;
301 new_vote = qca->rx_vote | qca->tx_vote;
305 BT_ERR("Voting irregularity");
309 if (new_vote != old_vote) {
311 __serial_clock_on(hu->tty);
313 __serial_clock_off(hu->tty);
315 BT_DBG("Vote serial clock %s(%s)", new_vote ? "true" : "false",
316 vote ? "true" : "false");
318 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
322 qca->vote_off_ms += diff;
325 qca->vote_on_ms += diff;
327 qca->vote_last_jif = jiffies;
331 /* Builds and sends an HCI_IBS command packet.
332 * These are very simple packets with only 1 cmd byte.
334 static int send_hci_ibs_cmd(u8 cmd, struct hci_uart *hu)
337 struct sk_buff *skb = NULL;
338 struct qca_data *qca = hu->priv;
340 BT_DBG("hu %p send hci ibs cmd 0x%x", hu, cmd);
342 skb = bt_skb_alloc(1, GFP_ATOMIC);
344 BT_ERR("Failed to allocate memory for HCI_IBS packet");
348 /* Assign HCI_IBS type */
349 skb_put_u8(skb, cmd);
351 skb_queue_tail(&qca->txq, skb);
356 static void qca_wq_awake_device(struct work_struct *work)
358 struct qca_data *qca = container_of(work, struct qca_data,
360 struct hci_uart *hu = qca->hu;
361 unsigned long retrans_delay;
364 BT_DBG("hu %p wq awake device", hu);
366 /* Vote for serial clock */
367 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_ON, hu);
369 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
371 /* Send wake indication to device */
372 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0)
373 BT_ERR("Failed to send WAKE to device");
375 qca->ibs_sent_wakes++;
377 /* Start retransmit timer */
378 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
379 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
381 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
383 /* Actually send the packets */
384 hci_uart_tx_wakeup(hu);
387 static void qca_wq_awake_rx(struct work_struct *work)
389 struct qca_data *qca = container_of(work, struct qca_data,
391 struct hci_uart *hu = qca->hu;
394 BT_DBG("hu %p wq awake rx", hu);
396 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_ON, hu);
398 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
399 qca->rx_ibs_state = HCI_IBS_RX_AWAKE;
401 /* Always acknowledge device wake up,
402 * sending IBS message doesn't count as TX ON.
404 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0)
405 BT_ERR("Failed to acknowledge device wake up");
407 qca->ibs_sent_wacks++;
409 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
411 /* Actually send the packets */
412 hci_uart_tx_wakeup(hu);
415 static void qca_wq_serial_rx_clock_vote_off(struct work_struct *work)
417 struct qca_data *qca = container_of(work, struct qca_data,
419 struct hci_uart *hu = qca->hu;
421 BT_DBG("hu %p rx clock vote off", hu);
423 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_OFF, hu);
426 static void qca_wq_serial_tx_clock_vote_off(struct work_struct *work)
428 struct qca_data *qca = container_of(work, struct qca_data,
430 struct hci_uart *hu = qca->hu;
432 BT_DBG("hu %p tx clock vote off", hu);
434 /* Run HCI tx handling unlocked */
435 hci_uart_tx_wakeup(hu);
437 /* Now that message queued to tty driver, vote for tty clocks off.
438 * It is up to the tty driver to pend the clocks off until tx done.
440 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_OFF, hu);
443 static void hci_ibs_tx_idle_timeout(struct timer_list *t)
445 struct qca_data *qca = from_timer(qca, t, tx_idle_timer);
446 struct hci_uart *hu = qca->hu;
449 BT_DBG("hu %p idle timeout in %d state", hu, qca->tx_ibs_state);
451 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
452 flags, SINGLE_DEPTH_NESTING);
454 switch (qca->tx_ibs_state) {
455 case HCI_IBS_TX_AWAKE:
456 /* TX_IDLE, go to SLEEP */
457 if (send_hci_ibs_cmd(HCI_IBS_SLEEP_IND, hu) < 0) {
458 BT_ERR("Failed to send SLEEP to device");
461 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
462 qca->ibs_sent_slps++;
463 queue_work(qca->workqueue, &qca->ws_tx_vote_off);
466 case HCI_IBS_TX_ASLEEP:
467 case HCI_IBS_TX_WAKING:
471 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
475 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
478 static void hci_ibs_wake_retrans_timeout(struct timer_list *t)
480 struct qca_data *qca = from_timer(qca, t, wake_retrans_timer);
481 struct hci_uart *hu = qca->hu;
482 unsigned long flags, retrans_delay;
483 bool retransmit = false;
485 BT_DBG("hu %p wake retransmit timeout in %d state",
486 hu, qca->tx_ibs_state);
488 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
489 flags, SINGLE_DEPTH_NESTING);
491 /* Don't retransmit the HCI_IBS_WAKE_IND when suspending. */
492 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
493 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
497 switch (qca->tx_ibs_state) {
498 case HCI_IBS_TX_WAKING:
499 /* No WAKE_ACK, retransmit WAKE */
501 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0) {
502 BT_ERR("Failed to acknowledge device wake up");
505 qca->ibs_sent_wakes++;
506 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
507 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
510 case HCI_IBS_TX_ASLEEP:
511 case HCI_IBS_TX_AWAKE:
515 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
519 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
522 hci_uart_tx_wakeup(hu);
525 static void hci_memdump_timeout(struct timer_list *t)
527 struct qca_data *qca = from_timer(qca, t, tx_idle_timer);
528 struct hci_uart *hu = qca->hu;
529 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
530 char *memdump_buf = qca_memdump->memdump_buf_tail;
532 bt_dev_err(hu->hdev, "clearing allocated memory due to memdump timeout");
533 /* Inject hw error event to reset the device and driver. */
534 hci_reset_dev(hu->hdev);
537 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
538 del_timer(&qca->memdump_timer);
539 cancel_work_sync(&qca->ctrl_memdump_evt);
542 /* Initialize protocol */
543 static int qca_open(struct hci_uart *hu)
545 struct qca_serdev *qcadev;
546 struct qca_data *qca;
548 BT_DBG("hu %p qca_open", hu);
550 if (!hci_uart_has_flow_control(hu))
553 qca = kzalloc(sizeof(struct qca_data), GFP_KERNEL);
557 skb_queue_head_init(&qca->txq);
558 skb_queue_head_init(&qca->tx_wait_q);
559 skb_queue_head_init(&qca->rx_memdump_q);
560 spin_lock_init(&qca->hci_ibs_lock);
561 qca->workqueue = alloc_ordered_workqueue("qca_wq", 0);
562 if (!qca->workqueue) {
563 BT_ERR("QCA Workqueue not initialized properly");
568 INIT_WORK(&qca->ws_awake_rx, qca_wq_awake_rx);
569 INIT_WORK(&qca->ws_awake_device, qca_wq_awake_device);
570 INIT_WORK(&qca->ws_rx_vote_off, qca_wq_serial_rx_clock_vote_off);
571 INIT_WORK(&qca->ws_tx_vote_off, qca_wq_serial_tx_clock_vote_off);
572 INIT_WORK(&qca->ctrl_memdump_evt, qca_controller_memdump);
573 init_waitqueue_head(&qca->suspend_wait_q);
576 init_completion(&qca->drop_ev_comp);
578 /* Assume we start with both sides asleep -- extra wakes OK */
579 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
580 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
582 qca->vote_last_jif = jiffies;
587 qcadev = serdev_device_get_drvdata(hu->serdev);
588 if (qca_is_wcn399x(qcadev->btsoc_type)) {
589 hu->init_speed = qcadev->init_speed;
590 hu->oper_speed = qcadev->oper_speed;
594 timer_setup(&qca->wake_retrans_timer, hci_ibs_wake_retrans_timeout, 0);
595 qca->wake_retrans = IBS_WAKE_RETRANS_TIMEOUT_MS;
597 timer_setup(&qca->tx_idle_timer, hci_ibs_tx_idle_timeout, 0);
598 qca->tx_idle_delay = IBS_HOST_TX_IDLE_TIMEOUT_MS;
599 timer_setup(&qca->memdump_timer, hci_memdump_timeout, 0);
601 BT_DBG("HCI_UART_QCA open, tx_idle_delay=%u, wake_retrans=%u",
602 qca->tx_idle_delay, qca->wake_retrans);
607 static void qca_debugfs_init(struct hci_dev *hdev)
609 struct hci_uart *hu = hci_get_drvdata(hdev);
610 struct qca_data *qca = hu->priv;
611 struct dentry *ibs_dir;
617 ibs_dir = debugfs_create_dir("ibs", hdev->debugfs);
621 debugfs_create_u8("tx_ibs_state", mode, ibs_dir, &qca->tx_ibs_state);
622 debugfs_create_u8("rx_ibs_state", mode, ibs_dir, &qca->rx_ibs_state);
623 debugfs_create_u64("ibs_sent_sleeps", mode, ibs_dir,
624 &qca->ibs_sent_slps);
625 debugfs_create_u64("ibs_sent_wakes", mode, ibs_dir,
626 &qca->ibs_sent_wakes);
627 debugfs_create_u64("ibs_sent_wake_acks", mode, ibs_dir,
628 &qca->ibs_sent_wacks);
629 debugfs_create_u64("ibs_recv_sleeps", mode, ibs_dir,
630 &qca->ibs_recv_slps);
631 debugfs_create_u64("ibs_recv_wakes", mode, ibs_dir,
632 &qca->ibs_recv_wakes);
633 debugfs_create_u64("ibs_recv_wake_acks", mode, ibs_dir,
634 &qca->ibs_recv_wacks);
635 debugfs_create_bool("tx_vote", mode, ibs_dir, &qca->tx_vote);
636 debugfs_create_u64("tx_votes_on", mode, ibs_dir, &qca->tx_votes_on);
637 debugfs_create_u64("tx_votes_off", mode, ibs_dir, &qca->tx_votes_off);
638 debugfs_create_bool("rx_vote", mode, ibs_dir, &qca->rx_vote);
639 debugfs_create_u64("rx_votes_on", mode, ibs_dir, &qca->rx_votes_on);
640 debugfs_create_u64("rx_votes_off", mode, ibs_dir, &qca->rx_votes_off);
641 debugfs_create_u64("votes_on", mode, ibs_dir, &qca->votes_on);
642 debugfs_create_u64("votes_off", mode, ibs_dir, &qca->votes_off);
643 debugfs_create_u32("vote_on_ms", mode, ibs_dir, &qca->vote_on_ms);
644 debugfs_create_u32("vote_off_ms", mode, ibs_dir, &qca->vote_off_ms);
647 mode = S_IRUGO | S_IWUSR;
648 debugfs_create_u32("wake_retrans", mode, ibs_dir, &qca->wake_retrans);
649 debugfs_create_u32("tx_idle_delay", mode, ibs_dir,
650 &qca->tx_idle_delay);
653 /* Flush protocol data */
654 static int qca_flush(struct hci_uart *hu)
656 struct qca_data *qca = hu->priv;
658 BT_DBG("hu %p qca flush", hu);
660 skb_queue_purge(&qca->tx_wait_q);
661 skb_queue_purge(&qca->txq);
667 static int qca_close(struct hci_uart *hu)
669 struct qca_data *qca = hu->priv;
671 BT_DBG("hu %p qca close", hu);
673 serial_clock_vote(HCI_IBS_VOTE_STATS_UPDATE, hu);
675 skb_queue_purge(&qca->tx_wait_q);
676 skb_queue_purge(&qca->txq);
677 skb_queue_purge(&qca->rx_memdump_q);
678 del_timer(&qca->tx_idle_timer);
679 del_timer(&qca->wake_retrans_timer);
680 del_timer(&qca->memdump_timer);
681 destroy_workqueue(qca->workqueue);
684 qca_power_shutdown(hu);
686 kfree_skb(qca->rx_skb);
695 /* Called upon a wake-up-indication from the device.
697 static void device_want_to_wakeup(struct hci_uart *hu)
700 struct qca_data *qca = hu->priv;
702 BT_DBG("hu %p want to wake up", hu);
704 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
706 qca->ibs_recv_wakes++;
708 /* Don't wake the rx up when suspending. */
709 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
710 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
714 switch (qca->rx_ibs_state) {
715 case HCI_IBS_RX_ASLEEP:
716 /* Make sure clock is on - we may have turned clock off since
717 * receiving the wake up indicator awake rx clock.
719 queue_work(qca->workqueue, &qca->ws_awake_rx);
720 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
723 case HCI_IBS_RX_AWAKE:
724 /* Always acknowledge device wake up,
725 * sending IBS message doesn't count as TX ON.
727 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0) {
728 BT_ERR("Failed to acknowledge device wake up");
731 qca->ibs_sent_wacks++;
735 /* Any other state is illegal */
736 BT_ERR("Received HCI_IBS_WAKE_IND in rx state %d",
741 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
743 /* Actually send the packets */
744 hci_uart_tx_wakeup(hu);
747 /* Called upon a sleep-indication from the device.
749 static void device_want_to_sleep(struct hci_uart *hu)
752 struct qca_data *qca = hu->priv;
754 BT_DBG("hu %p want to sleep in %d state", hu, qca->rx_ibs_state);
756 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
758 qca->ibs_recv_slps++;
760 switch (qca->rx_ibs_state) {
761 case HCI_IBS_RX_AWAKE:
763 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
764 /* Vote off rx clock under workqueue */
765 queue_work(qca->workqueue, &qca->ws_rx_vote_off);
768 case HCI_IBS_RX_ASLEEP:
772 /* Any other state is illegal */
773 BT_ERR("Received HCI_IBS_SLEEP_IND in rx state %d",
778 wake_up_interruptible(&qca->suspend_wait_q);
780 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
783 /* Called upon wake-up-acknowledgement from the device
785 static void device_woke_up(struct hci_uart *hu)
787 unsigned long flags, idle_delay;
788 struct qca_data *qca = hu->priv;
789 struct sk_buff *skb = NULL;
791 BT_DBG("hu %p woke up", hu);
793 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
795 qca->ibs_recv_wacks++;
797 /* Don't react to the wake-up-acknowledgment when suspending. */
798 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
799 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
803 switch (qca->tx_ibs_state) {
804 case HCI_IBS_TX_AWAKE:
805 /* Expect one if we send 2 WAKEs */
806 BT_DBG("Received HCI_IBS_WAKE_ACK in tx state %d",
810 case HCI_IBS_TX_WAKING:
811 /* Send pending packets */
812 while ((skb = skb_dequeue(&qca->tx_wait_q)))
813 skb_queue_tail(&qca->txq, skb);
815 /* Switch timers and change state to HCI_IBS_TX_AWAKE */
816 del_timer(&qca->wake_retrans_timer);
817 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
818 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
819 qca->tx_ibs_state = HCI_IBS_TX_AWAKE;
822 case HCI_IBS_TX_ASLEEP:
826 BT_ERR("Received HCI_IBS_WAKE_ACK in tx state %d",
831 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
833 /* Actually send the packets */
834 hci_uart_tx_wakeup(hu);
837 /* Enqueue frame for transmittion (padding, crc, etc) may be called from
838 * two simultaneous tasklets.
840 static int qca_enqueue(struct hci_uart *hu, struct sk_buff *skb)
842 unsigned long flags = 0, idle_delay;
843 struct qca_data *qca = hu->priv;
845 BT_DBG("hu %p qca enq skb %p tx_ibs_state %d", hu, skb,
848 /* Prepend skb with frame type */
849 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
851 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
853 /* Don't go to sleep in middle of patch download or
854 * Out-Of-Band(GPIOs control) sleep is selected.
855 * Don't wake the device up when suspending.
857 if (!test_bit(QCA_IBS_ENABLED, &qca->flags) ||
858 test_bit(QCA_SUSPENDING, &qca->flags)) {
859 skb_queue_tail(&qca->txq, skb);
860 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
864 /* Act according to current state */
865 switch (qca->tx_ibs_state) {
866 case HCI_IBS_TX_AWAKE:
867 BT_DBG("Device awake, sending normally");
868 skb_queue_tail(&qca->txq, skb);
869 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
870 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
873 case HCI_IBS_TX_ASLEEP:
874 BT_DBG("Device asleep, waking up and queueing packet");
875 /* Save packet for later */
876 skb_queue_tail(&qca->tx_wait_q, skb);
878 qca->tx_ibs_state = HCI_IBS_TX_WAKING;
879 /* Schedule a work queue to wake up device */
880 queue_work(qca->workqueue, &qca->ws_awake_device);
883 case HCI_IBS_TX_WAKING:
884 BT_DBG("Device waking up, queueing packet");
885 /* Transient state; just keep packet for later */
886 skb_queue_tail(&qca->tx_wait_q, skb);
890 BT_ERR("Illegal tx state: %d (losing packet)",
896 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
901 static int qca_ibs_sleep_ind(struct hci_dev *hdev, struct sk_buff *skb)
903 struct hci_uart *hu = hci_get_drvdata(hdev);
905 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_SLEEP_IND);
907 device_want_to_sleep(hu);
913 static int qca_ibs_wake_ind(struct hci_dev *hdev, struct sk_buff *skb)
915 struct hci_uart *hu = hci_get_drvdata(hdev);
917 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_IND);
919 device_want_to_wakeup(hu);
925 static int qca_ibs_wake_ack(struct hci_dev *hdev, struct sk_buff *skb)
927 struct hci_uart *hu = hci_get_drvdata(hdev);
929 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_ACK);
937 static int qca_recv_acl_data(struct hci_dev *hdev, struct sk_buff *skb)
939 /* We receive debug logs from chip as an ACL packets.
940 * Instead of sending the data to ACL to decode the
941 * received data, we are pushing them to the above layers
942 * as a diagnostic packet.
944 if (get_unaligned_le16(skb->data) == QCA_DEBUG_HANDLE)
945 return hci_recv_diag(hdev, skb);
947 return hci_recv_frame(hdev, skb);
950 static void qca_controller_memdump(struct work_struct *work)
952 struct qca_data *qca = container_of(work, struct qca_data,
954 struct hci_uart *hu = qca->hu;
956 struct qca_memdump_event_hdr *cmd_hdr;
957 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
958 struct qca_dump_size *dump;
960 char nullBuff[QCA_DUMP_PACKET_SIZE] = { 0 };
964 while ((skb = skb_dequeue(&qca->rx_memdump_q))) {
967 qca_memdump = kzalloc(sizeof(struct qca_memdump_data),
972 qca->qca_memdump = qca_memdump;
975 qca->memdump_state = QCA_MEMDUMP_COLLECTING;
976 cmd_hdr = (void *) skb->data;
977 seq_no = __le16_to_cpu(cmd_hdr->seq_no);
978 skb_pull(skb, sizeof(struct qca_memdump_event_hdr));
982 /* This is the first frame of memdump packet from
983 * the controller, Disable IBS to recevie dump
984 * with out any interruption, ideally time required for
985 * the controller to send the dump is 8 seconds. let us
986 * start timer to handle this asynchronous activity.
988 clear_bit(QCA_IBS_ENABLED, &qca->flags);
989 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
990 dump = (void *) skb->data;
991 dump_size = __le32_to_cpu(dump->dump_size);
993 bt_dev_err(hu->hdev, "Rx invalid memdump size");
998 bt_dev_info(hu->hdev, "QCA collecting dump of size:%u",
1000 mod_timer(&qca->memdump_timer, (jiffies +
1001 msecs_to_jiffies(MEMDUMP_TIMEOUT_MS)));
1003 skb_pull(skb, sizeof(dump_size));
1004 memdump_buf = vmalloc(dump_size);
1005 qca_memdump->memdump_buf_head = memdump_buf;
1006 qca_memdump->memdump_buf_tail = memdump_buf;
1009 memdump_buf = qca_memdump->memdump_buf_tail;
1011 /* If sequence no 0 is missed then there is no point in
1012 * accepting the other sequences.
1015 bt_dev_err(hu->hdev, "QCA: Discarding other packets");
1018 qca->qca_memdump = NULL;
1022 /* There could be chance of missing some packets from
1023 * the controller. In such cases let us store the dummy
1024 * packets in the buffer.
1026 while ((seq_no > qca_memdump->current_seq_no + 1) &&
1027 seq_no != QCA_LAST_SEQUENCE_NUM) {
1028 bt_dev_err(hu->hdev, "QCA controller missed packet:%d",
1029 qca_memdump->current_seq_no);
1030 memcpy(memdump_buf, nullBuff, QCA_DUMP_PACKET_SIZE);
1031 memdump_buf = memdump_buf + QCA_DUMP_PACKET_SIZE;
1032 qca_memdump->received_dump += QCA_DUMP_PACKET_SIZE;
1033 qca_memdump->current_seq_no++;
1036 memcpy(memdump_buf, (unsigned char *) skb->data, skb->len);
1037 memdump_buf = memdump_buf + skb->len;
1038 qca_memdump->memdump_buf_tail = memdump_buf;
1039 qca_memdump->current_seq_no = seq_no + 1;
1040 qca_memdump->received_dump += skb->len;
1041 qca->qca_memdump = qca_memdump;
1043 if (seq_no == QCA_LAST_SEQUENCE_NUM) {
1044 bt_dev_info(hu->hdev, "QCA writing crash dump of size %d bytes",
1045 qca_memdump->received_dump);
1046 memdump_buf = qca_memdump->memdump_buf_head;
1047 dev_coredumpv(&hu->serdev->dev, memdump_buf,
1048 qca_memdump->received_dump, GFP_KERNEL);
1049 del_timer(&qca->memdump_timer);
1050 kfree(qca->qca_memdump);
1051 qca->qca_memdump = NULL;
1052 qca->memdump_state = QCA_MEMDUMP_COLLECTED;
1058 int qca_controller_memdump_event(struct hci_dev *hdev, struct sk_buff *skb)
1060 struct hci_uart *hu = hci_get_drvdata(hdev);
1061 struct qca_data *qca = hu->priv;
1063 skb_queue_tail(&qca->rx_memdump_q, skb);
1064 queue_work(qca->workqueue, &qca->ctrl_memdump_evt);
1069 static int qca_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
1071 struct hci_uart *hu = hci_get_drvdata(hdev);
1072 struct qca_data *qca = hu->priv;
1074 if (test_bit(QCA_DROP_VENDOR_EVENT, &qca->flags)) {
1075 struct hci_event_hdr *hdr = (void *)skb->data;
1077 /* For the WCN3990 the vendor command for a baudrate change
1078 * isn't sent as synchronous HCI command, because the
1079 * controller sends the corresponding vendor event with the
1080 * new baudrate. The event is received and properly decoded
1081 * after changing the baudrate of the host port. It needs to
1082 * be dropped, otherwise it can be misinterpreted as
1083 * response to a later firmware download command (also a
1087 if (hdr->evt == HCI_EV_VENDOR)
1088 complete(&qca->drop_ev_comp);
1094 /* We receive chip memory dump as an event packet, With a dedicated
1095 * handler followed by a hardware error event. When this event is
1096 * received we store dump into a file before closing hci. This
1097 * dump will help in triaging the issues.
1099 if ((skb->data[0] == HCI_VENDOR_PKT) &&
1100 (get_unaligned_be16(skb->data + 2) == QCA_SSR_DUMP_HANDLE))
1101 return qca_controller_memdump_event(hdev, skb);
1103 return hci_recv_frame(hdev, skb);
1106 #define QCA_IBS_SLEEP_IND_EVENT \
1107 .type = HCI_IBS_SLEEP_IND, \
1111 .maxlen = HCI_MAX_IBS_SIZE
1113 #define QCA_IBS_WAKE_IND_EVENT \
1114 .type = HCI_IBS_WAKE_IND, \
1118 .maxlen = HCI_MAX_IBS_SIZE
1120 #define QCA_IBS_WAKE_ACK_EVENT \
1121 .type = HCI_IBS_WAKE_ACK, \
1125 .maxlen = HCI_MAX_IBS_SIZE
1127 static const struct h4_recv_pkt qca_recv_pkts[] = {
1128 { H4_RECV_ACL, .recv = qca_recv_acl_data },
1129 { H4_RECV_SCO, .recv = hci_recv_frame },
1130 { H4_RECV_EVENT, .recv = qca_recv_event },
1131 { QCA_IBS_WAKE_IND_EVENT, .recv = qca_ibs_wake_ind },
1132 { QCA_IBS_WAKE_ACK_EVENT, .recv = qca_ibs_wake_ack },
1133 { QCA_IBS_SLEEP_IND_EVENT, .recv = qca_ibs_sleep_ind },
1136 static int qca_recv(struct hci_uart *hu, const void *data, int count)
1138 struct qca_data *qca = hu->priv;
1140 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
1143 qca->rx_skb = h4_recv_buf(hu->hdev, qca->rx_skb, data, count,
1144 qca_recv_pkts, ARRAY_SIZE(qca_recv_pkts));
1145 if (IS_ERR(qca->rx_skb)) {
1146 int err = PTR_ERR(qca->rx_skb);
1147 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
1155 static struct sk_buff *qca_dequeue(struct hci_uart *hu)
1157 struct qca_data *qca = hu->priv;
1159 return skb_dequeue(&qca->txq);
1162 static uint8_t qca_get_baudrate_value(int speed)
1166 return QCA_BAUDRATE_9600;
1168 return QCA_BAUDRATE_19200;
1170 return QCA_BAUDRATE_38400;
1172 return QCA_BAUDRATE_57600;
1174 return QCA_BAUDRATE_115200;
1176 return QCA_BAUDRATE_230400;
1178 return QCA_BAUDRATE_460800;
1180 return QCA_BAUDRATE_500000;
1182 return QCA_BAUDRATE_921600;
1184 return QCA_BAUDRATE_1000000;
1186 return QCA_BAUDRATE_2000000;
1188 return QCA_BAUDRATE_3000000;
1190 return QCA_BAUDRATE_3200000;
1192 return QCA_BAUDRATE_3500000;
1194 return QCA_BAUDRATE_115200;
1198 static int qca_set_baudrate(struct hci_dev *hdev, uint8_t baudrate)
1200 struct hci_uart *hu = hci_get_drvdata(hdev);
1201 struct qca_data *qca = hu->priv;
1202 struct sk_buff *skb;
1203 u8 cmd[] = { 0x01, 0x48, 0xFC, 0x01, 0x00 };
1205 if (baudrate > QCA_BAUDRATE_3200000)
1210 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
1212 bt_dev_err(hdev, "Failed to allocate baudrate packet");
1216 /* Assign commands to change baudrate and packet type. */
1217 skb_put_data(skb, cmd, sizeof(cmd));
1218 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1220 skb_queue_tail(&qca->txq, skb);
1221 hci_uart_tx_wakeup(hu);
1223 /* Wait for the baudrate change request to be sent */
1225 while (!skb_queue_empty(&qca->txq))
1226 usleep_range(100, 200);
1229 serdev_device_wait_until_sent(hu->serdev,
1230 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1232 /* Give the controller time to process the request */
1233 if (qca_is_wcn399x(qca_soc_type(hu)))
1241 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
1244 serdev_device_set_baudrate(hu->serdev, speed);
1246 hci_uart_set_baudrate(hu, speed);
1249 static int qca_send_power_pulse(struct hci_uart *hu, bool on)
1252 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
1253 u8 cmd = on ? QCA_WCN3990_POWERON_PULSE : QCA_WCN3990_POWEROFF_PULSE;
1255 /* These power pulses are single byte command which are sent
1256 * at required baudrate to wcn3990. On wcn3990, we have an external
1257 * circuit at Tx pin which decodes the pulse sent at specific baudrate.
1258 * For example, wcn3990 supports RF COEX antenna for both Wi-Fi/BT
1259 * and also we use the same power inputs to turn on and off for
1260 * Wi-Fi/BT. Powering up the power sources will not enable BT, until
1261 * we send a power on pulse at 115200 bps. This algorithm will help to
1262 * save power. Disabling hardware flow control is mandatory while
1263 * sending power pulses to SoC.
1265 bt_dev_dbg(hu->hdev, "sending power pulse %02x to controller", cmd);
1267 serdev_device_write_flush(hu->serdev);
1268 hci_uart_set_flow_control(hu, true);
1269 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1271 bt_dev_err(hu->hdev, "failed to send power pulse %02x", cmd);
1275 serdev_device_wait_until_sent(hu->serdev, timeout);
1276 hci_uart_set_flow_control(hu, false);
1278 /* Give to controller time to boot/shutdown */
1287 static unsigned int qca_get_speed(struct hci_uart *hu,
1288 enum qca_speed_type speed_type)
1290 unsigned int speed = 0;
1292 if (speed_type == QCA_INIT_SPEED) {
1294 speed = hu->init_speed;
1295 else if (hu->proto->init_speed)
1296 speed = hu->proto->init_speed;
1299 speed = hu->oper_speed;
1300 else if (hu->proto->oper_speed)
1301 speed = hu->proto->oper_speed;
1307 static int qca_check_speeds(struct hci_uart *hu)
1309 if (qca_is_wcn399x(qca_soc_type(hu))) {
1310 if (!qca_get_speed(hu, QCA_INIT_SPEED) &&
1311 !qca_get_speed(hu, QCA_OPER_SPEED))
1314 if (!qca_get_speed(hu, QCA_INIT_SPEED) ||
1315 !qca_get_speed(hu, QCA_OPER_SPEED))
1322 static int qca_set_speed(struct hci_uart *hu, enum qca_speed_type speed_type)
1324 unsigned int speed, qca_baudrate;
1325 struct qca_data *qca = hu->priv;
1328 if (speed_type == QCA_INIT_SPEED) {
1329 speed = qca_get_speed(hu, QCA_INIT_SPEED);
1331 host_set_baudrate(hu, speed);
1333 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1335 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1339 /* Disable flow control for wcn3990 to deassert RTS while
1340 * changing the baudrate of chip and host.
1342 if (qca_is_wcn399x(soc_type))
1343 hci_uart_set_flow_control(hu, true);
1345 if (soc_type == QCA_WCN3990) {
1346 reinit_completion(&qca->drop_ev_comp);
1347 set_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1350 qca_baudrate = qca_get_baudrate_value(speed);
1351 bt_dev_dbg(hu->hdev, "Set UART speed to %d", speed);
1352 ret = qca_set_baudrate(hu->hdev, qca_baudrate);
1356 host_set_baudrate(hu, speed);
1359 if (qca_is_wcn399x(soc_type))
1360 hci_uart_set_flow_control(hu, false);
1362 if (soc_type == QCA_WCN3990) {
1363 /* Wait for the controller to send the vendor event
1364 * for the baudrate change command.
1366 if (!wait_for_completion_timeout(&qca->drop_ev_comp,
1367 msecs_to_jiffies(100))) {
1368 bt_dev_err(hu->hdev,
1369 "Failed to change controller baudrate\n");
1373 clear_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1380 static int qca_send_crashbuffer(struct hci_uart *hu)
1382 struct qca_data *qca = hu->priv;
1383 struct sk_buff *skb;
1385 skb = bt_skb_alloc(QCA_CRASHBYTE_PACKET_LEN, GFP_KERNEL);
1387 bt_dev_err(hu->hdev, "Failed to allocate memory for skb packet");
1391 /* We forcefully crash the controller, by sending 0xfb byte for
1392 * 1024 times. We also might have chance of losing data, To be
1393 * on safer side we send 1096 bytes to the SoC.
1395 memset(skb_put(skb, QCA_CRASHBYTE_PACKET_LEN), QCA_MEMDUMP_BYTE,
1396 QCA_CRASHBYTE_PACKET_LEN);
1397 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1398 bt_dev_info(hu->hdev, "crash the soc to collect controller dump");
1399 skb_queue_tail(&qca->txq, skb);
1400 hci_uart_tx_wakeup(hu);
1405 static void qca_wait_for_dump_collection(struct hci_dev *hdev)
1407 struct hci_uart *hu = hci_get_drvdata(hdev);
1408 struct qca_data *qca = hu->priv;
1409 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
1410 char *memdump_buf = NULL;
1412 wait_on_bit_timeout(&qca->flags, QCA_MEMDUMP_COLLECTION,
1413 TASK_UNINTERRUPTIBLE, MEMDUMP_TIMEOUT_MS);
1415 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1416 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1417 bt_dev_err(hu->hdev, "Clearing the buffers due to timeout");
1419 memdump_buf = qca_memdump->memdump_buf_tail;
1422 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1423 del_timer(&qca->memdump_timer);
1424 cancel_work_sync(&qca->ctrl_memdump_evt);
1428 static void qca_hw_error(struct hci_dev *hdev, u8 code)
1430 struct hci_uart *hu = hci_get_drvdata(hdev);
1431 struct qca_data *qca = hu->priv;
1433 bt_dev_info(hdev, "mem_dump_status: %d", qca->memdump_state);
1435 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1436 /* If hardware error event received for other than QCA
1437 * soc memory dump event, then we need to crash the SOC
1438 * and wait here for 8 seconds to get the dump packets.
1439 * This will block main thread to be on hold until we
1442 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1443 qca_send_crashbuffer(hu);
1444 qca_wait_for_dump_collection(hdev);
1445 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1446 /* Let us wait here until memory dump collected or
1447 * memory dump timer expired.
1449 bt_dev_info(hdev, "waiting for dump to complete");
1450 qca_wait_for_dump_collection(hdev);
1454 static void qca_cmd_timeout(struct hci_dev *hdev)
1456 struct hci_uart *hu = hci_get_drvdata(hdev);
1457 struct qca_data *qca = hu->priv;
1459 if (qca->memdump_state == QCA_MEMDUMP_IDLE)
1460 qca_send_crashbuffer(hu);
1462 bt_dev_info(hdev, "Dump collection is in process");
1465 static int qca_wcn3990_init(struct hci_uart *hu)
1467 struct qca_serdev *qcadev;
1470 /* Check for vregs status, may be hci down has turned
1471 * off the voltage regulator.
1473 qcadev = serdev_device_get_drvdata(hu->serdev);
1474 if (!qcadev->bt_power->vregs_on) {
1475 serdev_device_close(hu->serdev);
1476 ret = qca_regulator_enable(qcadev);
1480 ret = serdev_device_open(hu->serdev);
1482 bt_dev_err(hu->hdev, "failed to open port");
1487 /* Forcefully enable wcn3990 to enter in to boot mode. */
1488 host_set_baudrate(hu, 2400);
1489 ret = qca_send_power_pulse(hu, false);
1493 qca_set_speed(hu, QCA_INIT_SPEED);
1494 ret = qca_send_power_pulse(hu, true);
1498 /* Now the device is in ready state to communicate with host.
1499 * To sync host with device we need to reopen port.
1500 * Without this, we will have RTS and CTS synchronization
1503 serdev_device_close(hu->serdev);
1504 ret = serdev_device_open(hu->serdev);
1506 bt_dev_err(hu->hdev, "failed to open port");
1510 hci_uart_set_flow_control(hu, false);
1515 static int qca_power_on(struct hci_dev *hdev)
1517 struct hci_uart *hu = hci_get_drvdata(hdev);
1518 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1519 struct qca_serdev *qcadev;
1522 /* Non-serdev device usually is powered by external power
1523 * and don't need additional action in driver for power on
1528 if (qca_is_wcn399x(soc_type)) {
1529 ret = qca_wcn3990_init(hu);
1531 qcadev = serdev_device_get_drvdata(hu->serdev);
1532 gpiod_set_value_cansleep(qcadev->bt_en, 1);
1533 /* Controller needs time to bootup. */
1540 static int qca_setup(struct hci_uart *hu)
1542 struct hci_dev *hdev = hu->hdev;
1543 struct qca_data *qca = hu->priv;
1544 unsigned int speed, qca_baudrate = QCA_BAUDRATE_115200;
1545 unsigned int retries = 0;
1546 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1547 const char *firmware_name = qca_get_firmware_name(hu);
1551 ret = qca_check_speeds(hu);
1555 /* Patch downloading has to be done without IBS mode */
1556 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1558 /* Enable controller to do both LE scan and BR/EDR inquiry
1561 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1563 bt_dev_info(hdev, "setting up %s",
1564 qca_is_wcn399x(soc_type) ? "wcn399x" : "ROME");
1567 ret = qca_power_on(hdev);
1571 if (qca_is_wcn399x(soc_type)) {
1572 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hdev->quirks);
1574 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1578 qca_set_speed(hu, QCA_INIT_SPEED);
1581 /* Setup user speed if needed */
1582 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1584 ret = qca_set_speed(hu, QCA_OPER_SPEED);
1588 qca_baudrate = qca_get_baudrate_value(speed);
1591 if (!qca_is_wcn399x(soc_type)) {
1592 /* Get QCA version information */
1593 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1598 bt_dev_info(hdev, "QCA controller version 0x%08x", soc_ver);
1599 /* Setup patch / NVM configurations */
1600 ret = qca_uart_setup(hdev, qca_baudrate, soc_type, soc_ver,
1603 set_bit(QCA_IBS_ENABLED, &qca->flags);
1604 qca_debugfs_init(hdev);
1605 hu->hdev->hw_error = qca_hw_error;
1606 hu->hdev->cmd_timeout = qca_cmd_timeout;
1607 } else if (ret == -ENOENT) {
1608 /* No patch/nvm-config found, run with original fw/config */
1610 } else if (ret == -EAGAIN) {
1612 * Userspace firmware loader will return -EAGAIN in case no
1613 * patch/nvm-config is found, so run with original fw/config.
1617 if (retries < MAX_INIT_RETRIES) {
1618 qca_power_shutdown(hu);
1620 serdev_device_close(hu->serdev);
1621 ret = serdev_device_open(hu->serdev);
1623 bt_dev_err(hdev, "failed to open port");
1633 if (qca_is_wcn399x(soc_type))
1634 hu->hdev->set_bdaddr = qca_set_bdaddr;
1636 hu->hdev->set_bdaddr = qca_set_bdaddr_rome;
1641 static const struct hci_uart_proto qca_proto = {
1645 .init_speed = 115200,
1646 .oper_speed = 3000000,
1652 .enqueue = qca_enqueue,
1653 .dequeue = qca_dequeue,
1656 static const struct qca_vreg_data qca_soc_data_wcn3990 = {
1657 .soc_type = QCA_WCN3990,
1658 .vregs = (struct qca_vreg []) {
1661 { "vddrf", 300000 },
1662 { "vddch0", 450000 },
1667 static const struct qca_vreg_data qca_soc_data_wcn3991 = {
1668 .soc_type = QCA_WCN3991,
1669 .vregs = (struct qca_vreg []) {
1672 { "vddrf", 300000 },
1673 { "vddch0", 450000 },
1678 static const struct qca_vreg_data qca_soc_data_wcn3998 = {
1679 .soc_type = QCA_WCN3998,
1680 .vregs = (struct qca_vreg []) {
1683 { "vddrf", 300000 },
1684 { "vddch0", 450000 },
1689 static void qca_power_shutdown(struct hci_uart *hu)
1691 struct qca_serdev *qcadev;
1692 struct qca_data *qca = hu->priv;
1693 unsigned long flags;
1694 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1696 qcadev = serdev_device_get_drvdata(hu->serdev);
1698 /* From this point we go into power off state. But serial port is
1699 * still open, stop queueing the IBS data and flush all the buffered
1702 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
1703 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1705 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
1707 hu->hdev->hw_error = NULL;
1708 hu->hdev->cmd_timeout = NULL;
1710 /* Non-serdev device usually is powered by external power
1711 * and don't need additional action in driver for power down
1716 if (qca_is_wcn399x(soc_type)) {
1717 host_set_baudrate(hu, 2400);
1718 qca_send_power_pulse(hu, false);
1719 qca_regulator_disable(qcadev);
1721 gpiod_set_value_cansleep(qcadev->bt_en, 0);
1725 static int qca_power_off(struct hci_dev *hdev)
1727 struct hci_uart *hu = hci_get_drvdata(hdev);
1728 struct qca_data *qca = hu->priv;
1730 /* Stop sending shutdown command if soc crashes. */
1731 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1732 qca_send_pre_shutdown_cmd(hdev);
1733 usleep_range(8000, 10000);
1736 qca->memdump_state = QCA_MEMDUMP_IDLE;
1737 qca_power_shutdown(hu);
1741 static int qca_regulator_enable(struct qca_serdev *qcadev)
1743 struct qca_power *power = qcadev->bt_power;
1746 /* Already enabled */
1747 if (power->vregs_on)
1750 BT_DBG("enabling %d regulators)", power->num_vregs);
1752 ret = regulator_bulk_enable(power->num_vregs, power->vreg_bulk);
1756 power->vregs_on = true;
1761 static void qca_regulator_disable(struct qca_serdev *qcadev)
1763 struct qca_power *power;
1768 power = qcadev->bt_power;
1770 /* Already disabled? */
1771 if (!power->vregs_on)
1774 regulator_bulk_disable(power->num_vregs, power->vreg_bulk);
1775 power->vregs_on = false;
1778 static int qca_init_regulators(struct qca_power *qca,
1779 const struct qca_vreg *vregs, size_t num_vregs)
1781 struct regulator_bulk_data *bulk;
1785 bulk = devm_kcalloc(qca->dev, num_vregs, sizeof(*bulk), GFP_KERNEL);
1789 for (i = 0; i < num_vregs; i++)
1790 bulk[i].supply = vregs[i].name;
1792 ret = devm_regulator_bulk_get(qca->dev, num_vregs, bulk);
1796 for (i = 0; i < num_vregs; i++) {
1797 ret = regulator_set_load(bulk[i].consumer, vregs[i].load_uA);
1802 qca->vreg_bulk = bulk;
1803 qca->num_vregs = num_vregs;
1808 static int qca_serdev_probe(struct serdev_device *serdev)
1810 struct qca_serdev *qcadev;
1811 struct hci_dev *hdev;
1812 const struct qca_vreg_data *data;
1815 qcadev = devm_kzalloc(&serdev->dev, sizeof(*qcadev), GFP_KERNEL);
1819 qcadev->serdev_hu.serdev = serdev;
1820 data = device_get_match_data(&serdev->dev);
1821 serdev_device_set_drvdata(serdev, qcadev);
1822 device_property_read_string(&serdev->dev, "firmware-name",
1823 &qcadev->firmware_name);
1824 if (data && qca_is_wcn399x(data->soc_type)) {
1825 qcadev->btsoc_type = data->soc_type;
1826 qcadev->bt_power = devm_kzalloc(&serdev->dev,
1827 sizeof(struct qca_power),
1829 if (!qcadev->bt_power)
1832 qcadev->bt_power->dev = &serdev->dev;
1833 err = qca_init_regulators(qcadev->bt_power, data->vregs,
1836 BT_ERR("Failed to init regulators:%d", err);
1840 qcadev->bt_power->vregs_on = false;
1842 device_property_read_u32(&serdev->dev, "max-speed",
1843 &qcadev->oper_speed);
1844 if (!qcadev->oper_speed)
1845 BT_DBG("UART will pick default operating speed");
1847 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1849 BT_ERR("wcn3990 serdev registration failed");
1853 qcadev->btsoc_type = QCA_ROME;
1854 qcadev->bt_en = devm_gpiod_get(&serdev->dev, "enable",
1856 if (IS_ERR(qcadev->bt_en)) {
1857 dev_err(&serdev->dev, "failed to acquire enable gpio\n");
1858 return PTR_ERR(qcadev->bt_en);
1861 qcadev->susclk = devm_clk_get(&serdev->dev, NULL);
1862 if (IS_ERR(qcadev->susclk)) {
1863 dev_err(&serdev->dev, "failed to acquire clk\n");
1864 return PTR_ERR(qcadev->susclk);
1867 err = clk_set_rate(qcadev->susclk, SUSCLK_RATE_32KHZ);
1871 err = clk_prepare_enable(qcadev->susclk);
1875 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1877 BT_ERR("Rome serdev registration failed");
1878 clk_disable_unprepare(qcadev->susclk);
1883 hdev = qcadev->serdev_hu.hdev;
1884 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
1885 hdev->shutdown = qca_power_off;
1890 static void qca_serdev_remove(struct serdev_device *serdev)
1892 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
1894 if (qca_is_wcn399x(qcadev->btsoc_type))
1895 qca_power_shutdown(&qcadev->serdev_hu);
1897 clk_disable_unprepare(qcadev->susclk);
1899 hci_uart_unregister_device(&qcadev->serdev_hu);
1902 static int __maybe_unused qca_suspend(struct device *dev)
1904 struct hci_dev *hdev = container_of(dev, struct hci_dev, dev);
1905 struct hci_uart *hu = hci_get_drvdata(hdev);
1906 struct qca_data *qca = hu->priv;
1907 unsigned long flags;
1911 set_bit(QCA_SUSPENDING, &qca->flags);
1913 /* Device is downloading patch or doesn't support in-band sleep. */
1914 if (!test_bit(QCA_IBS_ENABLED, &qca->flags))
1917 cancel_work_sync(&qca->ws_awake_device);
1918 cancel_work_sync(&qca->ws_awake_rx);
1920 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
1921 flags, SINGLE_DEPTH_NESTING);
1923 switch (qca->tx_ibs_state) {
1924 case HCI_IBS_TX_WAKING:
1925 del_timer(&qca->wake_retrans_timer);
1927 case HCI_IBS_TX_AWAKE:
1928 del_timer(&qca->tx_idle_timer);
1930 serdev_device_write_flush(hu->serdev);
1931 cmd = HCI_IBS_SLEEP_IND;
1932 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1935 BT_ERR("Failed to send SLEEP to device");
1939 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
1940 qca->ibs_sent_slps++;
1942 qca_wq_serial_tx_clock_vote_off(&qca->ws_tx_vote_off);
1945 case HCI_IBS_TX_ASLEEP:
1949 BT_ERR("Spurious tx state %d", qca->tx_ibs_state);
1954 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
1959 serdev_device_wait_until_sent(hu->serdev,
1960 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1962 /* Wait for HCI_IBS_SLEEP_IND sent by device to indicate its Tx is going
1963 * to sleep, so that the packet does not wake the system later.
1966 ret = wait_event_interruptible_timeout(qca->suspend_wait_q,
1967 qca->rx_ibs_state == HCI_IBS_RX_ASLEEP,
1968 msecs_to_jiffies(IBS_BTSOC_TX_IDLE_TIMEOUT_MS));
1977 clear_bit(QCA_SUSPENDING, &qca->flags);
1982 static int __maybe_unused qca_resume(struct device *dev)
1984 struct hci_dev *hdev = container_of(dev, struct hci_dev, dev);
1985 struct hci_uart *hu = hci_get_drvdata(hdev);
1986 struct qca_data *qca = hu->priv;
1988 clear_bit(QCA_SUSPENDING, &qca->flags);
1993 static SIMPLE_DEV_PM_OPS(qca_pm_ops, qca_suspend, qca_resume);
1995 static const struct of_device_id qca_bluetooth_of_match[] = {
1996 { .compatible = "qcom,qca6174-bt" },
1997 { .compatible = "qcom,wcn3990-bt", .data = &qca_soc_data_wcn3990},
1998 { .compatible = "qcom,wcn3991-bt", .data = &qca_soc_data_wcn3991},
1999 { .compatible = "qcom,wcn3998-bt", .data = &qca_soc_data_wcn3998},
2002 MODULE_DEVICE_TABLE(of, qca_bluetooth_of_match);
2004 static struct serdev_device_driver qca_serdev_driver = {
2005 .probe = qca_serdev_probe,
2006 .remove = qca_serdev_remove,
2008 .name = "hci_uart_qca",
2009 .of_match_table = qca_bluetooth_of_match,
2014 int __init qca_init(void)
2016 serdev_device_driver_register(&qca_serdev_driver);
2018 return hci_uart_register_proto(&qca_proto);
2021 int __exit qca_deinit(void)
2023 serdev_device_driver_unregister(&qca_serdev_driver);
2025 return hci_uart_unregister_proto(&qca_proto);