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/tty.h>
24 #include <linux/interrupt.h>
25 #include <linux/dmi.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/serdev.h>
29 #include <net/bluetooth/bluetooth.h>
30 #include <net/bluetooth/hci_core.h>
35 #define BCM_NULL_PKT 0x00
36 #define BCM_NULL_SIZE 0
38 #define BCM_LM_DIAG_PKT 0x07
39 #define BCM_LM_DIAG_SIZE 63
41 #define BCM_TYPE49_PKT 0x31
42 #define BCM_TYPE49_SIZE 0
44 #define BCM_TYPE52_PKT 0x34
45 #define BCM_TYPE52_SIZE 0
47 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
49 #define BCM_NUM_SUPPLIES 2
52 * struct bcm_device_data - device specific data
53 * @no_early_set_baudrate: Disallow set baudrate before driver setup()
54 * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
56 struct bcm_device_data {
57 bool no_early_set_baudrate;
58 bool drive_rts_on_open;
62 * struct bcm_device - device driver resources
63 * @serdev_hu: HCI UART controller struct
64 * @list: bcm_device_list node
65 * @dev: physical UART slave
66 * @name: device name logged by bt_dev_*() functions
67 * @device_wakeup: BT_WAKE pin,
68 * assert = Bluetooth device must wake up or remain awake,
69 * deassert = Bluetooth device may sleep when sleep criteria are met
70 * @shutdown: BT_REG_ON pin,
71 * power up or power down Bluetooth device internal regulators
72 * @reset: BT_RST_N pin,
73 * active low resets the Bluetooth logic core
74 * @set_device_wakeup: callback to toggle BT_WAKE pin
75 * either by accessing @device_wakeup or by calling @btlp
76 * @set_shutdown: callback to toggle BT_REG_ON pin
77 * either by accessing @shutdown or by calling @btpu/@btpd
78 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
79 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
80 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
81 * @gpio_count: internal counter for GPIO resources associated with ACPI device
82 * @gpio_int_idx: index in _CRS for GpioInt() resource
83 * @txco_clk: external reference frequency clock used by Bluetooth device
84 * @lpo_clk: external LPO clock used by Bluetooth device
85 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
86 * @res_enabled: whether clocks and supplies are prepared and enabled
87 * @init_speed: default baudrate of Bluetooth device;
88 * the host UART is initially set to this baudrate so that
89 * it can configure the Bluetooth device for @oper_speed
90 * @oper_speed: preferred baudrate of Bluetooth device;
91 * set to 0 if @init_speed is already the preferred baudrate
92 * @irq: interrupt triggered by HOST_WAKE_BT pin
93 * @irq_active_low: whether @irq is active low
94 * @irq_acquired: flag to show if IRQ handler has been assigned
95 * @hu: pointer to HCI UART controller struct,
96 * used to disable flow control during runtime suspend and system sleep
97 * @is_suspended: whether flow control is currently disabled
98 * @no_early_set_baudrate: don't set_baudrate before setup()
99 * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
100 * @pcm_int_params: keep the initial PCM configuration
103 /* Must be the first member, hci_serdev.c expects this. */
104 struct hci_uart serdev_hu;
105 struct list_head list;
110 struct gpio_desc *device_wakeup;
111 struct gpio_desc *shutdown;
112 struct gpio_desc *reset;
113 int (*set_device_wakeup)(struct bcm_device *, bool);
114 int (*set_shutdown)(struct bcm_device *, bool);
116 acpi_handle btlp, btpu, btpd;
121 struct clk *txco_clk;
123 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
136 bool no_early_set_baudrate;
137 bool drive_rts_on_open;
138 u8 pcm_int_params[5];
141 /* generic bcm uart resources */
143 struct sk_buff *rx_skb;
144 struct sk_buff_head txq;
146 struct bcm_device *dev;
149 /* List of BCM BT UART devices */
150 static DEFINE_MUTEX(bcm_device_lock);
151 static LIST_HEAD(bcm_device_list);
153 static int irq_polarity = -1;
154 module_param(irq_polarity, int, 0444);
155 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
157 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
160 serdev_device_set_baudrate(hu->serdev, speed);
162 hci_uart_set_baudrate(hu, speed);
165 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
167 struct hci_dev *hdev = hu->hdev;
169 struct bcm_update_uart_baud_rate param;
171 if (speed > 3000000) {
172 struct bcm_write_uart_clock_setting clock;
174 clock.type = BCM_UART_CLOCK_48MHZ;
176 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
178 /* This Broadcom specific command changes the UART's controller
179 * clock for baud rate > 3000000.
181 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
183 int err = PTR_ERR(skb);
184 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
192 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
194 param.zero = cpu_to_le16(0);
195 param.baud_rate = cpu_to_le32(speed);
197 /* This Broadcom specific command changes the UART's controller baud
200 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
203 int err = PTR_ERR(skb);
204 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
214 /* bcm_device_exists should be protected by bcm_device_lock */
215 static bool bcm_device_exists(struct bcm_device *device)
220 /* Devices using serdev always exist */
221 if (device && device->hu && device->hu->serdev)
225 list_for_each(p, &bcm_device_list) {
226 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
235 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
239 if (powered && !dev->res_enabled) {
240 /* Intel Macs use bcm_apple_get_resources() and don't
241 * have regulator supplies configured.
243 if (dev->supplies[0].supply) {
244 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
250 /* LPO clock needs to be 32.768 kHz */
251 err = clk_set_rate(dev->lpo_clk, 32768);
253 dev_err(dev->dev, "Could not set LPO clock rate\n");
254 goto err_regulator_disable;
257 err = clk_prepare_enable(dev->lpo_clk);
259 goto err_regulator_disable;
261 err = clk_prepare_enable(dev->txco_clk);
263 goto err_lpo_clk_disable;
266 err = dev->set_shutdown(dev, powered);
268 goto err_txco_clk_disable;
270 err = dev->set_device_wakeup(dev, powered);
272 goto err_revert_shutdown;
274 if (!powered && dev->res_enabled) {
275 clk_disable_unprepare(dev->txco_clk);
276 clk_disable_unprepare(dev->lpo_clk);
278 /* Intel Macs use bcm_apple_get_resources() and don't
279 * have regulator supplies configured.
281 if (dev->supplies[0].supply)
282 regulator_bulk_disable(BCM_NUM_SUPPLIES,
286 /* wait for device to power on and come out of reset */
287 usleep_range(100000, 120000);
289 dev->res_enabled = powered;
294 dev->set_shutdown(dev, !powered);
295 err_txco_clk_disable:
296 if (powered && !dev->res_enabled)
297 clk_disable_unprepare(dev->txco_clk);
299 if (powered && !dev->res_enabled)
300 clk_disable_unprepare(dev->lpo_clk);
301 err_regulator_disable:
302 if (powered && !dev->res_enabled)
303 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
308 static irqreturn_t bcm_host_wake(int irq, void *data)
310 struct bcm_device *bdev = data;
312 bt_dev_dbg(bdev, "Host wake IRQ");
314 pm_runtime_get(bdev->dev);
315 pm_runtime_mark_last_busy(bdev->dev);
316 pm_runtime_put_autosuspend(bdev->dev);
321 static int bcm_request_irq(struct bcm_data *bcm)
323 struct bcm_device *bdev = bcm->dev;
326 mutex_lock(&bcm_device_lock);
327 if (!bcm_device_exists(bdev)) {
332 if (bdev->irq <= 0) {
337 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
338 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
346 bdev->irq_acquired = true;
348 device_init_wakeup(bdev->dev, true);
350 pm_runtime_set_autosuspend_delay(bdev->dev,
351 BCM_AUTOSUSPEND_DELAY);
352 pm_runtime_use_autosuspend(bdev->dev);
353 pm_runtime_set_active(bdev->dev);
354 pm_runtime_enable(bdev->dev);
357 mutex_unlock(&bcm_device_lock);
362 static const struct bcm_set_sleep_mode default_sleep_params = {
363 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
364 .idle_host = 2, /* idle threshold HOST, in 300ms */
365 .idle_dev = 2, /* idle threshold device, in 300ms */
366 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
367 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
368 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
369 .combine_modes = 1, /* Combine sleep and LPM flag */
370 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
371 /* Irrelevant USB flags */
373 .usb_resume_timeout = 0,
375 .pulsed_host_wake = 1,
378 static int bcm_setup_sleep(struct hci_uart *hu)
380 struct bcm_data *bcm = hu->priv;
382 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
384 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
386 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
387 &sleep_params, HCI_INIT_TIMEOUT);
389 int err = PTR_ERR(skb);
390 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
395 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
400 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
401 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
404 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
406 struct hci_uart *hu = hci_get_drvdata(hdev);
407 struct bcm_data *bcm = hu->priv;
410 if (!test_bit(HCI_RUNNING, &hdev->flags))
413 skb = bt_skb_alloc(3, GFP_KERNEL);
417 skb_put_u8(skb, BCM_LM_DIAG_PKT);
418 skb_put_u8(skb, 0xf0);
419 skb_put_u8(skb, enable);
421 skb_queue_tail(&bcm->txq, skb);
422 hci_uart_tx_wakeup(hu);
427 static int bcm_open(struct hci_uart *hu)
429 struct bcm_data *bcm;
433 bt_dev_dbg(hu->hdev, "hu %p", hu);
435 if (!hci_uart_has_flow_control(hu))
438 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
442 skb_queue_head_init(&bcm->txq);
446 mutex_lock(&bcm_device_lock);
449 bcm->dev = serdev_device_get_drvdata(hu->serdev);
456 list_for_each(p, &bcm_device_list) {
457 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
459 /* Retrieve saved bcm_device based on parent of the
460 * platform device (saved during device probe) and
461 * parent of tty device used by hci_uart
463 if (hu->tty->dev->parent == dev->dev->parent) {
474 if (bcm->dev->drive_rts_on_open)
475 hci_uart_set_flow_control(hu, true);
477 hu->init_speed = bcm->dev->init_speed;
479 /* If oper_speed is set, ldisc/serdev will set the baudrate
480 * before calling setup()
482 if (!bcm->dev->no_early_set_baudrate)
483 hu->oper_speed = bcm->dev->oper_speed;
485 err = bcm_gpio_set_power(bcm->dev, true);
487 if (bcm->dev->drive_rts_on_open)
488 hci_uart_set_flow_control(hu, false);
494 mutex_unlock(&bcm_device_lock);
502 mutex_unlock(&bcm_device_lock);
508 static int bcm_close(struct hci_uart *hu)
510 struct bcm_data *bcm = hu->priv;
511 struct bcm_device *bdev = NULL;
514 bt_dev_dbg(hu->hdev, "hu %p", hu);
516 /* Protect bcm->dev against removal of the device or driver */
517 mutex_lock(&bcm_device_lock);
520 bdev = serdev_device_get_drvdata(hu->serdev);
521 } else if (bcm_device_exists(bcm->dev)) {
529 if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
530 devm_free_irq(bdev->dev, bdev->irq, bdev);
531 device_init_wakeup(bdev->dev, false);
532 pm_runtime_disable(bdev->dev);
535 err = bcm_gpio_set_power(bdev, false);
537 bt_dev_err(hu->hdev, "Failed to power down");
539 pm_runtime_set_suspended(bdev->dev);
541 mutex_unlock(&bcm_device_lock);
543 skb_queue_purge(&bcm->txq);
544 kfree_skb(bcm->rx_skb);
551 static int bcm_flush(struct hci_uart *hu)
553 struct bcm_data *bcm = hu->priv;
555 bt_dev_dbg(hu->hdev, "hu %p", hu);
557 skb_queue_purge(&bcm->txq);
562 static int bcm_setup(struct hci_uart *hu)
564 struct bcm_data *bcm = hu->priv;
565 bool fw_load_done = false;
569 bt_dev_dbg(hu->hdev, "hu %p", hu);
571 hu->hdev->set_diag = bcm_set_diag;
572 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
574 err = btbcm_initialize(hu->hdev, &fw_load_done);
581 /* Init speed if any */
583 speed = hu->init_speed;
584 else if (hu->proto->init_speed)
585 speed = hu->proto->init_speed;
590 host_set_baudrate(hu, speed);
592 /* Operational speed if any */
594 speed = hu->oper_speed;
595 else if (bcm->dev && bcm->dev->oper_speed)
596 speed = bcm->dev->oper_speed;
597 else if (hu->proto->oper_speed)
598 speed = hu->proto->oper_speed;
603 err = bcm_set_baudrate(hu, speed);
605 host_set_baudrate(hu, speed);
608 /* PCM parameters if provided */
609 if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
610 struct bcm_set_pcm_int_params params;
612 btbcm_read_pcm_int_params(hu->hdev, ¶ms);
614 memcpy(¶ms, bcm->dev->pcm_int_params, 5);
615 btbcm_write_pcm_int_params(hu->hdev, ¶ms);
618 err = btbcm_finalize(hu->hdev, &fw_load_done);
622 /* Some devices ship with the controller default address.
623 * Allow the bootloader to set a valid address through the
626 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hu->hdev->quirks);
628 if (!bcm_request_irq(bcm))
629 err = bcm_setup_sleep(hu);
634 #define BCM_RECV_LM_DIAG \
635 .type = BCM_LM_DIAG_PKT, \
636 .hlen = BCM_LM_DIAG_SIZE, \
639 .maxlen = BCM_LM_DIAG_SIZE
641 #define BCM_RECV_NULL \
642 .type = BCM_NULL_PKT, \
643 .hlen = BCM_NULL_SIZE, \
646 .maxlen = BCM_NULL_SIZE
648 #define BCM_RECV_TYPE49 \
649 .type = BCM_TYPE49_PKT, \
650 .hlen = BCM_TYPE49_SIZE, \
653 .maxlen = BCM_TYPE49_SIZE
655 #define BCM_RECV_TYPE52 \
656 .type = BCM_TYPE52_PKT, \
657 .hlen = BCM_TYPE52_SIZE, \
660 .maxlen = BCM_TYPE52_SIZE
662 static const struct h4_recv_pkt bcm_recv_pkts[] = {
663 { H4_RECV_ACL, .recv = hci_recv_frame },
664 { H4_RECV_SCO, .recv = hci_recv_frame },
665 { H4_RECV_EVENT, .recv = hci_recv_frame },
666 { H4_RECV_ISO, .recv = hci_recv_frame },
667 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
668 { BCM_RECV_NULL, .recv = hci_recv_diag },
669 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
670 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
673 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
675 struct bcm_data *bcm = hu->priv;
677 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
680 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
681 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
682 if (IS_ERR(bcm->rx_skb)) {
683 int err = PTR_ERR(bcm->rx_skb);
684 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
687 } else if (!bcm->rx_skb) {
688 /* Delay auto-suspend when receiving completed packet */
689 mutex_lock(&bcm_device_lock);
690 if (bcm->dev && bcm_device_exists(bcm->dev)) {
691 pm_runtime_get(bcm->dev->dev);
692 pm_runtime_mark_last_busy(bcm->dev->dev);
693 pm_runtime_put_autosuspend(bcm->dev->dev);
695 mutex_unlock(&bcm_device_lock);
701 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
703 struct bcm_data *bcm = hu->priv;
705 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
707 /* Prepend skb with frame type */
708 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
709 skb_queue_tail(&bcm->txq, skb);
714 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
716 struct bcm_data *bcm = hu->priv;
717 struct sk_buff *skb = NULL;
718 struct bcm_device *bdev = NULL;
720 mutex_lock(&bcm_device_lock);
722 if (bcm_device_exists(bcm->dev)) {
724 pm_runtime_get_sync(bdev->dev);
725 /* Shall be resumed here */
728 skb = skb_dequeue(&bcm->txq);
731 pm_runtime_mark_last_busy(bdev->dev);
732 pm_runtime_put_autosuspend(bdev->dev);
735 mutex_unlock(&bcm_device_lock);
741 static int bcm_suspend_device(struct device *dev)
743 struct bcm_device *bdev = dev_get_drvdata(dev);
746 bt_dev_dbg(bdev, "");
748 if (!bdev->is_suspended && bdev->hu) {
749 hci_uart_set_flow_control(bdev->hu, true);
751 /* Once this returns, driver suspends BT via GPIO */
752 bdev->is_suspended = true;
755 /* Suspend the device */
756 err = bdev->set_device_wakeup(bdev, false);
758 if (bdev->is_suspended && bdev->hu) {
759 bdev->is_suspended = false;
760 hci_uart_set_flow_control(bdev->hu, false);
765 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
771 static int bcm_resume_device(struct device *dev)
773 struct bcm_device *bdev = dev_get_drvdata(dev);
776 bt_dev_dbg(bdev, "");
778 err = bdev->set_device_wakeup(bdev, true);
780 dev_err(dev, "Failed to power up\n");
784 bt_dev_dbg(bdev, "resume, delaying 15 ms");
787 /* When this executes, the device has woken up already */
788 if (bdev->is_suspended && bdev->hu) {
789 bdev->is_suspended = false;
791 hci_uart_set_flow_control(bdev->hu, false);
798 #ifdef CONFIG_PM_SLEEP
799 /* suspend callback */
800 static int bcm_suspend(struct device *dev)
802 struct bcm_device *bdev = dev_get_drvdata(dev);
805 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
808 * When used with a device instantiated as platform_device, bcm_suspend
809 * can be called at any time as long as the platform device is bound,
810 * so it should use bcm_device_lock to protect access to hci_uart
811 * and device_wake-up GPIO.
813 mutex_lock(&bcm_device_lock);
818 if (pm_runtime_active(dev))
819 bcm_suspend_device(dev);
821 if (device_may_wakeup(dev) && bdev->irq > 0) {
822 error = enable_irq_wake(bdev->irq);
824 bt_dev_dbg(bdev, "BCM irq: enabled");
828 mutex_unlock(&bcm_device_lock);
833 /* resume callback */
834 static int bcm_resume(struct device *dev)
836 struct bcm_device *bdev = dev_get_drvdata(dev);
839 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
842 * When used with a device instantiated as platform_device, bcm_resume
843 * can be called at any time as long as platform device is bound,
844 * so it should use bcm_device_lock to protect access to hci_uart
845 * and device_wake-up GPIO.
847 mutex_lock(&bcm_device_lock);
852 if (device_may_wakeup(dev) && bdev->irq > 0) {
853 disable_irq_wake(bdev->irq);
854 bt_dev_dbg(bdev, "BCM irq: disabled");
857 err = bcm_resume_device(dev);
860 mutex_unlock(&bcm_device_lock);
863 pm_runtime_disable(dev);
864 pm_runtime_set_active(dev);
865 pm_runtime_enable(dev);
872 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
873 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
875 .ident = "Meegopad T08",
877 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
878 "To be filled by OEM."),
879 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
880 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
887 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
888 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
889 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
891 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
892 { "device-wakeup-gpios", &first_gpio, 1 },
893 { "shutdown-gpios", &second_gpio, 1 },
894 { "host-wakeup-gpios", &third_gpio, 1 },
898 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
899 { "host-wakeup-gpios", &first_gpio, 1 },
900 { "device-wakeup-gpios", &second_gpio, 1 },
901 { "shutdown-gpios", &third_gpio, 1 },
905 static int bcm_resource(struct acpi_resource *ares, void *data)
907 struct bcm_device *dev = data;
908 struct acpi_resource_extended_irq *irq;
909 struct acpi_resource_gpio *gpio;
910 struct acpi_resource_uart_serialbus *sb;
912 switch (ares->type) {
913 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
914 irq = &ares->data.extended_irq;
915 if (irq->polarity != ACPI_ACTIVE_LOW)
916 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
917 dev->irq_active_low = true;
920 case ACPI_RESOURCE_TYPE_GPIO:
921 gpio = &ares->data.gpio;
922 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
923 dev->gpio_int_idx = dev->gpio_count;
924 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
929 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
930 sb = &ares->data.uart_serial_bus;
931 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
932 dev->init_speed = sb->default_baud_rate;
933 dev->oper_speed = 4000000;
944 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
946 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
952 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
954 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
961 static int bcm_apple_get_resources(struct bcm_device *dev)
963 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
964 const union acpi_object *obj;
967 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
968 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
969 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
972 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
973 obj->buffer.length == 8)
974 dev->init_speed = *(u64 *)obj->buffer.pointer;
976 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
977 dev->set_shutdown = bcm_apple_set_shutdown;
982 static inline int bcm_apple_get_resources(struct bcm_device *dev)
986 #endif /* CONFIG_ACPI */
988 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
990 gpiod_set_value_cansleep(dev->device_wakeup, awake);
994 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
996 gpiod_set_value_cansleep(dev->shutdown, powered);
999 * The reset line is asserted on powerdown and deasserted
1000 * on poweron so the inverse of powered is used. Notice
1001 * that the GPIO line BT_RST_N needs to be specified as
1002 * active low in the device tree or similar system
1005 gpiod_set_value_cansleep(dev->reset, !powered);
1009 /* Try a bunch of names for TXCO */
1010 static struct clk *bcm_get_txco(struct device *dev)
1014 /* New explicit name */
1015 clk = devm_clk_get(dev, "txco");
1016 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1019 /* Deprecated name */
1020 clk = devm_clk_get(dev, "extclk");
1021 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1024 /* Original code used no name at all */
1025 return devm_clk_get(dev, NULL);
1028 static int bcm_get_resources(struct bcm_device *dev)
1030 const struct dmi_system_id *dmi_id;
1033 dev->name = dev_name(dev->dev);
1035 if (x86_apple_machine && !bcm_apple_get_resources(dev))
1038 dev->txco_clk = bcm_get_txco(dev->dev);
1040 /* Handle deferred probing */
1041 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
1042 return PTR_ERR(dev->txco_clk);
1044 /* Ignore all other errors as before */
1045 if (IS_ERR(dev->txco_clk))
1046 dev->txco_clk = NULL;
1048 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
1049 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
1050 return PTR_ERR(dev->lpo_clk);
1052 if (IS_ERR(dev->lpo_clk))
1053 dev->lpo_clk = NULL;
1055 /* Check if we accidentally fetched the lpo clock twice */
1056 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1057 devm_clk_put(dev->dev, dev->txco_clk);
1058 dev->txco_clk = NULL;
1061 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1063 if (IS_ERR(dev->device_wakeup))
1064 return PTR_ERR(dev->device_wakeup);
1066 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1068 if (IS_ERR(dev->shutdown))
1069 return PTR_ERR(dev->shutdown);
1071 dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1073 if (IS_ERR(dev->reset))
1074 return PTR_ERR(dev->reset);
1076 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1077 dev->set_shutdown = bcm_gpio_set_shutdown;
1079 dev->supplies[0].supply = "vbat";
1080 dev->supplies[1].supply = "vddio";
1081 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1086 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1087 if (dev->irq <= 0) {
1088 struct gpio_desc *gpio;
1090 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1093 return PTR_ERR(gpio);
1095 dev->irq = gpiod_to_irq(gpio);
1098 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1100 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1105 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1110 static int bcm_acpi_probe(struct bcm_device *dev)
1112 LIST_HEAD(resources);
1113 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1114 struct resource_entry *entry;
1117 /* Retrieve UART ACPI info */
1118 dev->gpio_int_idx = -1;
1119 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1120 &resources, bcm_resource, dev);
1124 resource_list_for_each_entry(entry, &resources) {
1125 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1126 dev->irq = entry->res->start;
1130 acpi_dev_free_resource_list(&resources);
1132 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1133 * only 2 GPIO resources, we use the irq-last mapping for this, since
1134 * we already have an irq the 3th / last mapping will not be used.
1137 gpio_mapping = acpi_bcm_int_last_gpios;
1138 else if (dev->gpio_int_idx == 0)
1139 gpio_mapping = acpi_bcm_int_first_gpios;
1140 else if (dev->gpio_int_idx == 2)
1141 gpio_mapping = acpi_bcm_int_last_gpios;
1143 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1146 /* Warn if our expectations are not met. */
1147 if (dev->gpio_count != (dev->irq ? 2 : 3))
1148 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1151 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1155 if (irq_polarity != -1) {
1156 dev->irq_active_low = irq_polarity;
1157 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1158 dev->irq_active_low ? "low" : "high");
1164 static int bcm_acpi_probe(struct bcm_device *dev)
1168 #endif /* CONFIG_ACPI */
1170 static int bcm_of_probe(struct bcm_device *bdev)
1172 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1173 device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1174 bdev->pcm_int_params, 5);
1175 bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1176 bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1177 & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1181 static int bcm_probe(struct platform_device *pdev)
1183 struct bcm_device *dev;
1186 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1190 dev->dev = &pdev->dev;
1191 dev->irq = platform_get_irq(pdev, 0);
1193 /* Initialize routing field to an unused value */
1194 dev->pcm_int_params[0] = 0xff;
1196 if (has_acpi_companion(&pdev->dev)) {
1197 ret = bcm_acpi_probe(dev);
1202 ret = bcm_get_resources(dev);
1206 platform_set_drvdata(pdev, dev);
1208 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1210 /* Place this instance on the device list */
1211 mutex_lock(&bcm_device_lock);
1212 list_add_tail(&dev->list, &bcm_device_list);
1213 mutex_unlock(&bcm_device_lock);
1215 ret = bcm_gpio_set_power(dev, false);
1217 dev_err(&pdev->dev, "Failed to power down\n");
1222 static int bcm_remove(struct platform_device *pdev)
1224 struct bcm_device *dev = platform_get_drvdata(pdev);
1226 mutex_lock(&bcm_device_lock);
1227 list_del(&dev->list);
1228 mutex_unlock(&bcm_device_lock);
1230 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1235 static const struct hci_uart_proto bcm_proto = {
1239 .init_speed = 115200,
1244 .set_baudrate = bcm_set_baudrate,
1246 .enqueue = bcm_enqueue,
1247 .dequeue = bcm_dequeue,
1251 static const struct acpi_device_id bcm_acpi_match[] = {
1420 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1423 /* suspend and resume callbacks */
1424 static const struct dev_pm_ops bcm_pm_ops = {
1425 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1426 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1429 static struct platform_driver bcm_driver = {
1431 .remove = bcm_remove,
1434 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1439 static int bcm_serdev_probe(struct serdev_device *serdev)
1441 struct bcm_device *bcmdev;
1442 const struct bcm_device_data *data;
1445 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1449 bcmdev->dev = &serdev->dev;
1451 bcmdev->hu = &bcmdev->serdev_hu;
1453 bcmdev->serdev_hu.serdev = serdev;
1454 serdev_device_set_drvdata(serdev, bcmdev);
1456 /* Initialize routing field to an unused value */
1457 bcmdev->pcm_int_params[0] = 0xff;
1459 if (has_acpi_companion(&serdev->dev))
1460 err = bcm_acpi_probe(bcmdev);
1462 err = bcm_of_probe(bcmdev);
1466 err = bcm_get_resources(bcmdev);
1470 if (!bcmdev->shutdown) {
1471 dev_warn(&serdev->dev,
1472 "No reset resource, using default baud rate\n");
1473 bcmdev->oper_speed = bcmdev->init_speed;
1476 err = bcm_gpio_set_power(bcmdev, false);
1478 dev_err(&serdev->dev, "Failed to power down\n");
1480 data = device_get_match_data(bcmdev->dev);
1482 bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1483 bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1486 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1489 static void bcm_serdev_remove(struct serdev_device *serdev)
1491 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1493 hci_uart_unregister_device(&bcmdev->serdev_hu);
1497 static struct bcm_device_data bcm4354_device_data = {
1498 .no_early_set_baudrate = true,
1501 static struct bcm_device_data bcm43438_device_data = {
1502 .drive_rts_on_open = true,
1505 static const struct of_device_id bcm_bluetooth_of_match[] = {
1506 { .compatible = "brcm,bcm20702a1" },
1507 { .compatible = "brcm,bcm4329-bt" },
1508 { .compatible = "brcm,bcm4330-bt" },
1509 { .compatible = "brcm,bcm4334-bt" },
1510 { .compatible = "brcm,bcm4345c5" },
1511 { .compatible = "brcm,bcm4330-bt" },
1512 { .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1513 { .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1514 { .compatible = "brcm,bcm4335a0" },
1517 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1520 static struct serdev_device_driver bcm_serdev_driver = {
1521 .probe = bcm_serdev_probe,
1522 .remove = bcm_serdev_remove,
1524 .name = "hci_uart_bcm",
1525 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1526 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1531 int __init bcm_init(void)
1533 /* For now, we need to keep both platform device
1534 * driver (ACPI generated) and serdev driver (DT).
1536 platform_driver_register(&bcm_driver);
1537 serdev_device_driver_register(&bcm_serdev_driver);
1539 return hci_uart_register_proto(&bcm_proto);
1542 int __exit bcm_deinit(void)
1544 platform_driver_unregister(&bcm_driver);
1545 serdev_device_driver_unregister(&bcm_serdev_driver);
1547 return hci_uart_unregister_proto(&bcm_proto);