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()
55 struct bcm_device_data {
56 bool no_early_set_baudrate;
57 bool drive_rts_on_open;
61 * struct bcm_device - device driver resources
62 * @serdev_hu: HCI UART controller struct
63 * @list: bcm_device_list node
64 * @dev: physical UART slave
65 * @name: device name logged by bt_dev_*() functions
66 * @device_wakeup: BT_WAKE pin,
67 * assert = Bluetooth device must wake up or remain awake,
68 * deassert = Bluetooth device may sleep when sleep criteria are met
69 * @shutdown: BT_REG_ON pin,
70 * power up or power down Bluetooth device internal regulators
71 * @reset: BT_RST_N pin,
72 * active low resets the Bluetooth logic core
73 * @set_device_wakeup: callback to toggle BT_WAKE pin
74 * either by accessing @device_wakeup or by calling @btlp
75 * @set_shutdown: callback to toggle BT_REG_ON pin
76 * either by accessing @shutdown or by calling @btpu/@btpd
77 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
78 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
79 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
80 * @txco_clk: external reference frequency clock used by Bluetooth device
81 * @lpo_clk: external LPO clock used by Bluetooth device
82 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
83 * @res_enabled: whether clocks and supplies are prepared and enabled
84 * @init_speed: default baudrate of Bluetooth device;
85 * the host UART is initially set to this baudrate so that
86 * it can configure the Bluetooth device for @oper_speed
87 * @oper_speed: preferred baudrate of Bluetooth device;
88 * set to 0 if @init_speed is already the preferred baudrate
89 * @irq: interrupt triggered by HOST_WAKE_BT pin
90 * @irq_active_low: whether @irq is active low
91 * @hu: pointer to HCI UART controller struct,
92 * used to disable flow control during runtime suspend and system sleep
93 * @is_suspended: whether flow control is currently disabled
94 * @no_early_set_baudrate: don't set_baudrate before setup()
97 /* Must be the first member, hci_serdev.c expects this. */
98 struct hci_uart serdev_hu;
99 struct list_head list;
104 struct gpio_desc *device_wakeup;
105 struct gpio_desc *shutdown;
106 struct gpio_desc *reset;
107 int (*set_device_wakeup)(struct bcm_device *, bool);
108 int (*set_shutdown)(struct bcm_device *, bool);
110 acpi_handle btlp, btpu, btpd;
115 struct clk *txco_clk;
117 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
130 bool no_early_set_baudrate;
131 bool drive_rts_on_open;
132 u8 pcm_int_params[5];
135 /* generic bcm uart resources */
137 struct sk_buff *rx_skb;
138 struct sk_buff_head txq;
140 struct bcm_device *dev;
143 /* List of BCM BT UART devices */
144 static DEFINE_MUTEX(bcm_device_lock);
145 static LIST_HEAD(bcm_device_list);
147 static int irq_polarity = -1;
148 module_param(irq_polarity, int, 0444);
149 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
151 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
154 serdev_device_set_baudrate(hu->serdev, speed);
156 hci_uart_set_baudrate(hu, speed);
159 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
161 struct hci_dev *hdev = hu->hdev;
163 struct bcm_update_uart_baud_rate param;
165 if (speed > 3000000) {
166 struct bcm_write_uart_clock_setting clock;
168 clock.type = BCM_UART_CLOCK_48MHZ;
170 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
172 /* This Broadcom specific command changes the UART's controller
173 * clock for baud rate > 3000000.
175 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
177 int err = PTR_ERR(skb);
178 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
186 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
188 param.zero = cpu_to_le16(0);
189 param.baud_rate = cpu_to_le32(speed);
191 /* This Broadcom specific command changes the UART's controller baud
194 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
197 int err = PTR_ERR(skb);
198 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
208 /* bcm_device_exists should be protected by bcm_device_lock */
209 static bool bcm_device_exists(struct bcm_device *device)
214 /* Devices using serdev always exist */
215 if (device && device->hu && device->hu->serdev)
219 list_for_each(p, &bcm_device_list) {
220 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
229 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
233 if (powered && !dev->res_enabled) {
234 /* Intel Macs use bcm_apple_get_resources() and don't
235 * have regulator supplies configured.
237 if (dev->supplies[0].supply) {
238 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
244 /* LPO clock needs to be 32.768 kHz */
245 err = clk_set_rate(dev->lpo_clk, 32768);
247 dev_err(dev->dev, "Could not set LPO clock rate\n");
248 goto err_regulator_disable;
251 err = clk_prepare_enable(dev->lpo_clk);
253 goto err_regulator_disable;
255 err = clk_prepare_enable(dev->txco_clk);
257 goto err_lpo_clk_disable;
260 err = dev->set_shutdown(dev, powered);
262 goto err_txco_clk_disable;
264 err = dev->set_device_wakeup(dev, powered);
266 goto err_revert_shutdown;
268 if (!powered && dev->res_enabled) {
269 clk_disable_unprepare(dev->txco_clk);
270 clk_disable_unprepare(dev->lpo_clk);
272 /* Intel Macs use bcm_apple_get_resources() and don't
273 * have regulator supplies configured.
275 if (dev->supplies[0].supply)
276 regulator_bulk_disable(BCM_NUM_SUPPLIES,
280 /* wait for device to power on and come out of reset */
281 usleep_range(100000, 120000);
283 dev->res_enabled = powered;
288 dev->set_shutdown(dev, !powered);
289 err_txco_clk_disable:
290 if (powered && !dev->res_enabled)
291 clk_disable_unprepare(dev->txco_clk);
293 if (powered && !dev->res_enabled)
294 clk_disable_unprepare(dev->lpo_clk);
295 err_regulator_disable:
296 if (powered && !dev->res_enabled)
297 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
302 static irqreturn_t bcm_host_wake(int irq, void *data)
304 struct bcm_device *bdev = data;
306 bt_dev_dbg(bdev, "Host wake IRQ");
308 pm_runtime_get(bdev->dev);
309 pm_runtime_mark_last_busy(bdev->dev);
310 pm_runtime_put_autosuspend(bdev->dev);
315 static int bcm_request_irq(struct bcm_data *bcm)
317 struct bcm_device *bdev = bcm->dev;
320 mutex_lock(&bcm_device_lock);
321 if (!bcm_device_exists(bdev)) {
326 if (bdev->irq <= 0) {
331 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
332 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
340 bdev->irq_acquired = true;
342 device_init_wakeup(bdev->dev, true);
344 pm_runtime_set_autosuspend_delay(bdev->dev,
345 BCM_AUTOSUSPEND_DELAY);
346 pm_runtime_use_autosuspend(bdev->dev);
347 pm_runtime_set_active(bdev->dev);
348 pm_runtime_enable(bdev->dev);
351 mutex_unlock(&bcm_device_lock);
356 static const struct bcm_set_sleep_mode default_sleep_params = {
357 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
358 .idle_host = 2, /* idle threshold HOST, in 300ms */
359 .idle_dev = 2, /* idle threshold device, in 300ms */
360 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
361 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
362 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
363 .combine_modes = 1, /* Combine sleep and LPM flag */
364 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
365 /* Irrelevant USB flags */
367 .usb_resume_timeout = 0,
369 .pulsed_host_wake = 1,
372 static int bcm_setup_sleep(struct hci_uart *hu)
374 struct bcm_data *bcm = hu->priv;
376 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
378 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
380 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
381 &sleep_params, HCI_INIT_TIMEOUT);
383 int err = PTR_ERR(skb);
384 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
389 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
394 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
395 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
398 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
400 struct hci_uart *hu = hci_get_drvdata(hdev);
401 struct bcm_data *bcm = hu->priv;
404 if (!test_bit(HCI_RUNNING, &hdev->flags))
407 skb = bt_skb_alloc(3, GFP_KERNEL);
411 skb_put_u8(skb, BCM_LM_DIAG_PKT);
412 skb_put_u8(skb, 0xf0);
413 skb_put_u8(skb, enable);
415 skb_queue_tail(&bcm->txq, skb);
416 hci_uart_tx_wakeup(hu);
421 static int bcm_open(struct hci_uart *hu)
423 struct bcm_data *bcm;
427 bt_dev_dbg(hu->hdev, "hu %p", hu);
429 if (!hci_uart_has_flow_control(hu))
432 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
436 skb_queue_head_init(&bcm->txq);
440 mutex_lock(&bcm_device_lock);
443 bcm->dev = serdev_device_get_drvdata(hu->serdev);
450 list_for_each(p, &bcm_device_list) {
451 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
453 /* Retrieve saved bcm_device based on parent of the
454 * platform device (saved during device probe) and
455 * parent of tty device used by hci_uart
457 if (hu->tty->dev->parent == dev->dev->parent) {
468 if (bcm->dev->drive_rts_on_open)
469 hci_uart_set_flow_control(hu, true);
471 hu->init_speed = bcm->dev->init_speed;
473 /* If oper_speed is set, ldisc/serdev will set the baudrate
474 * before calling setup()
476 if (!bcm->dev->no_early_set_baudrate)
477 hu->oper_speed = bcm->dev->oper_speed;
479 err = bcm_gpio_set_power(bcm->dev, true);
481 if (bcm->dev->drive_rts_on_open)
482 hci_uart_set_flow_control(hu, false);
488 mutex_unlock(&bcm_device_lock);
496 mutex_unlock(&bcm_device_lock);
502 static int bcm_close(struct hci_uart *hu)
504 struct bcm_data *bcm = hu->priv;
505 struct bcm_device *bdev = NULL;
508 bt_dev_dbg(hu->hdev, "hu %p", hu);
510 /* Protect bcm->dev against removal of the device or driver */
511 mutex_lock(&bcm_device_lock);
514 bdev = serdev_device_get_drvdata(hu->serdev);
515 } else if (bcm_device_exists(bcm->dev)) {
523 if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
524 devm_free_irq(bdev->dev, bdev->irq, bdev);
525 device_init_wakeup(bdev->dev, false);
526 pm_runtime_disable(bdev->dev);
529 err = bcm_gpio_set_power(bdev, false);
531 bt_dev_err(hu->hdev, "Failed to power down");
533 pm_runtime_set_suspended(bdev->dev);
535 mutex_unlock(&bcm_device_lock);
537 skb_queue_purge(&bcm->txq);
538 kfree_skb(bcm->rx_skb);
545 static int bcm_flush(struct hci_uart *hu)
547 struct bcm_data *bcm = hu->priv;
549 bt_dev_dbg(hu->hdev, "hu %p", hu);
551 skb_queue_purge(&bcm->txq);
556 static int bcm_setup(struct hci_uart *hu)
558 struct bcm_data *bcm = hu->priv;
559 bool fw_load_done = false;
563 bt_dev_dbg(hu->hdev, "hu %p", hu);
565 hu->hdev->set_diag = bcm_set_diag;
566 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
568 err = btbcm_initialize(hu->hdev, &fw_load_done);
575 /* Init speed if any */
577 speed = hu->init_speed;
578 else if (hu->proto->init_speed)
579 speed = hu->proto->init_speed;
584 host_set_baudrate(hu, speed);
586 /* Operational speed if any */
588 speed = hu->oper_speed;
589 else if (bcm->dev && bcm->dev->oper_speed)
590 speed = bcm->dev->oper_speed;
591 else if (hu->proto->oper_speed)
592 speed = hu->proto->oper_speed;
597 err = bcm_set_baudrate(hu, speed);
599 host_set_baudrate(hu, speed);
602 /* PCM parameters if provided */
603 if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
604 struct bcm_set_pcm_int_params params;
606 btbcm_read_pcm_int_params(hu->hdev, ¶ms);
608 memcpy(¶ms, bcm->dev->pcm_int_params, 5);
609 btbcm_write_pcm_int_params(hu->hdev, ¶ms);
612 err = btbcm_finalize(hu->hdev, &fw_load_done);
616 /* Some devices ship with the controller default address.
617 * Allow the bootloader to set a valid address through the
620 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hu->hdev->quirks);
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 { H4_RECV_ISO, .recv = hci_recv_frame },
661 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
662 { BCM_RECV_NULL, .recv = hci_recv_diag },
663 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
664 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
667 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
669 struct bcm_data *bcm = hu->priv;
671 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
674 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
675 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
676 if (IS_ERR(bcm->rx_skb)) {
677 int err = PTR_ERR(bcm->rx_skb);
678 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
681 } else if (!bcm->rx_skb) {
682 /* Delay auto-suspend when receiving completed packet */
683 mutex_lock(&bcm_device_lock);
684 if (bcm->dev && bcm_device_exists(bcm->dev)) {
685 pm_runtime_get(bcm->dev->dev);
686 pm_runtime_mark_last_busy(bcm->dev->dev);
687 pm_runtime_put_autosuspend(bcm->dev->dev);
689 mutex_unlock(&bcm_device_lock);
695 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
697 struct bcm_data *bcm = hu->priv;
699 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
701 /* Prepend skb with frame type */
702 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
703 skb_queue_tail(&bcm->txq, skb);
708 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
710 struct bcm_data *bcm = hu->priv;
711 struct sk_buff *skb = NULL;
712 struct bcm_device *bdev = NULL;
714 mutex_lock(&bcm_device_lock);
716 if (bcm_device_exists(bcm->dev)) {
718 pm_runtime_get_sync(bdev->dev);
719 /* Shall be resumed here */
722 skb = skb_dequeue(&bcm->txq);
725 pm_runtime_mark_last_busy(bdev->dev);
726 pm_runtime_put_autosuspend(bdev->dev);
729 mutex_unlock(&bcm_device_lock);
735 static int bcm_suspend_device(struct device *dev)
737 struct bcm_device *bdev = dev_get_drvdata(dev);
740 bt_dev_dbg(bdev, "");
742 if (!bdev->is_suspended && bdev->hu) {
743 hci_uart_set_flow_control(bdev->hu, true);
745 /* Once this returns, driver suspends BT via GPIO */
746 bdev->is_suspended = true;
749 /* Suspend the device */
750 err = bdev->set_device_wakeup(bdev, false);
752 if (bdev->is_suspended && bdev->hu) {
753 bdev->is_suspended = false;
754 hci_uart_set_flow_control(bdev->hu, false);
759 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
765 static int bcm_resume_device(struct device *dev)
767 struct bcm_device *bdev = dev_get_drvdata(dev);
770 bt_dev_dbg(bdev, "");
772 err = bdev->set_device_wakeup(bdev, true);
774 dev_err(dev, "Failed to power up\n");
778 bt_dev_dbg(bdev, "resume, delaying 15 ms");
781 /* When this executes, the device has woken up already */
782 if (bdev->is_suspended && bdev->hu) {
783 bdev->is_suspended = false;
785 hci_uart_set_flow_control(bdev->hu, false);
792 #ifdef CONFIG_PM_SLEEP
793 /* suspend callback */
794 static int bcm_suspend(struct device *dev)
796 struct bcm_device *bdev = dev_get_drvdata(dev);
799 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
802 * When used with a device instantiated as platform_device, bcm_suspend
803 * can be called at any time as long as the platform device is bound,
804 * so it should use bcm_device_lock to protect access to hci_uart
805 * and device_wake-up GPIO.
807 mutex_lock(&bcm_device_lock);
812 if (pm_runtime_active(dev))
813 bcm_suspend_device(dev);
815 if (device_may_wakeup(dev) && bdev->irq > 0) {
816 error = enable_irq_wake(bdev->irq);
818 bt_dev_dbg(bdev, "BCM irq: enabled");
822 mutex_unlock(&bcm_device_lock);
827 /* resume callback */
828 static int bcm_resume(struct device *dev)
830 struct bcm_device *bdev = dev_get_drvdata(dev);
833 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
836 * When used with a device instantiated as platform_device, bcm_resume
837 * can be called at any time as long as platform device is bound,
838 * so it should use bcm_device_lock to protect access to hci_uart
839 * and device_wake-up GPIO.
841 mutex_lock(&bcm_device_lock);
846 if (device_may_wakeup(dev) && bdev->irq > 0) {
847 disable_irq_wake(bdev->irq);
848 bt_dev_dbg(bdev, "BCM irq: disabled");
851 err = bcm_resume_device(dev);
854 mutex_unlock(&bcm_device_lock);
857 pm_runtime_disable(dev);
858 pm_runtime_set_active(dev);
859 pm_runtime_enable(dev);
866 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
867 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
869 .ident = "Meegopad T08",
871 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
872 "To be filled by OEM."),
873 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
874 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
881 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
882 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
883 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
885 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
886 { "device-wakeup-gpios", &first_gpio, 1 },
887 { "shutdown-gpios", &second_gpio, 1 },
888 { "host-wakeup-gpios", &third_gpio, 1 },
892 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
893 { "host-wakeup-gpios", &first_gpio, 1 },
894 { "device-wakeup-gpios", &second_gpio, 1 },
895 { "shutdown-gpios", &third_gpio, 1 },
899 static int bcm_resource(struct acpi_resource *ares, void *data)
901 struct bcm_device *dev = data;
902 struct acpi_resource_extended_irq *irq;
903 struct acpi_resource_gpio *gpio;
904 struct acpi_resource_uart_serialbus *sb;
906 switch (ares->type) {
907 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
908 irq = &ares->data.extended_irq;
909 if (irq->polarity != ACPI_ACTIVE_LOW)
910 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
911 dev->irq_active_low = true;
914 case ACPI_RESOURCE_TYPE_GPIO:
915 gpio = &ares->data.gpio;
916 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
917 dev->gpio_int_idx = dev->gpio_count;
918 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
923 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
924 sb = &ares->data.uart_serial_bus;
925 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
926 dev->init_speed = sb->default_baud_rate;
927 dev->oper_speed = 4000000;
938 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
940 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
946 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
948 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
955 static int bcm_apple_get_resources(struct bcm_device *dev)
957 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
958 const union acpi_object *obj;
961 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
962 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
963 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
966 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
967 obj->buffer.length == 8)
968 dev->init_speed = *(u64 *)obj->buffer.pointer;
970 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
971 dev->set_shutdown = bcm_apple_set_shutdown;
976 static inline int bcm_apple_get_resources(struct bcm_device *dev)
980 #endif /* CONFIG_ACPI */
982 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
984 gpiod_set_value_cansleep(dev->device_wakeup, awake);
988 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
990 gpiod_set_value_cansleep(dev->shutdown, powered);
993 * The reset line is asserted on powerdown and deasserted
994 * on poweron so the inverse of powered is used. Notice
995 * that the GPIO line BT_RST_N needs to be specified as
996 * active low in the device tree or similar system
999 gpiod_set_value_cansleep(dev->reset, !powered);
1003 /* Try a bunch of names for TXCO */
1004 static struct clk *bcm_get_txco(struct device *dev)
1008 /* New explicit name */
1009 clk = devm_clk_get(dev, "txco");
1010 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1013 /* Deprecated name */
1014 clk = devm_clk_get(dev, "extclk");
1015 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
1018 /* Original code used no name at all */
1019 return devm_clk_get(dev, NULL);
1022 static int bcm_get_resources(struct bcm_device *dev)
1024 const struct dmi_system_id *dmi_id;
1027 dev->name = dev_name(dev->dev);
1029 if (x86_apple_machine && !bcm_apple_get_resources(dev))
1032 dev->txco_clk = bcm_get_txco(dev->dev);
1034 /* Handle deferred probing */
1035 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
1036 return PTR_ERR(dev->txco_clk);
1038 /* Ignore all other errors as before */
1039 if (IS_ERR(dev->txco_clk))
1040 dev->txco_clk = NULL;
1042 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
1043 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
1044 return PTR_ERR(dev->lpo_clk);
1046 if (IS_ERR(dev->lpo_clk))
1047 dev->lpo_clk = NULL;
1049 /* Check if we accidentally fetched the lpo clock twice */
1050 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1051 devm_clk_put(dev->dev, dev->txco_clk);
1052 dev->txco_clk = NULL;
1055 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1057 if (IS_ERR(dev->device_wakeup))
1058 return PTR_ERR(dev->device_wakeup);
1060 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1062 if (IS_ERR(dev->shutdown))
1063 return PTR_ERR(dev->shutdown);
1065 dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1067 if (IS_ERR(dev->reset))
1068 return PTR_ERR(dev->reset);
1070 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1071 dev->set_shutdown = bcm_gpio_set_shutdown;
1073 dev->supplies[0].supply = "vbat";
1074 dev->supplies[1].supply = "vddio";
1075 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1080 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1081 if (dev->irq <= 0) {
1082 struct gpio_desc *gpio;
1084 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1087 return PTR_ERR(gpio);
1089 dev->irq = gpiod_to_irq(gpio);
1092 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1094 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1099 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1104 static int bcm_acpi_probe(struct bcm_device *dev)
1106 LIST_HEAD(resources);
1107 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1108 struct resource_entry *entry;
1111 /* Retrieve UART ACPI info */
1112 dev->gpio_int_idx = -1;
1113 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1114 &resources, bcm_resource, dev);
1118 resource_list_for_each_entry(entry, &resources) {
1119 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1120 dev->irq = entry->res->start;
1124 acpi_dev_free_resource_list(&resources);
1126 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1127 * only 2 GPIO resources, we use the irq-last mapping for this, since
1128 * we already have an irq the 3th / last mapping will not be used.
1131 gpio_mapping = acpi_bcm_int_last_gpios;
1132 else if (dev->gpio_int_idx == 0)
1133 gpio_mapping = acpi_bcm_int_first_gpios;
1134 else if (dev->gpio_int_idx == 2)
1135 gpio_mapping = acpi_bcm_int_last_gpios;
1137 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1140 /* Warn if our expectations are not met. */
1141 if (dev->gpio_count != (dev->irq ? 2 : 3))
1142 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1145 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1149 if (irq_polarity != -1) {
1150 dev->irq_active_low = irq_polarity;
1151 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1152 dev->irq_active_low ? "low" : "high");
1158 static int bcm_acpi_probe(struct bcm_device *dev)
1162 #endif /* CONFIG_ACPI */
1164 static int bcm_of_probe(struct bcm_device *bdev)
1166 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1167 device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1168 bdev->pcm_int_params, 5);
1169 bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1170 bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1171 & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1175 static int bcm_probe(struct platform_device *pdev)
1177 struct bcm_device *dev;
1180 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1184 dev->dev = &pdev->dev;
1185 dev->irq = platform_get_irq(pdev, 0);
1187 /* Initialize routing field to an unused value */
1188 dev->pcm_int_params[0] = 0xff;
1190 if (has_acpi_companion(&pdev->dev)) {
1191 ret = bcm_acpi_probe(dev);
1196 ret = bcm_get_resources(dev);
1200 platform_set_drvdata(pdev, dev);
1202 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1204 /* Place this instance on the device list */
1205 mutex_lock(&bcm_device_lock);
1206 list_add_tail(&dev->list, &bcm_device_list);
1207 mutex_unlock(&bcm_device_lock);
1209 ret = bcm_gpio_set_power(dev, false);
1211 dev_err(&pdev->dev, "Failed to power down\n");
1216 static int bcm_remove(struct platform_device *pdev)
1218 struct bcm_device *dev = platform_get_drvdata(pdev);
1220 mutex_lock(&bcm_device_lock);
1221 list_del(&dev->list);
1222 mutex_unlock(&bcm_device_lock);
1224 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1229 static const struct hci_uart_proto bcm_proto = {
1233 .init_speed = 115200,
1238 .set_baudrate = bcm_set_baudrate,
1240 .enqueue = bcm_enqueue,
1241 .dequeue = bcm_dequeue,
1245 static const struct acpi_device_id bcm_acpi_match[] = {
1414 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1417 /* suspend and resume callbacks */
1418 static const struct dev_pm_ops bcm_pm_ops = {
1419 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1420 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1423 static struct platform_driver bcm_driver = {
1425 .remove = bcm_remove,
1428 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1433 static int bcm_serdev_probe(struct serdev_device *serdev)
1435 struct bcm_device *bcmdev;
1436 const struct bcm_device_data *data;
1439 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1443 bcmdev->dev = &serdev->dev;
1445 bcmdev->hu = &bcmdev->serdev_hu;
1447 bcmdev->serdev_hu.serdev = serdev;
1448 serdev_device_set_drvdata(serdev, bcmdev);
1450 /* Initialize routing field to an unused value */
1451 bcmdev->pcm_int_params[0] = 0xff;
1453 if (has_acpi_companion(&serdev->dev))
1454 err = bcm_acpi_probe(bcmdev);
1456 err = bcm_of_probe(bcmdev);
1460 err = bcm_get_resources(bcmdev);
1464 if (!bcmdev->shutdown) {
1465 dev_warn(&serdev->dev,
1466 "No reset resource, using default baud rate\n");
1467 bcmdev->oper_speed = bcmdev->init_speed;
1470 err = bcm_gpio_set_power(bcmdev, false);
1472 dev_err(&serdev->dev, "Failed to power down\n");
1474 data = device_get_match_data(bcmdev->dev);
1476 bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1477 bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1480 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1483 static void bcm_serdev_remove(struct serdev_device *serdev)
1485 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1487 hci_uart_unregister_device(&bcmdev->serdev_hu);
1491 static struct bcm_device_data bcm4354_device_data = {
1492 .no_early_set_baudrate = true,
1495 static struct bcm_device_data bcm43438_device_data = {
1496 .drive_rts_on_open = true,
1499 static const struct of_device_id bcm_bluetooth_of_match[] = {
1500 { .compatible = "brcm,bcm20702a1" },
1501 { .compatible = "brcm,bcm4329-bt" },
1502 { .compatible = "brcm,bcm4330-bt" },
1503 { .compatible = "brcm,bcm4334-bt" },
1504 { .compatible = "brcm,bcm4345c5" },
1505 { .compatible = "brcm,bcm4330-bt" },
1506 { .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1507 { .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1508 { .compatible = "brcm,bcm4335a0" },
1511 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1514 static struct serdev_device_driver bcm_serdev_driver = {
1515 .probe = bcm_serdev_probe,
1516 .remove = bcm_serdev_remove,
1518 .name = "hci_uart_bcm",
1519 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1520 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1525 int __init bcm_init(void)
1527 /* For now, we need to keep both platform device
1528 * driver (ACPI generated) and serdev driver (DT).
1530 platform_driver_register(&bcm_driver);
1531 serdev_device_driver_register(&bcm_serdev_driver);
1533 return hci_uart_register_proto(&bcm_proto);
1536 int __exit bcm_deinit(void)
1538 platform_driver_unregister(&bcm_driver);
1539 serdev_device_driver_unregister(&bcm_serdev_driver);
1541 return hci_uart_unregister_proto(&bcm_proto);