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/regulator/consumer.h>
35 #include <linux/clk.h>
36 #include <linux/gpio/consumer.h>
37 #include <linux/tty.h>
38 #include <linux/interrupt.h>
39 #include <linux/dmi.h>
40 #include <linux/pm_runtime.h>
41 #include <linux/serdev.h>
43 #include <net/bluetooth/bluetooth.h>
44 #include <net/bluetooth/hci_core.h>
49 #define BCM_NULL_PKT 0x00
50 #define BCM_NULL_SIZE 0
52 #define BCM_LM_DIAG_PKT 0x07
53 #define BCM_LM_DIAG_SIZE 63
55 #define BCM_TYPE49_PKT 0x31
56 #define BCM_TYPE49_SIZE 0
58 #define BCM_TYPE52_PKT 0x34
59 #define BCM_TYPE52_SIZE 0
61 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
63 #define BCM_NUM_SUPPLIES 2
66 * struct bcm_device - device driver resources
67 * @serdev_hu: HCI UART controller struct
68 * @list: bcm_device_list node
69 * @dev: physical UART slave
70 * @name: device name logged by bt_dev_*() functions
71 * @device_wakeup: BT_WAKE pin,
72 * assert = Bluetooth device must wake up or remain awake,
73 * deassert = Bluetooth device may sleep when sleep criteria are met
74 * @shutdown: BT_REG_ON pin,
75 * power up or power down Bluetooth device internal regulators
76 * @set_device_wakeup: callback to toggle BT_WAKE pin
77 * either by accessing @device_wakeup or by calling @btlp
78 * @set_shutdown: callback to toggle BT_REG_ON pin
79 * either by accessing @shutdown or by calling @btpu/@btpd
80 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
81 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
82 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
83 * @txco_clk: external reference frequency clock used by Bluetooth device
84 * @lpo_clk: external LPO clock used by Bluetooth device
85 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
86 * @res_enabled: whether clocks and supplies are prepared and enabled
87 * @init_speed: default baudrate of Bluetooth device;
88 * the host UART is initially set to this baudrate so that
89 * it can configure the Bluetooth device for @oper_speed
90 * @oper_speed: preferred baudrate of Bluetooth device;
91 * set to 0 if @init_speed is already the preferred baudrate
92 * @irq: interrupt triggered by HOST_WAKE_BT pin
93 * @irq_active_low: whether @irq is active low
94 * @hu: pointer to HCI UART controller struct,
95 * used to disable flow control during runtime suspend and system sleep
96 * @is_suspended: whether flow control is currently disabled
99 /* Must be the first member, hci_serdev.c expects this. */
100 struct hci_uart serdev_hu;
101 struct list_head list;
106 struct gpio_desc *device_wakeup;
107 struct gpio_desc *shutdown;
108 int (*set_device_wakeup)(struct bcm_device *, bool);
109 int (*set_shutdown)(struct bcm_device *, bool);
111 acpi_handle btlp, btpu, btpd;
116 struct clk *txco_clk;
118 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
132 /* generic bcm uart resources */
134 struct sk_buff *rx_skb;
135 struct sk_buff_head txq;
137 struct bcm_device *dev;
140 /* List of BCM BT UART devices */
141 static DEFINE_MUTEX(bcm_device_lock);
142 static LIST_HEAD(bcm_device_list);
144 static int irq_polarity = -1;
145 module_param(irq_polarity, int, 0444);
146 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
148 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
151 serdev_device_set_baudrate(hu->serdev, speed);
153 hci_uart_set_baudrate(hu, speed);
156 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
158 struct hci_dev *hdev = hu->hdev;
160 struct bcm_update_uart_baud_rate param;
162 if (speed > 3000000) {
163 struct bcm_write_uart_clock_setting clock;
165 clock.type = BCM_UART_CLOCK_48MHZ;
167 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
169 /* This Broadcom specific command changes the UART's controller
170 * clock for baud rate > 3000000.
172 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
174 int err = PTR_ERR(skb);
175 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
183 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
185 param.zero = cpu_to_le16(0);
186 param.baud_rate = cpu_to_le32(speed);
188 /* This Broadcom specific command changes the UART's controller baud
191 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
194 int err = PTR_ERR(skb);
195 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
205 /* bcm_device_exists should be protected by bcm_device_lock */
206 static bool bcm_device_exists(struct bcm_device *device)
211 /* Devices using serdev always exist */
212 if (device && device->hu && device->hu->serdev)
216 list_for_each(p, &bcm_device_list) {
217 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
226 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
230 if (powered && !dev->res_enabled) {
231 err = regulator_bulk_enable(BCM_NUM_SUPPLIES, dev->supplies);
235 /* LPO clock needs to be 32.768 kHz */
236 err = clk_set_rate(dev->lpo_clk, 32768);
238 dev_err(dev->dev, "Could not set LPO clock rate\n");
239 goto err_regulator_disable;
242 err = clk_prepare_enable(dev->lpo_clk);
244 goto err_regulator_disable;
246 err = clk_prepare_enable(dev->txco_clk);
248 goto err_lpo_clk_disable;
251 err = dev->set_shutdown(dev, powered);
253 goto err_txco_clk_disable;
255 err = dev->set_device_wakeup(dev, powered);
257 goto err_revert_shutdown;
259 if (!powered && dev->res_enabled) {
260 clk_disable_unprepare(dev->txco_clk);
261 clk_disable_unprepare(dev->lpo_clk);
262 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
265 /* wait for device to power on and come out of reset */
266 usleep_range(10000, 20000);
268 dev->res_enabled = powered;
273 dev->set_shutdown(dev, !powered);
274 err_txco_clk_disable:
275 if (powered && !dev->res_enabled)
276 clk_disable_unprepare(dev->txco_clk);
278 if (powered && !dev->res_enabled)
279 clk_disable_unprepare(dev->lpo_clk);
280 err_regulator_disable:
281 if (powered && !dev->res_enabled)
282 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
287 static irqreturn_t bcm_host_wake(int irq, void *data)
289 struct bcm_device *bdev = data;
291 bt_dev_dbg(bdev, "Host wake IRQ");
293 pm_runtime_get(bdev->dev);
294 pm_runtime_mark_last_busy(bdev->dev);
295 pm_runtime_put_autosuspend(bdev->dev);
300 static int bcm_request_irq(struct bcm_data *bcm)
302 struct bcm_device *bdev = bcm->dev;
305 mutex_lock(&bcm_device_lock);
306 if (!bcm_device_exists(bdev)) {
311 if (bdev->irq <= 0) {
316 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
317 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
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 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
416 skb_queue_head_init(&bcm->txq);
420 mutex_lock(&bcm_device_lock);
423 bcm->dev = serdev_device_get_drvdata(hu->serdev);
430 list_for_each(p, &bcm_device_list) {
431 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
433 /* Retrieve saved bcm_device based on parent of the
434 * platform device (saved during device probe) and
435 * parent of tty device used by hci_uart
437 if (hu->tty->dev->parent == dev->dev->parent) {
448 hu->init_speed = bcm->dev->init_speed;
449 hu->oper_speed = bcm->dev->oper_speed;
450 err = bcm_gpio_set_power(bcm->dev, true);
455 mutex_unlock(&bcm_device_lock);
463 mutex_unlock(&bcm_device_lock);
469 static int bcm_close(struct hci_uart *hu)
471 struct bcm_data *bcm = hu->priv;
472 struct bcm_device *bdev = NULL;
475 bt_dev_dbg(hu->hdev, "hu %p", hu);
477 /* Protect bcm->dev against removal of the device or driver */
478 mutex_lock(&bcm_device_lock);
481 bdev = serdev_device_get_drvdata(hu->serdev);
482 } else if (bcm_device_exists(bcm->dev)) {
490 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) {
491 devm_free_irq(bdev->dev, bdev->irq, bdev);
492 device_init_wakeup(bdev->dev, false);
493 pm_runtime_disable(bdev->dev);
496 err = bcm_gpio_set_power(bdev, false);
498 bt_dev_err(hu->hdev, "Failed to power down");
500 pm_runtime_set_suspended(bdev->dev);
502 mutex_unlock(&bcm_device_lock);
504 skb_queue_purge(&bcm->txq);
505 kfree_skb(bcm->rx_skb);
512 static int bcm_flush(struct hci_uart *hu)
514 struct bcm_data *bcm = hu->priv;
516 bt_dev_dbg(hu->hdev, "hu %p", hu);
518 skb_queue_purge(&bcm->txq);
523 static int bcm_setup(struct hci_uart *hu)
525 struct bcm_data *bcm = hu->priv;
527 const struct firmware *fw;
531 bt_dev_dbg(hu->hdev, "hu %p", hu);
533 hu->hdev->set_diag = bcm_set_diag;
534 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
536 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false);
540 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
542 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
546 err = btbcm_patchram(hu->hdev, fw);
548 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
552 /* Init speed if any */
554 speed = hu->init_speed;
555 else if (hu->proto->init_speed)
556 speed = hu->proto->init_speed;
561 host_set_baudrate(hu, speed);
563 /* Operational speed if any */
565 speed = hu->oper_speed;
566 else if (hu->proto->oper_speed)
567 speed = hu->proto->oper_speed;
572 err = bcm_set_baudrate(hu, speed);
574 host_set_baudrate(hu, speed);
578 release_firmware(fw);
580 err = btbcm_finalize(hu->hdev);
584 if (!bcm_request_irq(bcm))
585 err = bcm_setup_sleep(hu);
590 #define BCM_RECV_LM_DIAG \
591 .type = BCM_LM_DIAG_PKT, \
592 .hlen = BCM_LM_DIAG_SIZE, \
595 .maxlen = BCM_LM_DIAG_SIZE
597 #define BCM_RECV_NULL \
598 .type = BCM_NULL_PKT, \
599 .hlen = BCM_NULL_SIZE, \
602 .maxlen = BCM_NULL_SIZE
604 #define BCM_RECV_TYPE49 \
605 .type = BCM_TYPE49_PKT, \
606 .hlen = BCM_TYPE49_SIZE, \
609 .maxlen = BCM_TYPE49_SIZE
611 #define BCM_RECV_TYPE52 \
612 .type = BCM_TYPE52_PKT, \
613 .hlen = BCM_TYPE52_SIZE, \
616 .maxlen = BCM_TYPE52_SIZE
618 static const struct h4_recv_pkt bcm_recv_pkts[] = {
619 { H4_RECV_ACL, .recv = hci_recv_frame },
620 { H4_RECV_SCO, .recv = hci_recv_frame },
621 { H4_RECV_EVENT, .recv = hci_recv_frame },
622 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
623 { BCM_RECV_NULL, .recv = hci_recv_diag },
624 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
625 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
628 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
630 struct bcm_data *bcm = hu->priv;
632 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
635 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
636 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
637 if (IS_ERR(bcm->rx_skb)) {
638 int err = PTR_ERR(bcm->rx_skb);
639 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
642 } else if (!bcm->rx_skb) {
643 /* Delay auto-suspend when receiving completed packet */
644 mutex_lock(&bcm_device_lock);
645 if (bcm->dev && bcm_device_exists(bcm->dev)) {
646 pm_runtime_get(bcm->dev->dev);
647 pm_runtime_mark_last_busy(bcm->dev->dev);
648 pm_runtime_put_autosuspend(bcm->dev->dev);
650 mutex_unlock(&bcm_device_lock);
656 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
658 struct bcm_data *bcm = hu->priv;
660 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
662 /* Prepend skb with frame type */
663 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
664 skb_queue_tail(&bcm->txq, skb);
669 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
671 struct bcm_data *bcm = hu->priv;
672 struct sk_buff *skb = NULL;
673 struct bcm_device *bdev = NULL;
675 mutex_lock(&bcm_device_lock);
677 if (bcm_device_exists(bcm->dev)) {
679 pm_runtime_get_sync(bdev->dev);
680 /* Shall be resumed here */
683 skb = skb_dequeue(&bcm->txq);
686 pm_runtime_mark_last_busy(bdev->dev);
687 pm_runtime_put_autosuspend(bdev->dev);
690 mutex_unlock(&bcm_device_lock);
696 static int bcm_suspend_device(struct device *dev)
698 struct bcm_device *bdev = dev_get_drvdata(dev);
701 bt_dev_dbg(bdev, "");
703 if (!bdev->is_suspended && bdev->hu) {
704 hci_uart_set_flow_control(bdev->hu, true);
706 /* Once this returns, driver suspends BT via GPIO */
707 bdev->is_suspended = true;
710 /* Suspend the device */
711 err = bdev->set_device_wakeup(bdev, false);
713 if (bdev->is_suspended && bdev->hu) {
714 bdev->is_suspended = false;
715 hci_uart_set_flow_control(bdev->hu, false);
720 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
726 static int bcm_resume_device(struct device *dev)
728 struct bcm_device *bdev = dev_get_drvdata(dev);
731 bt_dev_dbg(bdev, "");
733 err = bdev->set_device_wakeup(bdev, true);
735 dev_err(dev, "Failed to power up\n");
739 bt_dev_dbg(bdev, "resume, delaying 15 ms");
742 /* When this executes, the device has woken up already */
743 if (bdev->is_suspended && bdev->hu) {
744 bdev->is_suspended = false;
746 hci_uart_set_flow_control(bdev->hu, false);
753 #ifdef CONFIG_PM_SLEEP
754 /* suspend callback */
755 static int bcm_suspend(struct device *dev)
757 struct bcm_device *bdev = dev_get_drvdata(dev);
760 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
763 * When used with a device instantiated as platform_device, bcm_suspend
764 * can be called at any time as long as the platform device is bound,
765 * so it should use bcm_device_lock to protect access to hci_uart
766 * and device_wake-up GPIO.
768 mutex_lock(&bcm_device_lock);
773 if (pm_runtime_active(dev))
774 bcm_suspend_device(dev);
776 if (device_may_wakeup(dev) && bdev->irq > 0) {
777 error = enable_irq_wake(bdev->irq);
779 bt_dev_dbg(bdev, "BCM irq: enabled");
783 mutex_unlock(&bcm_device_lock);
788 /* resume callback */
789 static int bcm_resume(struct device *dev)
791 struct bcm_device *bdev = dev_get_drvdata(dev);
794 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
797 * When used with a device instantiated as platform_device, bcm_resume
798 * can be called at any time as long as platform device is bound,
799 * so it should use bcm_device_lock to protect access to hci_uart
800 * and device_wake-up GPIO.
802 mutex_lock(&bcm_device_lock);
807 if (device_may_wakeup(dev) && bdev->irq > 0) {
808 disable_irq_wake(bdev->irq);
809 bt_dev_dbg(bdev, "BCM irq: disabled");
812 err = bcm_resume_device(dev);
815 mutex_unlock(&bcm_device_lock);
818 pm_runtime_disable(dev);
819 pm_runtime_set_active(dev);
820 pm_runtime_enable(dev);
827 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
828 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
829 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
831 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
832 { "device-wakeup-gpios", &first_gpio, 1 },
833 { "shutdown-gpios", &second_gpio, 1 },
834 { "host-wakeup-gpios", &third_gpio, 1 },
838 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
839 { "host-wakeup-gpios", &first_gpio, 1 },
840 { "device-wakeup-gpios", &second_gpio, 1 },
841 { "shutdown-gpios", &third_gpio, 1 },
845 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
846 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
848 .ident = "Meegopad T08",
850 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
851 "To be filled by OEM."),
852 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
853 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
860 static int bcm_resource(struct acpi_resource *ares, void *data)
862 struct bcm_device *dev = data;
863 struct acpi_resource_extended_irq *irq;
864 struct acpi_resource_gpio *gpio;
865 struct acpi_resource_uart_serialbus *sb;
867 switch (ares->type) {
868 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
869 irq = &ares->data.extended_irq;
870 if (irq->polarity != ACPI_ACTIVE_LOW)
871 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
872 dev->irq_active_low = true;
875 case ACPI_RESOURCE_TYPE_GPIO:
876 gpio = &ares->data.gpio;
877 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
878 dev->gpio_int_idx = dev->gpio_count;
879 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
884 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
885 sb = &ares->data.uart_serial_bus;
886 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
887 dev->init_speed = sb->default_baud_rate;
888 dev->oper_speed = 4000000;
899 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
901 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
907 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
909 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
916 static int bcm_apple_get_resources(struct bcm_device *dev)
918 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
919 const union acpi_object *obj;
922 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
923 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
924 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
927 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
928 obj->buffer.length == 8)
929 dev->init_speed = *(u64 *)obj->buffer.pointer;
931 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
932 dev->set_shutdown = bcm_apple_set_shutdown;
937 static inline int bcm_apple_get_resources(struct bcm_device *dev)
941 #endif /* CONFIG_ACPI */
943 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
945 gpiod_set_value_cansleep(dev->device_wakeup, awake);
949 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
951 gpiod_set_value_cansleep(dev->shutdown, powered);
955 /* Try a bunch of names for TXCO */
956 static struct clk *bcm_get_txco(struct device *dev)
960 /* New explicit name */
961 clk = devm_clk_get(dev, "txco");
962 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
965 /* Deprecated name */
966 clk = devm_clk_get(dev, "extclk");
967 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
970 /* Original code used no name at all */
971 return devm_clk_get(dev, NULL);
974 static int bcm_get_resources(struct bcm_device *dev)
976 const struct dmi_system_id *dmi_id;
979 dev->name = dev_name(dev->dev);
981 if (x86_apple_machine && !bcm_apple_get_resources(dev))
984 dev->txco_clk = bcm_get_txco(dev->dev);
986 /* Handle deferred probing */
987 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
988 return PTR_ERR(dev->txco_clk);
990 /* Ignore all other errors as before */
991 if (IS_ERR(dev->txco_clk))
992 dev->txco_clk = NULL;
994 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
995 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
996 return PTR_ERR(dev->lpo_clk);
998 if (IS_ERR(dev->lpo_clk))
1001 /* Check if we accidentally fetched the lpo clock twice */
1002 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1003 devm_clk_put(dev->dev, dev->txco_clk);
1004 dev->txco_clk = NULL;
1007 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1009 if (IS_ERR(dev->device_wakeup))
1010 return PTR_ERR(dev->device_wakeup);
1012 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1014 if (IS_ERR(dev->shutdown))
1015 return PTR_ERR(dev->shutdown);
1017 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1018 dev->set_shutdown = bcm_gpio_set_shutdown;
1020 dev->supplies[0].supply = "vbat";
1021 dev->supplies[1].supply = "vddio";
1022 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1027 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1028 if (dev->irq <= 0) {
1029 struct gpio_desc *gpio;
1031 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1034 return PTR_ERR(gpio);
1036 dev->irq = gpiod_to_irq(gpio);
1039 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1041 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1046 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1051 static int bcm_acpi_probe(struct bcm_device *dev)
1053 LIST_HEAD(resources);
1054 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1055 struct resource_entry *entry;
1058 /* Retrieve UART ACPI info */
1059 dev->gpio_int_idx = -1;
1060 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1061 &resources, bcm_resource, dev);
1065 resource_list_for_each_entry(entry, &resources) {
1066 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1067 dev->irq = entry->res->start;
1071 acpi_dev_free_resource_list(&resources);
1073 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1074 * only 2 GPIO resources, we use the irq-last mapping for this, since
1075 * we already have an irq the 3th / last mapping will not be used.
1078 gpio_mapping = acpi_bcm_int_last_gpios;
1079 else if (dev->gpio_int_idx == 0)
1080 gpio_mapping = acpi_bcm_int_first_gpios;
1081 else if (dev->gpio_int_idx == 2)
1082 gpio_mapping = acpi_bcm_int_last_gpios;
1084 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1087 /* Warn if our expectations are not met. */
1088 if (dev->gpio_count != (dev->irq ? 2 : 3))
1089 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1092 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1096 if (irq_polarity != -1) {
1097 dev->irq_active_low = irq_polarity;
1098 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1099 dev->irq_active_low ? "low" : "high");
1105 static int bcm_acpi_probe(struct bcm_device *dev)
1109 #endif /* CONFIG_ACPI */
1111 static int bcm_of_probe(struct bcm_device *bdev)
1113 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1117 static int bcm_probe(struct platform_device *pdev)
1119 struct bcm_device *dev;
1122 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1126 dev->dev = &pdev->dev;
1127 dev->irq = platform_get_irq(pdev, 0);
1129 if (has_acpi_companion(&pdev->dev)) {
1130 ret = bcm_acpi_probe(dev);
1135 ret = bcm_get_resources(dev);
1139 platform_set_drvdata(pdev, dev);
1141 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1143 /* Place this instance on the device list */
1144 mutex_lock(&bcm_device_lock);
1145 list_add_tail(&dev->list, &bcm_device_list);
1146 mutex_unlock(&bcm_device_lock);
1148 ret = bcm_gpio_set_power(dev, false);
1150 dev_err(&pdev->dev, "Failed to power down\n");
1155 static int bcm_remove(struct platform_device *pdev)
1157 struct bcm_device *dev = platform_get_drvdata(pdev);
1159 mutex_lock(&bcm_device_lock);
1160 list_del(&dev->list);
1161 mutex_unlock(&bcm_device_lock);
1163 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1168 static const struct hci_uart_proto bcm_proto = {
1172 .init_speed = 115200,
1177 .set_baudrate = bcm_set_baudrate,
1179 .enqueue = bcm_enqueue,
1180 .dequeue = bcm_dequeue,
1184 static const struct acpi_device_id bcm_acpi_match[] = {
1353 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1356 /* suspend and resume callbacks */
1357 static const struct dev_pm_ops bcm_pm_ops = {
1358 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1359 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1362 static struct platform_driver bcm_driver = {
1364 .remove = bcm_remove,
1367 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1372 static int bcm_serdev_probe(struct serdev_device *serdev)
1374 struct bcm_device *bcmdev;
1377 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1381 bcmdev->dev = &serdev->dev;
1383 bcmdev->hu = &bcmdev->serdev_hu;
1385 bcmdev->serdev_hu.serdev = serdev;
1386 serdev_device_set_drvdata(serdev, bcmdev);
1388 if (has_acpi_companion(&serdev->dev))
1389 err = bcm_acpi_probe(bcmdev);
1391 err = bcm_of_probe(bcmdev);
1395 err = bcm_get_resources(bcmdev);
1399 if (!bcmdev->shutdown) {
1400 dev_warn(&serdev->dev,
1401 "No reset resource, using default baud rate\n");
1402 bcmdev->oper_speed = bcmdev->init_speed;
1405 err = bcm_gpio_set_power(bcmdev, false);
1407 dev_err(&serdev->dev, "Failed to power down\n");
1409 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1412 static void bcm_serdev_remove(struct serdev_device *serdev)
1414 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1416 hci_uart_unregister_device(&bcmdev->serdev_hu);
1420 static const struct of_device_id bcm_bluetooth_of_match[] = {
1421 { .compatible = "brcm,bcm20702a1" },
1422 { .compatible = "brcm,bcm4330-bt" },
1423 { .compatible = "brcm,bcm43438-bt" },
1426 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1429 static struct serdev_device_driver bcm_serdev_driver = {
1430 .probe = bcm_serdev_probe,
1431 .remove = bcm_serdev_remove,
1433 .name = "hci_uart_bcm",
1434 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1435 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1440 int __init bcm_init(void)
1442 /* For now, we need to keep both platform device
1443 * driver (ACPI generated) and serdev driver (DT).
1445 platform_driver_register(&bcm_driver);
1446 serdev_device_driver_register(&bcm_serdev_driver);
1448 return hci_uart_register_proto(&bcm_proto);
1451 int __exit bcm_deinit(void)
1453 platform_driver_unregister(&bcm_driver);
1454 serdev_device_driver_unregister(&bcm_serdev_driver);
1456 return hci_uart_unregister_proto(&bcm_proto);