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
58 * @max_speed: max baudrate supported
60 struct bcm_device_data {
61 bool no_early_set_baudrate;
62 bool drive_rts_on_open;
63 bool no_uart_clock_set;
64 u32 max_autobaud_speed;
69 * struct bcm_device - device driver resources
70 * @serdev_hu: HCI UART controller struct
71 * @list: bcm_device_list node
72 * @dev: physical UART slave
73 * @name: device name logged by bt_dev_*() functions
74 * @device_wakeup: BT_WAKE pin,
75 * assert = Bluetooth device must wake up or remain awake,
76 * deassert = Bluetooth device may sleep when sleep criteria are met
77 * @shutdown: BT_REG_ON pin,
78 * power up or power down Bluetooth device internal regulators
79 * @reset: BT_RST_N pin,
80 * active low resets the Bluetooth logic core
81 * @set_device_wakeup: callback to toggle BT_WAKE pin
82 * either by accessing @device_wakeup or by calling @btlp
83 * @set_shutdown: callback to toggle BT_REG_ON pin
84 * either by accessing @shutdown or by calling @btpu/@btpd
85 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
86 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
87 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
88 * @gpio_count: internal counter for GPIO resources associated with ACPI device
89 * @gpio_int_idx: index in _CRS for GpioInt() resource
90 * @txco_clk: external reference frequency clock used by Bluetooth device
91 * @lpo_clk: external LPO clock used by Bluetooth device
92 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
93 * @res_enabled: whether clocks and supplies are prepared and enabled
94 * @init_speed: default baudrate of Bluetooth device;
95 * the host UART is initially set to this baudrate so that
96 * it can configure the Bluetooth device for @oper_speed
97 * @oper_speed: preferred baudrate of Bluetooth device;
98 * set to 0 if @init_speed is already the preferred baudrate
99 * @irq: interrupt triggered by HOST_WAKE_BT pin
100 * @irq_active_low: whether @irq is active low
101 * @irq_acquired: flag to show if IRQ handler has been assigned
102 * @hu: pointer to HCI UART controller struct,
103 * used to disable flow control during runtime suspend and system sleep
104 * @is_suspended: whether flow control is currently disabled
105 * @no_early_set_baudrate: don't set_baudrate before setup()
106 * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
107 * @no_uart_clock_set: UART clock set command for >3Mbps mode is unavailable
108 * @pcm_int_params: keep the initial PCM configuration
109 * @use_autobaud_mode: start Bluetooth device in autobaud mode
110 * @max_autobaud_speed: max baudrate supported by device in autobaud mode
113 /* Must be the first member, hci_serdev.c expects this. */
114 struct hci_uart serdev_hu;
115 struct list_head list;
120 struct gpio_desc *device_wakeup;
121 struct gpio_desc *shutdown;
122 struct gpio_desc *reset;
123 int (*set_device_wakeup)(struct bcm_device *, bool);
124 int (*set_shutdown)(struct bcm_device *, bool);
126 acpi_handle btlp, btpu, btpd;
131 struct clk *txco_clk;
133 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
146 bool no_early_set_baudrate;
147 bool drive_rts_on_open;
148 bool no_uart_clock_set;
149 bool use_autobaud_mode;
150 u8 pcm_int_params[5];
151 u32 max_autobaud_speed;
154 /* generic bcm uart resources */
156 struct sk_buff *rx_skb;
157 struct sk_buff_head txq;
159 struct bcm_device *dev;
162 /* List of BCM BT UART devices */
163 static DEFINE_MUTEX(bcm_device_lock);
164 static LIST_HEAD(bcm_device_list);
166 static int irq_polarity = -1;
167 module_param(irq_polarity, int, 0444);
168 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
170 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
173 serdev_device_set_baudrate(hu->serdev, speed);
175 hci_uart_set_baudrate(hu, speed);
178 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
180 struct hci_dev *hdev = hu->hdev;
181 struct bcm_data *bcm = hu->priv;
183 struct bcm_update_uart_baud_rate param;
185 if (speed > 3000000 && !bcm->dev->no_uart_clock_set) {
186 struct bcm_write_uart_clock_setting clock;
188 clock.type = BCM_UART_CLOCK_48MHZ;
190 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
192 /* This Broadcom specific command changes the UART's controller
193 * clock for baud rate > 3000000.
195 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
197 int err = PTR_ERR(skb);
198 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
206 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
208 param.zero = cpu_to_le16(0);
209 param.baud_rate = cpu_to_le32(speed);
211 /* This Broadcom specific command changes the UART's controller baud
214 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
217 int err = PTR_ERR(skb);
218 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
228 /* bcm_device_exists should be protected by bcm_device_lock */
229 static bool bcm_device_exists(struct bcm_device *device)
234 /* Devices using serdev always exist */
235 if (device && device->hu && device->hu->serdev)
239 list_for_each(p, &bcm_device_list) {
240 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
249 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
253 if (powered && !dev->res_enabled) {
254 /* Intel Macs use bcm_apple_get_resources() and don't
255 * have regulator supplies configured.
257 if (dev->supplies[0].supply) {
258 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
264 /* LPO clock needs to be 32.768 kHz */
265 err = clk_set_rate(dev->lpo_clk, 32768);
267 dev_err(dev->dev, "Could not set LPO clock rate\n");
268 goto err_regulator_disable;
271 err = clk_prepare_enable(dev->lpo_clk);
273 goto err_regulator_disable;
275 err = clk_prepare_enable(dev->txco_clk);
277 goto err_lpo_clk_disable;
280 err = dev->set_shutdown(dev, powered);
282 goto err_txco_clk_disable;
284 err = dev->set_device_wakeup(dev, powered);
286 goto err_revert_shutdown;
288 if (!powered && dev->res_enabled) {
289 clk_disable_unprepare(dev->txco_clk);
290 clk_disable_unprepare(dev->lpo_clk);
292 /* Intel Macs use bcm_apple_get_resources() and don't
293 * have regulator supplies configured.
295 if (dev->supplies[0].supply)
296 regulator_bulk_disable(BCM_NUM_SUPPLIES,
300 /* wait for device to power on and come out of reset */
301 usleep_range(100000, 120000);
303 dev->res_enabled = powered;
308 dev->set_shutdown(dev, !powered);
309 err_txco_clk_disable:
310 if (powered && !dev->res_enabled)
311 clk_disable_unprepare(dev->txco_clk);
313 if (powered && !dev->res_enabled)
314 clk_disable_unprepare(dev->lpo_clk);
315 err_regulator_disable:
316 if (powered && !dev->res_enabled)
317 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
322 static irqreturn_t bcm_host_wake(int irq, void *data)
324 struct bcm_device *bdev = data;
326 bt_dev_dbg(bdev, "Host wake IRQ");
328 pm_runtime_get(bdev->dev);
329 pm_runtime_mark_last_busy(bdev->dev);
330 pm_runtime_put_autosuspend(bdev->dev);
335 static int bcm_request_irq(struct bcm_data *bcm)
337 struct bcm_device *bdev = bcm->dev;
340 mutex_lock(&bcm_device_lock);
341 if (!bcm_device_exists(bdev)) {
346 if (bdev->irq <= 0) {
351 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
352 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
360 bdev->irq_acquired = true;
362 device_init_wakeup(bdev->dev, true);
364 pm_runtime_set_autosuspend_delay(bdev->dev,
365 BCM_AUTOSUSPEND_DELAY);
366 pm_runtime_use_autosuspend(bdev->dev);
367 pm_runtime_set_active(bdev->dev);
368 pm_runtime_enable(bdev->dev);
371 mutex_unlock(&bcm_device_lock);
376 static const struct bcm_set_sleep_mode default_sleep_params = {
377 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
378 .idle_host = 2, /* idle threshold HOST, in 300ms */
379 .idle_dev = 2, /* idle threshold device, in 300ms */
380 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
381 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
382 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
383 .combine_modes = 1, /* Combine sleep and LPM flag */
384 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
385 /* Irrelevant USB flags */
387 .usb_resume_timeout = 0,
389 .pulsed_host_wake = 1,
392 static int bcm_setup_sleep(struct hci_uart *hu)
394 struct bcm_data *bcm = hu->priv;
396 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
398 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
400 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
401 &sleep_params, HCI_INIT_TIMEOUT);
403 int err = PTR_ERR(skb);
404 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
409 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
414 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
415 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
418 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
420 struct hci_uart *hu = hci_get_drvdata(hdev);
421 struct bcm_data *bcm = hu->priv;
424 if (!test_bit(HCI_RUNNING, &hdev->flags))
427 skb = bt_skb_alloc(3, GFP_KERNEL);
431 skb_put_u8(skb, BCM_LM_DIAG_PKT);
432 skb_put_u8(skb, 0xf0);
433 skb_put_u8(skb, enable);
435 skb_queue_tail(&bcm->txq, skb);
436 hci_uart_tx_wakeup(hu);
441 static int bcm_open(struct hci_uart *hu)
443 struct bcm_data *bcm;
447 bt_dev_dbg(hu->hdev, "hu %p", hu);
449 if (!hci_uart_has_flow_control(hu))
452 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
456 skb_queue_head_init(&bcm->txq);
460 mutex_lock(&bcm_device_lock);
463 bcm->dev = serdev_device_get_drvdata(hu->serdev);
470 list_for_each(p, &bcm_device_list) {
471 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
473 /* Retrieve saved bcm_device based on parent of the
474 * platform device (saved during device probe) and
475 * parent of tty device used by hci_uart
477 if (hu->tty->dev->parent == dev->dev->parent) {
488 if (bcm->dev->use_autobaud_mode)
489 hci_uart_set_flow_control(hu, false); /* Assert BT_UART_CTS_N */
490 else if (bcm->dev->drive_rts_on_open)
491 hci_uart_set_flow_control(hu, true);
493 if (bcm->dev->use_autobaud_mode && bcm->dev->max_autobaud_speed)
494 hu->init_speed = min(bcm->dev->oper_speed, bcm->dev->max_autobaud_speed);
496 hu->init_speed = bcm->dev->init_speed;
498 /* If oper_speed is set, ldisc/serdev will set the baudrate
499 * before calling setup()
501 if (!bcm->dev->no_early_set_baudrate && !bcm->dev->use_autobaud_mode)
502 hu->oper_speed = bcm->dev->oper_speed;
504 err = bcm_gpio_set_power(bcm->dev, true);
506 if (bcm->dev->drive_rts_on_open)
507 hci_uart_set_flow_control(hu, false);
513 mutex_unlock(&bcm_device_lock);
521 mutex_unlock(&bcm_device_lock);
527 static int bcm_close(struct hci_uart *hu)
529 struct bcm_data *bcm = hu->priv;
530 struct bcm_device *bdev = NULL;
533 bt_dev_dbg(hu->hdev, "hu %p", hu);
535 /* Protect bcm->dev against removal of the device or driver */
536 mutex_lock(&bcm_device_lock);
539 bdev = serdev_device_get_drvdata(hu->serdev);
540 } else if (bcm_device_exists(bcm->dev)) {
548 if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
549 devm_free_irq(bdev->dev, bdev->irq, bdev);
550 device_init_wakeup(bdev->dev, false);
551 pm_runtime_disable(bdev->dev);
554 err = bcm_gpio_set_power(bdev, false);
556 bt_dev_err(hu->hdev, "Failed to power down");
558 pm_runtime_set_suspended(bdev->dev);
560 mutex_unlock(&bcm_device_lock);
562 skb_queue_purge(&bcm->txq);
563 kfree_skb(bcm->rx_skb);
570 static int bcm_flush(struct hci_uart *hu)
572 struct bcm_data *bcm = hu->priv;
574 bt_dev_dbg(hu->hdev, "hu %p", hu);
576 skb_queue_purge(&bcm->txq);
581 static int bcm_setup(struct hci_uart *hu)
583 struct bcm_data *bcm = hu->priv;
584 bool fw_load_done = false;
585 bool use_autobaud_mode = (bcm->dev ? bcm->dev->use_autobaud_mode : 0);
589 bt_dev_dbg(hu->hdev, "hu %p", hu);
591 hu->hdev->set_diag = bcm_set_diag;
592 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
594 err = btbcm_initialize(hu->hdev, &fw_load_done, use_autobaud_mode);
601 /* Init speed if any */
602 if (bcm->dev && bcm->dev->init_speed)
603 speed = bcm->dev->init_speed;
604 else if (hu->proto->init_speed)
605 speed = hu->proto->init_speed;
610 host_set_baudrate(hu, speed);
612 /* Operational speed if any */
614 speed = hu->oper_speed;
615 else if (bcm->dev && bcm->dev->oper_speed)
616 speed = bcm->dev->oper_speed;
617 else if (hu->proto->oper_speed)
618 speed = hu->proto->oper_speed;
623 err = bcm_set_baudrate(hu, speed);
625 host_set_baudrate(hu, speed);
628 /* PCM parameters if provided */
629 if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
630 struct bcm_set_pcm_int_params params;
632 btbcm_read_pcm_int_params(hu->hdev, ¶ms);
634 memcpy(¶ms, bcm->dev->pcm_int_params, 5);
635 btbcm_write_pcm_int_params(hu->hdev, ¶ms);
638 err = btbcm_finalize(hu->hdev, &fw_load_done, use_autobaud_mode);
642 /* Some devices ship with the controller default address.
643 * Allow the bootloader to set a valid address through the
646 if (test_bit(HCI_QUIRK_INVALID_BDADDR, &hu->hdev->quirks))
647 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hu->hdev->quirks);
649 if (!bcm_request_irq(bcm))
650 err = bcm_setup_sleep(hu);
655 #define BCM_RECV_LM_DIAG \
656 .type = BCM_LM_DIAG_PKT, \
657 .hlen = BCM_LM_DIAG_SIZE, \
660 .maxlen = BCM_LM_DIAG_SIZE
662 #define BCM_RECV_NULL \
663 .type = BCM_NULL_PKT, \
664 .hlen = BCM_NULL_SIZE, \
667 .maxlen = BCM_NULL_SIZE
669 #define BCM_RECV_TYPE49 \
670 .type = BCM_TYPE49_PKT, \
671 .hlen = BCM_TYPE49_SIZE, \
674 .maxlen = BCM_TYPE49_SIZE
676 #define BCM_RECV_TYPE52 \
677 .type = BCM_TYPE52_PKT, \
678 .hlen = BCM_TYPE52_SIZE, \
681 .maxlen = BCM_TYPE52_SIZE
683 static const struct h4_recv_pkt bcm_recv_pkts[] = {
684 { H4_RECV_ACL, .recv = hci_recv_frame },
685 { H4_RECV_SCO, .recv = hci_recv_frame },
686 { H4_RECV_EVENT, .recv = hci_recv_frame },
687 { H4_RECV_ISO, .recv = hci_recv_frame },
688 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
689 { BCM_RECV_NULL, .recv = hci_recv_diag },
690 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
691 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
694 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
696 struct bcm_data *bcm = hu->priv;
698 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
701 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
702 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
703 if (IS_ERR(bcm->rx_skb)) {
704 int err = PTR_ERR(bcm->rx_skb);
705 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
708 } else if (!bcm->rx_skb) {
709 /* Delay auto-suspend when receiving completed packet */
710 mutex_lock(&bcm_device_lock);
711 if (bcm->dev && bcm_device_exists(bcm->dev)) {
712 pm_runtime_get(bcm->dev->dev);
713 pm_runtime_mark_last_busy(bcm->dev->dev);
714 pm_runtime_put_autosuspend(bcm->dev->dev);
716 mutex_unlock(&bcm_device_lock);
722 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
724 struct bcm_data *bcm = hu->priv;
726 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
728 /* Prepend skb with frame type */
729 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
730 skb_queue_tail(&bcm->txq, skb);
735 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
737 struct bcm_data *bcm = hu->priv;
738 struct sk_buff *skb = NULL;
739 struct bcm_device *bdev = NULL;
741 mutex_lock(&bcm_device_lock);
743 if (bcm_device_exists(bcm->dev)) {
745 pm_runtime_get_sync(bdev->dev);
746 /* Shall be resumed here */
749 skb = skb_dequeue(&bcm->txq);
752 pm_runtime_mark_last_busy(bdev->dev);
753 pm_runtime_put_autosuspend(bdev->dev);
756 mutex_unlock(&bcm_device_lock);
762 static int bcm_suspend_device(struct device *dev)
764 struct bcm_device *bdev = dev_get_drvdata(dev);
767 bt_dev_dbg(bdev, "");
769 if (!bdev->is_suspended && bdev->hu) {
770 hci_uart_set_flow_control(bdev->hu, true);
772 /* Once this returns, driver suspends BT via GPIO */
773 bdev->is_suspended = true;
776 /* Suspend the device */
777 err = bdev->set_device_wakeup(bdev, false);
779 if (bdev->is_suspended && bdev->hu) {
780 bdev->is_suspended = false;
781 hci_uart_set_flow_control(bdev->hu, false);
786 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
792 static int bcm_resume_device(struct device *dev)
794 struct bcm_device *bdev = dev_get_drvdata(dev);
797 bt_dev_dbg(bdev, "");
799 err = bdev->set_device_wakeup(bdev, true);
801 dev_err(dev, "Failed to power up\n");
805 bt_dev_dbg(bdev, "resume, delaying 15 ms");
808 /* When this executes, the device has woken up already */
809 if (bdev->is_suspended && bdev->hu) {
810 bdev->is_suspended = false;
812 hci_uart_set_flow_control(bdev->hu, false);
819 #ifdef CONFIG_PM_SLEEP
820 /* suspend callback */
821 static int bcm_suspend(struct device *dev)
823 struct bcm_device *bdev = dev_get_drvdata(dev);
826 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
829 * When used with a device instantiated as platform_device, bcm_suspend
830 * can be called at any time as long as the platform device is bound,
831 * so it should use bcm_device_lock to protect access to hci_uart
832 * and device_wake-up GPIO.
834 mutex_lock(&bcm_device_lock);
839 if (pm_runtime_active(dev))
840 bcm_suspend_device(dev);
842 if (device_may_wakeup(dev) && bdev->irq > 0) {
843 error = enable_irq_wake(bdev->irq);
845 bt_dev_dbg(bdev, "BCM irq: enabled");
849 mutex_unlock(&bcm_device_lock);
854 /* resume callback */
855 static int bcm_resume(struct device *dev)
857 struct bcm_device *bdev = dev_get_drvdata(dev);
860 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
863 * When used with a device instantiated as platform_device, bcm_resume
864 * can be called at any time as long as platform device is bound,
865 * so it should use bcm_device_lock to protect access to hci_uart
866 * and device_wake-up GPIO.
868 mutex_lock(&bcm_device_lock);
873 if (device_may_wakeup(dev) && bdev->irq > 0) {
874 disable_irq_wake(bdev->irq);
875 bt_dev_dbg(bdev, "BCM irq: disabled");
878 err = bcm_resume_device(dev);
881 mutex_unlock(&bcm_device_lock);
884 pm_runtime_disable(dev);
885 pm_runtime_set_active(dev);
886 pm_runtime_enable(dev);
893 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
894 static struct gpiod_lookup_table irq_on_int33fc02_pin17_gpios = {
895 .dev_id = "serial0-0",
897 GPIO_LOOKUP("INT33FC:02", 17, "host-wakeup-alt", GPIO_ACTIVE_HIGH),
902 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
904 .ident = "Acer Iconia One 7 B1-750",
906 DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
907 DMI_MATCH(DMI_PRODUCT_NAME, "VESPA2"),
909 .driver_data = &irq_on_int33fc02_pin17_gpios,
912 .ident = "Asus TF103C",
914 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
915 DMI_MATCH(DMI_PRODUCT_NAME, "TF103C"),
917 .driver_data = &irq_on_int33fc02_pin17_gpios,
920 .ident = "Lenovo Yoga Tablet 2 830F/L / 1050F/L",
922 DMI_MATCH(DMI_SYS_VENDOR, "Intel Corp."),
923 DMI_MATCH(DMI_PRODUCT_NAME, "VALLEYVIEW C0 PLATFORM"),
924 DMI_MATCH(DMI_BOARD_NAME, "BYT-T FFD8"),
925 /* Partial match on beginning of BIOS version */
926 DMI_MATCH(DMI_BIOS_VERSION, "BLADE_21"),
928 .driver_data = &irq_on_int33fc02_pin17_gpios,
931 .ident = "Meegopad T08",
933 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
934 "To be filled by OEM."),
935 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
936 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
943 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
944 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
945 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
947 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
948 { "device-wakeup-gpios", &first_gpio, 1 },
949 { "shutdown-gpios", &second_gpio, 1 },
950 { "host-wakeup-gpios", &third_gpio, 1 },
954 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
955 { "host-wakeup-gpios", &first_gpio, 1 },
956 { "device-wakeup-gpios", &second_gpio, 1 },
957 { "shutdown-gpios", &third_gpio, 1 },
961 static int bcm_resource(struct acpi_resource *ares, void *data)
963 struct bcm_device *dev = data;
964 struct acpi_resource_extended_irq *irq;
965 struct acpi_resource_gpio *gpio;
966 struct acpi_resource_uart_serialbus *sb;
968 switch (ares->type) {
969 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
970 irq = &ares->data.extended_irq;
971 if (irq->polarity != ACPI_ACTIVE_LOW)
972 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
973 dev->irq_active_low = true;
976 case ACPI_RESOURCE_TYPE_GPIO:
977 gpio = &ares->data.gpio;
978 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
979 dev->gpio_int_idx = dev->gpio_count;
980 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
985 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
986 sb = &ares->data.uart_serial_bus;
987 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
988 dev->init_speed = sb->default_baud_rate;
989 dev->oper_speed = 4000000;
1000 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
1002 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
1008 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
1010 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
1017 static int bcm_apple_get_resources(struct bcm_device *dev)
1019 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
1020 const union acpi_object *obj;
1023 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
1024 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
1025 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
1028 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
1029 obj->buffer.length == 8)
1030 dev->init_speed = *(u64 *)obj->buffer.pointer;
1032 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
1033 dev->set_shutdown = bcm_apple_set_shutdown;
1038 static inline int bcm_apple_get_resources(struct bcm_device *dev)
1042 #endif /* CONFIG_ACPI */
1044 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
1046 gpiod_set_value_cansleep(dev->device_wakeup, awake);
1050 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
1052 gpiod_set_value_cansleep(dev->shutdown, powered);
1055 * The reset line is asserted on powerdown and deasserted
1056 * on poweron so the inverse of powered is used. Notice
1057 * that the GPIO line BT_RST_N needs to be specified as
1058 * active low in the device tree or similar system
1061 gpiod_set_value_cansleep(dev->reset, !powered);
1065 /* Try a bunch of names for TXCO */
1066 static struct clk *bcm_get_txco(struct device *dev)
1070 /* New explicit name */
1071 clk = devm_clk_get(dev, "txco");
1072 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1075 /* Deprecated name */
1076 clk = devm_clk_get(dev, "extclk");
1077 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1080 /* Original code used no name at all */
1081 return devm_clk_get(dev, NULL);
1084 static int bcm_get_resources(struct bcm_device *dev)
1086 const struct dmi_system_id *broken_irq_dmi_id;
1087 const char *irq_con_id = "host-wakeup";
1090 dev->name = dev_name(dev->dev);
1092 if (x86_apple_machine && !bcm_apple_get_resources(dev))
1095 dev->txco_clk = bcm_get_txco(dev->dev);
1097 /* Handle deferred probing */
1098 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
1099 return PTR_ERR(dev->txco_clk);
1101 /* Ignore all other errors as before */
1102 if (IS_ERR(dev->txco_clk))
1103 dev->txco_clk = NULL;
1105 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
1106 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
1107 return PTR_ERR(dev->lpo_clk);
1109 if (IS_ERR(dev->lpo_clk))
1110 dev->lpo_clk = NULL;
1112 /* Check if we accidentally fetched the lpo clock twice */
1113 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1114 devm_clk_put(dev->dev, dev->txco_clk);
1115 dev->txco_clk = NULL;
1118 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1120 if (IS_ERR(dev->device_wakeup))
1121 return PTR_ERR(dev->device_wakeup);
1123 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1125 if (IS_ERR(dev->shutdown))
1126 return PTR_ERR(dev->shutdown);
1128 dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1130 if (IS_ERR(dev->reset))
1131 return PTR_ERR(dev->reset);
1133 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1134 dev->set_shutdown = bcm_gpio_set_shutdown;
1136 dev->supplies[0].supply = "vbat";
1137 dev->supplies[1].supply = "vddio";
1138 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1143 broken_irq_dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1144 if (broken_irq_dmi_id && broken_irq_dmi_id->driver_data) {
1145 gpiod_add_lookup_table(broken_irq_dmi_id->driver_data);
1146 irq_con_id = "host-wakeup-alt";
1147 dev->irq_active_low = false;
1151 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1152 if (dev->irq <= 0) {
1153 struct gpio_desc *gpio;
1155 gpio = devm_gpiod_get_optional(dev->dev, irq_con_id, GPIOD_IN);
1157 return PTR_ERR(gpio);
1159 dev->irq = gpiod_to_irq(gpio);
1162 if (broken_irq_dmi_id) {
1163 if (broken_irq_dmi_id->driver_data) {
1164 gpiod_remove_lookup_table(broken_irq_dmi_id->driver_data);
1166 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1167 broken_irq_dmi_id->ident);
1172 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1177 static int bcm_acpi_probe(struct bcm_device *dev)
1179 LIST_HEAD(resources);
1180 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1181 struct resource_entry *entry;
1184 /* Retrieve UART ACPI info */
1185 dev->gpio_int_idx = -1;
1186 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1187 &resources, bcm_resource, dev);
1191 resource_list_for_each_entry(entry, &resources) {
1192 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1193 dev->irq = entry->res->start;
1197 acpi_dev_free_resource_list(&resources);
1199 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1200 * only 2 GPIO resources, we use the irq-last mapping for this, since
1201 * we already have an irq the 3th / last mapping will not be used.
1204 gpio_mapping = acpi_bcm_int_last_gpios;
1205 else if (dev->gpio_int_idx == 0)
1206 gpio_mapping = acpi_bcm_int_first_gpios;
1207 else if (dev->gpio_int_idx == 2)
1208 gpio_mapping = acpi_bcm_int_last_gpios;
1210 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1213 /* Warn if our expectations are not met. */
1214 if (dev->gpio_count != (dev->irq ? 2 : 3))
1215 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1218 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1222 if (irq_polarity != -1) {
1223 dev->irq_active_low = irq_polarity;
1224 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1225 dev->irq_active_low ? "low" : "high");
1231 static int bcm_acpi_probe(struct bcm_device *dev)
1235 #endif /* CONFIG_ACPI */
1237 static int bcm_of_probe(struct bcm_device *bdev)
1239 bdev->use_autobaud_mode = device_property_read_bool(bdev->dev,
1240 "brcm,requires-autobaud-mode");
1241 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1242 device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1243 bdev->pcm_int_params, 5);
1244 bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1245 bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1246 & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1250 static int bcm_probe(struct platform_device *pdev)
1252 struct bcm_device *dev;
1255 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1259 dev->dev = &pdev->dev;
1261 ret = platform_get_irq(pdev, 0);
1267 /* Initialize routing field to an unused value */
1268 dev->pcm_int_params[0] = 0xff;
1270 if (has_acpi_companion(&pdev->dev)) {
1271 ret = bcm_acpi_probe(dev);
1276 ret = bcm_get_resources(dev);
1280 platform_set_drvdata(pdev, dev);
1282 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1284 /* Place this instance on the device list */
1285 mutex_lock(&bcm_device_lock);
1286 list_add_tail(&dev->list, &bcm_device_list);
1287 mutex_unlock(&bcm_device_lock);
1289 ret = bcm_gpio_set_power(dev, false);
1291 dev_err(&pdev->dev, "Failed to power down\n");
1296 static int bcm_remove(struct platform_device *pdev)
1298 struct bcm_device *dev = platform_get_drvdata(pdev);
1300 mutex_lock(&bcm_device_lock);
1301 list_del(&dev->list);
1302 mutex_unlock(&bcm_device_lock);
1304 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1309 static const struct hci_uart_proto bcm_proto = {
1313 .init_speed = 115200,
1318 .set_baudrate = bcm_set_baudrate,
1320 .enqueue = bcm_enqueue,
1321 .dequeue = bcm_dequeue,
1326 /* bcm43430a0/a1 BT does not support 48MHz UART clock, limit to 2000000 baud */
1327 static struct bcm_device_data bcm43430_device_data = {
1328 .max_speed = 2000000,
1331 static const struct acpi_device_id bcm_acpi_match[] = {
1445 { "BCM2E74", (long)&bcm43430_device_data },
1446 { "BCM2E75", (long)&bcm43430_device_data },
1452 { "BCM2E7B", (long)&bcm43430_device_data },
1457 { "BCM2E80", (long)&bcm43430_device_data },
1466 { "BCM2E89", (long)&bcm43430_device_data },
1475 { "BCM2E94", (long)&bcm43430_device_data },
1480 { "BCM2E99", (long)&bcm43430_device_data },
1482 { "BCM2E9B", (long)&bcm43430_device_data },
1485 { "BCM2E9F", (long)&bcm43430_device_data },
1488 { "BCM2EA2", (long)&bcm43430_device_data },
1489 { "BCM2EA3", (long)&bcm43430_device_data },
1496 { "BCM2EAA", (long)&bcm43430_device_data },
1497 { "BCM2EAB", (long)&bcm43430_device_data },
1498 { "BCM2EAC", (long)&bcm43430_device_data },
1501 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1504 /* suspend and resume callbacks */
1505 static const struct dev_pm_ops bcm_pm_ops = {
1506 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1507 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1510 static struct platform_driver bcm_driver = {
1512 .remove = bcm_remove,
1515 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1520 static int bcm_serdev_probe(struct serdev_device *serdev)
1522 struct bcm_device *bcmdev;
1523 const struct bcm_device_data *data;
1526 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1530 bcmdev->dev = &serdev->dev;
1532 bcmdev->hu = &bcmdev->serdev_hu;
1534 bcmdev->serdev_hu.serdev = serdev;
1535 serdev_device_set_drvdata(serdev, bcmdev);
1537 /* Initialize routing field to an unused value */
1538 bcmdev->pcm_int_params[0] = 0xff;
1540 if (has_acpi_companion(&serdev->dev))
1541 err = bcm_acpi_probe(bcmdev);
1543 err = bcm_of_probe(bcmdev);
1547 err = bcm_get_resources(bcmdev);
1551 if (!bcmdev->shutdown) {
1552 dev_warn(&serdev->dev,
1553 "No reset resource, using default baud rate\n");
1554 bcmdev->oper_speed = bcmdev->init_speed;
1557 err = bcm_gpio_set_power(bcmdev, false);
1559 dev_err(&serdev->dev, "Failed to power down\n");
1561 data = device_get_match_data(bcmdev->dev);
1563 bcmdev->max_autobaud_speed = data->max_autobaud_speed;
1564 bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1565 bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1566 bcmdev->no_uart_clock_set = data->no_uart_clock_set;
1567 if (data->max_speed && bcmdev->oper_speed > data->max_speed)
1568 bcmdev->oper_speed = data->max_speed;
1571 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1574 static void bcm_serdev_remove(struct serdev_device *serdev)
1576 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1578 hci_uart_unregister_device(&bcmdev->serdev_hu);
1582 static struct bcm_device_data bcm4354_device_data = {
1583 .no_early_set_baudrate = true,
1586 static struct bcm_device_data bcm43438_device_data = {
1587 .drive_rts_on_open = true,
1590 static struct bcm_device_data cyw4373a0_device_data = {
1591 .no_uart_clock_set = true,
1594 static struct bcm_device_data cyw55572_device_data = {
1595 .max_autobaud_speed = 921600,
1598 static const struct of_device_id bcm_bluetooth_of_match[] = {
1599 { .compatible = "brcm,bcm20702a1" },
1600 { .compatible = "brcm,bcm4329-bt" },
1601 { .compatible = "brcm,bcm4330-bt" },
1602 { .compatible = "brcm,bcm4334-bt" },
1603 { .compatible = "brcm,bcm4345c5" },
1604 { .compatible = "brcm,bcm43430a0-bt" },
1605 { .compatible = "brcm,bcm43430a1-bt" },
1606 { .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1607 { .compatible = "brcm,bcm4349-bt", .data = &bcm43438_device_data },
1608 { .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1609 { .compatible = "brcm,bcm4335a0" },
1610 { .compatible = "cypress,cyw4373a0-bt", .data = &cyw4373a0_device_data },
1611 { .compatible = "infineon,cyw55572-bt", .data = &cyw55572_device_data },
1614 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1617 static struct serdev_device_driver bcm_serdev_driver = {
1618 .probe = bcm_serdev_probe,
1619 .remove = bcm_serdev_remove,
1621 .name = "hci_uart_bcm",
1622 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1623 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1628 int __init bcm_init(void)
1630 /* For now, we need to keep both platform device
1631 * driver (ACPI generated) and serdev driver (DT).
1633 platform_driver_register(&bcm_driver);
1634 serdev_device_driver_register(&bcm_serdev_driver);
1636 return hci_uart_register_proto(&bcm_proto);
1639 int __exit bcm_deinit(void)
1641 platform_driver_unregister(&bcm_driver);
1642 serdev_device_driver_unregister(&bcm_serdev_driver);
1644 return hci_uart_unregister_proto(&bcm_proto);