3 * Bluetooth HCI UART driver for Broadcom devices
5 * Copyright (C) 2015 Intel Corporation
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/skbuff.h>
27 #include <linux/firmware.h>
28 #include <linux/module.h>
29 #include <linux/acpi.h>
31 #include <linux/property.h>
32 #include <linux/platform_data/x86/apple.h>
33 #include <linux/platform_device.h>
34 #include <linux/clk.h>
35 #include <linux/gpio/consumer.h>
36 #include <linux/tty.h>
37 #include <linux/interrupt.h>
38 #include <linux/dmi.h>
39 #include <linux/pm_runtime.h>
40 #include <linux/serdev.h>
42 #include <net/bluetooth/bluetooth.h>
43 #include <net/bluetooth/hci_core.h>
48 #define BCM_NULL_PKT 0x00
49 #define BCM_NULL_SIZE 0
51 #define BCM_LM_DIAG_PKT 0x07
52 #define BCM_LM_DIAG_SIZE 63
54 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
57 * struct bcm_device - device driver resources
58 * @serdev_hu: HCI UART controller struct
59 * @list: bcm_device_list node
60 * @dev: physical UART slave
61 * @name: device name logged by bt_dev_*() functions
62 * @device_wakeup: BT_WAKE pin,
63 * assert = Bluetooth device must wake up or remain awake,
64 * deassert = Bluetooth device may sleep when sleep criteria are met
65 * @shutdown: BT_REG_ON pin,
66 * power up or power down Bluetooth device internal regulators
67 * @set_device_wakeup: callback to toggle BT_WAKE pin
68 * either by accessing @device_wakeup or by calling @btlp
69 * @set_shutdown: callback to toggle BT_REG_ON pin
70 * either by accessing @shutdown or by calling @btpu/@btpd
71 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
72 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
73 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
74 * @clk: clock used by Bluetooth device
75 * @clk_enabled: whether @clk is prepared and enabled
76 * @init_speed: default baudrate of Bluetooth device;
77 * the host UART is initially set to this baudrate so that
78 * it can configure the Bluetooth device for @oper_speed
79 * @oper_speed: preferred baudrate of Bluetooth device;
80 * set to 0 if @init_speed is already the preferred baudrate
81 * @irq: interrupt triggered by HOST_WAKE_BT pin
82 * @irq_active_low: whether @irq is active low
83 * @hu: pointer to HCI UART controller struct,
84 * used to disable flow control during runtime suspend and system sleep
85 * @is_suspended: whether flow control is currently disabled
88 /* Must be the first member, hci_serdev.c expects this. */
89 struct hci_uart serdev_hu;
90 struct list_head list;
95 struct gpio_desc *device_wakeup;
96 struct gpio_desc *shutdown;
97 int (*set_device_wakeup)(struct bcm_device *, bool);
98 int (*set_shutdown)(struct bcm_device *, bool);
100 acpi_handle btlp, btpu, btpd;
119 /* generic bcm uart resources */
121 struct sk_buff *rx_skb;
122 struct sk_buff_head txq;
124 struct bcm_device *dev;
127 /* List of BCM BT UART devices */
128 static DEFINE_MUTEX(bcm_device_lock);
129 static LIST_HEAD(bcm_device_list);
131 static int irq_polarity = -1;
132 module_param(irq_polarity, int, 0444);
133 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
135 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
138 serdev_device_set_baudrate(hu->serdev, speed);
140 hci_uart_set_baudrate(hu, speed);
143 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
145 struct hci_dev *hdev = hu->hdev;
147 struct bcm_update_uart_baud_rate param;
149 if (speed > 3000000) {
150 struct bcm_write_uart_clock_setting clock;
152 clock.type = BCM_UART_CLOCK_48MHZ;
154 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
156 /* This Broadcom specific command changes the UART's controller
157 * clock for baud rate > 3000000.
159 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
161 int err = PTR_ERR(skb);
162 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
170 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
172 param.zero = cpu_to_le16(0);
173 param.baud_rate = cpu_to_le32(speed);
175 /* This Broadcom specific command changes the UART's controller baud
178 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
181 int err = PTR_ERR(skb);
182 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
192 /* bcm_device_exists should be protected by bcm_device_lock */
193 static bool bcm_device_exists(struct bcm_device *device)
198 /* Devices using serdev always exist */
199 if (device && device->hu && device->hu->serdev)
203 list_for_each(p, &bcm_device_list) {
204 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
213 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
217 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled) {
218 err = clk_prepare_enable(dev->clk);
223 err = dev->set_shutdown(dev, powered);
225 goto err_clk_disable;
227 err = dev->set_device_wakeup(dev, powered);
229 goto err_revert_shutdown;
231 if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
232 clk_disable_unprepare(dev->clk);
234 dev->clk_enabled = powered;
239 dev->set_shutdown(dev, !powered);
241 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
242 clk_disable_unprepare(dev->clk);
247 static irqreturn_t bcm_host_wake(int irq, void *data)
249 struct bcm_device *bdev = data;
251 bt_dev_dbg(bdev, "Host wake IRQ");
253 pm_runtime_get(bdev->dev);
254 pm_runtime_mark_last_busy(bdev->dev);
255 pm_runtime_put_autosuspend(bdev->dev);
260 static int bcm_request_irq(struct bcm_data *bcm)
262 struct bcm_device *bdev = bcm->dev;
265 mutex_lock(&bcm_device_lock);
266 if (!bcm_device_exists(bdev)) {
271 if (bdev->irq <= 0) {
276 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
277 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
285 device_init_wakeup(bdev->dev, true);
287 pm_runtime_set_autosuspend_delay(bdev->dev,
288 BCM_AUTOSUSPEND_DELAY);
289 pm_runtime_use_autosuspend(bdev->dev);
290 pm_runtime_set_active(bdev->dev);
291 pm_runtime_enable(bdev->dev);
294 mutex_unlock(&bcm_device_lock);
299 static const struct bcm_set_sleep_mode default_sleep_params = {
300 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
301 .idle_host = 2, /* idle threshold HOST, in 300ms */
302 .idle_dev = 2, /* idle threshold device, in 300ms */
303 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
304 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
305 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
306 .combine_modes = 1, /* Combine sleep and LPM flag */
307 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
308 /* Irrelevant USB flags */
310 .usb_resume_timeout = 0,
312 .pulsed_host_wake = 1,
315 static int bcm_setup_sleep(struct hci_uart *hu)
317 struct bcm_data *bcm = hu->priv;
319 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
321 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
323 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
324 &sleep_params, HCI_INIT_TIMEOUT);
326 int err = PTR_ERR(skb);
327 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
332 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
337 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
338 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
341 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
343 struct hci_uart *hu = hci_get_drvdata(hdev);
344 struct bcm_data *bcm = hu->priv;
347 if (!test_bit(HCI_RUNNING, &hdev->flags))
350 skb = bt_skb_alloc(3, GFP_KERNEL);
354 skb_put_u8(skb, BCM_LM_DIAG_PKT);
355 skb_put_u8(skb, 0xf0);
356 skb_put_u8(skb, enable);
358 skb_queue_tail(&bcm->txq, skb);
359 hci_uart_tx_wakeup(hu);
364 static int bcm_open(struct hci_uart *hu)
366 struct bcm_data *bcm;
370 bt_dev_dbg(hu->hdev, "hu %p", hu);
372 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
376 skb_queue_head_init(&bcm->txq);
380 mutex_lock(&bcm_device_lock);
383 err = serdev_device_open(hu->serdev);
387 bcm->dev = serdev_device_get_drvdata(hu->serdev);
394 list_for_each(p, &bcm_device_list) {
395 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
397 /* Retrieve saved bcm_device based on parent of the
398 * platform device (saved during device probe) and
399 * parent of tty device used by hci_uart
401 if (hu->tty->dev->parent == dev->dev->parent) {
412 hu->init_speed = bcm->dev->init_speed;
413 hu->oper_speed = bcm->dev->oper_speed;
414 err = bcm_gpio_set_power(bcm->dev, true);
419 mutex_unlock(&bcm_device_lock);
424 serdev_device_close(hu->serdev);
430 mutex_unlock(&bcm_device_lock);
436 static int bcm_close(struct hci_uart *hu)
438 struct bcm_data *bcm = hu->priv;
439 struct bcm_device *bdev = NULL;
442 bt_dev_dbg(hu->hdev, "hu %p", hu);
444 /* Protect bcm->dev against removal of the device or driver */
445 mutex_lock(&bcm_device_lock);
448 serdev_device_close(hu->serdev);
449 bdev = serdev_device_get_drvdata(hu->serdev);
450 } else if (bcm_device_exists(bcm->dev)) {
458 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) {
459 devm_free_irq(bdev->dev, bdev->irq, bdev);
460 device_init_wakeup(bdev->dev, false);
461 pm_runtime_disable(bdev->dev);
464 err = bcm_gpio_set_power(bdev, false);
466 bt_dev_err(hu->hdev, "Failed to power down");
468 pm_runtime_set_suspended(bdev->dev);
470 mutex_unlock(&bcm_device_lock);
472 skb_queue_purge(&bcm->txq);
473 kfree_skb(bcm->rx_skb);
480 static int bcm_flush(struct hci_uart *hu)
482 struct bcm_data *bcm = hu->priv;
484 bt_dev_dbg(hu->hdev, "hu %p", hu);
486 skb_queue_purge(&bcm->txq);
491 static int bcm_setup(struct hci_uart *hu)
493 struct bcm_data *bcm = hu->priv;
495 const struct firmware *fw;
499 bt_dev_dbg(hu->hdev, "hu %p", hu);
501 hu->hdev->set_diag = bcm_set_diag;
502 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
504 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
508 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
510 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
514 err = btbcm_patchram(hu->hdev, fw);
516 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
520 /* Init speed if any */
522 speed = hu->init_speed;
523 else if (hu->proto->init_speed)
524 speed = hu->proto->init_speed;
529 host_set_baudrate(hu, speed);
531 /* Operational speed if any */
533 speed = hu->oper_speed;
534 else if (hu->proto->oper_speed)
535 speed = hu->proto->oper_speed;
540 err = bcm_set_baudrate(hu, speed);
542 host_set_baudrate(hu, speed);
546 release_firmware(fw);
548 err = btbcm_finalize(hu->hdev);
552 if (!bcm_request_irq(bcm))
553 err = bcm_setup_sleep(hu);
558 #define BCM_RECV_LM_DIAG \
559 .type = BCM_LM_DIAG_PKT, \
560 .hlen = BCM_LM_DIAG_SIZE, \
563 .maxlen = BCM_LM_DIAG_SIZE
565 #define BCM_RECV_NULL \
566 .type = BCM_NULL_PKT, \
567 .hlen = BCM_NULL_SIZE, \
570 .maxlen = BCM_NULL_SIZE
572 static const struct h4_recv_pkt bcm_recv_pkts[] = {
573 { H4_RECV_ACL, .recv = hci_recv_frame },
574 { H4_RECV_SCO, .recv = hci_recv_frame },
575 { H4_RECV_EVENT, .recv = hci_recv_frame },
576 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
577 { BCM_RECV_NULL, .recv = hci_recv_diag },
580 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
582 struct bcm_data *bcm = hu->priv;
584 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
587 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
588 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
589 if (IS_ERR(bcm->rx_skb)) {
590 int err = PTR_ERR(bcm->rx_skb);
591 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
594 } else if (!bcm->rx_skb) {
595 /* Delay auto-suspend when receiving completed packet */
596 mutex_lock(&bcm_device_lock);
597 if (bcm->dev && bcm_device_exists(bcm->dev)) {
598 pm_runtime_get(bcm->dev->dev);
599 pm_runtime_mark_last_busy(bcm->dev->dev);
600 pm_runtime_put_autosuspend(bcm->dev->dev);
602 mutex_unlock(&bcm_device_lock);
608 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
610 struct bcm_data *bcm = hu->priv;
612 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
614 /* Prepend skb with frame type */
615 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
616 skb_queue_tail(&bcm->txq, skb);
621 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
623 struct bcm_data *bcm = hu->priv;
624 struct sk_buff *skb = NULL;
625 struct bcm_device *bdev = NULL;
627 mutex_lock(&bcm_device_lock);
629 if (bcm_device_exists(bcm->dev)) {
631 pm_runtime_get_sync(bdev->dev);
632 /* Shall be resumed here */
635 skb = skb_dequeue(&bcm->txq);
638 pm_runtime_mark_last_busy(bdev->dev);
639 pm_runtime_put_autosuspend(bdev->dev);
642 mutex_unlock(&bcm_device_lock);
648 static int bcm_suspend_device(struct device *dev)
650 struct bcm_device *bdev = dev_get_drvdata(dev);
653 bt_dev_dbg(bdev, "");
655 if (!bdev->is_suspended && bdev->hu) {
656 hci_uart_set_flow_control(bdev->hu, true);
658 /* Once this returns, driver suspends BT via GPIO */
659 bdev->is_suspended = true;
662 /* Suspend the device */
663 err = bdev->set_device_wakeup(bdev, false);
665 if (bdev->is_suspended && bdev->hu) {
666 bdev->is_suspended = false;
667 hci_uart_set_flow_control(bdev->hu, false);
672 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
678 static int bcm_resume_device(struct device *dev)
680 struct bcm_device *bdev = dev_get_drvdata(dev);
683 bt_dev_dbg(bdev, "");
685 err = bdev->set_device_wakeup(bdev, true);
687 dev_err(dev, "Failed to power up\n");
691 bt_dev_dbg(bdev, "resume, delaying 15 ms");
694 /* When this executes, the device has woken up already */
695 if (bdev->is_suspended && bdev->hu) {
696 bdev->is_suspended = false;
698 hci_uart_set_flow_control(bdev->hu, false);
705 #ifdef CONFIG_PM_SLEEP
706 /* suspend callback */
707 static int bcm_suspend(struct device *dev)
709 struct bcm_device *bdev = dev_get_drvdata(dev);
712 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
715 * When used with a device instantiated as platform_device, bcm_suspend
716 * can be called at any time as long as the platform device is bound,
717 * so it should use bcm_device_lock to protect access to hci_uart
718 * and device_wake-up GPIO.
720 mutex_lock(&bcm_device_lock);
725 if (pm_runtime_active(dev))
726 bcm_suspend_device(dev);
728 if (device_may_wakeup(dev) && bdev->irq > 0) {
729 error = enable_irq_wake(bdev->irq);
731 bt_dev_dbg(bdev, "BCM irq: enabled");
735 mutex_unlock(&bcm_device_lock);
740 /* resume callback */
741 static int bcm_resume(struct device *dev)
743 struct bcm_device *bdev = dev_get_drvdata(dev);
746 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
749 * When used with a device instantiated as platform_device, bcm_resume
750 * can be called at any time as long as platform device is bound,
751 * so it should use bcm_device_lock to protect access to hci_uart
752 * and device_wake-up GPIO.
754 mutex_lock(&bcm_device_lock);
759 if (device_may_wakeup(dev) && bdev->irq > 0) {
760 disable_irq_wake(bdev->irq);
761 bt_dev_dbg(bdev, "BCM irq: disabled");
764 err = bcm_resume_device(dev);
767 mutex_unlock(&bcm_device_lock);
770 pm_runtime_disable(dev);
771 pm_runtime_set_active(dev);
772 pm_runtime_enable(dev);
779 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
780 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
781 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
783 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
784 { "device-wakeup-gpios", &first_gpio, 1 },
785 { "shutdown-gpios", &second_gpio, 1 },
786 { "host-wakeup-gpios", &third_gpio, 1 },
790 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
791 { "host-wakeup-gpios", &first_gpio, 1 },
792 { "device-wakeup-gpios", &second_gpio, 1 },
793 { "shutdown-gpios", &third_gpio, 1 },
798 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */
799 static const struct dmi_system_id bcm_active_low_irq_dmi_table[] = {
800 { /* Handle ThinkPad 8 tablets with BCM2E55 chipset ACPI ID */
801 .ident = "Lenovo ThinkPad 8",
803 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "LENOVO"),
804 DMI_EXACT_MATCH(DMI_PRODUCT_VERSION, "ThinkPad 8"),
810 static int bcm_resource(struct acpi_resource *ares, void *data)
812 struct bcm_device *dev = data;
813 struct acpi_resource_extended_irq *irq;
814 struct acpi_resource_gpio *gpio;
815 struct acpi_resource_uart_serialbus *sb;
817 switch (ares->type) {
818 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
819 irq = &ares->data.extended_irq;
820 if (irq->polarity != ACPI_ACTIVE_LOW)
821 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
822 dev->irq_active_low = true;
825 case ACPI_RESOURCE_TYPE_GPIO:
826 gpio = &ares->data.gpio;
827 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
828 dev->gpio_int_idx = dev->gpio_count;
829 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
834 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
835 sb = &ares->data.uart_serial_bus;
836 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
837 dev->init_speed = sb->default_baud_rate;
838 dev->oper_speed = 4000000;
849 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
851 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
857 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
859 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
866 static int bcm_apple_get_resources(struct bcm_device *dev)
868 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
869 const union acpi_object *obj;
872 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
873 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
874 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
877 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
878 obj->buffer.length == 8)
879 dev->init_speed = *(u64 *)obj->buffer.pointer;
881 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
882 dev->set_shutdown = bcm_apple_set_shutdown;
887 static inline int bcm_apple_get_resources(struct bcm_device *dev)
891 #endif /* CONFIG_ACPI */
893 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
895 gpiod_set_value_cansleep(dev->device_wakeup, awake);
899 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
901 gpiod_set_value_cansleep(dev->shutdown, powered);
905 static int bcm_get_resources(struct bcm_device *dev)
907 dev->name = dev_name(dev->dev);
909 if (x86_apple_machine && !bcm_apple_get_resources(dev))
912 dev->clk = devm_clk_get(dev->dev, NULL);
914 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
916 if (IS_ERR(dev->device_wakeup))
917 return PTR_ERR(dev->device_wakeup);
919 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
921 if (IS_ERR(dev->shutdown))
922 return PTR_ERR(dev->shutdown);
924 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
925 dev->set_shutdown = bcm_gpio_set_shutdown;
927 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
929 struct gpio_desc *gpio;
931 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
934 return PTR_ERR(gpio);
936 dev->irq = gpiod_to_irq(gpio);
939 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
944 static int bcm_acpi_probe(struct bcm_device *dev)
946 LIST_HEAD(resources);
947 const struct dmi_system_id *dmi_id;
948 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
949 struct resource_entry *entry;
952 /* Retrieve UART ACPI info */
953 dev->gpio_int_idx = -1;
954 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
955 &resources, bcm_resource, dev);
959 resource_list_for_each_entry(entry, &resources) {
960 if (resource_type(entry->res) == IORESOURCE_IRQ) {
961 dev->irq = entry->res->start;
965 acpi_dev_free_resource_list(&resources);
967 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
968 * only 2 GPIO resources, we use the irq-last mapping for this, since
969 * we already have an irq the 3th / last mapping will not be used.
972 gpio_mapping = acpi_bcm_int_last_gpios;
973 else if (dev->gpio_int_idx == 0)
974 gpio_mapping = acpi_bcm_int_first_gpios;
975 else if (dev->gpio_int_idx == 2)
976 gpio_mapping = acpi_bcm_int_last_gpios;
978 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
981 /* Warn if our expectations are not met. */
982 if (dev->gpio_count != (dev->irq ? 2 : 3))
983 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
986 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
990 if (irq_polarity != -1) {
991 dev->irq_active_low = irq_polarity;
992 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
993 dev->irq_active_low ? "low" : "high");
995 dmi_id = dmi_first_match(bcm_active_low_irq_dmi_table);
997 dev_warn(dev->dev, "%s: Overwriting IRQ polarity to active low",
999 dev->irq_active_low = true;
1006 static int bcm_acpi_probe(struct bcm_device *dev)
1010 #endif /* CONFIG_ACPI */
1012 static int bcm_of_probe(struct bcm_device *bdev)
1014 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1018 static int bcm_probe(struct platform_device *pdev)
1020 struct bcm_device *dev;
1023 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1027 dev->dev = &pdev->dev;
1028 dev->irq = platform_get_irq(pdev, 0);
1030 if (has_acpi_companion(&pdev->dev)) {
1031 ret = bcm_acpi_probe(dev);
1036 ret = bcm_get_resources(dev);
1040 platform_set_drvdata(pdev, dev);
1042 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1044 /* Place this instance on the device list */
1045 mutex_lock(&bcm_device_lock);
1046 list_add_tail(&dev->list, &bcm_device_list);
1047 mutex_unlock(&bcm_device_lock);
1049 ret = bcm_gpio_set_power(dev, false);
1051 dev_err(&pdev->dev, "Failed to power down\n");
1056 static int bcm_remove(struct platform_device *pdev)
1058 struct bcm_device *dev = platform_get_drvdata(pdev);
1060 mutex_lock(&bcm_device_lock);
1061 list_del(&dev->list);
1062 mutex_unlock(&bcm_device_lock);
1064 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1069 static const struct hci_uart_proto bcm_proto = {
1073 .init_speed = 115200,
1078 .set_baudrate = bcm_set_baudrate,
1080 .enqueue = bcm_enqueue,
1081 .dequeue = bcm_dequeue,
1085 static const struct acpi_device_id bcm_acpi_match[] = {
1254 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1257 /* suspend and resume callbacks */
1258 static const struct dev_pm_ops bcm_pm_ops = {
1259 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1260 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1263 static struct platform_driver bcm_driver = {
1265 .remove = bcm_remove,
1268 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1273 static int bcm_serdev_probe(struct serdev_device *serdev)
1275 struct bcm_device *bcmdev;
1278 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1282 bcmdev->dev = &serdev->dev;
1284 bcmdev->hu = &bcmdev->serdev_hu;
1286 bcmdev->serdev_hu.serdev = serdev;
1287 serdev_device_set_drvdata(serdev, bcmdev);
1289 if (has_acpi_companion(&serdev->dev))
1290 err = bcm_acpi_probe(bcmdev);
1292 err = bcm_of_probe(bcmdev);
1296 err = bcm_get_resources(bcmdev);
1300 if (!bcmdev->shutdown) {
1301 dev_warn(&serdev->dev,
1302 "No reset resource, using default baud rate\n");
1303 bcmdev->oper_speed = bcmdev->init_speed;
1306 err = bcm_gpio_set_power(bcmdev, false);
1308 dev_err(&serdev->dev, "Failed to power down\n");
1310 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1313 static void bcm_serdev_remove(struct serdev_device *serdev)
1315 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1317 hci_uart_unregister_device(&bcmdev->serdev_hu);
1321 static const struct of_device_id bcm_bluetooth_of_match[] = {
1322 { .compatible = "brcm,bcm43438-bt" },
1325 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1328 static struct serdev_device_driver bcm_serdev_driver = {
1329 .probe = bcm_serdev_probe,
1330 .remove = bcm_serdev_remove,
1332 .name = "hci_uart_bcm",
1333 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1334 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1339 int __init bcm_init(void)
1341 /* For now, we need to keep both platform device
1342 * driver (ACPI generated) and serdev driver (DT).
1344 platform_driver_register(&bcm_driver);
1345 serdev_device_driver_register(&bcm_serdev_driver);
1347 return hci_uart_register_proto(&bcm_proto);
1350 int __exit bcm_deinit(void)
1352 platform_driver_unregister(&bcm_driver);
1353 serdev_device_driver_unregister(&bcm_serdev_driver);
1355 return hci_uart_unregister_proto(&bcm_proto);