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 /* Controller dump header */
59 #define QCA_SSR_DUMP_HANDLE 0x0108
60 #define QCA_DUMP_PACKET_SIZE 255
61 #define QCA_LAST_SEQUENCE_NUM 0xFFFF
62 #define QCA_CRASHBYTE_PACKET_LEN 1096
63 #define QCA_MEMDUMP_BYTE 0xFB
67 QCA_DROP_VENDOR_EVENT,
69 QCA_MEMDUMP_COLLECTION
73 /* HCI_IBS transmit side sleep protocol states */
80 /* HCI_IBS receive side sleep protocol states */
86 /* HCI_IBS transmit and receive side clock state vote */
87 enum hci_ibs_clock_state_vote {
88 HCI_IBS_VOTE_STATS_UPDATE,
89 HCI_IBS_TX_VOTE_CLOCK_ON,
90 HCI_IBS_TX_VOTE_CLOCK_OFF,
91 HCI_IBS_RX_VOTE_CLOCK_ON,
92 HCI_IBS_RX_VOTE_CLOCK_OFF,
95 /* Controller memory dump states */
96 enum qca_memdump_states {
98 QCA_MEMDUMP_COLLECTING,
99 QCA_MEMDUMP_COLLECTED,
103 struct qca_memdump_data {
104 char *memdump_buf_head;
105 char *memdump_buf_tail;
110 struct qca_memdump_event_hdr {
119 struct qca_dump_size {
125 struct sk_buff *rx_skb;
126 struct sk_buff_head txq;
127 struct sk_buff_head tx_wait_q; /* HCI_IBS wait queue */
128 struct sk_buff_head rx_memdump_q; /* Memdump wait queue */
129 spinlock_t hci_ibs_lock; /* HCI_IBS state lock */
130 u8 tx_ibs_state; /* HCI_IBS transmit side power state*/
131 u8 rx_ibs_state; /* HCI_IBS receive side power state */
132 bool tx_vote; /* Clock must be on for TX */
133 bool rx_vote; /* Clock must be on for RX */
134 struct timer_list tx_idle_timer;
136 struct timer_list wake_retrans_timer;
138 struct timer_list memdump_timer;
139 struct workqueue_struct *workqueue;
140 struct work_struct ws_awake_rx;
141 struct work_struct ws_awake_device;
142 struct work_struct ws_rx_vote_off;
143 struct work_struct ws_tx_vote_off;
144 struct work_struct ctrl_memdump_evt;
145 struct qca_memdump_data *qca_memdump;
147 struct completion drop_ev_comp;
148 wait_queue_head_t suspend_wait_q;
149 enum qca_memdump_states memdump_state;
151 /* For debugging purpose */
169 enum qca_speed_type {
175 * Voltage regulator information required for configuring the
176 * QCA Bluetooth chipset
180 unsigned int load_uA;
183 struct qca_vreg_data {
184 enum qca_btsoc_type soc_type;
185 struct qca_vreg *vregs;
190 * Platform data for the QCA Bluetooth power driver.
194 struct regulator_bulk_data *vreg_bulk;
200 struct hci_uart serdev_hu;
201 struct gpio_desc *bt_en;
203 enum qca_btsoc_type btsoc_type;
204 struct qca_power *bt_power;
207 const char *firmware_name;
210 static int qca_regulator_enable(struct qca_serdev *qcadev);
211 static void qca_regulator_disable(struct qca_serdev *qcadev);
212 static void qca_power_shutdown(struct hci_uart *hu);
213 static int qca_power_off(struct hci_dev *hdev);
214 static void qca_controller_memdump(struct work_struct *work);
216 static enum qca_btsoc_type qca_soc_type(struct hci_uart *hu)
218 enum qca_btsoc_type soc_type;
221 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
223 soc_type = qsd->btsoc_type;
231 static const char *qca_get_firmware_name(struct hci_uart *hu)
234 struct qca_serdev *qsd = serdev_device_get_drvdata(hu->serdev);
236 return qsd->firmware_name;
242 static void __serial_clock_on(struct tty_struct *tty)
244 /* TODO: Some chipset requires to enable UART clock on client
245 * side to save power consumption or manual work is required.
246 * Please put your code to control UART clock here if needed
250 static void __serial_clock_off(struct tty_struct *tty)
252 /* TODO: Some chipset requires to disable UART clock on client
253 * side to save power consumption or manual work is required.
254 * Please put your code to control UART clock off here if needed
258 /* serial_clock_vote needs to be called with the ibs lock held */
259 static void serial_clock_vote(unsigned long vote, struct hci_uart *hu)
261 struct qca_data *qca = hu->priv;
264 bool old_vote = (qca->tx_vote | qca->rx_vote);
268 case HCI_IBS_VOTE_STATS_UPDATE:
269 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
272 qca->vote_off_ms += diff;
274 qca->vote_on_ms += diff;
277 case HCI_IBS_TX_VOTE_CLOCK_ON:
283 case HCI_IBS_RX_VOTE_CLOCK_ON:
289 case HCI_IBS_TX_VOTE_CLOCK_OFF:
290 qca->tx_vote = false;
292 new_vote = qca->rx_vote | qca->tx_vote;
295 case HCI_IBS_RX_VOTE_CLOCK_OFF:
296 qca->rx_vote = false;
298 new_vote = qca->rx_vote | qca->tx_vote;
302 BT_ERR("Voting irregularity");
306 if (new_vote != old_vote) {
308 __serial_clock_on(hu->tty);
310 __serial_clock_off(hu->tty);
312 BT_DBG("Vote serial clock %s(%s)", new_vote ? "true" : "false",
313 vote ? "true" : "false");
315 diff = jiffies_to_msecs(jiffies - qca->vote_last_jif);
319 qca->vote_off_ms += diff;
322 qca->vote_on_ms += diff;
324 qca->vote_last_jif = jiffies;
328 /* Builds and sends an HCI_IBS command packet.
329 * These are very simple packets with only 1 cmd byte.
331 static int send_hci_ibs_cmd(u8 cmd, struct hci_uart *hu)
334 struct sk_buff *skb = NULL;
335 struct qca_data *qca = hu->priv;
337 BT_DBG("hu %p send hci ibs cmd 0x%x", hu, cmd);
339 skb = bt_skb_alloc(1, GFP_ATOMIC);
341 BT_ERR("Failed to allocate memory for HCI_IBS packet");
345 /* Assign HCI_IBS type */
346 skb_put_u8(skb, cmd);
348 skb_queue_tail(&qca->txq, skb);
353 static void qca_wq_awake_device(struct work_struct *work)
355 struct qca_data *qca = container_of(work, struct qca_data,
357 struct hci_uart *hu = qca->hu;
358 unsigned long retrans_delay;
361 BT_DBG("hu %p wq awake device", hu);
363 /* Vote for serial clock */
364 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_ON, hu);
366 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
368 /* Send wake indication to device */
369 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0)
370 BT_ERR("Failed to send WAKE to device");
372 qca->ibs_sent_wakes++;
374 /* Start retransmit timer */
375 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
376 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
378 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
380 /* Actually send the packets */
381 hci_uart_tx_wakeup(hu);
384 static void qca_wq_awake_rx(struct work_struct *work)
386 struct qca_data *qca = container_of(work, struct qca_data,
388 struct hci_uart *hu = qca->hu;
391 BT_DBG("hu %p wq awake rx", hu);
393 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_ON, hu);
395 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
396 qca->rx_ibs_state = HCI_IBS_RX_AWAKE;
398 /* Always acknowledge device wake up,
399 * sending IBS message doesn't count as TX ON.
401 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0)
402 BT_ERR("Failed to acknowledge device wake up");
404 qca->ibs_sent_wacks++;
406 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
408 /* Actually send the packets */
409 hci_uart_tx_wakeup(hu);
412 static void qca_wq_serial_rx_clock_vote_off(struct work_struct *work)
414 struct qca_data *qca = container_of(work, struct qca_data,
416 struct hci_uart *hu = qca->hu;
418 BT_DBG("hu %p rx clock vote off", hu);
420 serial_clock_vote(HCI_IBS_RX_VOTE_CLOCK_OFF, hu);
423 static void qca_wq_serial_tx_clock_vote_off(struct work_struct *work)
425 struct qca_data *qca = container_of(work, struct qca_data,
427 struct hci_uart *hu = qca->hu;
429 BT_DBG("hu %p tx clock vote off", hu);
431 /* Run HCI tx handling unlocked */
432 hci_uart_tx_wakeup(hu);
434 /* Now that message queued to tty driver, vote for tty clocks off.
435 * It is up to the tty driver to pend the clocks off until tx done.
437 serial_clock_vote(HCI_IBS_TX_VOTE_CLOCK_OFF, hu);
440 static void hci_ibs_tx_idle_timeout(struct timer_list *t)
442 struct qca_data *qca = from_timer(qca, t, tx_idle_timer);
443 struct hci_uart *hu = qca->hu;
446 BT_DBG("hu %p idle timeout in %d state", hu, qca->tx_ibs_state);
448 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
449 flags, SINGLE_DEPTH_NESTING);
451 switch (qca->tx_ibs_state) {
452 case HCI_IBS_TX_AWAKE:
453 /* TX_IDLE, go to SLEEP */
454 if (send_hci_ibs_cmd(HCI_IBS_SLEEP_IND, hu) < 0) {
455 BT_ERR("Failed to send SLEEP to device");
458 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
459 qca->ibs_sent_slps++;
460 queue_work(qca->workqueue, &qca->ws_tx_vote_off);
463 case HCI_IBS_TX_ASLEEP:
464 case HCI_IBS_TX_WAKING:
468 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
472 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
475 static void hci_ibs_wake_retrans_timeout(struct timer_list *t)
477 struct qca_data *qca = from_timer(qca, t, wake_retrans_timer);
478 struct hci_uart *hu = qca->hu;
479 unsigned long flags, retrans_delay;
480 bool retransmit = false;
482 BT_DBG("hu %p wake retransmit timeout in %d state",
483 hu, qca->tx_ibs_state);
485 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
486 flags, SINGLE_DEPTH_NESTING);
488 /* Don't retransmit the HCI_IBS_WAKE_IND when suspending. */
489 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
490 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
494 switch (qca->tx_ibs_state) {
495 case HCI_IBS_TX_WAKING:
496 /* No WAKE_ACK, retransmit WAKE */
498 if (send_hci_ibs_cmd(HCI_IBS_WAKE_IND, hu) < 0) {
499 BT_ERR("Failed to acknowledge device wake up");
502 qca->ibs_sent_wakes++;
503 retrans_delay = msecs_to_jiffies(qca->wake_retrans);
504 mod_timer(&qca->wake_retrans_timer, jiffies + retrans_delay);
507 case HCI_IBS_TX_ASLEEP:
508 case HCI_IBS_TX_AWAKE:
512 BT_ERR("Spurious timeout tx state %d", qca->tx_ibs_state);
516 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
519 hci_uart_tx_wakeup(hu);
522 static void hci_memdump_timeout(struct timer_list *t)
524 struct qca_data *qca = from_timer(qca, t, tx_idle_timer);
525 struct hci_uart *hu = qca->hu;
526 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
527 char *memdump_buf = qca_memdump->memdump_buf_tail;
529 bt_dev_err(hu->hdev, "clearing allocated memory due to memdump timeout");
530 /* Inject hw error event to reset the device and driver. */
531 hci_reset_dev(hu->hdev);
534 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
535 del_timer(&qca->memdump_timer);
536 cancel_work_sync(&qca->ctrl_memdump_evt);
539 /* Initialize protocol */
540 static int qca_open(struct hci_uart *hu)
542 struct qca_serdev *qcadev;
543 struct qca_data *qca;
545 BT_DBG("hu %p qca_open", hu);
547 if (!hci_uart_has_flow_control(hu))
550 qca = kzalloc(sizeof(struct qca_data), GFP_KERNEL);
554 skb_queue_head_init(&qca->txq);
555 skb_queue_head_init(&qca->tx_wait_q);
556 skb_queue_head_init(&qca->rx_memdump_q);
557 spin_lock_init(&qca->hci_ibs_lock);
558 qca->workqueue = alloc_ordered_workqueue("qca_wq", 0);
559 if (!qca->workqueue) {
560 BT_ERR("QCA Workqueue not initialized properly");
565 INIT_WORK(&qca->ws_awake_rx, qca_wq_awake_rx);
566 INIT_WORK(&qca->ws_awake_device, qca_wq_awake_device);
567 INIT_WORK(&qca->ws_rx_vote_off, qca_wq_serial_rx_clock_vote_off);
568 INIT_WORK(&qca->ws_tx_vote_off, qca_wq_serial_tx_clock_vote_off);
569 INIT_WORK(&qca->ctrl_memdump_evt, qca_controller_memdump);
570 init_waitqueue_head(&qca->suspend_wait_q);
573 init_completion(&qca->drop_ev_comp);
575 /* Assume we start with both sides asleep -- extra wakes OK */
576 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
577 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
579 qca->vote_last_jif = jiffies;
584 qcadev = serdev_device_get_drvdata(hu->serdev);
585 if (qca_is_wcn399x(qcadev->btsoc_type)) {
586 hu->init_speed = qcadev->init_speed;
587 hu->oper_speed = qcadev->oper_speed;
591 timer_setup(&qca->wake_retrans_timer, hci_ibs_wake_retrans_timeout, 0);
592 qca->wake_retrans = IBS_WAKE_RETRANS_TIMEOUT_MS;
594 timer_setup(&qca->tx_idle_timer, hci_ibs_tx_idle_timeout, 0);
595 qca->tx_idle_delay = IBS_HOST_TX_IDLE_TIMEOUT_MS;
596 timer_setup(&qca->memdump_timer, hci_memdump_timeout, 0);
598 BT_DBG("HCI_UART_QCA open, tx_idle_delay=%u, wake_retrans=%u",
599 qca->tx_idle_delay, qca->wake_retrans);
604 static void qca_debugfs_init(struct hci_dev *hdev)
606 struct hci_uart *hu = hci_get_drvdata(hdev);
607 struct qca_data *qca = hu->priv;
608 struct dentry *ibs_dir;
614 ibs_dir = debugfs_create_dir("ibs", hdev->debugfs);
618 debugfs_create_u8("tx_ibs_state", mode, ibs_dir, &qca->tx_ibs_state);
619 debugfs_create_u8("rx_ibs_state", mode, ibs_dir, &qca->rx_ibs_state);
620 debugfs_create_u64("ibs_sent_sleeps", mode, ibs_dir,
621 &qca->ibs_sent_slps);
622 debugfs_create_u64("ibs_sent_wakes", mode, ibs_dir,
623 &qca->ibs_sent_wakes);
624 debugfs_create_u64("ibs_sent_wake_acks", mode, ibs_dir,
625 &qca->ibs_sent_wacks);
626 debugfs_create_u64("ibs_recv_sleeps", mode, ibs_dir,
627 &qca->ibs_recv_slps);
628 debugfs_create_u64("ibs_recv_wakes", mode, ibs_dir,
629 &qca->ibs_recv_wakes);
630 debugfs_create_u64("ibs_recv_wake_acks", mode, ibs_dir,
631 &qca->ibs_recv_wacks);
632 debugfs_create_bool("tx_vote", mode, ibs_dir, &qca->tx_vote);
633 debugfs_create_u64("tx_votes_on", mode, ibs_dir, &qca->tx_votes_on);
634 debugfs_create_u64("tx_votes_off", mode, ibs_dir, &qca->tx_votes_off);
635 debugfs_create_bool("rx_vote", mode, ibs_dir, &qca->rx_vote);
636 debugfs_create_u64("rx_votes_on", mode, ibs_dir, &qca->rx_votes_on);
637 debugfs_create_u64("rx_votes_off", mode, ibs_dir, &qca->rx_votes_off);
638 debugfs_create_u64("votes_on", mode, ibs_dir, &qca->votes_on);
639 debugfs_create_u64("votes_off", mode, ibs_dir, &qca->votes_off);
640 debugfs_create_u32("vote_on_ms", mode, ibs_dir, &qca->vote_on_ms);
641 debugfs_create_u32("vote_off_ms", mode, ibs_dir, &qca->vote_off_ms);
644 mode = S_IRUGO | S_IWUSR;
645 debugfs_create_u32("wake_retrans", mode, ibs_dir, &qca->wake_retrans);
646 debugfs_create_u32("tx_idle_delay", mode, ibs_dir,
647 &qca->tx_idle_delay);
650 /* Flush protocol data */
651 static int qca_flush(struct hci_uart *hu)
653 struct qca_data *qca = hu->priv;
655 BT_DBG("hu %p qca flush", hu);
657 skb_queue_purge(&qca->tx_wait_q);
658 skb_queue_purge(&qca->txq);
664 static int qca_close(struct hci_uart *hu)
666 struct qca_serdev *qcadev;
667 struct qca_data *qca = hu->priv;
669 BT_DBG("hu %p qca close", hu);
671 serial_clock_vote(HCI_IBS_VOTE_STATS_UPDATE, hu);
673 skb_queue_purge(&qca->tx_wait_q);
674 skb_queue_purge(&qca->txq);
675 skb_queue_purge(&qca->rx_memdump_q);
676 del_timer(&qca->tx_idle_timer);
677 del_timer(&qca->wake_retrans_timer);
678 del_timer(&qca->memdump_timer);
679 destroy_workqueue(qca->workqueue);
683 qcadev = serdev_device_get_drvdata(hu->serdev);
684 if (qca_is_wcn399x(qcadev->btsoc_type))
685 qca_power_shutdown(hu);
687 gpiod_set_value_cansleep(qcadev->bt_en, 0);
691 kfree_skb(qca->rx_skb);
700 /* Called upon a wake-up-indication from the device.
702 static void device_want_to_wakeup(struct hci_uart *hu)
705 struct qca_data *qca = hu->priv;
707 BT_DBG("hu %p want to wake up", hu);
709 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
711 qca->ibs_recv_wakes++;
713 /* Don't wake the rx up when suspending. */
714 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
715 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
719 switch (qca->rx_ibs_state) {
720 case HCI_IBS_RX_ASLEEP:
721 /* Make sure clock is on - we may have turned clock off since
722 * receiving the wake up indicator awake rx clock.
724 queue_work(qca->workqueue, &qca->ws_awake_rx);
725 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
728 case HCI_IBS_RX_AWAKE:
729 /* Always acknowledge device wake up,
730 * sending IBS message doesn't count as TX ON.
732 if (send_hci_ibs_cmd(HCI_IBS_WAKE_ACK, hu) < 0) {
733 BT_ERR("Failed to acknowledge device wake up");
736 qca->ibs_sent_wacks++;
740 /* Any other state is illegal */
741 BT_ERR("Received HCI_IBS_WAKE_IND in rx state %d",
746 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
748 /* Actually send the packets */
749 hci_uart_tx_wakeup(hu);
752 /* Called upon a sleep-indication from the device.
754 static void device_want_to_sleep(struct hci_uart *hu)
757 struct qca_data *qca = hu->priv;
759 BT_DBG("hu %p want to sleep in %d state", hu, qca->rx_ibs_state);
761 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
763 qca->ibs_recv_slps++;
765 switch (qca->rx_ibs_state) {
766 case HCI_IBS_RX_AWAKE:
768 qca->rx_ibs_state = HCI_IBS_RX_ASLEEP;
769 /* Vote off rx clock under workqueue */
770 queue_work(qca->workqueue, &qca->ws_rx_vote_off);
773 case HCI_IBS_RX_ASLEEP:
777 /* Any other state is illegal */
778 BT_ERR("Received HCI_IBS_SLEEP_IND in rx state %d",
783 wake_up_interruptible(&qca->suspend_wait_q);
785 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
788 /* Called upon wake-up-acknowledgement from the device
790 static void device_woke_up(struct hci_uart *hu)
792 unsigned long flags, idle_delay;
793 struct qca_data *qca = hu->priv;
794 struct sk_buff *skb = NULL;
796 BT_DBG("hu %p woke up", hu);
798 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
800 qca->ibs_recv_wacks++;
802 /* Don't react to the wake-up-acknowledgment when suspending. */
803 if (test_bit(QCA_SUSPENDING, &qca->flags)) {
804 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
808 switch (qca->tx_ibs_state) {
809 case HCI_IBS_TX_AWAKE:
810 /* Expect one if we send 2 WAKEs */
811 BT_DBG("Received HCI_IBS_WAKE_ACK in tx state %d",
815 case HCI_IBS_TX_WAKING:
816 /* Send pending packets */
817 while ((skb = skb_dequeue(&qca->tx_wait_q)))
818 skb_queue_tail(&qca->txq, skb);
820 /* Switch timers and change state to HCI_IBS_TX_AWAKE */
821 del_timer(&qca->wake_retrans_timer);
822 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
823 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
824 qca->tx_ibs_state = HCI_IBS_TX_AWAKE;
827 case HCI_IBS_TX_ASLEEP:
831 BT_ERR("Received HCI_IBS_WAKE_ACK in tx state %d",
836 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
838 /* Actually send the packets */
839 hci_uart_tx_wakeup(hu);
842 /* Enqueue frame for transmittion (padding, crc, etc) may be called from
843 * two simultaneous tasklets.
845 static int qca_enqueue(struct hci_uart *hu, struct sk_buff *skb)
847 unsigned long flags = 0, idle_delay;
848 struct qca_data *qca = hu->priv;
850 BT_DBG("hu %p qca enq skb %p tx_ibs_state %d", hu, skb,
853 /* Prepend skb with frame type */
854 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
856 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
858 /* Don't go to sleep in middle of patch download or
859 * Out-Of-Band(GPIOs control) sleep is selected.
860 * Don't wake the device up when suspending.
862 if (!test_bit(QCA_IBS_ENABLED, &qca->flags) ||
863 test_bit(QCA_SUSPENDING, &qca->flags)) {
864 skb_queue_tail(&qca->txq, skb);
865 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
869 /* Act according to current state */
870 switch (qca->tx_ibs_state) {
871 case HCI_IBS_TX_AWAKE:
872 BT_DBG("Device awake, sending normally");
873 skb_queue_tail(&qca->txq, skb);
874 idle_delay = msecs_to_jiffies(qca->tx_idle_delay);
875 mod_timer(&qca->tx_idle_timer, jiffies + idle_delay);
878 case HCI_IBS_TX_ASLEEP:
879 BT_DBG("Device asleep, waking up and queueing packet");
880 /* Save packet for later */
881 skb_queue_tail(&qca->tx_wait_q, skb);
883 qca->tx_ibs_state = HCI_IBS_TX_WAKING;
884 /* Schedule a work queue to wake up device */
885 queue_work(qca->workqueue, &qca->ws_awake_device);
888 case HCI_IBS_TX_WAKING:
889 BT_DBG("Device waking up, queueing packet");
890 /* Transient state; just keep packet for later */
891 skb_queue_tail(&qca->tx_wait_q, skb);
895 BT_ERR("Illegal tx state: %d (losing packet)",
901 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
906 static int qca_ibs_sleep_ind(struct hci_dev *hdev, struct sk_buff *skb)
908 struct hci_uart *hu = hci_get_drvdata(hdev);
910 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_SLEEP_IND);
912 device_want_to_sleep(hu);
918 static int qca_ibs_wake_ind(struct hci_dev *hdev, struct sk_buff *skb)
920 struct hci_uart *hu = hci_get_drvdata(hdev);
922 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_IND);
924 device_want_to_wakeup(hu);
930 static int qca_ibs_wake_ack(struct hci_dev *hdev, struct sk_buff *skb)
932 struct hci_uart *hu = hci_get_drvdata(hdev);
934 BT_DBG("hu %p recv hci ibs cmd 0x%x", hu, HCI_IBS_WAKE_ACK);
942 static int qca_recv_acl_data(struct hci_dev *hdev, struct sk_buff *skb)
944 /* We receive debug logs from chip as an ACL packets.
945 * Instead of sending the data to ACL to decode the
946 * received data, we are pushing them to the above layers
947 * as a diagnostic packet.
949 if (get_unaligned_le16(skb->data) == QCA_DEBUG_HANDLE)
950 return hci_recv_diag(hdev, skb);
952 return hci_recv_frame(hdev, skb);
955 static void qca_controller_memdump(struct work_struct *work)
957 struct qca_data *qca = container_of(work, struct qca_data,
959 struct hci_uart *hu = qca->hu;
961 struct qca_memdump_event_hdr *cmd_hdr;
962 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
963 struct qca_dump_size *dump;
965 char nullBuff[QCA_DUMP_PACKET_SIZE] = { 0 };
969 while ((skb = skb_dequeue(&qca->rx_memdump_q))) {
972 qca_memdump = kzalloc(sizeof(struct qca_memdump_data),
977 qca->qca_memdump = qca_memdump;
980 qca->memdump_state = QCA_MEMDUMP_COLLECTING;
981 cmd_hdr = (void *) skb->data;
982 seq_no = __le16_to_cpu(cmd_hdr->seq_no);
983 skb_pull(skb, sizeof(struct qca_memdump_event_hdr));
987 /* This is the first frame of memdump packet from
988 * the controller, Disable IBS to recevie dump
989 * with out any interruption, ideally time required for
990 * the controller to send the dump is 8 seconds. let us
991 * start timer to handle this asynchronous activity.
993 clear_bit(QCA_IBS_ENABLED, &qca->flags);
994 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
995 dump = (void *) skb->data;
996 dump_size = __le32_to_cpu(dump->dump_size);
998 bt_dev_err(hu->hdev, "Rx invalid memdump size");
1003 bt_dev_info(hu->hdev, "QCA collecting dump of size:%u",
1005 mod_timer(&qca->memdump_timer, (jiffies +
1006 msecs_to_jiffies(MEMDUMP_TIMEOUT_MS)));
1008 skb_pull(skb, sizeof(dump_size));
1009 memdump_buf = vmalloc(dump_size);
1010 qca_memdump->memdump_buf_head = memdump_buf;
1011 qca_memdump->memdump_buf_tail = memdump_buf;
1014 memdump_buf = qca_memdump->memdump_buf_tail;
1016 /* If sequence no 0 is missed then there is no point in
1017 * accepting the other sequences.
1020 bt_dev_err(hu->hdev, "QCA: Discarding other packets");
1023 qca->qca_memdump = NULL;
1027 /* There could be chance of missing some packets from
1028 * the controller. In such cases let us store the dummy
1029 * packets in the buffer.
1031 while ((seq_no > qca_memdump->current_seq_no + 1) &&
1032 seq_no != QCA_LAST_SEQUENCE_NUM) {
1033 bt_dev_err(hu->hdev, "QCA controller missed packet:%d",
1034 qca_memdump->current_seq_no);
1035 memcpy(memdump_buf, nullBuff, QCA_DUMP_PACKET_SIZE);
1036 memdump_buf = memdump_buf + QCA_DUMP_PACKET_SIZE;
1037 qca_memdump->received_dump += QCA_DUMP_PACKET_SIZE;
1038 qca_memdump->current_seq_no++;
1041 memcpy(memdump_buf, (unsigned char *) skb->data, skb->len);
1042 memdump_buf = memdump_buf + skb->len;
1043 qca_memdump->memdump_buf_tail = memdump_buf;
1044 qca_memdump->current_seq_no = seq_no + 1;
1045 qca_memdump->received_dump += skb->len;
1046 qca->qca_memdump = qca_memdump;
1048 if (seq_no == QCA_LAST_SEQUENCE_NUM) {
1049 bt_dev_info(hu->hdev, "QCA writing crash dump of size %d bytes",
1050 qca_memdump->received_dump);
1051 memdump_buf = qca_memdump->memdump_buf_head;
1052 dev_coredumpv(&hu->serdev->dev, memdump_buf,
1053 qca_memdump->received_dump, GFP_KERNEL);
1054 del_timer(&qca->memdump_timer);
1055 kfree(qca->qca_memdump);
1056 qca->qca_memdump = NULL;
1057 qca->memdump_state = QCA_MEMDUMP_COLLECTED;
1063 int qca_controller_memdump_event(struct hci_dev *hdev, struct sk_buff *skb)
1065 struct hci_uart *hu = hci_get_drvdata(hdev);
1066 struct qca_data *qca = hu->priv;
1068 skb_queue_tail(&qca->rx_memdump_q, skb);
1069 queue_work(qca->workqueue, &qca->ctrl_memdump_evt);
1074 static int qca_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
1076 struct hci_uart *hu = hci_get_drvdata(hdev);
1077 struct qca_data *qca = hu->priv;
1079 if (test_bit(QCA_DROP_VENDOR_EVENT, &qca->flags)) {
1080 struct hci_event_hdr *hdr = (void *)skb->data;
1082 /* For the WCN3990 the vendor command for a baudrate change
1083 * isn't sent as synchronous HCI command, because the
1084 * controller sends the corresponding vendor event with the
1085 * new baudrate. The event is received and properly decoded
1086 * after changing the baudrate of the host port. It needs to
1087 * be dropped, otherwise it can be misinterpreted as
1088 * response to a later firmware download command (also a
1092 if (hdr->evt == HCI_EV_VENDOR)
1093 complete(&qca->drop_ev_comp);
1099 /* We receive chip memory dump as an event packet, With a dedicated
1100 * handler followed by a hardware error event. When this event is
1101 * received we store dump into a file before closing hci. This
1102 * dump will help in triaging the issues.
1104 if ((skb->data[0] == HCI_VENDOR_PKT) &&
1105 (get_unaligned_be16(skb->data + 2) == QCA_SSR_DUMP_HANDLE))
1106 return qca_controller_memdump_event(hdev, skb);
1108 return hci_recv_frame(hdev, skb);
1111 #define QCA_IBS_SLEEP_IND_EVENT \
1112 .type = HCI_IBS_SLEEP_IND, \
1116 .maxlen = HCI_MAX_IBS_SIZE
1118 #define QCA_IBS_WAKE_IND_EVENT \
1119 .type = HCI_IBS_WAKE_IND, \
1123 .maxlen = HCI_MAX_IBS_SIZE
1125 #define QCA_IBS_WAKE_ACK_EVENT \
1126 .type = HCI_IBS_WAKE_ACK, \
1130 .maxlen = HCI_MAX_IBS_SIZE
1132 static const struct h4_recv_pkt qca_recv_pkts[] = {
1133 { H4_RECV_ACL, .recv = qca_recv_acl_data },
1134 { H4_RECV_SCO, .recv = hci_recv_frame },
1135 { H4_RECV_EVENT, .recv = qca_recv_event },
1136 { QCA_IBS_WAKE_IND_EVENT, .recv = qca_ibs_wake_ind },
1137 { QCA_IBS_WAKE_ACK_EVENT, .recv = qca_ibs_wake_ack },
1138 { QCA_IBS_SLEEP_IND_EVENT, .recv = qca_ibs_sleep_ind },
1141 static int qca_recv(struct hci_uart *hu, const void *data, int count)
1143 struct qca_data *qca = hu->priv;
1145 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
1148 qca->rx_skb = h4_recv_buf(hu->hdev, qca->rx_skb, data, count,
1149 qca_recv_pkts, ARRAY_SIZE(qca_recv_pkts));
1150 if (IS_ERR(qca->rx_skb)) {
1151 int err = PTR_ERR(qca->rx_skb);
1152 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
1160 static struct sk_buff *qca_dequeue(struct hci_uart *hu)
1162 struct qca_data *qca = hu->priv;
1164 return skb_dequeue(&qca->txq);
1167 static uint8_t qca_get_baudrate_value(int speed)
1171 return QCA_BAUDRATE_9600;
1173 return QCA_BAUDRATE_19200;
1175 return QCA_BAUDRATE_38400;
1177 return QCA_BAUDRATE_57600;
1179 return QCA_BAUDRATE_115200;
1181 return QCA_BAUDRATE_230400;
1183 return QCA_BAUDRATE_460800;
1185 return QCA_BAUDRATE_500000;
1187 return QCA_BAUDRATE_921600;
1189 return QCA_BAUDRATE_1000000;
1191 return QCA_BAUDRATE_2000000;
1193 return QCA_BAUDRATE_3000000;
1195 return QCA_BAUDRATE_3200000;
1197 return QCA_BAUDRATE_3500000;
1199 return QCA_BAUDRATE_115200;
1203 static int qca_set_baudrate(struct hci_dev *hdev, uint8_t baudrate)
1205 struct hci_uart *hu = hci_get_drvdata(hdev);
1206 struct qca_data *qca = hu->priv;
1207 struct sk_buff *skb;
1208 u8 cmd[] = { 0x01, 0x48, 0xFC, 0x01, 0x00 };
1210 if (baudrate > QCA_BAUDRATE_3200000)
1215 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
1217 bt_dev_err(hdev, "Failed to allocate baudrate packet");
1221 /* Assign commands to change baudrate and packet type. */
1222 skb_put_data(skb, cmd, sizeof(cmd));
1223 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1225 skb_queue_tail(&qca->txq, skb);
1226 hci_uart_tx_wakeup(hu);
1228 /* Wait for the baudrate change request to be sent */
1230 while (!skb_queue_empty(&qca->txq))
1231 usleep_range(100, 200);
1234 serdev_device_wait_until_sent(hu->serdev,
1235 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1237 /* Give the controller time to process the request */
1238 if (qca_is_wcn399x(qca_soc_type(hu)))
1246 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
1249 serdev_device_set_baudrate(hu->serdev, speed);
1251 hci_uart_set_baudrate(hu, speed);
1254 static int qca_send_power_pulse(struct hci_uart *hu, bool on)
1257 int timeout = msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS);
1258 u8 cmd = on ? QCA_WCN3990_POWERON_PULSE : QCA_WCN3990_POWEROFF_PULSE;
1260 /* These power pulses are single byte command which are sent
1261 * at required baudrate to wcn3990. On wcn3990, we have an external
1262 * circuit at Tx pin which decodes the pulse sent at specific baudrate.
1263 * For example, wcn3990 supports RF COEX antenna for both Wi-Fi/BT
1264 * and also we use the same power inputs to turn on and off for
1265 * Wi-Fi/BT. Powering up the power sources will not enable BT, until
1266 * we send a power on pulse at 115200 bps. This algorithm will help to
1267 * save power. Disabling hardware flow control is mandatory while
1268 * sending power pulses to SoC.
1270 bt_dev_dbg(hu->hdev, "sending power pulse %02x to controller", cmd);
1272 serdev_device_write_flush(hu->serdev);
1273 hci_uart_set_flow_control(hu, true);
1274 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1276 bt_dev_err(hu->hdev, "failed to send power pulse %02x", cmd);
1280 serdev_device_wait_until_sent(hu->serdev, timeout);
1281 hci_uart_set_flow_control(hu, false);
1283 /* Give to controller time to boot/shutdown */
1292 static unsigned int qca_get_speed(struct hci_uart *hu,
1293 enum qca_speed_type speed_type)
1295 unsigned int speed = 0;
1297 if (speed_type == QCA_INIT_SPEED) {
1299 speed = hu->init_speed;
1300 else if (hu->proto->init_speed)
1301 speed = hu->proto->init_speed;
1304 speed = hu->oper_speed;
1305 else if (hu->proto->oper_speed)
1306 speed = hu->proto->oper_speed;
1312 static int qca_check_speeds(struct hci_uart *hu)
1314 if (qca_is_wcn399x(qca_soc_type(hu))) {
1315 if (!qca_get_speed(hu, QCA_INIT_SPEED) &&
1316 !qca_get_speed(hu, QCA_OPER_SPEED))
1319 if (!qca_get_speed(hu, QCA_INIT_SPEED) ||
1320 !qca_get_speed(hu, QCA_OPER_SPEED))
1327 static int qca_set_speed(struct hci_uart *hu, enum qca_speed_type speed_type)
1329 unsigned int speed, qca_baudrate;
1330 struct qca_data *qca = hu->priv;
1333 if (speed_type == QCA_INIT_SPEED) {
1334 speed = qca_get_speed(hu, QCA_INIT_SPEED);
1336 host_set_baudrate(hu, speed);
1338 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1340 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1344 /* Disable flow control for wcn3990 to deassert RTS while
1345 * changing the baudrate of chip and host.
1347 if (qca_is_wcn399x(soc_type))
1348 hci_uart_set_flow_control(hu, true);
1350 if (soc_type == QCA_WCN3990) {
1351 reinit_completion(&qca->drop_ev_comp);
1352 set_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1355 qca_baudrate = qca_get_baudrate_value(speed);
1356 bt_dev_dbg(hu->hdev, "Set UART speed to %d", speed);
1357 ret = qca_set_baudrate(hu->hdev, qca_baudrate);
1361 host_set_baudrate(hu, speed);
1364 if (qca_is_wcn399x(soc_type))
1365 hci_uart_set_flow_control(hu, false);
1367 if (soc_type == QCA_WCN3990) {
1368 /* Wait for the controller to send the vendor event
1369 * for the baudrate change command.
1371 if (!wait_for_completion_timeout(&qca->drop_ev_comp,
1372 msecs_to_jiffies(100))) {
1373 bt_dev_err(hu->hdev,
1374 "Failed to change controller baudrate\n");
1378 clear_bit(QCA_DROP_VENDOR_EVENT, &qca->flags);
1385 static int qca_send_crashbuffer(struct hci_uart *hu)
1387 struct qca_data *qca = hu->priv;
1388 struct sk_buff *skb;
1390 skb = bt_skb_alloc(QCA_CRASHBYTE_PACKET_LEN, GFP_KERNEL);
1392 bt_dev_err(hu->hdev, "Failed to allocate memory for skb packet");
1396 /* We forcefully crash the controller, by sending 0xfb byte for
1397 * 1024 times. We also might have chance of losing data, To be
1398 * on safer side we send 1096 bytes to the SoC.
1400 memset(skb_put(skb, QCA_CRASHBYTE_PACKET_LEN), QCA_MEMDUMP_BYTE,
1401 QCA_CRASHBYTE_PACKET_LEN);
1402 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1403 bt_dev_info(hu->hdev, "crash the soc to collect controller dump");
1404 skb_queue_tail(&qca->txq, skb);
1405 hci_uart_tx_wakeup(hu);
1410 static void qca_wait_for_dump_collection(struct hci_dev *hdev)
1412 struct hci_uart *hu = hci_get_drvdata(hdev);
1413 struct qca_data *qca = hu->priv;
1414 struct qca_memdump_data *qca_memdump = qca->qca_memdump;
1415 char *memdump_buf = NULL;
1417 wait_on_bit_timeout(&qca->flags, QCA_MEMDUMP_COLLECTION,
1418 TASK_UNINTERRUPTIBLE, MEMDUMP_TIMEOUT_MS);
1420 clear_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1421 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1422 bt_dev_err(hu->hdev, "Clearing the buffers due to timeout");
1424 memdump_buf = qca_memdump->memdump_buf_tail;
1427 qca->memdump_state = QCA_MEMDUMP_TIMEOUT;
1428 del_timer(&qca->memdump_timer);
1429 cancel_work_sync(&qca->ctrl_memdump_evt);
1433 static void qca_hw_error(struct hci_dev *hdev, u8 code)
1435 struct hci_uart *hu = hci_get_drvdata(hdev);
1436 struct qca_data *qca = hu->priv;
1438 bt_dev_info(hdev, "mem_dump_status: %d", qca->memdump_state);
1440 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1441 /* If hardware error event received for other than QCA
1442 * soc memory dump event, then we need to crash the SOC
1443 * and wait here for 8 seconds to get the dump packets.
1444 * This will block main thread to be on hold until we
1447 set_bit(QCA_MEMDUMP_COLLECTION, &qca->flags);
1448 qca_send_crashbuffer(hu);
1449 qca_wait_for_dump_collection(hdev);
1450 } else if (qca->memdump_state == QCA_MEMDUMP_COLLECTING) {
1451 /* Let us wait here until memory dump collected or
1452 * memory dump timer expired.
1454 bt_dev_info(hdev, "waiting for dump to complete");
1455 qca_wait_for_dump_collection(hdev);
1459 static void qca_cmd_timeout(struct hci_dev *hdev)
1461 struct hci_uart *hu = hci_get_drvdata(hdev);
1462 struct qca_data *qca = hu->priv;
1464 if (qca->memdump_state == QCA_MEMDUMP_IDLE)
1465 qca_send_crashbuffer(hu);
1467 bt_dev_info(hdev, "Dump collection is in process");
1470 static int qca_wcn3990_init(struct hci_uart *hu)
1472 struct qca_serdev *qcadev;
1475 /* Check for vregs status, may be hci down has turned
1476 * off the voltage regulator.
1478 qcadev = serdev_device_get_drvdata(hu->serdev);
1479 if (!qcadev->bt_power->vregs_on) {
1480 serdev_device_close(hu->serdev);
1481 ret = qca_regulator_enable(qcadev);
1485 ret = serdev_device_open(hu->serdev);
1487 bt_dev_err(hu->hdev, "failed to open port");
1492 /* Forcefully enable wcn3990 to enter in to boot mode. */
1493 host_set_baudrate(hu, 2400);
1494 ret = qca_send_power_pulse(hu, false);
1498 qca_set_speed(hu, QCA_INIT_SPEED);
1499 ret = qca_send_power_pulse(hu, true);
1503 /* Now the device is in ready state to communicate with host.
1504 * To sync host with device we need to reopen port.
1505 * Without this, we will have RTS and CTS synchronization
1508 serdev_device_close(hu->serdev);
1509 ret = serdev_device_open(hu->serdev);
1511 bt_dev_err(hu->hdev, "failed to open port");
1515 hci_uart_set_flow_control(hu, false);
1520 static int qca_power_on(struct hci_dev *hdev)
1522 struct hci_uart *hu = hci_get_drvdata(hdev);
1523 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1524 struct qca_serdev *qcadev;
1527 /* Non-serdev device usually is powered by external power
1528 * and don't need additional action in driver for power on
1533 if (qca_is_wcn399x(soc_type)) {
1534 ret = qca_wcn3990_init(hu);
1536 qcadev = serdev_device_get_drvdata(hu->serdev);
1537 gpiod_set_value_cansleep(qcadev->bt_en, 1);
1538 /* Controller needs time to bootup. */
1545 static int qca_setup(struct hci_uart *hu)
1547 struct hci_dev *hdev = hu->hdev;
1548 struct qca_data *qca = hu->priv;
1549 unsigned int speed, qca_baudrate = QCA_BAUDRATE_115200;
1550 enum qca_btsoc_type soc_type = qca_soc_type(hu);
1551 const char *firmware_name = qca_get_firmware_name(hu);
1555 ret = qca_check_speeds(hu);
1559 /* Patch downloading has to be done without IBS mode */
1560 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1562 /* Enable controller to do both LE scan and BR/EDR inquiry
1565 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1567 bt_dev_info(hdev, "setting up %s",
1568 qca_is_wcn399x(soc_type) ? "wcn399x" : "ROME");
1570 ret = qca_power_on(hdev);
1574 if (qca_is_wcn399x(soc_type)) {
1575 /* Enable NON_PERSISTENT_SETUP QUIRK to ensure to execute
1576 * setup for every hci up.
1578 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
1579 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hdev->quirks);
1580 hu->hdev->shutdown = qca_power_off;
1582 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1586 qca_set_speed(hu, QCA_INIT_SPEED);
1589 /* Setup user speed if needed */
1590 speed = qca_get_speed(hu, QCA_OPER_SPEED);
1592 ret = qca_set_speed(hu, QCA_OPER_SPEED);
1596 qca_baudrate = qca_get_baudrate_value(speed);
1599 if (!qca_is_wcn399x(soc_type)) {
1600 /* Get QCA version information */
1601 ret = qca_read_soc_version(hdev, &soc_ver, soc_type);
1606 bt_dev_info(hdev, "QCA controller version 0x%08x", soc_ver);
1607 /* Setup patch / NVM configurations */
1608 ret = qca_uart_setup(hdev, qca_baudrate, soc_type, soc_ver,
1611 set_bit(QCA_IBS_ENABLED, &qca->flags);
1612 qca_debugfs_init(hdev);
1613 hu->hdev->hw_error = qca_hw_error;
1614 hu->hdev->cmd_timeout = qca_cmd_timeout;
1615 } else if (ret == -ENOENT) {
1616 /* No patch/nvm-config found, run with original fw/config */
1618 } else if (ret == -EAGAIN) {
1620 * Userspace firmware loader will return -EAGAIN in case no
1621 * patch/nvm-config is found, so run with original fw/config.
1627 if (qca_is_wcn399x(soc_type))
1628 hu->hdev->set_bdaddr = qca_set_bdaddr;
1630 hu->hdev->set_bdaddr = qca_set_bdaddr_rome;
1635 static const struct hci_uart_proto qca_proto = {
1639 .init_speed = 115200,
1640 .oper_speed = 3000000,
1646 .enqueue = qca_enqueue,
1647 .dequeue = qca_dequeue,
1650 static const struct qca_vreg_data qca_soc_data_wcn3990 = {
1651 .soc_type = QCA_WCN3990,
1652 .vregs = (struct qca_vreg []) {
1655 { "vddrf", 300000 },
1656 { "vddch0", 450000 },
1661 static const struct qca_vreg_data qca_soc_data_wcn3991 = {
1662 .soc_type = QCA_WCN3991,
1663 .vregs = (struct qca_vreg []) {
1666 { "vddrf", 300000 },
1667 { "vddch0", 450000 },
1672 static const struct qca_vreg_data qca_soc_data_wcn3998 = {
1673 .soc_type = QCA_WCN3998,
1674 .vregs = (struct qca_vreg []) {
1677 { "vddrf", 300000 },
1678 { "vddch0", 450000 },
1683 static void qca_power_shutdown(struct hci_uart *hu)
1685 struct qca_serdev *qcadev;
1686 struct qca_data *qca = hu->priv;
1687 unsigned long flags;
1689 qcadev = serdev_device_get_drvdata(hu->serdev);
1691 /* From this point we go into power off state. But serial port is
1692 * still open, stop queueing the IBS data and flush all the buffered
1695 spin_lock_irqsave(&qca->hci_ibs_lock, flags);
1696 clear_bit(QCA_IBS_ENABLED, &qca->flags);
1698 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
1700 host_set_baudrate(hu, 2400);
1701 qca_send_power_pulse(hu, false);
1702 qca_regulator_disable(qcadev);
1703 hu->hdev->hw_error = NULL;
1704 hu->hdev->cmd_timeout = NULL;
1707 static int qca_power_off(struct hci_dev *hdev)
1709 struct hci_uart *hu = hci_get_drvdata(hdev);
1710 struct qca_data *qca = hu->priv;
1712 /* Stop sending shutdown command if soc crashes. */
1713 if (qca->memdump_state == QCA_MEMDUMP_IDLE) {
1714 qca_send_pre_shutdown_cmd(hdev);
1715 usleep_range(8000, 10000);
1718 qca->memdump_state = QCA_MEMDUMP_IDLE;
1719 qca_power_shutdown(hu);
1723 static int qca_regulator_enable(struct qca_serdev *qcadev)
1725 struct qca_power *power = qcadev->bt_power;
1728 /* Already enabled */
1729 if (power->vregs_on)
1732 BT_DBG("enabling %d regulators)", power->num_vregs);
1734 ret = regulator_bulk_enable(power->num_vregs, power->vreg_bulk);
1738 power->vregs_on = true;
1743 static void qca_regulator_disable(struct qca_serdev *qcadev)
1745 struct qca_power *power;
1750 power = qcadev->bt_power;
1752 /* Already disabled? */
1753 if (!power->vregs_on)
1756 regulator_bulk_disable(power->num_vregs, power->vreg_bulk);
1757 power->vregs_on = false;
1760 static int qca_init_regulators(struct qca_power *qca,
1761 const struct qca_vreg *vregs, size_t num_vregs)
1763 struct regulator_bulk_data *bulk;
1767 bulk = devm_kcalloc(qca->dev, num_vregs, sizeof(*bulk), GFP_KERNEL);
1771 for (i = 0; i < num_vregs; i++)
1772 bulk[i].supply = vregs[i].name;
1774 ret = devm_regulator_bulk_get(qca->dev, num_vregs, bulk);
1778 for (i = 0; i < num_vregs; i++) {
1779 ret = regulator_set_load(bulk[i].consumer, vregs[i].load_uA);
1784 qca->vreg_bulk = bulk;
1785 qca->num_vregs = num_vregs;
1790 static int qca_serdev_probe(struct serdev_device *serdev)
1792 struct qca_serdev *qcadev;
1793 const struct qca_vreg_data *data;
1796 qcadev = devm_kzalloc(&serdev->dev, sizeof(*qcadev), GFP_KERNEL);
1800 qcadev->serdev_hu.serdev = serdev;
1801 data = device_get_match_data(&serdev->dev);
1802 serdev_device_set_drvdata(serdev, qcadev);
1803 device_property_read_string(&serdev->dev, "firmware-name",
1804 &qcadev->firmware_name);
1805 if (data && qca_is_wcn399x(data->soc_type)) {
1806 qcadev->btsoc_type = data->soc_type;
1807 qcadev->bt_power = devm_kzalloc(&serdev->dev,
1808 sizeof(struct qca_power),
1810 if (!qcadev->bt_power)
1813 qcadev->bt_power->dev = &serdev->dev;
1814 err = qca_init_regulators(qcadev->bt_power, data->vregs,
1817 BT_ERR("Failed to init regulators:%d", err);
1821 qcadev->bt_power->vregs_on = false;
1823 device_property_read_u32(&serdev->dev, "max-speed",
1824 &qcadev->oper_speed);
1825 if (!qcadev->oper_speed)
1826 BT_DBG("UART will pick default operating speed");
1828 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1830 BT_ERR("wcn3990 serdev registration failed");
1834 qcadev->btsoc_type = QCA_ROME;
1835 qcadev->bt_en = devm_gpiod_get(&serdev->dev, "enable",
1837 if (IS_ERR(qcadev->bt_en)) {
1838 dev_err(&serdev->dev, "failed to acquire enable gpio\n");
1839 return PTR_ERR(qcadev->bt_en);
1842 qcadev->susclk = devm_clk_get(&serdev->dev, NULL);
1843 if (IS_ERR(qcadev->susclk)) {
1844 dev_err(&serdev->dev, "failed to acquire clk\n");
1845 return PTR_ERR(qcadev->susclk);
1848 err = clk_set_rate(qcadev->susclk, SUSCLK_RATE_32KHZ);
1852 err = clk_prepare_enable(qcadev->susclk);
1856 err = hci_uart_register_device(&qcadev->serdev_hu, &qca_proto);
1858 clk_disable_unprepare(qcadev->susclk);
1865 static void qca_serdev_remove(struct serdev_device *serdev)
1867 struct qca_serdev *qcadev = serdev_device_get_drvdata(serdev);
1869 if (qca_is_wcn399x(qcadev->btsoc_type))
1870 qca_power_shutdown(&qcadev->serdev_hu);
1872 clk_disable_unprepare(qcadev->susclk);
1874 hci_uart_unregister_device(&qcadev->serdev_hu);
1877 static int __maybe_unused qca_suspend(struct device *dev)
1879 struct hci_dev *hdev = container_of(dev, struct hci_dev, dev);
1880 struct hci_uart *hu = hci_get_drvdata(hdev);
1881 struct qca_data *qca = hu->priv;
1882 unsigned long flags;
1886 set_bit(QCA_SUSPENDING, &qca->flags);
1888 /* Device is downloading patch or doesn't support in-band sleep. */
1889 if (!test_bit(QCA_IBS_ENABLED, &qca->flags))
1892 cancel_work_sync(&qca->ws_awake_device);
1893 cancel_work_sync(&qca->ws_awake_rx);
1895 spin_lock_irqsave_nested(&qca->hci_ibs_lock,
1896 flags, SINGLE_DEPTH_NESTING);
1898 switch (qca->tx_ibs_state) {
1899 case HCI_IBS_TX_WAKING:
1900 del_timer(&qca->wake_retrans_timer);
1902 case HCI_IBS_TX_AWAKE:
1903 del_timer(&qca->tx_idle_timer);
1905 serdev_device_write_flush(hu->serdev);
1906 cmd = HCI_IBS_SLEEP_IND;
1907 ret = serdev_device_write_buf(hu->serdev, &cmd, sizeof(cmd));
1910 BT_ERR("Failed to send SLEEP to device");
1914 qca->tx_ibs_state = HCI_IBS_TX_ASLEEP;
1915 qca->ibs_sent_slps++;
1917 qca_wq_serial_tx_clock_vote_off(&qca->ws_tx_vote_off);
1920 case HCI_IBS_TX_ASLEEP:
1924 BT_ERR("Spurious tx state %d", qca->tx_ibs_state);
1929 spin_unlock_irqrestore(&qca->hci_ibs_lock, flags);
1934 serdev_device_wait_until_sent(hu->serdev,
1935 msecs_to_jiffies(CMD_TRANS_TIMEOUT_MS));
1937 /* Wait for HCI_IBS_SLEEP_IND sent by device to indicate its Tx is going
1938 * to sleep, so that the packet does not wake the system later.
1941 ret = wait_event_interruptible_timeout(qca->suspend_wait_q,
1942 qca->rx_ibs_state == HCI_IBS_RX_ASLEEP,
1943 msecs_to_jiffies(IBS_BTSOC_TX_IDLE_TIMEOUT_MS));
1952 clear_bit(QCA_SUSPENDING, &qca->flags);
1957 static int __maybe_unused qca_resume(struct device *dev)
1959 struct hci_dev *hdev = container_of(dev, struct hci_dev, dev);
1960 struct hci_uart *hu = hci_get_drvdata(hdev);
1961 struct qca_data *qca = hu->priv;
1963 clear_bit(QCA_SUSPENDING, &qca->flags);
1968 static SIMPLE_DEV_PM_OPS(qca_pm_ops, qca_suspend, qca_resume);
1970 static const struct of_device_id qca_bluetooth_of_match[] = {
1971 { .compatible = "qcom,qca6174-bt" },
1972 { .compatible = "qcom,wcn3990-bt", .data = &qca_soc_data_wcn3990},
1973 { .compatible = "qcom,wcn3991-bt", .data = &qca_soc_data_wcn3991},
1974 { .compatible = "qcom,wcn3998-bt", .data = &qca_soc_data_wcn3998},
1977 MODULE_DEVICE_TABLE(of, qca_bluetooth_of_match);
1979 static struct serdev_device_driver qca_serdev_driver = {
1980 .probe = qca_serdev_probe,
1981 .remove = qca_serdev_remove,
1983 .name = "hci_uart_qca",
1984 .of_match_table = qca_bluetooth_of_match,
1989 int __init qca_init(void)
1991 serdev_device_driver_register(&qca_serdev_driver);
1993 return hci_uart_register_proto(&qca_proto);
1996 int __exit qca_deinit(void)
1998 serdev_device_driver_unregister(&qca_serdev_driver);
2000 return hci_uart_unregister_proto(&qca_proto);