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/property.h>
17 #include <linux/platform_data/x86/apple.h>
18 #include <linux/platform_device.h>
19 #include <linux/regulator/consumer.h>
20 #include <linux/clk.h>
21 #include <linux/gpio/consumer.h>
22 #include <linux/tty.h>
23 #include <linux/interrupt.h>
24 #include <linux/dmi.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/serdev.h>
28 #include <net/bluetooth/bluetooth.h>
29 #include <net/bluetooth/hci_core.h>
34 #define BCM_NULL_PKT 0x00
35 #define BCM_NULL_SIZE 0
37 #define BCM_LM_DIAG_PKT 0x07
38 #define BCM_LM_DIAG_SIZE 63
40 #define BCM_TYPE49_PKT 0x31
41 #define BCM_TYPE49_SIZE 0
43 #define BCM_TYPE52_PKT 0x34
44 #define BCM_TYPE52_SIZE 0
46 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
48 #define BCM_NUM_SUPPLIES 2
51 * struct bcm_device - device driver resources
52 * @serdev_hu: HCI UART controller struct
53 * @list: bcm_device_list node
54 * @dev: physical UART slave
55 * @name: device name logged by bt_dev_*() functions
56 * @device_wakeup: BT_WAKE pin,
57 * assert = Bluetooth device must wake up or remain awake,
58 * deassert = Bluetooth device may sleep when sleep criteria are met
59 * @shutdown: BT_REG_ON pin,
60 * power up or power down Bluetooth device internal regulators
61 * @set_device_wakeup: callback to toggle BT_WAKE pin
62 * either by accessing @device_wakeup or by calling @btlp
63 * @set_shutdown: callback to toggle BT_REG_ON pin
64 * either by accessing @shutdown or by calling @btpu/@btpd
65 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
66 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
67 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
68 * @txco_clk: external reference frequency clock used by Bluetooth device
69 * @lpo_clk: external LPO clock used by Bluetooth device
70 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
71 * @res_enabled: whether clocks and supplies are prepared and enabled
72 * @init_speed: default baudrate of Bluetooth device;
73 * the host UART is initially set to this baudrate so that
74 * it can configure the Bluetooth device for @oper_speed
75 * @oper_speed: preferred baudrate of Bluetooth device;
76 * set to 0 if @init_speed is already the preferred baudrate
77 * @irq: interrupt triggered by HOST_WAKE_BT pin
78 * @irq_active_low: whether @irq is active low
79 * @hu: pointer to HCI UART controller struct,
80 * used to disable flow control during runtime suspend and system sleep
81 * @is_suspended: whether flow control is currently disabled
84 /* Must be the first member, hci_serdev.c expects this. */
85 struct hci_uart serdev_hu;
86 struct list_head list;
91 struct gpio_desc *device_wakeup;
92 struct gpio_desc *shutdown;
93 int (*set_device_wakeup)(struct bcm_device *, bool);
94 int (*set_shutdown)(struct bcm_device *, bool);
96 acpi_handle btlp, btpu, btpd;
101 struct clk *txco_clk;
103 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
118 /* generic bcm uart resources */
120 struct sk_buff *rx_skb;
121 struct sk_buff_head txq;
123 struct bcm_device *dev;
126 /* List of BCM BT UART devices */
127 static DEFINE_MUTEX(bcm_device_lock);
128 static LIST_HEAD(bcm_device_list);
130 static int irq_polarity = -1;
131 module_param(irq_polarity, int, 0444);
132 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
134 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
137 serdev_device_set_baudrate(hu->serdev, speed);
139 hci_uart_set_baudrate(hu, speed);
142 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
144 struct hci_dev *hdev = hu->hdev;
146 struct bcm_update_uart_baud_rate param;
148 if (speed > 3000000) {
149 struct bcm_write_uart_clock_setting clock;
151 clock.type = BCM_UART_CLOCK_48MHZ;
153 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
155 /* This Broadcom specific command changes the UART's controller
156 * clock for baud rate > 3000000.
158 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
160 int err = PTR_ERR(skb);
161 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
169 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
171 param.zero = cpu_to_le16(0);
172 param.baud_rate = cpu_to_le32(speed);
174 /* This Broadcom specific command changes the UART's controller baud
177 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
180 int err = PTR_ERR(skb);
181 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
191 /* bcm_device_exists should be protected by bcm_device_lock */
192 static bool bcm_device_exists(struct bcm_device *device)
197 /* Devices using serdev always exist */
198 if (device && device->hu && device->hu->serdev)
202 list_for_each(p, &bcm_device_list) {
203 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
212 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
216 if (powered && !dev->res_enabled) {
217 /* Intel Macs use bcm_apple_get_resources() and don't
218 * have regulator supplies configured.
220 if (dev->supplies[0].supply) {
221 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
227 /* LPO clock needs to be 32.768 kHz */
228 err = clk_set_rate(dev->lpo_clk, 32768);
230 dev_err(dev->dev, "Could not set LPO clock rate\n");
231 goto err_regulator_disable;
234 err = clk_prepare_enable(dev->lpo_clk);
236 goto err_regulator_disable;
238 err = clk_prepare_enable(dev->txco_clk);
240 goto err_lpo_clk_disable;
243 err = dev->set_shutdown(dev, powered);
245 goto err_txco_clk_disable;
247 err = dev->set_device_wakeup(dev, powered);
249 goto err_revert_shutdown;
251 if (!powered && dev->res_enabled) {
252 clk_disable_unprepare(dev->txco_clk);
253 clk_disable_unprepare(dev->lpo_clk);
255 /* Intel Macs use bcm_apple_get_resources() and don't
256 * have regulator supplies configured.
258 if (dev->supplies[0].supply)
259 regulator_bulk_disable(BCM_NUM_SUPPLIES,
263 /* wait for device to power on and come out of reset */
264 usleep_range(100000, 120000);
266 dev->res_enabled = powered;
271 dev->set_shutdown(dev, !powered);
272 err_txco_clk_disable:
273 if (powered && !dev->res_enabled)
274 clk_disable_unprepare(dev->txco_clk);
276 if (powered && !dev->res_enabled)
277 clk_disable_unprepare(dev->lpo_clk);
278 err_regulator_disable:
279 if (powered && !dev->res_enabled)
280 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
285 static irqreturn_t bcm_host_wake(int irq, void *data)
287 struct bcm_device *bdev = data;
289 bt_dev_dbg(bdev, "Host wake IRQ");
291 pm_runtime_get(bdev->dev);
292 pm_runtime_mark_last_busy(bdev->dev);
293 pm_runtime_put_autosuspend(bdev->dev);
298 static int bcm_request_irq(struct bcm_data *bcm)
300 struct bcm_device *bdev = bcm->dev;
303 mutex_lock(&bcm_device_lock);
304 if (!bcm_device_exists(bdev)) {
309 if (bdev->irq <= 0) {
314 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
315 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
323 bdev->irq_acquired = true;
325 device_init_wakeup(bdev->dev, true);
327 pm_runtime_set_autosuspend_delay(bdev->dev,
328 BCM_AUTOSUSPEND_DELAY);
329 pm_runtime_use_autosuspend(bdev->dev);
330 pm_runtime_set_active(bdev->dev);
331 pm_runtime_enable(bdev->dev);
334 mutex_unlock(&bcm_device_lock);
339 static const struct bcm_set_sleep_mode default_sleep_params = {
340 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
341 .idle_host = 2, /* idle threshold HOST, in 300ms */
342 .idle_dev = 2, /* idle threshold device, in 300ms */
343 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
344 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
345 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
346 .combine_modes = 1, /* Combine sleep and LPM flag */
347 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
348 /* Irrelevant USB flags */
350 .usb_resume_timeout = 0,
352 .pulsed_host_wake = 1,
355 static int bcm_setup_sleep(struct hci_uart *hu)
357 struct bcm_data *bcm = hu->priv;
359 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
361 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
363 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
364 &sleep_params, HCI_INIT_TIMEOUT);
366 int err = PTR_ERR(skb);
367 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
372 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
377 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
378 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
381 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
383 struct hci_uart *hu = hci_get_drvdata(hdev);
384 struct bcm_data *bcm = hu->priv;
387 if (!test_bit(HCI_RUNNING, &hdev->flags))
390 skb = bt_skb_alloc(3, GFP_KERNEL);
394 skb_put_u8(skb, BCM_LM_DIAG_PKT);
395 skb_put_u8(skb, 0xf0);
396 skb_put_u8(skb, enable);
398 skb_queue_tail(&bcm->txq, skb);
399 hci_uart_tx_wakeup(hu);
404 static int bcm_open(struct hci_uart *hu)
406 struct bcm_data *bcm;
410 bt_dev_dbg(hu->hdev, "hu %p", hu);
412 if (!hci_uart_has_flow_control(hu))
415 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
419 skb_queue_head_init(&bcm->txq);
423 mutex_lock(&bcm_device_lock);
426 bcm->dev = serdev_device_get_drvdata(hu->serdev);
433 list_for_each(p, &bcm_device_list) {
434 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
436 /* Retrieve saved bcm_device based on parent of the
437 * platform device (saved during device probe) and
438 * parent of tty device used by hci_uart
440 if (hu->tty->dev->parent == dev->dev->parent) {
451 hu->init_speed = bcm->dev->init_speed;
452 hu->oper_speed = bcm->dev->oper_speed;
453 err = bcm_gpio_set_power(bcm->dev, true);
458 mutex_unlock(&bcm_device_lock);
466 mutex_unlock(&bcm_device_lock);
472 static int bcm_close(struct hci_uart *hu)
474 struct bcm_data *bcm = hu->priv;
475 struct bcm_device *bdev = NULL;
478 bt_dev_dbg(hu->hdev, "hu %p", hu);
480 /* Protect bcm->dev against removal of the device or driver */
481 mutex_lock(&bcm_device_lock);
484 bdev = serdev_device_get_drvdata(hu->serdev);
485 } else if (bcm_device_exists(bcm->dev)) {
493 if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
494 devm_free_irq(bdev->dev, bdev->irq, bdev);
495 device_init_wakeup(bdev->dev, false);
496 pm_runtime_disable(bdev->dev);
499 err = bcm_gpio_set_power(bdev, false);
501 bt_dev_err(hu->hdev, "Failed to power down");
503 pm_runtime_set_suspended(bdev->dev);
505 mutex_unlock(&bcm_device_lock);
507 skb_queue_purge(&bcm->txq);
508 kfree_skb(bcm->rx_skb);
515 static int bcm_flush(struct hci_uart *hu)
517 struct bcm_data *bcm = hu->priv;
519 bt_dev_dbg(hu->hdev, "hu %p", hu);
521 skb_queue_purge(&bcm->txq);
526 static int bcm_setup(struct hci_uart *hu)
528 struct bcm_data *bcm = hu->priv;
530 const struct firmware *fw;
534 bt_dev_dbg(hu->hdev, "hu %p", hu);
536 hu->hdev->set_diag = bcm_set_diag;
537 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
539 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false);
543 err = reject_firmware(&fw, fw_name, &hu->hdev->dev);
545 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
549 err = btbcm_patchram(hu->hdev, fw);
551 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
555 /* Init speed if any */
557 speed = hu->init_speed;
558 else if (hu->proto->init_speed)
559 speed = hu->proto->init_speed;
564 host_set_baudrate(hu, speed);
566 /* Operational speed if any */
568 speed = hu->oper_speed;
569 else if (hu->proto->oper_speed)
570 speed = hu->proto->oper_speed;
575 err = bcm_set_baudrate(hu, speed);
577 host_set_baudrate(hu, speed);
581 release_firmware(fw);
583 err = btbcm_finalize(hu->hdev);
587 if (!bcm_request_irq(bcm))
588 err = bcm_setup_sleep(hu);
593 #define BCM_RECV_LM_DIAG \
594 .type = BCM_LM_DIAG_PKT, \
595 .hlen = BCM_LM_DIAG_SIZE, \
598 .maxlen = BCM_LM_DIAG_SIZE
600 #define BCM_RECV_NULL \
601 .type = BCM_NULL_PKT, \
602 .hlen = BCM_NULL_SIZE, \
605 .maxlen = BCM_NULL_SIZE
607 #define BCM_RECV_TYPE49 \
608 .type = BCM_TYPE49_PKT, \
609 .hlen = BCM_TYPE49_SIZE, \
612 .maxlen = BCM_TYPE49_SIZE
614 #define BCM_RECV_TYPE52 \
615 .type = BCM_TYPE52_PKT, \
616 .hlen = BCM_TYPE52_SIZE, \
619 .maxlen = BCM_TYPE52_SIZE
621 static const struct h4_recv_pkt bcm_recv_pkts[] = {
622 { H4_RECV_ACL, .recv = hci_recv_frame },
623 { H4_RECV_SCO, .recv = hci_recv_frame },
624 { H4_RECV_EVENT, .recv = hci_recv_frame },
625 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
626 { BCM_RECV_NULL, .recv = hci_recv_diag },
627 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
628 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
631 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
633 struct bcm_data *bcm = hu->priv;
635 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
638 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
639 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
640 if (IS_ERR(bcm->rx_skb)) {
641 int err = PTR_ERR(bcm->rx_skb);
642 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
645 } else if (!bcm->rx_skb) {
646 /* Delay auto-suspend when receiving completed packet */
647 mutex_lock(&bcm_device_lock);
648 if (bcm->dev && bcm_device_exists(bcm->dev)) {
649 pm_runtime_get(bcm->dev->dev);
650 pm_runtime_mark_last_busy(bcm->dev->dev);
651 pm_runtime_put_autosuspend(bcm->dev->dev);
653 mutex_unlock(&bcm_device_lock);
659 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
661 struct bcm_data *bcm = hu->priv;
663 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
665 /* Prepend skb with frame type */
666 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
667 skb_queue_tail(&bcm->txq, skb);
672 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
674 struct bcm_data *bcm = hu->priv;
675 struct sk_buff *skb = NULL;
676 struct bcm_device *bdev = NULL;
678 mutex_lock(&bcm_device_lock);
680 if (bcm_device_exists(bcm->dev)) {
682 pm_runtime_get_sync(bdev->dev);
683 /* Shall be resumed here */
686 skb = skb_dequeue(&bcm->txq);
689 pm_runtime_mark_last_busy(bdev->dev);
690 pm_runtime_put_autosuspend(bdev->dev);
693 mutex_unlock(&bcm_device_lock);
699 static int bcm_suspend_device(struct device *dev)
701 struct bcm_device *bdev = dev_get_drvdata(dev);
704 bt_dev_dbg(bdev, "");
706 if (!bdev->is_suspended && bdev->hu) {
707 hci_uart_set_flow_control(bdev->hu, true);
709 /* Once this returns, driver suspends BT via GPIO */
710 bdev->is_suspended = true;
713 /* Suspend the device */
714 err = bdev->set_device_wakeup(bdev, false);
716 if (bdev->is_suspended && bdev->hu) {
717 bdev->is_suspended = false;
718 hci_uart_set_flow_control(bdev->hu, false);
723 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
729 static int bcm_resume_device(struct device *dev)
731 struct bcm_device *bdev = dev_get_drvdata(dev);
734 bt_dev_dbg(bdev, "");
736 err = bdev->set_device_wakeup(bdev, true);
738 dev_err(dev, "Failed to power up\n");
742 bt_dev_dbg(bdev, "resume, delaying 15 ms");
745 /* When this executes, the device has woken up already */
746 if (bdev->is_suspended && bdev->hu) {
747 bdev->is_suspended = false;
749 hci_uart_set_flow_control(bdev->hu, false);
756 #ifdef CONFIG_PM_SLEEP
757 /* suspend callback */
758 static int bcm_suspend(struct device *dev)
760 struct bcm_device *bdev = dev_get_drvdata(dev);
763 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
766 * When used with a device instantiated as platform_device, bcm_suspend
767 * can be called at any time as long as the platform device is bound,
768 * so it should use bcm_device_lock to protect access to hci_uart
769 * and device_wake-up GPIO.
771 mutex_lock(&bcm_device_lock);
776 if (pm_runtime_active(dev))
777 bcm_suspend_device(dev);
779 if (device_may_wakeup(dev) && bdev->irq > 0) {
780 error = enable_irq_wake(bdev->irq);
782 bt_dev_dbg(bdev, "BCM irq: enabled");
786 mutex_unlock(&bcm_device_lock);
791 /* resume callback */
792 static int bcm_resume(struct device *dev)
794 struct bcm_device *bdev = dev_get_drvdata(dev);
797 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
800 * When used with a device instantiated as platform_device, bcm_resume
801 * can be called at any time as long as platform device is bound,
802 * so it should use bcm_device_lock to protect access to hci_uart
803 * and device_wake-up GPIO.
805 mutex_lock(&bcm_device_lock);
810 if (device_may_wakeup(dev) && bdev->irq > 0) {
811 disable_irq_wake(bdev->irq);
812 bt_dev_dbg(bdev, "BCM irq: disabled");
815 err = bcm_resume_device(dev);
818 mutex_unlock(&bcm_device_lock);
821 pm_runtime_disable(dev);
822 pm_runtime_set_active(dev);
823 pm_runtime_enable(dev);
830 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
831 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
833 .ident = "Meegopad T08",
835 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
836 "To be filled by OEM."),
837 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
838 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
845 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
846 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
847 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
849 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
850 { "device-wakeup-gpios", &first_gpio, 1 },
851 { "shutdown-gpios", &second_gpio, 1 },
852 { "host-wakeup-gpios", &third_gpio, 1 },
856 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
857 { "host-wakeup-gpios", &first_gpio, 1 },
858 { "device-wakeup-gpios", &second_gpio, 1 },
859 { "shutdown-gpios", &third_gpio, 1 },
863 static int bcm_resource(struct acpi_resource *ares, void *data)
865 struct bcm_device *dev = data;
866 struct acpi_resource_extended_irq *irq;
867 struct acpi_resource_gpio *gpio;
868 struct acpi_resource_uart_serialbus *sb;
870 switch (ares->type) {
871 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
872 irq = &ares->data.extended_irq;
873 if (irq->polarity != ACPI_ACTIVE_LOW)
874 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
875 dev->irq_active_low = true;
878 case ACPI_RESOURCE_TYPE_GPIO:
879 gpio = &ares->data.gpio;
880 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
881 dev->gpio_int_idx = dev->gpio_count;
882 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
887 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
888 sb = &ares->data.uart_serial_bus;
889 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
890 dev->init_speed = sb->default_baud_rate;
891 dev->oper_speed = 4000000;
902 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
904 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
910 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
912 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
919 static int bcm_apple_get_resources(struct bcm_device *dev)
921 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
922 const union acpi_object *obj;
925 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
926 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
927 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
930 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
931 obj->buffer.length == 8)
932 dev->init_speed = *(u64 *)obj->buffer.pointer;
934 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
935 dev->set_shutdown = bcm_apple_set_shutdown;
940 static inline int bcm_apple_get_resources(struct bcm_device *dev)
944 #endif /* CONFIG_ACPI */
946 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
948 gpiod_set_value_cansleep(dev->device_wakeup, awake);
952 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
954 gpiod_set_value_cansleep(dev->shutdown, powered);
958 /* Try a bunch of names for TXCO */
959 static struct clk *bcm_get_txco(struct device *dev)
963 /* New explicit name */
964 clk = devm_clk_get(dev, "txco");
965 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
968 /* Deprecated name */
969 clk = devm_clk_get(dev, "extclk");
970 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
973 /* Original code used no name at all */
974 return devm_clk_get(dev, NULL);
977 static int bcm_get_resources(struct bcm_device *dev)
979 const struct dmi_system_id *dmi_id;
982 dev->name = dev_name(dev->dev);
984 if (x86_apple_machine && !bcm_apple_get_resources(dev))
987 dev->txco_clk = bcm_get_txco(dev->dev);
989 /* Handle deferred probing */
990 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
991 return PTR_ERR(dev->txco_clk);
993 /* Ignore all other errors as before */
994 if (IS_ERR(dev->txco_clk))
995 dev->txco_clk = NULL;
997 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
998 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
999 return PTR_ERR(dev->lpo_clk);
1001 if (IS_ERR(dev->lpo_clk))
1002 dev->lpo_clk = NULL;
1004 /* Check if we accidentally fetched the lpo clock twice */
1005 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1006 devm_clk_put(dev->dev, dev->txco_clk);
1007 dev->txco_clk = NULL;
1010 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1012 if (IS_ERR(dev->device_wakeup))
1013 return PTR_ERR(dev->device_wakeup);
1015 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1017 if (IS_ERR(dev->shutdown))
1018 return PTR_ERR(dev->shutdown);
1020 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1021 dev->set_shutdown = bcm_gpio_set_shutdown;
1023 dev->supplies[0].supply = "vbat";
1024 dev->supplies[1].supply = "vddio";
1025 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1030 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1031 if (dev->irq <= 0) {
1032 struct gpio_desc *gpio;
1034 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1037 return PTR_ERR(gpio);
1039 dev->irq = gpiod_to_irq(gpio);
1042 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1044 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1049 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1054 static int bcm_acpi_probe(struct bcm_device *dev)
1056 LIST_HEAD(resources);
1057 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1058 struct resource_entry *entry;
1061 /* Retrieve UART ACPI info */
1062 dev->gpio_int_idx = -1;
1063 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1064 &resources, bcm_resource, dev);
1068 resource_list_for_each_entry(entry, &resources) {
1069 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1070 dev->irq = entry->res->start;
1074 acpi_dev_free_resource_list(&resources);
1076 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1077 * only 2 GPIO resources, we use the irq-last mapping for this, since
1078 * we already have an irq the 3th / last mapping will not be used.
1081 gpio_mapping = acpi_bcm_int_last_gpios;
1082 else if (dev->gpio_int_idx == 0)
1083 gpio_mapping = acpi_bcm_int_first_gpios;
1084 else if (dev->gpio_int_idx == 2)
1085 gpio_mapping = acpi_bcm_int_last_gpios;
1087 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1090 /* Warn if our expectations are not met. */
1091 if (dev->gpio_count != (dev->irq ? 2 : 3))
1092 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1095 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1099 if (irq_polarity != -1) {
1100 dev->irq_active_low = irq_polarity;
1101 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1102 dev->irq_active_low ? "low" : "high");
1108 static int bcm_acpi_probe(struct bcm_device *dev)
1112 #endif /* CONFIG_ACPI */
1114 static int bcm_of_probe(struct bcm_device *bdev)
1116 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1120 static int bcm_probe(struct platform_device *pdev)
1122 struct bcm_device *dev;
1125 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1129 dev->dev = &pdev->dev;
1131 ret = platform_get_irq(pdev, 0);
1137 if (has_acpi_companion(&pdev->dev)) {
1138 ret = bcm_acpi_probe(dev);
1143 ret = bcm_get_resources(dev);
1147 platform_set_drvdata(pdev, dev);
1149 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1151 /* Place this instance on the device list */
1152 mutex_lock(&bcm_device_lock);
1153 list_add_tail(&dev->list, &bcm_device_list);
1154 mutex_unlock(&bcm_device_lock);
1156 ret = bcm_gpio_set_power(dev, false);
1158 dev_err(&pdev->dev, "Failed to power down\n");
1163 static int bcm_remove(struct platform_device *pdev)
1165 struct bcm_device *dev = platform_get_drvdata(pdev);
1167 mutex_lock(&bcm_device_lock);
1168 list_del(&dev->list);
1169 mutex_unlock(&bcm_device_lock);
1171 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1176 static const struct hci_uart_proto bcm_proto = {
1180 .init_speed = 115200,
1185 .set_baudrate = bcm_set_baudrate,
1187 .enqueue = bcm_enqueue,
1188 .dequeue = bcm_dequeue,
1192 static const struct acpi_device_id bcm_acpi_match[] = {
1361 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1364 /* suspend and resume callbacks */
1365 static const struct dev_pm_ops bcm_pm_ops = {
1366 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1367 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1370 static struct platform_driver bcm_driver = {
1372 .remove = bcm_remove,
1375 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1380 static int bcm_serdev_probe(struct serdev_device *serdev)
1382 struct bcm_device *bcmdev;
1385 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1389 bcmdev->dev = &serdev->dev;
1391 bcmdev->hu = &bcmdev->serdev_hu;
1393 bcmdev->serdev_hu.serdev = serdev;
1394 serdev_device_set_drvdata(serdev, bcmdev);
1396 if (has_acpi_companion(&serdev->dev))
1397 err = bcm_acpi_probe(bcmdev);
1399 err = bcm_of_probe(bcmdev);
1403 err = bcm_get_resources(bcmdev);
1407 if (!bcmdev->shutdown) {
1408 dev_warn(&serdev->dev,
1409 "No reset resource, using default baud rate\n");
1410 bcmdev->oper_speed = bcmdev->init_speed;
1413 err = bcm_gpio_set_power(bcmdev, false);
1415 dev_err(&serdev->dev, "Failed to power down\n");
1417 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1420 static void bcm_serdev_remove(struct serdev_device *serdev)
1422 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1424 hci_uart_unregister_device(&bcmdev->serdev_hu);
1428 static const struct of_device_id bcm_bluetooth_of_match[] = {
1429 { .compatible = "brcm,bcm20702a1" },
1430 { .compatible = "brcm,bcm4345c5" },
1431 { .compatible = "brcm,bcm4330-bt" },
1432 { .compatible = "brcm,bcm43438-bt" },
1435 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1438 static struct serdev_device_driver bcm_serdev_driver = {
1439 .probe = bcm_serdev_probe,
1440 .remove = bcm_serdev_remove,
1442 .name = "hci_uart_bcm",
1443 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1444 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1449 int __init bcm_init(void)
1451 /* For now, we need to keep both platform device
1452 * driver (ACPI generated) and serdev driver (DT).
1454 platform_driver_register(&bcm_driver);
1455 serdev_device_driver_register(&bcm_serdev_driver);
1457 return hci_uart_register_proto(&bcm_proto);
1460 int __exit bcm_deinit(void)
1462 platform_driver_unregister(&bcm_driver);
1463 serdev_device_driver_unregister(&bcm_serdev_driver);
1465 return hci_uart_unregister_proto(&bcm_proto);