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_data - device specific data
52 * @no_early_set_baudrate: Disallow set baudrate before driver setup()
54 struct bcm_device_data {
55 bool no_early_set_baudrate;
56 bool drive_rts_on_open;
60 * struct bcm_device - device driver resources
61 * @serdev_hu: HCI UART controller struct
62 * @list: bcm_device_list node
63 * @dev: physical UART slave
64 * @name: device name logged by bt_dev_*() functions
65 * @device_wakeup: BT_WAKE pin,
66 * assert = Bluetooth device must wake up or remain awake,
67 * deassert = Bluetooth device may sleep when sleep criteria are met
68 * @shutdown: BT_REG_ON pin,
69 * power up or power down Bluetooth device internal regulators
70 * @set_device_wakeup: callback to toggle BT_WAKE pin
71 * either by accessing @device_wakeup or by calling @btlp
72 * @set_shutdown: callback to toggle BT_REG_ON pin
73 * either by accessing @shutdown or by calling @btpu/@btpd
74 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
75 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
76 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
77 * @txco_clk: external reference frequency clock used by Bluetooth device
78 * @lpo_clk: external LPO clock used by Bluetooth device
79 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
80 * @res_enabled: whether clocks and supplies are prepared and enabled
81 * @init_speed: default baudrate of Bluetooth device;
82 * the host UART is initially set to this baudrate so that
83 * it can configure the Bluetooth device for @oper_speed
84 * @oper_speed: preferred baudrate of Bluetooth device;
85 * set to 0 if @init_speed is already the preferred baudrate
86 * @irq: interrupt triggered by HOST_WAKE_BT pin
87 * @irq_active_low: whether @irq is active low
88 * @hu: pointer to HCI UART controller struct,
89 * used to disable flow control during runtime suspend and system sleep
90 * @is_suspended: whether flow control is currently disabled
91 * @no_early_set_baudrate: don't set_baudrate before setup()
94 /* Must be the first member, hci_serdev.c expects this. */
95 struct hci_uart serdev_hu;
96 struct list_head list;
101 struct gpio_desc *device_wakeup;
102 struct gpio_desc *shutdown;
103 int (*set_device_wakeup)(struct bcm_device *, bool);
104 int (*set_shutdown)(struct bcm_device *, bool);
106 acpi_handle btlp, btpu, btpd;
111 struct clk *txco_clk;
113 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
125 bool no_early_set_baudrate;
126 bool drive_rts_on_open;
127 u8 pcm_int_params[5];
130 /* generic bcm uart resources */
132 struct sk_buff *rx_skb;
133 struct sk_buff_head txq;
135 struct bcm_device *dev;
138 /* List of BCM BT UART devices */
139 static DEFINE_MUTEX(bcm_device_lock);
140 static LIST_HEAD(bcm_device_list);
142 static int irq_polarity = -1;
143 module_param(irq_polarity, int, 0444);
144 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
146 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
149 serdev_device_set_baudrate(hu->serdev, speed);
151 hci_uart_set_baudrate(hu, speed);
154 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
156 struct hci_dev *hdev = hu->hdev;
158 struct bcm_update_uart_baud_rate param;
160 if (speed > 3000000) {
161 struct bcm_write_uart_clock_setting clock;
163 clock.type = BCM_UART_CLOCK_48MHZ;
165 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
167 /* This Broadcom specific command changes the UART's controller
168 * clock for baud rate > 3000000.
170 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
172 int err = PTR_ERR(skb);
173 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
181 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
183 param.zero = cpu_to_le16(0);
184 param.baud_rate = cpu_to_le32(speed);
186 /* This Broadcom specific command changes the UART's controller baud
189 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
192 int err = PTR_ERR(skb);
193 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
203 /* bcm_device_exists should be protected by bcm_device_lock */
204 static bool bcm_device_exists(struct bcm_device *device)
209 /* Devices using serdev always exist */
210 if (device && device->hu && device->hu->serdev)
214 list_for_each(p, &bcm_device_list) {
215 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
224 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
228 if (powered && !dev->res_enabled) {
229 /* Intel Macs use bcm_apple_get_resources() and don't
230 * have regulator supplies configured.
232 if (dev->supplies[0].supply) {
233 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
239 /* LPO clock needs to be 32.768 kHz */
240 err = clk_set_rate(dev->lpo_clk, 32768);
242 dev_err(dev->dev, "Could not set LPO clock rate\n");
243 goto err_regulator_disable;
246 err = clk_prepare_enable(dev->lpo_clk);
248 goto err_regulator_disable;
250 err = clk_prepare_enable(dev->txco_clk);
252 goto err_lpo_clk_disable;
255 err = dev->set_shutdown(dev, powered);
257 goto err_txco_clk_disable;
259 err = dev->set_device_wakeup(dev, powered);
261 goto err_revert_shutdown;
263 if (!powered && dev->res_enabled) {
264 clk_disable_unprepare(dev->txco_clk);
265 clk_disable_unprepare(dev->lpo_clk);
267 /* Intel Macs use bcm_apple_get_resources() and don't
268 * have regulator supplies configured.
270 if (dev->supplies[0].supply)
271 regulator_bulk_disable(BCM_NUM_SUPPLIES,
275 /* wait for device to power on and come out of reset */
276 usleep_range(100000, 120000);
278 dev->res_enabled = powered;
283 dev->set_shutdown(dev, !powered);
284 err_txco_clk_disable:
285 if (powered && !dev->res_enabled)
286 clk_disable_unprepare(dev->txco_clk);
288 if (powered && !dev->res_enabled)
289 clk_disable_unprepare(dev->lpo_clk);
290 err_regulator_disable:
291 if (powered && !dev->res_enabled)
292 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
297 static irqreturn_t bcm_host_wake(int irq, void *data)
299 struct bcm_device *bdev = data;
301 bt_dev_dbg(bdev, "Host wake IRQ");
303 pm_runtime_get(bdev->dev);
304 pm_runtime_mark_last_busy(bdev->dev);
305 pm_runtime_put_autosuspend(bdev->dev);
310 static int bcm_request_irq(struct bcm_data *bcm)
312 struct bcm_device *bdev = bcm->dev;
315 mutex_lock(&bcm_device_lock);
316 if (!bcm_device_exists(bdev)) {
321 if (bdev->irq <= 0) {
326 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
327 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
335 device_init_wakeup(bdev->dev, true);
337 pm_runtime_set_autosuspend_delay(bdev->dev,
338 BCM_AUTOSUSPEND_DELAY);
339 pm_runtime_use_autosuspend(bdev->dev);
340 pm_runtime_set_active(bdev->dev);
341 pm_runtime_enable(bdev->dev);
344 mutex_unlock(&bcm_device_lock);
349 static const struct bcm_set_sleep_mode default_sleep_params = {
350 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
351 .idle_host = 2, /* idle threshold HOST, in 300ms */
352 .idle_dev = 2, /* idle threshold device, in 300ms */
353 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
354 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
355 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
356 .combine_modes = 1, /* Combine sleep and LPM flag */
357 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
358 /* Irrelevant USB flags */
360 .usb_resume_timeout = 0,
362 .pulsed_host_wake = 1,
365 static int bcm_setup_sleep(struct hci_uart *hu)
367 struct bcm_data *bcm = hu->priv;
369 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
371 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
373 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
374 &sleep_params, HCI_INIT_TIMEOUT);
376 int err = PTR_ERR(skb);
377 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
382 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
387 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
388 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
391 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
393 struct hci_uart *hu = hci_get_drvdata(hdev);
394 struct bcm_data *bcm = hu->priv;
397 if (!test_bit(HCI_RUNNING, &hdev->flags))
400 skb = bt_skb_alloc(3, GFP_KERNEL);
404 skb_put_u8(skb, BCM_LM_DIAG_PKT);
405 skb_put_u8(skb, 0xf0);
406 skb_put_u8(skb, enable);
408 skb_queue_tail(&bcm->txq, skb);
409 hci_uart_tx_wakeup(hu);
414 static int bcm_open(struct hci_uart *hu)
416 struct bcm_data *bcm;
420 bt_dev_dbg(hu->hdev, "hu %p", hu);
422 if (!hci_uart_has_flow_control(hu))
425 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
429 skb_queue_head_init(&bcm->txq);
433 mutex_lock(&bcm_device_lock);
436 bcm->dev = serdev_device_get_drvdata(hu->serdev);
443 list_for_each(p, &bcm_device_list) {
444 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
446 /* Retrieve saved bcm_device based on parent of the
447 * platform device (saved during device probe) and
448 * parent of tty device used by hci_uart
450 if (hu->tty->dev->parent == dev->dev->parent) {
461 if (bcm->dev->drive_rts_on_open)
462 hci_uart_set_flow_control(hu, true);
464 hu->init_speed = bcm->dev->init_speed;
466 /* If oper_speed is set, ldisc/serdev will set the baudrate
467 * before calling setup()
469 if (!bcm->dev->no_early_set_baudrate)
470 hu->oper_speed = bcm->dev->oper_speed;
472 err = bcm_gpio_set_power(bcm->dev, true);
474 if (bcm->dev->drive_rts_on_open)
475 hci_uart_set_flow_control(hu, false);
481 mutex_unlock(&bcm_device_lock);
489 mutex_unlock(&bcm_device_lock);
495 static int bcm_close(struct hci_uart *hu)
497 struct bcm_data *bcm = hu->priv;
498 struct bcm_device *bdev = NULL;
501 bt_dev_dbg(hu->hdev, "hu %p", hu);
503 /* Protect bcm->dev against removal of the device or driver */
504 mutex_lock(&bcm_device_lock);
507 bdev = serdev_device_get_drvdata(hu->serdev);
508 } else if (bcm_device_exists(bcm->dev)) {
516 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) {
517 devm_free_irq(bdev->dev, bdev->irq, bdev);
518 device_init_wakeup(bdev->dev, false);
519 pm_runtime_disable(bdev->dev);
522 err = bcm_gpio_set_power(bdev, false);
524 bt_dev_err(hu->hdev, "Failed to power down");
526 pm_runtime_set_suspended(bdev->dev);
528 mutex_unlock(&bcm_device_lock);
530 skb_queue_purge(&bcm->txq);
531 kfree_skb(bcm->rx_skb);
538 static int bcm_flush(struct hci_uart *hu)
540 struct bcm_data *bcm = hu->priv;
542 bt_dev_dbg(hu->hdev, "hu %p", hu);
544 skb_queue_purge(&bcm->txq);
549 static int bcm_setup(struct hci_uart *hu)
551 struct bcm_data *bcm = hu->priv;
553 const struct firmware *fw;
557 bt_dev_dbg(hu->hdev, "hu %p", hu);
559 hu->hdev->set_diag = bcm_set_diag;
560 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
562 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false);
566 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
568 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
572 err = btbcm_patchram(hu->hdev, fw);
574 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
578 /* Init speed if any */
580 speed = hu->init_speed;
581 else if (hu->proto->init_speed)
582 speed = hu->proto->init_speed;
587 host_set_baudrate(hu, speed);
589 /* Operational speed if any */
591 speed = hu->oper_speed;
592 else if (bcm->dev && bcm->dev->oper_speed)
593 speed = bcm->dev->oper_speed;
594 else if (hu->proto->oper_speed)
595 speed = hu->proto->oper_speed;
600 err = bcm_set_baudrate(hu, speed);
602 host_set_baudrate(hu, speed);
605 /* PCM parameters if provided */
606 if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
607 struct bcm_set_pcm_int_params params;
609 btbcm_read_pcm_int_params(hu->hdev, ¶ms);
611 memcpy(¶ms, bcm->dev->pcm_int_params, 5);
612 btbcm_write_pcm_int_params(hu->hdev, ¶ms);
616 release_firmware(fw);
618 err = btbcm_finalize(hu->hdev);
622 if (!bcm_request_irq(bcm))
623 err = bcm_setup_sleep(hu);
628 #define BCM_RECV_LM_DIAG \
629 .type = BCM_LM_DIAG_PKT, \
630 .hlen = BCM_LM_DIAG_SIZE, \
633 .maxlen = BCM_LM_DIAG_SIZE
635 #define BCM_RECV_NULL \
636 .type = BCM_NULL_PKT, \
637 .hlen = BCM_NULL_SIZE, \
640 .maxlen = BCM_NULL_SIZE
642 #define BCM_RECV_TYPE49 \
643 .type = BCM_TYPE49_PKT, \
644 .hlen = BCM_TYPE49_SIZE, \
647 .maxlen = BCM_TYPE49_SIZE
649 #define BCM_RECV_TYPE52 \
650 .type = BCM_TYPE52_PKT, \
651 .hlen = BCM_TYPE52_SIZE, \
654 .maxlen = BCM_TYPE52_SIZE
656 static const struct h4_recv_pkt bcm_recv_pkts[] = {
657 { H4_RECV_ACL, .recv = hci_recv_frame },
658 { H4_RECV_SCO, .recv = hci_recv_frame },
659 { H4_RECV_EVENT, .recv = hci_recv_frame },
660 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
661 { BCM_RECV_NULL, .recv = hci_recv_diag },
662 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
663 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
666 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
668 struct bcm_data *bcm = hu->priv;
670 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
673 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
674 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
675 if (IS_ERR(bcm->rx_skb)) {
676 int err = PTR_ERR(bcm->rx_skb);
677 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
680 } else if (!bcm->rx_skb) {
681 /* Delay auto-suspend when receiving completed packet */
682 mutex_lock(&bcm_device_lock);
683 if (bcm->dev && bcm_device_exists(bcm->dev)) {
684 pm_runtime_get(bcm->dev->dev);
685 pm_runtime_mark_last_busy(bcm->dev->dev);
686 pm_runtime_put_autosuspend(bcm->dev->dev);
688 mutex_unlock(&bcm_device_lock);
694 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
696 struct bcm_data *bcm = hu->priv;
698 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
700 /* Prepend skb with frame type */
701 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
702 skb_queue_tail(&bcm->txq, skb);
707 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
709 struct bcm_data *bcm = hu->priv;
710 struct sk_buff *skb = NULL;
711 struct bcm_device *bdev = NULL;
713 mutex_lock(&bcm_device_lock);
715 if (bcm_device_exists(bcm->dev)) {
717 pm_runtime_get_sync(bdev->dev);
718 /* Shall be resumed here */
721 skb = skb_dequeue(&bcm->txq);
724 pm_runtime_mark_last_busy(bdev->dev);
725 pm_runtime_put_autosuspend(bdev->dev);
728 mutex_unlock(&bcm_device_lock);
734 static int bcm_suspend_device(struct device *dev)
736 struct bcm_device *bdev = dev_get_drvdata(dev);
739 bt_dev_dbg(bdev, "");
741 if (!bdev->is_suspended && bdev->hu) {
742 hci_uart_set_flow_control(bdev->hu, true);
744 /* Once this returns, driver suspends BT via GPIO */
745 bdev->is_suspended = true;
748 /* Suspend the device */
749 err = bdev->set_device_wakeup(bdev, false);
751 if (bdev->is_suspended && bdev->hu) {
752 bdev->is_suspended = false;
753 hci_uart_set_flow_control(bdev->hu, false);
758 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
764 static int bcm_resume_device(struct device *dev)
766 struct bcm_device *bdev = dev_get_drvdata(dev);
769 bt_dev_dbg(bdev, "");
771 err = bdev->set_device_wakeup(bdev, true);
773 dev_err(dev, "Failed to power up\n");
777 bt_dev_dbg(bdev, "resume, delaying 15 ms");
780 /* When this executes, the device has woken up already */
781 if (bdev->is_suspended && bdev->hu) {
782 bdev->is_suspended = false;
784 hci_uart_set_flow_control(bdev->hu, false);
791 #ifdef CONFIG_PM_SLEEP
792 /* suspend callback */
793 static int bcm_suspend(struct device *dev)
795 struct bcm_device *bdev = dev_get_drvdata(dev);
798 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
801 * When used with a device instantiated as platform_device, bcm_suspend
802 * can be called at any time as long as the platform device is bound,
803 * so it should use bcm_device_lock to protect access to hci_uart
804 * and device_wake-up GPIO.
806 mutex_lock(&bcm_device_lock);
811 if (pm_runtime_active(dev))
812 bcm_suspend_device(dev);
814 if (device_may_wakeup(dev) && bdev->irq > 0) {
815 error = enable_irq_wake(bdev->irq);
817 bt_dev_dbg(bdev, "BCM irq: enabled");
821 mutex_unlock(&bcm_device_lock);
826 /* resume callback */
827 static int bcm_resume(struct device *dev)
829 struct bcm_device *bdev = dev_get_drvdata(dev);
832 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
835 * When used with a device instantiated as platform_device, bcm_resume
836 * can be called at any time as long as platform device is bound,
837 * so it should use bcm_device_lock to protect access to hci_uart
838 * and device_wake-up GPIO.
840 mutex_lock(&bcm_device_lock);
845 if (device_may_wakeup(dev) && bdev->irq > 0) {
846 disable_irq_wake(bdev->irq);
847 bt_dev_dbg(bdev, "BCM irq: disabled");
850 err = bcm_resume_device(dev);
853 mutex_unlock(&bcm_device_lock);
856 pm_runtime_disable(dev);
857 pm_runtime_set_active(dev);
858 pm_runtime_enable(dev);
865 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
866 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
868 .ident = "Meegopad T08",
870 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
871 "To be filled by OEM."),
872 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
873 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
880 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
881 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
882 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
884 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
885 { "device-wakeup-gpios", &first_gpio, 1 },
886 { "shutdown-gpios", &second_gpio, 1 },
887 { "host-wakeup-gpios", &third_gpio, 1 },
891 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
892 { "host-wakeup-gpios", &first_gpio, 1 },
893 { "device-wakeup-gpios", &second_gpio, 1 },
894 { "shutdown-gpios", &third_gpio, 1 },
898 static int bcm_resource(struct acpi_resource *ares, void *data)
900 struct bcm_device *dev = data;
901 struct acpi_resource_extended_irq *irq;
902 struct acpi_resource_gpio *gpio;
903 struct acpi_resource_uart_serialbus *sb;
905 switch (ares->type) {
906 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
907 irq = &ares->data.extended_irq;
908 if (irq->polarity != ACPI_ACTIVE_LOW)
909 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
910 dev->irq_active_low = true;
913 case ACPI_RESOURCE_TYPE_GPIO:
914 gpio = &ares->data.gpio;
915 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
916 dev->gpio_int_idx = dev->gpio_count;
917 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
922 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
923 sb = &ares->data.uart_serial_bus;
924 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
925 dev->init_speed = sb->default_baud_rate;
926 dev->oper_speed = 4000000;
937 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
939 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
945 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
947 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
954 static int bcm_apple_get_resources(struct bcm_device *dev)
956 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
957 const union acpi_object *obj;
960 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
961 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
962 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
965 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
966 obj->buffer.length == 8)
967 dev->init_speed = *(u64 *)obj->buffer.pointer;
969 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
970 dev->set_shutdown = bcm_apple_set_shutdown;
975 static inline int bcm_apple_get_resources(struct bcm_device *dev)
979 #endif /* CONFIG_ACPI */
981 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
983 gpiod_set_value_cansleep(dev->device_wakeup, awake);
987 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
989 gpiod_set_value_cansleep(dev->shutdown, powered);
993 /* Try a bunch of names for TXCO */
994 static struct clk *bcm_get_txco(struct device *dev)
998 /* New explicit name */
999 clk = devm_clk_get(dev, "txco");
1000 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1003 /* Deprecated name */
1004 clk = devm_clk_get(dev, "extclk");
1005 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1008 /* Original code used no name at all */
1009 return devm_clk_get(dev, NULL);
1012 static int bcm_get_resources(struct bcm_device *dev)
1014 const struct dmi_system_id *dmi_id;
1017 dev->name = dev_name(dev->dev);
1019 if (x86_apple_machine && !bcm_apple_get_resources(dev))
1022 dev->txco_clk = bcm_get_txco(dev->dev);
1024 /* Handle deferred probing */
1025 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
1026 return PTR_ERR(dev->txco_clk);
1028 /* Ignore all other errors as before */
1029 if (IS_ERR(dev->txco_clk))
1030 dev->txco_clk = NULL;
1032 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
1033 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
1034 return PTR_ERR(dev->lpo_clk);
1036 if (IS_ERR(dev->lpo_clk))
1037 dev->lpo_clk = NULL;
1039 /* Check if we accidentally fetched the lpo clock twice */
1040 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1041 devm_clk_put(dev->dev, dev->txco_clk);
1042 dev->txco_clk = NULL;
1045 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1047 if (IS_ERR(dev->device_wakeup))
1048 return PTR_ERR(dev->device_wakeup);
1050 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1052 if (IS_ERR(dev->shutdown))
1053 return PTR_ERR(dev->shutdown);
1055 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1056 dev->set_shutdown = bcm_gpio_set_shutdown;
1058 dev->supplies[0].supply = "vbat";
1059 dev->supplies[1].supply = "vddio";
1060 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1065 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1066 if (dev->irq <= 0) {
1067 struct gpio_desc *gpio;
1069 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1072 return PTR_ERR(gpio);
1074 dev->irq = gpiod_to_irq(gpio);
1077 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1079 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1084 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1089 static int bcm_acpi_probe(struct bcm_device *dev)
1091 LIST_HEAD(resources);
1092 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1093 struct resource_entry *entry;
1096 /* Retrieve UART ACPI info */
1097 dev->gpio_int_idx = -1;
1098 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1099 &resources, bcm_resource, dev);
1103 resource_list_for_each_entry(entry, &resources) {
1104 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1105 dev->irq = entry->res->start;
1109 acpi_dev_free_resource_list(&resources);
1111 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1112 * only 2 GPIO resources, we use the irq-last mapping for this, since
1113 * we already have an irq the 3th / last mapping will not be used.
1116 gpio_mapping = acpi_bcm_int_last_gpios;
1117 else if (dev->gpio_int_idx == 0)
1118 gpio_mapping = acpi_bcm_int_first_gpios;
1119 else if (dev->gpio_int_idx == 2)
1120 gpio_mapping = acpi_bcm_int_last_gpios;
1122 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1125 /* Warn if our expectations are not met. */
1126 if (dev->gpio_count != (dev->irq ? 2 : 3))
1127 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1130 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1134 if (irq_polarity != -1) {
1135 dev->irq_active_low = irq_polarity;
1136 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1137 dev->irq_active_low ? "low" : "high");
1143 static int bcm_acpi_probe(struct bcm_device *dev)
1147 #endif /* CONFIG_ACPI */
1149 static int bcm_of_probe(struct bcm_device *bdev)
1151 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1152 device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1153 bdev->pcm_int_params, 5);
1157 static int bcm_probe(struct platform_device *pdev)
1159 struct bcm_device *dev;
1162 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1166 dev->dev = &pdev->dev;
1167 dev->irq = platform_get_irq(pdev, 0);
1169 /* Initialize routing field to an unused value */
1170 dev->pcm_int_params[0] = 0xff;
1172 if (has_acpi_companion(&pdev->dev)) {
1173 ret = bcm_acpi_probe(dev);
1178 ret = bcm_get_resources(dev);
1182 platform_set_drvdata(pdev, dev);
1184 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1186 /* Place this instance on the device list */
1187 mutex_lock(&bcm_device_lock);
1188 list_add_tail(&dev->list, &bcm_device_list);
1189 mutex_unlock(&bcm_device_lock);
1191 ret = bcm_gpio_set_power(dev, false);
1193 dev_err(&pdev->dev, "Failed to power down\n");
1198 static int bcm_remove(struct platform_device *pdev)
1200 struct bcm_device *dev = platform_get_drvdata(pdev);
1202 mutex_lock(&bcm_device_lock);
1203 list_del(&dev->list);
1204 mutex_unlock(&bcm_device_lock);
1206 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1211 static const struct hci_uart_proto bcm_proto = {
1215 .init_speed = 115200,
1220 .set_baudrate = bcm_set_baudrate,
1222 .enqueue = bcm_enqueue,
1223 .dequeue = bcm_dequeue,
1227 static const struct acpi_device_id bcm_acpi_match[] = {
1396 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1399 /* suspend and resume callbacks */
1400 static const struct dev_pm_ops bcm_pm_ops = {
1401 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1402 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1405 static struct platform_driver bcm_driver = {
1407 .remove = bcm_remove,
1410 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1415 static int bcm_serdev_probe(struct serdev_device *serdev)
1417 struct bcm_device *bcmdev;
1418 const struct bcm_device_data *data;
1421 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1425 bcmdev->dev = &serdev->dev;
1427 bcmdev->hu = &bcmdev->serdev_hu;
1429 bcmdev->serdev_hu.serdev = serdev;
1430 serdev_device_set_drvdata(serdev, bcmdev);
1432 /* Initialize routing field to an unused value */
1433 bcmdev->pcm_int_params[0] = 0xff;
1435 if (has_acpi_companion(&serdev->dev))
1436 err = bcm_acpi_probe(bcmdev);
1438 err = bcm_of_probe(bcmdev);
1442 err = bcm_get_resources(bcmdev);
1446 if (!bcmdev->shutdown) {
1447 dev_warn(&serdev->dev,
1448 "No reset resource, using default baud rate\n");
1449 bcmdev->oper_speed = bcmdev->init_speed;
1452 err = bcm_gpio_set_power(bcmdev, false);
1454 dev_err(&serdev->dev, "Failed to power down\n");
1456 data = device_get_match_data(bcmdev->dev);
1458 bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1459 bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1462 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1465 static void bcm_serdev_remove(struct serdev_device *serdev)
1467 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1469 hci_uart_unregister_device(&bcmdev->serdev_hu);
1473 static struct bcm_device_data bcm4354_device_data = {
1474 .no_early_set_baudrate = true,
1477 static struct bcm_device_data bcm43438_device_data = {
1478 .drive_rts_on_open = true,
1481 static const struct of_device_id bcm_bluetooth_of_match[] = {
1482 { .compatible = "brcm,bcm20702a1" },
1483 { .compatible = "brcm,bcm4329-bt" },
1484 { .compatible = "brcm,bcm4345c5" },
1485 { .compatible = "brcm,bcm4330-bt" },
1486 { .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1487 { .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1488 { .compatible = "brcm,bcm4335a0" },
1491 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1494 static struct serdev_device_driver bcm_serdev_driver = {
1495 .probe = bcm_serdev_probe,
1496 .remove = bcm_serdev_remove,
1498 .name = "hci_uart_bcm",
1499 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1500 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1505 int __init bcm_init(void)
1507 /* For now, we need to keep both platform device
1508 * driver (ACPI generated) and serdev driver (DT).
1510 platform_driver_register(&bcm_driver);
1511 serdev_device_driver_register(&bcm_serdev_driver);
1513 return hci_uart_register_proto(&bcm_proto);
1516 int __exit bcm_deinit(void)
1518 platform_driver_unregister(&bcm_driver);
1519 serdev_device_driver_unregister(&bcm_serdev_driver);
1521 return hci_uart_unregister_proto(&bcm_proto);