1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Bluetooth HCI UART driver for Broadcom devices
6 * Copyright (C) 2015 Intel Corporation
9 #include <linux/kernel.h>
10 #include <linux/errno.h>
11 #include <linux/skbuff.h>
12 #include <linux/firmware.h>
13 #include <linux/module.h>
14 #include <linux/acpi.h>
16 #include <linux/of_irq.h>
17 #include <linux/property.h>
18 #include <linux/platform_data/x86/apple.h>
19 #include <linux/platform_device.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/clk.h>
22 #include <linux/gpio/consumer.h>
23 #include <linux/gpio/machine.h>
24 #include <linux/tty.h>
25 #include <linux/interrupt.h>
26 #include <linux/dmi.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/serdev.h>
30 #include <net/bluetooth/bluetooth.h>
31 #include <net/bluetooth/hci_core.h>
36 #define BCM_NULL_PKT 0x00
37 #define BCM_NULL_SIZE 0
39 #define BCM_LM_DIAG_PKT 0x07
40 #define BCM_LM_DIAG_SIZE 63
42 #define BCM_TYPE49_PKT 0x31
43 #define BCM_TYPE49_SIZE 0
45 #define BCM_TYPE52_PKT 0x34
46 #define BCM_TYPE52_SIZE 0
48 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
50 #define BCM_NUM_SUPPLIES 2
53 * struct bcm_device_data - device specific data
54 * @no_early_set_baudrate: Disallow set baudrate before driver setup()
55 * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
56 * @no_uart_clock_set: UART clock set command for >3Mbps mode is unavailable
57 * @max_autobaud_speed: max baudrate supported by device in autobaud mode
59 struct bcm_device_data {
60 bool no_early_set_baudrate;
61 bool drive_rts_on_open;
62 bool no_uart_clock_set;
63 u32 max_autobaud_speed;
67 * struct bcm_device - device driver resources
68 * @serdev_hu: HCI UART controller struct
69 * @list: bcm_device_list node
70 * @dev: physical UART slave
71 * @name: device name logged by bt_dev_*() functions
72 * @device_wakeup: BT_WAKE pin,
73 * assert = Bluetooth device must wake up or remain awake,
74 * deassert = Bluetooth device may sleep when sleep criteria are met
75 * @shutdown: BT_REG_ON pin,
76 * power up or power down Bluetooth device internal regulators
77 * @reset: BT_RST_N pin,
78 * active low resets the Bluetooth logic core
79 * @set_device_wakeup: callback to toggle BT_WAKE pin
80 * either by accessing @device_wakeup or by calling @btlp
81 * @set_shutdown: callback to toggle BT_REG_ON pin
82 * either by accessing @shutdown or by calling @btpu/@btpd
83 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
84 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
85 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
86 * @gpio_count: internal counter for GPIO resources associated with ACPI device
87 * @gpio_int_idx: index in _CRS for GpioInt() resource
88 * @txco_clk: external reference frequency clock used by Bluetooth device
89 * @lpo_clk: external LPO clock used by Bluetooth device
90 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
91 * @res_enabled: whether clocks and supplies are prepared and enabled
92 * @init_speed: default baudrate of Bluetooth device;
93 * the host UART is initially set to this baudrate so that
94 * it can configure the Bluetooth device for @oper_speed
95 * @oper_speed: preferred baudrate of Bluetooth device;
96 * set to 0 if @init_speed is already the preferred baudrate
97 * @irq: interrupt triggered by HOST_WAKE_BT pin
98 * @irq_active_low: whether @irq is active low
99 * @irq_acquired: flag to show if IRQ handler has been assigned
100 * @hu: pointer to HCI UART controller struct,
101 * used to disable flow control during runtime suspend and system sleep
102 * @is_suspended: whether flow control is currently disabled
103 * @no_early_set_baudrate: don't set_baudrate before setup()
104 * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
105 * @no_uart_clock_set: UART clock set command for >3Mbps mode is unavailable
106 * @pcm_int_params: keep the initial PCM configuration
107 * @use_autobaud_mode: start Bluetooth device in autobaud mode
108 * @max_autobaud_speed: max baudrate supported by device in autobaud mode
111 /* Must be the first member, hci_serdev.c expects this. */
112 struct hci_uart serdev_hu;
113 struct list_head list;
118 struct gpio_desc *device_wakeup;
119 struct gpio_desc *shutdown;
120 struct gpio_desc *reset;
121 int (*set_device_wakeup)(struct bcm_device *, bool);
122 int (*set_shutdown)(struct bcm_device *, bool);
124 acpi_handle btlp, btpu, btpd;
129 struct clk *txco_clk;
131 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
144 bool no_early_set_baudrate;
145 bool drive_rts_on_open;
146 bool no_uart_clock_set;
147 bool use_autobaud_mode;
148 u8 pcm_int_params[5];
149 u32 max_autobaud_speed;
152 /* generic bcm uart resources */
154 struct sk_buff *rx_skb;
155 struct sk_buff_head txq;
157 struct bcm_device *dev;
160 /* List of BCM BT UART devices */
161 static DEFINE_MUTEX(bcm_device_lock);
162 static LIST_HEAD(bcm_device_list);
164 static int irq_polarity = -1;
165 module_param(irq_polarity, int, 0444);
166 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
168 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
171 serdev_device_set_baudrate(hu->serdev, speed);
173 hci_uart_set_baudrate(hu, speed);
176 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
178 struct hci_dev *hdev = hu->hdev;
179 struct bcm_data *bcm = hu->priv;
181 struct bcm_update_uart_baud_rate param;
183 if (speed > 3000000 && !bcm->dev->no_uart_clock_set) {
184 struct bcm_write_uart_clock_setting clock;
186 clock.type = BCM_UART_CLOCK_48MHZ;
188 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
190 /* This Broadcom specific command changes the UART's controller
191 * clock for baud rate > 3000000.
193 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
195 int err = PTR_ERR(skb);
196 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
204 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
206 param.zero = cpu_to_le16(0);
207 param.baud_rate = cpu_to_le32(speed);
209 /* This Broadcom specific command changes the UART's controller baud
212 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
215 int err = PTR_ERR(skb);
216 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
226 /* bcm_device_exists should be protected by bcm_device_lock */
227 static bool bcm_device_exists(struct bcm_device *device)
232 /* Devices using serdev always exist */
233 if (device && device->hu && device->hu->serdev)
237 list_for_each(p, &bcm_device_list) {
238 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
247 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
251 if (powered && !dev->res_enabled) {
252 /* Intel Macs use bcm_apple_get_resources() and don't
253 * have regulator supplies configured.
255 if (dev->supplies[0].supply) {
256 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
262 /* LPO clock needs to be 32.768 kHz */
263 err = clk_set_rate(dev->lpo_clk, 32768);
265 dev_err(dev->dev, "Could not set LPO clock rate\n");
266 goto err_regulator_disable;
269 err = clk_prepare_enable(dev->lpo_clk);
271 goto err_regulator_disable;
273 err = clk_prepare_enable(dev->txco_clk);
275 goto err_lpo_clk_disable;
278 err = dev->set_shutdown(dev, powered);
280 goto err_txco_clk_disable;
282 err = dev->set_device_wakeup(dev, powered);
284 goto err_revert_shutdown;
286 if (!powered && dev->res_enabled) {
287 clk_disable_unprepare(dev->txco_clk);
288 clk_disable_unprepare(dev->lpo_clk);
290 /* Intel Macs use bcm_apple_get_resources() and don't
291 * have regulator supplies configured.
293 if (dev->supplies[0].supply)
294 regulator_bulk_disable(BCM_NUM_SUPPLIES,
298 /* wait for device to power on and come out of reset */
299 usleep_range(100000, 120000);
301 dev->res_enabled = powered;
306 dev->set_shutdown(dev, !powered);
307 err_txco_clk_disable:
308 if (powered && !dev->res_enabled)
309 clk_disable_unprepare(dev->txco_clk);
311 if (powered && !dev->res_enabled)
312 clk_disable_unprepare(dev->lpo_clk);
313 err_regulator_disable:
314 if (powered && !dev->res_enabled)
315 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
320 static irqreturn_t bcm_host_wake(int irq, void *data)
322 struct bcm_device *bdev = data;
324 bt_dev_dbg(bdev, "Host wake IRQ");
326 pm_runtime_get(bdev->dev);
327 pm_runtime_mark_last_busy(bdev->dev);
328 pm_runtime_put_autosuspend(bdev->dev);
333 static int bcm_request_irq(struct bcm_data *bcm)
335 struct bcm_device *bdev = bcm->dev;
338 mutex_lock(&bcm_device_lock);
339 if (!bcm_device_exists(bdev)) {
344 if (bdev->irq <= 0) {
349 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
350 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
358 bdev->irq_acquired = true;
360 device_init_wakeup(bdev->dev, true);
362 pm_runtime_set_autosuspend_delay(bdev->dev,
363 BCM_AUTOSUSPEND_DELAY);
364 pm_runtime_use_autosuspend(bdev->dev);
365 pm_runtime_set_active(bdev->dev);
366 pm_runtime_enable(bdev->dev);
369 mutex_unlock(&bcm_device_lock);
374 static const struct bcm_set_sleep_mode default_sleep_params = {
375 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
376 .idle_host = 2, /* idle threshold HOST, in 300ms */
377 .idle_dev = 2, /* idle threshold device, in 300ms */
378 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
379 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
380 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
381 .combine_modes = 1, /* Combine sleep and LPM flag */
382 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
383 /* Irrelevant USB flags */
385 .usb_resume_timeout = 0,
387 .pulsed_host_wake = 1,
390 static int bcm_setup_sleep(struct hci_uart *hu)
392 struct bcm_data *bcm = hu->priv;
394 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
396 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
398 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
399 &sleep_params, HCI_INIT_TIMEOUT);
401 int err = PTR_ERR(skb);
402 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
407 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
412 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
413 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
416 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
418 struct hci_uart *hu = hci_get_drvdata(hdev);
419 struct bcm_data *bcm = hu->priv;
422 if (!test_bit(HCI_RUNNING, &hdev->flags))
425 skb = bt_skb_alloc(3, GFP_KERNEL);
429 skb_put_u8(skb, BCM_LM_DIAG_PKT);
430 skb_put_u8(skb, 0xf0);
431 skb_put_u8(skb, enable);
433 skb_queue_tail(&bcm->txq, skb);
434 hci_uart_tx_wakeup(hu);
439 static int bcm_open(struct hci_uart *hu)
441 struct bcm_data *bcm;
445 bt_dev_dbg(hu->hdev, "hu %p", hu);
447 if (!hci_uart_has_flow_control(hu))
450 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
454 skb_queue_head_init(&bcm->txq);
458 mutex_lock(&bcm_device_lock);
461 bcm->dev = serdev_device_get_drvdata(hu->serdev);
468 list_for_each(p, &bcm_device_list) {
469 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
471 /* Retrieve saved bcm_device based on parent of the
472 * platform device (saved during device probe) and
473 * parent of tty device used by hci_uart
475 if (hu->tty->dev->parent == dev->dev->parent) {
486 if (bcm->dev->use_autobaud_mode)
487 hci_uart_set_flow_control(hu, false); /* Assert BT_UART_CTS_N */
488 else if (bcm->dev->drive_rts_on_open)
489 hci_uart_set_flow_control(hu, true);
491 if (bcm->dev->use_autobaud_mode && bcm->dev->max_autobaud_speed)
492 hu->init_speed = min(bcm->dev->oper_speed, bcm->dev->max_autobaud_speed);
494 hu->init_speed = bcm->dev->init_speed;
496 /* If oper_speed is set, ldisc/serdev will set the baudrate
497 * before calling setup()
499 if (!bcm->dev->no_early_set_baudrate && !bcm->dev->use_autobaud_mode)
500 hu->oper_speed = bcm->dev->oper_speed;
502 err = bcm_gpio_set_power(bcm->dev, true);
504 if (bcm->dev->drive_rts_on_open)
505 hci_uart_set_flow_control(hu, false);
511 mutex_unlock(&bcm_device_lock);
519 mutex_unlock(&bcm_device_lock);
525 static int bcm_close(struct hci_uart *hu)
527 struct bcm_data *bcm = hu->priv;
528 struct bcm_device *bdev = NULL;
531 bt_dev_dbg(hu->hdev, "hu %p", hu);
533 /* Protect bcm->dev against removal of the device or driver */
534 mutex_lock(&bcm_device_lock);
537 bdev = serdev_device_get_drvdata(hu->serdev);
538 } else if (bcm_device_exists(bcm->dev)) {
546 if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
547 devm_free_irq(bdev->dev, bdev->irq, bdev);
548 device_init_wakeup(bdev->dev, false);
549 pm_runtime_disable(bdev->dev);
552 err = bcm_gpio_set_power(bdev, false);
554 bt_dev_err(hu->hdev, "Failed to power down");
556 pm_runtime_set_suspended(bdev->dev);
558 mutex_unlock(&bcm_device_lock);
560 skb_queue_purge(&bcm->txq);
561 kfree_skb(bcm->rx_skb);
568 static int bcm_flush(struct hci_uart *hu)
570 struct bcm_data *bcm = hu->priv;
572 bt_dev_dbg(hu->hdev, "hu %p", hu);
574 skb_queue_purge(&bcm->txq);
579 static int bcm_setup(struct hci_uart *hu)
581 struct bcm_data *bcm = hu->priv;
582 bool fw_load_done = false;
583 bool use_autobaud_mode = (bcm->dev ? bcm->dev->use_autobaud_mode : 0);
587 bt_dev_dbg(hu->hdev, "hu %p", hu);
589 hu->hdev->set_diag = bcm_set_diag;
590 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
592 err = btbcm_initialize(hu->hdev, &fw_load_done, use_autobaud_mode);
599 /* Init speed if any */
600 if (bcm->dev && bcm->dev->init_speed)
601 speed = bcm->dev->init_speed;
602 else if (hu->proto->init_speed)
603 speed = hu->proto->init_speed;
608 host_set_baudrate(hu, speed);
610 /* Operational speed if any */
612 speed = hu->oper_speed;
613 else if (bcm->dev && bcm->dev->oper_speed)
614 speed = bcm->dev->oper_speed;
615 else if (hu->proto->oper_speed)
616 speed = hu->proto->oper_speed;
621 err = bcm_set_baudrate(hu, speed);
623 host_set_baudrate(hu, speed);
626 /* PCM parameters if provided */
627 if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
628 struct bcm_set_pcm_int_params params;
630 btbcm_read_pcm_int_params(hu->hdev, ¶ms);
632 memcpy(¶ms, bcm->dev->pcm_int_params, 5);
633 btbcm_write_pcm_int_params(hu->hdev, ¶ms);
636 err = btbcm_finalize(hu->hdev, &fw_load_done, use_autobaud_mode);
640 /* Some devices ship with the controller default address.
641 * Allow the bootloader to set a valid address through the
644 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hu->hdev->quirks);
646 if (!bcm_request_irq(bcm))
647 err = bcm_setup_sleep(hu);
652 #define BCM_RECV_LM_DIAG \
653 .type = BCM_LM_DIAG_PKT, \
654 .hlen = BCM_LM_DIAG_SIZE, \
657 .maxlen = BCM_LM_DIAG_SIZE
659 #define BCM_RECV_NULL \
660 .type = BCM_NULL_PKT, \
661 .hlen = BCM_NULL_SIZE, \
664 .maxlen = BCM_NULL_SIZE
666 #define BCM_RECV_TYPE49 \
667 .type = BCM_TYPE49_PKT, \
668 .hlen = BCM_TYPE49_SIZE, \
671 .maxlen = BCM_TYPE49_SIZE
673 #define BCM_RECV_TYPE52 \
674 .type = BCM_TYPE52_PKT, \
675 .hlen = BCM_TYPE52_SIZE, \
678 .maxlen = BCM_TYPE52_SIZE
680 static const struct h4_recv_pkt bcm_recv_pkts[] = {
681 { H4_RECV_ACL, .recv = hci_recv_frame },
682 { H4_RECV_SCO, .recv = hci_recv_frame },
683 { H4_RECV_EVENT, .recv = hci_recv_frame },
684 { H4_RECV_ISO, .recv = hci_recv_frame },
685 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
686 { BCM_RECV_NULL, .recv = hci_recv_diag },
687 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
688 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
691 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
693 struct bcm_data *bcm = hu->priv;
695 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
698 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
699 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
700 if (IS_ERR(bcm->rx_skb)) {
701 int err = PTR_ERR(bcm->rx_skb);
702 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
705 } else if (!bcm->rx_skb) {
706 /* Delay auto-suspend when receiving completed packet */
707 mutex_lock(&bcm_device_lock);
708 if (bcm->dev && bcm_device_exists(bcm->dev)) {
709 pm_runtime_get(bcm->dev->dev);
710 pm_runtime_mark_last_busy(bcm->dev->dev);
711 pm_runtime_put_autosuspend(bcm->dev->dev);
713 mutex_unlock(&bcm_device_lock);
719 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
721 struct bcm_data *bcm = hu->priv;
723 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
725 /* Prepend skb with frame type */
726 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
727 skb_queue_tail(&bcm->txq, skb);
732 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
734 struct bcm_data *bcm = hu->priv;
735 struct sk_buff *skb = NULL;
736 struct bcm_device *bdev = NULL;
738 mutex_lock(&bcm_device_lock);
740 if (bcm_device_exists(bcm->dev)) {
742 pm_runtime_get_sync(bdev->dev);
743 /* Shall be resumed here */
746 skb = skb_dequeue(&bcm->txq);
749 pm_runtime_mark_last_busy(bdev->dev);
750 pm_runtime_put_autosuspend(bdev->dev);
753 mutex_unlock(&bcm_device_lock);
759 static int bcm_suspend_device(struct device *dev)
761 struct bcm_device *bdev = dev_get_drvdata(dev);
764 bt_dev_dbg(bdev, "");
766 if (!bdev->is_suspended && bdev->hu) {
767 hci_uart_set_flow_control(bdev->hu, true);
769 /* Once this returns, driver suspends BT via GPIO */
770 bdev->is_suspended = true;
773 /* Suspend the device */
774 err = bdev->set_device_wakeup(bdev, false);
776 if (bdev->is_suspended && bdev->hu) {
777 bdev->is_suspended = false;
778 hci_uart_set_flow_control(bdev->hu, false);
783 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
789 static int bcm_resume_device(struct device *dev)
791 struct bcm_device *bdev = dev_get_drvdata(dev);
794 bt_dev_dbg(bdev, "");
796 err = bdev->set_device_wakeup(bdev, true);
798 dev_err(dev, "Failed to power up\n");
802 bt_dev_dbg(bdev, "resume, delaying 15 ms");
805 /* When this executes, the device has woken up already */
806 if (bdev->is_suspended && bdev->hu) {
807 bdev->is_suspended = false;
809 hci_uart_set_flow_control(bdev->hu, false);
816 #ifdef CONFIG_PM_SLEEP
817 /* suspend callback */
818 static int bcm_suspend(struct device *dev)
820 struct bcm_device *bdev = dev_get_drvdata(dev);
823 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
826 * When used with a device instantiated as platform_device, bcm_suspend
827 * can be called at any time as long as the platform device is bound,
828 * so it should use bcm_device_lock to protect access to hci_uart
829 * and device_wake-up GPIO.
831 mutex_lock(&bcm_device_lock);
836 if (pm_runtime_active(dev))
837 bcm_suspend_device(dev);
839 if (device_may_wakeup(dev) && bdev->irq > 0) {
840 error = enable_irq_wake(bdev->irq);
842 bt_dev_dbg(bdev, "BCM irq: enabled");
846 mutex_unlock(&bcm_device_lock);
851 /* resume callback */
852 static int bcm_resume(struct device *dev)
854 struct bcm_device *bdev = dev_get_drvdata(dev);
857 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
860 * When used with a device instantiated as platform_device, bcm_resume
861 * can be called at any time as long as platform device is bound,
862 * so it should use bcm_device_lock to protect access to hci_uart
863 * and device_wake-up GPIO.
865 mutex_lock(&bcm_device_lock);
870 if (device_may_wakeup(dev) && bdev->irq > 0) {
871 disable_irq_wake(bdev->irq);
872 bt_dev_dbg(bdev, "BCM irq: disabled");
875 err = bcm_resume_device(dev);
878 mutex_unlock(&bcm_device_lock);
881 pm_runtime_disable(dev);
882 pm_runtime_set_active(dev);
883 pm_runtime_enable(dev);
890 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
891 static struct gpiod_lookup_table asus_tf103c_irq_gpios = {
892 .dev_id = "serial0-0",
894 GPIO_LOOKUP("INT33FC:02", 17, "host-wakeup-alt", GPIO_ACTIVE_HIGH),
899 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
901 .ident = "Asus TF103C",
903 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
904 DMI_MATCH(DMI_PRODUCT_NAME, "TF103C"),
906 .driver_data = &asus_tf103c_irq_gpios,
909 .ident = "Meegopad T08",
911 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
912 "To be filled by OEM."),
913 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
914 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
921 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
922 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
923 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
925 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
926 { "device-wakeup-gpios", &first_gpio, 1 },
927 { "shutdown-gpios", &second_gpio, 1 },
928 { "host-wakeup-gpios", &third_gpio, 1 },
932 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
933 { "host-wakeup-gpios", &first_gpio, 1 },
934 { "device-wakeup-gpios", &second_gpio, 1 },
935 { "shutdown-gpios", &third_gpio, 1 },
939 static int bcm_resource(struct acpi_resource *ares, void *data)
941 struct bcm_device *dev = data;
942 struct acpi_resource_extended_irq *irq;
943 struct acpi_resource_gpio *gpio;
944 struct acpi_resource_uart_serialbus *sb;
946 switch (ares->type) {
947 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
948 irq = &ares->data.extended_irq;
949 if (irq->polarity != ACPI_ACTIVE_LOW)
950 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
951 dev->irq_active_low = true;
954 case ACPI_RESOURCE_TYPE_GPIO:
955 gpio = &ares->data.gpio;
956 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
957 dev->gpio_int_idx = dev->gpio_count;
958 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
963 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
964 sb = &ares->data.uart_serial_bus;
965 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
966 dev->init_speed = sb->default_baud_rate;
967 dev->oper_speed = 4000000;
978 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
980 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
986 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
988 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
995 static int bcm_apple_get_resources(struct bcm_device *dev)
997 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
998 const union acpi_object *obj;
1001 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
1002 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
1003 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
1006 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
1007 obj->buffer.length == 8)
1008 dev->init_speed = *(u64 *)obj->buffer.pointer;
1010 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
1011 dev->set_shutdown = bcm_apple_set_shutdown;
1016 static inline int bcm_apple_get_resources(struct bcm_device *dev)
1020 #endif /* CONFIG_ACPI */
1022 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
1024 gpiod_set_value_cansleep(dev->device_wakeup, awake);
1028 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
1030 gpiod_set_value_cansleep(dev->shutdown, powered);
1033 * The reset line is asserted on powerdown and deasserted
1034 * on poweron so the inverse of powered is used. Notice
1035 * that the GPIO line BT_RST_N needs to be specified as
1036 * active low in the device tree or similar system
1039 gpiod_set_value_cansleep(dev->reset, !powered);
1043 /* Try a bunch of names for TXCO */
1044 static struct clk *bcm_get_txco(struct device *dev)
1048 /* New explicit name */
1049 clk = devm_clk_get(dev, "txco");
1050 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1053 /* Deprecated name */
1054 clk = devm_clk_get(dev, "extclk");
1055 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1058 /* Original code used no name at all */
1059 return devm_clk_get(dev, NULL);
1062 static int bcm_get_resources(struct bcm_device *dev)
1064 const struct dmi_system_id *broken_irq_dmi_id;
1065 const char *irq_con_id = "host-wakeup";
1068 dev->name = dev_name(dev->dev);
1070 if (x86_apple_machine && !bcm_apple_get_resources(dev))
1073 dev->txco_clk = bcm_get_txco(dev->dev);
1075 /* Handle deferred probing */
1076 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
1077 return PTR_ERR(dev->txco_clk);
1079 /* Ignore all other errors as before */
1080 if (IS_ERR(dev->txco_clk))
1081 dev->txco_clk = NULL;
1083 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
1084 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
1085 return PTR_ERR(dev->lpo_clk);
1087 if (IS_ERR(dev->lpo_clk))
1088 dev->lpo_clk = NULL;
1090 /* Check if we accidentally fetched the lpo clock twice */
1091 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1092 devm_clk_put(dev->dev, dev->txco_clk);
1093 dev->txco_clk = NULL;
1096 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1098 if (IS_ERR(dev->device_wakeup))
1099 return PTR_ERR(dev->device_wakeup);
1101 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1103 if (IS_ERR(dev->shutdown))
1104 return PTR_ERR(dev->shutdown);
1106 dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1108 if (IS_ERR(dev->reset))
1109 return PTR_ERR(dev->reset);
1111 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1112 dev->set_shutdown = bcm_gpio_set_shutdown;
1114 dev->supplies[0].supply = "vbat";
1115 dev->supplies[1].supply = "vddio";
1116 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1121 broken_irq_dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1122 if (broken_irq_dmi_id && broken_irq_dmi_id->driver_data) {
1123 gpiod_add_lookup_table(broken_irq_dmi_id->driver_data);
1124 irq_con_id = "host-wakeup-alt";
1125 dev->irq_active_low = false;
1129 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1130 if (dev->irq <= 0) {
1131 struct gpio_desc *gpio;
1133 gpio = devm_gpiod_get_optional(dev->dev, irq_con_id, GPIOD_IN);
1135 return PTR_ERR(gpio);
1137 dev->irq = gpiod_to_irq(gpio);
1140 if (broken_irq_dmi_id) {
1141 if (broken_irq_dmi_id->driver_data) {
1142 gpiod_remove_lookup_table(broken_irq_dmi_id->driver_data);
1144 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1145 broken_irq_dmi_id->ident);
1150 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1155 static int bcm_acpi_probe(struct bcm_device *dev)
1157 LIST_HEAD(resources);
1158 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1159 struct resource_entry *entry;
1162 /* Retrieve UART ACPI info */
1163 dev->gpio_int_idx = -1;
1164 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1165 &resources, bcm_resource, dev);
1169 resource_list_for_each_entry(entry, &resources) {
1170 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1171 dev->irq = entry->res->start;
1175 acpi_dev_free_resource_list(&resources);
1177 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1178 * only 2 GPIO resources, we use the irq-last mapping for this, since
1179 * we already have an irq the 3th / last mapping will not be used.
1182 gpio_mapping = acpi_bcm_int_last_gpios;
1183 else if (dev->gpio_int_idx == 0)
1184 gpio_mapping = acpi_bcm_int_first_gpios;
1185 else if (dev->gpio_int_idx == 2)
1186 gpio_mapping = acpi_bcm_int_last_gpios;
1188 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1191 /* Warn if our expectations are not met. */
1192 if (dev->gpio_count != (dev->irq ? 2 : 3))
1193 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1196 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1200 if (irq_polarity != -1) {
1201 dev->irq_active_low = irq_polarity;
1202 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1203 dev->irq_active_low ? "low" : "high");
1209 static int bcm_acpi_probe(struct bcm_device *dev)
1213 #endif /* CONFIG_ACPI */
1215 static int bcm_of_probe(struct bcm_device *bdev)
1217 bdev->use_autobaud_mode = device_property_read_bool(bdev->dev,
1218 "brcm,requires-autobaud-mode");
1219 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1220 device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1221 bdev->pcm_int_params, 5);
1222 bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1223 bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1224 & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1228 static int bcm_probe(struct platform_device *pdev)
1230 struct bcm_device *dev;
1233 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1237 dev->dev = &pdev->dev;
1239 ret = platform_get_irq(pdev, 0);
1245 /* Initialize routing field to an unused value */
1246 dev->pcm_int_params[0] = 0xff;
1248 if (has_acpi_companion(&pdev->dev)) {
1249 ret = bcm_acpi_probe(dev);
1254 ret = bcm_get_resources(dev);
1258 platform_set_drvdata(pdev, dev);
1260 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1262 /* Place this instance on the device list */
1263 mutex_lock(&bcm_device_lock);
1264 list_add_tail(&dev->list, &bcm_device_list);
1265 mutex_unlock(&bcm_device_lock);
1267 ret = bcm_gpio_set_power(dev, false);
1269 dev_err(&pdev->dev, "Failed to power down\n");
1274 static int bcm_remove(struct platform_device *pdev)
1276 struct bcm_device *dev = platform_get_drvdata(pdev);
1278 mutex_lock(&bcm_device_lock);
1279 list_del(&dev->list);
1280 mutex_unlock(&bcm_device_lock);
1282 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1287 static const struct hci_uart_proto bcm_proto = {
1291 .init_speed = 115200,
1296 .set_baudrate = bcm_set_baudrate,
1298 .enqueue = bcm_enqueue,
1299 .dequeue = bcm_dequeue,
1303 static const struct acpi_device_id bcm_acpi_match[] = {
1472 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1475 /* suspend and resume callbacks */
1476 static const struct dev_pm_ops bcm_pm_ops = {
1477 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1478 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1481 static struct platform_driver bcm_driver = {
1483 .remove = bcm_remove,
1486 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1491 static int bcm_serdev_probe(struct serdev_device *serdev)
1493 struct bcm_device *bcmdev;
1494 const struct bcm_device_data *data;
1497 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1501 bcmdev->dev = &serdev->dev;
1503 bcmdev->hu = &bcmdev->serdev_hu;
1505 bcmdev->serdev_hu.serdev = serdev;
1506 serdev_device_set_drvdata(serdev, bcmdev);
1508 /* Initialize routing field to an unused value */
1509 bcmdev->pcm_int_params[0] = 0xff;
1511 if (has_acpi_companion(&serdev->dev))
1512 err = bcm_acpi_probe(bcmdev);
1514 err = bcm_of_probe(bcmdev);
1518 err = bcm_get_resources(bcmdev);
1522 if (!bcmdev->shutdown) {
1523 dev_warn(&serdev->dev,
1524 "No reset resource, using default baud rate\n");
1525 bcmdev->oper_speed = bcmdev->init_speed;
1528 err = bcm_gpio_set_power(bcmdev, false);
1530 dev_err(&serdev->dev, "Failed to power down\n");
1532 data = device_get_match_data(bcmdev->dev);
1534 bcmdev->max_autobaud_speed = data->max_autobaud_speed;
1535 bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1536 bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1537 bcmdev->no_uart_clock_set = data->no_uart_clock_set;
1540 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1543 static void bcm_serdev_remove(struct serdev_device *serdev)
1545 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1547 hci_uart_unregister_device(&bcmdev->serdev_hu);
1551 static struct bcm_device_data bcm4354_device_data = {
1552 .no_early_set_baudrate = true,
1555 static struct bcm_device_data bcm43438_device_data = {
1556 .drive_rts_on_open = true,
1559 static struct bcm_device_data cyw4373a0_device_data = {
1560 .no_uart_clock_set = true,
1563 static struct bcm_device_data cyw55572_device_data = {
1564 .max_autobaud_speed = 921600,
1567 static const struct of_device_id bcm_bluetooth_of_match[] = {
1568 { .compatible = "brcm,bcm20702a1" },
1569 { .compatible = "brcm,bcm4329-bt" },
1570 { .compatible = "brcm,bcm4330-bt" },
1571 { .compatible = "brcm,bcm4334-bt" },
1572 { .compatible = "brcm,bcm4345c5" },
1573 { .compatible = "brcm,bcm43430a0-bt" },
1574 { .compatible = "brcm,bcm43430a1-bt" },
1575 { .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1576 { .compatible = "brcm,bcm4349-bt", .data = &bcm43438_device_data },
1577 { .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1578 { .compatible = "brcm,bcm4335a0" },
1579 { .compatible = "cypress,cyw4373a0-bt", .data = &cyw4373a0_device_data },
1580 { .compatible = "infineon,cyw55572-bt", .data = &cyw55572_device_data },
1583 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1586 static struct serdev_device_driver bcm_serdev_driver = {
1587 .probe = bcm_serdev_probe,
1588 .remove = bcm_serdev_remove,
1590 .name = "hci_uart_bcm",
1591 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1592 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1597 int __init bcm_init(void)
1599 /* For now, we need to keep both platform device
1600 * driver (ACPI generated) and serdev driver (DT).
1602 platform_driver_register(&bcm_driver);
1603 serdev_device_driver_register(&bcm_serdev_driver);
1605 return hci_uart_register_proto(&bcm_proto);
1608 int __exit bcm_deinit(void)
1610 platform_driver_unregister(&bcm_driver);
1611 serdev_device_driver_unregister(&bcm_serdev_driver);
1613 return hci_uart_unregister_proto(&bcm_proto);