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 /* Intel Macs use bcm_apple_get_resources() and don't
232 * have regulator supplies configured.
234 if (dev->supplies[0].supply) {
235 err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
241 /* LPO clock needs to be 32.768 kHz */
242 err = clk_set_rate(dev->lpo_clk, 32768);
244 dev_err(dev->dev, "Could not set LPO clock rate\n");
245 goto err_regulator_disable;
248 err = clk_prepare_enable(dev->lpo_clk);
250 goto err_regulator_disable;
252 err = clk_prepare_enable(dev->txco_clk);
254 goto err_lpo_clk_disable;
257 err = dev->set_shutdown(dev, powered);
259 goto err_txco_clk_disable;
261 err = dev->set_device_wakeup(dev, powered);
263 goto err_revert_shutdown;
265 if (!powered && dev->res_enabled) {
266 clk_disable_unprepare(dev->txco_clk);
267 clk_disable_unprepare(dev->lpo_clk);
269 /* Intel Macs use bcm_apple_get_resources() and don't
270 * have regulator supplies configured.
272 if (dev->supplies[0].supply)
273 regulator_bulk_disable(BCM_NUM_SUPPLIES,
277 /* wait for device to power on and come out of reset */
278 usleep_range(10000, 20000);
280 dev->res_enabled = powered;
285 dev->set_shutdown(dev, !powered);
286 err_txco_clk_disable:
287 if (powered && !dev->res_enabled)
288 clk_disable_unprepare(dev->txco_clk);
290 if (powered && !dev->res_enabled)
291 clk_disable_unprepare(dev->lpo_clk);
292 err_regulator_disable:
293 if (powered && !dev->res_enabled)
294 regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
299 static irqreturn_t bcm_host_wake(int irq, void *data)
301 struct bcm_device *bdev = data;
303 bt_dev_dbg(bdev, "Host wake IRQ");
305 pm_runtime_get(bdev->dev);
306 pm_runtime_mark_last_busy(bdev->dev);
307 pm_runtime_put_autosuspend(bdev->dev);
312 static int bcm_request_irq(struct bcm_data *bcm)
314 struct bcm_device *bdev = bcm->dev;
317 mutex_lock(&bcm_device_lock);
318 if (!bcm_device_exists(bdev)) {
323 if (bdev->irq <= 0) {
328 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
329 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
337 device_init_wakeup(bdev->dev, true);
339 pm_runtime_set_autosuspend_delay(bdev->dev,
340 BCM_AUTOSUSPEND_DELAY);
341 pm_runtime_use_autosuspend(bdev->dev);
342 pm_runtime_set_active(bdev->dev);
343 pm_runtime_enable(bdev->dev);
346 mutex_unlock(&bcm_device_lock);
351 static const struct bcm_set_sleep_mode default_sleep_params = {
352 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
353 .idle_host = 2, /* idle threshold HOST, in 300ms */
354 .idle_dev = 2, /* idle threshold device, in 300ms */
355 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
356 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
357 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
358 .combine_modes = 1, /* Combine sleep and LPM flag */
359 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
360 /* Irrelevant USB flags */
362 .usb_resume_timeout = 0,
364 .pulsed_host_wake = 1,
367 static int bcm_setup_sleep(struct hci_uart *hu)
369 struct bcm_data *bcm = hu->priv;
371 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
373 sleep_params.host_wake_active = !bcm->dev->irq_active_low;
375 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
376 &sleep_params, HCI_INIT_TIMEOUT);
378 int err = PTR_ERR(skb);
379 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
384 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
389 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
390 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
393 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
395 struct hci_uart *hu = hci_get_drvdata(hdev);
396 struct bcm_data *bcm = hu->priv;
399 if (!test_bit(HCI_RUNNING, &hdev->flags))
402 skb = bt_skb_alloc(3, GFP_KERNEL);
406 skb_put_u8(skb, BCM_LM_DIAG_PKT);
407 skb_put_u8(skb, 0xf0);
408 skb_put_u8(skb, enable);
410 skb_queue_tail(&bcm->txq, skb);
411 hci_uart_tx_wakeup(hu);
416 static int bcm_open(struct hci_uart *hu)
418 struct bcm_data *bcm;
422 bt_dev_dbg(hu->hdev, "hu %p", hu);
424 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
428 skb_queue_head_init(&bcm->txq);
432 mutex_lock(&bcm_device_lock);
435 bcm->dev = serdev_device_get_drvdata(hu->serdev);
442 list_for_each(p, &bcm_device_list) {
443 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
445 /* Retrieve saved bcm_device based on parent of the
446 * platform device (saved during device probe) and
447 * parent of tty device used by hci_uart
449 if (hu->tty->dev->parent == dev->dev->parent) {
460 hu->init_speed = bcm->dev->init_speed;
461 hu->oper_speed = bcm->dev->oper_speed;
462 err = bcm_gpio_set_power(bcm->dev, true);
467 mutex_unlock(&bcm_device_lock);
475 mutex_unlock(&bcm_device_lock);
481 static int bcm_close(struct hci_uart *hu)
483 struct bcm_data *bcm = hu->priv;
484 struct bcm_device *bdev = NULL;
487 bt_dev_dbg(hu->hdev, "hu %p", hu);
489 /* Protect bcm->dev against removal of the device or driver */
490 mutex_lock(&bcm_device_lock);
493 bdev = serdev_device_get_drvdata(hu->serdev);
494 } else if (bcm_device_exists(bcm->dev)) {
502 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) {
503 devm_free_irq(bdev->dev, bdev->irq, bdev);
504 device_init_wakeup(bdev->dev, false);
505 pm_runtime_disable(bdev->dev);
508 err = bcm_gpio_set_power(bdev, false);
510 bt_dev_err(hu->hdev, "Failed to power down");
512 pm_runtime_set_suspended(bdev->dev);
514 mutex_unlock(&bcm_device_lock);
516 skb_queue_purge(&bcm->txq);
517 kfree_skb(bcm->rx_skb);
524 static int bcm_flush(struct hci_uart *hu)
526 struct bcm_data *bcm = hu->priv;
528 bt_dev_dbg(hu->hdev, "hu %p", hu);
530 skb_queue_purge(&bcm->txq);
535 static int bcm_setup(struct hci_uart *hu)
537 struct bcm_data *bcm = hu->priv;
539 const struct firmware *fw;
543 bt_dev_dbg(hu->hdev, "hu %p", hu);
545 hu->hdev->set_diag = bcm_set_diag;
546 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
548 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false);
552 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
554 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
558 err = btbcm_patchram(hu->hdev, fw);
560 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
564 /* Init speed if any */
566 speed = hu->init_speed;
567 else if (hu->proto->init_speed)
568 speed = hu->proto->init_speed;
573 host_set_baudrate(hu, speed);
575 /* Operational speed if any */
577 speed = hu->oper_speed;
578 else if (hu->proto->oper_speed)
579 speed = hu->proto->oper_speed;
584 err = bcm_set_baudrate(hu, speed);
586 host_set_baudrate(hu, speed);
590 release_firmware(fw);
592 err = btbcm_finalize(hu->hdev);
596 if (!bcm_request_irq(bcm))
597 err = bcm_setup_sleep(hu);
602 #define BCM_RECV_LM_DIAG \
603 .type = BCM_LM_DIAG_PKT, \
604 .hlen = BCM_LM_DIAG_SIZE, \
607 .maxlen = BCM_LM_DIAG_SIZE
609 #define BCM_RECV_NULL \
610 .type = BCM_NULL_PKT, \
611 .hlen = BCM_NULL_SIZE, \
614 .maxlen = BCM_NULL_SIZE
616 #define BCM_RECV_TYPE49 \
617 .type = BCM_TYPE49_PKT, \
618 .hlen = BCM_TYPE49_SIZE, \
621 .maxlen = BCM_TYPE49_SIZE
623 #define BCM_RECV_TYPE52 \
624 .type = BCM_TYPE52_PKT, \
625 .hlen = BCM_TYPE52_SIZE, \
628 .maxlen = BCM_TYPE52_SIZE
630 static const struct h4_recv_pkt bcm_recv_pkts[] = {
631 { H4_RECV_ACL, .recv = hci_recv_frame },
632 { H4_RECV_SCO, .recv = hci_recv_frame },
633 { H4_RECV_EVENT, .recv = hci_recv_frame },
634 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
635 { BCM_RECV_NULL, .recv = hci_recv_diag },
636 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
637 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
640 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
642 struct bcm_data *bcm = hu->priv;
644 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
647 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
648 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
649 if (IS_ERR(bcm->rx_skb)) {
650 int err = PTR_ERR(bcm->rx_skb);
651 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
654 } else if (!bcm->rx_skb) {
655 /* Delay auto-suspend when receiving completed packet */
656 mutex_lock(&bcm_device_lock);
657 if (bcm->dev && bcm_device_exists(bcm->dev)) {
658 pm_runtime_get(bcm->dev->dev);
659 pm_runtime_mark_last_busy(bcm->dev->dev);
660 pm_runtime_put_autosuspend(bcm->dev->dev);
662 mutex_unlock(&bcm_device_lock);
668 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
670 struct bcm_data *bcm = hu->priv;
672 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
674 /* Prepend skb with frame type */
675 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
676 skb_queue_tail(&bcm->txq, skb);
681 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
683 struct bcm_data *bcm = hu->priv;
684 struct sk_buff *skb = NULL;
685 struct bcm_device *bdev = NULL;
687 mutex_lock(&bcm_device_lock);
689 if (bcm_device_exists(bcm->dev)) {
691 pm_runtime_get_sync(bdev->dev);
692 /* Shall be resumed here */
695 skb = skb_dequeue(&bcm->txq);
698 pm_runtime_mark_last_busy(bdev->dev);
699 pm_runtime_put_autosuspend(bdev->dev);
702 mutex_unlock(&bcm_device_lock);
708 static int bcm_suspend_device(struct device *dev)
710 struct bcm_device *bdev = dev_get_drvdata(dev);
713 bt_dev_dbg(bdev, "");
715 if (!bdev->is_suspended && bdev->hu) {
716 hci_uart_set_flow_control(bdev->hu, true);
718 /* Once this returns, driver suspends BT via GPIO */
719 bdev->is_suspended = true;
722 /* Suspend the device */
723 err = bdev->set_device_wakeup(bdev, false);
725 if (bdev->is_suspended && bdev->hu) {
726 bdev->is_suspended = false;
727 hci_uart_set_flow_control(bdev->hu, false);
732 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
738 static int bcm_resume_device(struct device *dev)
740 struct bcm_device *bdev = dev_get_drvdata(dev);
743 bt_dev_dbg(bdev, "");
745 err = bdev->set_device_wakeup(bdev, true);
747 dev_err(dev, "Failed to power up\n");
751 bt_dev_dbg(bdev, "resume, delaying 15 ms");
754 /* When this executes, the device has woken up already */
755 if (bdev->is_suspended && bdev->hu) {
756 bdev->is_suspended = false;
758 hci_uart_set_flow_control(bdev->hu, false);
765 #ifdef CONFIG_PM_SLEEP
766 /* suspend callback */
767 static int bcm_suspend(struct device *dev)
769 struct bcm_device *bdev = dev_get_drvdata(dev);
772 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
775 * When used with a device instantiated as platform_device, bcm_suspend
776 * can be called at any time as long as the platform device is bound,
777 * so it should use bcm_device_lock to protect access to hci_uart
778 * and device_wake-up GPIO.
780 mutex_lock(&bcm_device_lock);
785 if (pm_runtime_active(dev))
786 bcm_suspend_device(dev);
788 if (device_may_wakeup(dev) && bdev->irq > 0) {
789 error = enable_irq_wake(bdev->irq);
791 bt_dev_dbg(bdev, "BCM irq: enabled");
795 mutex_unlock(&bcm_device_lock);
800 /* resume callback */
801 static int bcm_resume(struct device *dev)
803 struct bcm_device *bdev = dev_get_drvdata(dev);
806 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
809 * When used with a device instantiated as platform_device, bcm_resume
810 * can be called at any time as long as platform device is bound,
811 * so it should use bcm_device_lock to protect access to hci_uart
812 * and device_wake-up GPIO.
814 mutex_lock(&bcm_device_lock);
819 if (device_may_wakeup(dev) && bdev->irq > 0) {
820 disable_irq_wake(bdev->irq);
821 bt_dev_dbg(bdev, "BCM irq: disabled");
824 err = bcm_resume_device(dev);
827 mutex_unlock(&bcm_device_lock);
830 pm_runtime_disable(dev);
831 pm_runtime_set_active(dev);
832 pm_runtime_enable(dev);
839 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
840 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
841 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
843 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
844 { "device-wakeup-gpios", &first_gpio, 1 },
845 { "shutdown-gpios", &second_gpio, 1 },
846 { "host-wakeup-gpios", &third_gpio, 1 },
850 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
851 { "host-wakeup-gpios", &first_gpio, 1 },
852 { "device-wakeup-gpios", &second_gpio, 1 },
853 { "shutdown-gpios", &third_gpio, 1 },
857 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
858 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
860 .ident = "Meegopad T08",
862 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
863 "To be filled by OEM."),
864 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
865 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
872 static int bcm_resource(struct acpi_resource *ares, void *data)
874 struct bcm_device *dev = data;
875 struct acpi_resource_extended_irq *irq;
876 struct acpi_resource_gpio *gpio;
877 struct acpi_resource_uart_serialbus *sb;
879 switch (ares->type) {
880 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
881 irq = &ares->data.extended_irq;
882 if (irq->polarity != ACPI_ACTIVE_LOW)
883 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
884 dev->irq_active_low = true;
887 case ACPI_RESOURCE_TYPE_GPIO:
888 gpio = &ares->data.gpio;
889 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
890 dev->gpio_int_idx = dev->gpio_count;
891 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
896 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
897 sb = &ares->data.uart_serial_bus;
898 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
899 dev->init_speed = sb->default_baud_rate;
900 dev->oper_speed = 4000000;
911 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
913 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
919 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
921 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
928 static int bcm_apple_get_resources(struct bcm_device *dev)
930 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
931 const union acpi_object *obj;
934 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
935 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
936 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
939 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
940 obj->buffer.length == 8)
941 dev->init_speed = *(u64 *)obj->buffer.pointer;
943 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
944 dev->set_shutdown = bcm_apple_set_shutdown;
949 static inline int bcm_apple_get_resources(struct bcm_device *dev)
953 #endif /* CONFIG_ACPI */
955 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
957 gpiod_set_value_cansleep(dev->device_wakeup, awake);
961 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
963 gpiod_set_value_cansleep(dev->shutdown, powered);
967 /* Try a bunch of names for TXCO */
968 static struct clk *bcm_get_txco(struct device *dev)
972 /* New explicit name */
973 clk = devm_clk_get(dev, "txco");
974 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
977 /* Deprecated name */
978 clk = devm_clk_get(dev, "extclk");
979 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
982 /* Original code used no name at all */
983 return devm_clk_get(dev, NULL);
986 static int bcm_get_resources(struct bcm_device *dev)
988 const struct dmi_system_id *dmi_id;
991 dev->name = dev_name(dev->dev);
993 if (x86_apple_machine && !bcm_apple_get_resources(dev))
996 dev->txco_clk = bcm_get_txco(dev->dev);
998 /* Handle deferred probing */
999 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
1000 return PTR_ERR(dev->txco_clk);
1002 /* Ignore all other errors as before */
1003 if (IS_ERR(dev->txco_clk))
1004 dev->txco_clk = NULL;
1006 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
1007 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
1008 return PTR_ERR(dev->lpo_clk);
1010 if (IS_ERR(dev->lpo_clk))
1011 dev->lpo_clk = NULL;
1013 /* Check if we accidentally fetched the lpo clock twice */
1014 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1015 devm_clk_put(dev->dev, dev->txco_clk);
1016 dev->txco_clk = NULL;
1019 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1021 if (IS_ERR(dev->device_wakeup))
1022 return PTR_ERR(dev->device_wakeup);
1024 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1026 if (IS_ERR(dev->shutdown))
1027 return PTR_ERR(dev->shutdown);
1029 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1030 dev->set_shutdown = bcm_gpio_set_shutdown;
1032 dev->supplies[0].supply = "vbat";
1033 dev->supplies[1].supply = "vddio";
1034 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1039 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1040 if (dev->irq <= 0) {
1041 struct gpio_desc *gpio;
1043 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1046 return PTR_ERR(gpio);
1048 dev->irq = gpiod_to_irq(gpio);
1051 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1053 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1058 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1063 static int bcm_acpi_probe(struct bcm_device *dev)
1065 LIST_HEAD(resources);
1066 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1067 struct resource_entry *entry;
1070 /* Retrieve UART ACPI info */
1071 dev->gpio_int_idx = -1;
1072 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1073 &resources, bcm_resource, dev);
1077 resource_list_for_each_entry(entry, &resources) {
1078 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1079 dev->irq = entry->res->start;
1083 acpi_dev_free_resource_list(&resources);
1085 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1086 * only 2 GPIO resources, we use the irq-last mapping for this, since
1087 * we already have an irq the 3th / last mapping will not be used.
1090 gpio_mapping = acpi_bcm_int_last_gpios;
1091 else if (dev->gpio_int_idx == 0)
1092 gpio_mapping = acpi_bcm_int_first_gpios;
1093 else if (dev->gpio_int_idx == 2)
1094 gpio_mapping = acpi_bcm_int_last_gpios;
1096 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1099 /* Warn if our expectations are not met. */
1100 if (dev->gpio_count != (dev->irq ? 2 : 3))
1101 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1104 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1108 if (irq_polarity != -1) {
1109 dev->irq_active_low = irq_polarity;
1110 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1111 dev->irq_active_low ? "low" : "high");
1117 static int bcm_acpi_probe(struct bcm_device *dev)
1121 #endif /* CONFIG_ACPI */
1123 static int bcm_of_probe(struct bcm_device *bdev)
1125 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1129 static int bcm_probe(struct platform_device *pdev)
1131 struct bcm_device *dev;
1134 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1138 dev->dev = &pdev->dev;
1139 dev->irq = platform_get_irq(pdev, 0);
1141 if (has_acpi_companion(&pdev->dev)) {
1142 ret = bcm_acpi_probe(dev);
1147 ret = bcm_get_resources(dev);
1151 platform_set_drvdata(pdev, dev);
1153 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1155 /* Place this instance on the device list */
1156 mutex_lock(&bcm_device_lock);
1157 list_add_tail(&dev->list, &bcm_device_list);
1158 mutex_unlock(&bcm_device_lock);
1160 ret = bcm_gpio_set_power(dev, false);
1162 dev_err(&pdev->dev, "Failed to power down\n");
1167 static int bcm_remove(struct platform_device *pdev)
1169 struct bcm_device *dev = platform_get_drvdata(pdev);
1171 mutex_lock(&bcm_device_lock);
1172 list_del(&dev->list);
1173 mutex_unlock(&bcm_device_lock);
1175 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1180 static const struct hci_uart_proto bcm_proto = {
1184 .init_speed = 115200,
1189 .set_baudrate = bcm_set_baudrate,
1191 .enqueue = bcm_enqueue,
1192 .dequeue = bcm_dequeue,
1196 static const struct acpi_device_id bcm_acpi_match[] = {
1365 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1368 /* suspend and resume callbacks */
1369 static const struct dev_pm_ops bcm_pm_ops = {
1370 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1371 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1374 static struct platform_driver bcm_driver = {
1376 .remove = bcm_remove,
1379 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1384 static int bcm_serdev_probe(struct serdev_device *serdev)
1386 struct bcm_device *bcmdev;
1389 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1393 bcmdev->dev = &serdev->dev;
1395 bcmdev->hu = &bcmdev->serdev_hu;
1397 bcmdev->serdev_hu.serdev = serdev;
1398 serdev_device_set_drvdata(serdev, bcmdev);
1400 if (has_acpi_companion(&serdev->dev))
1401 err = bcm_acpi_probe(bcmdev);
1403 err = bcm_of_probe(bcmdev);
1407 err = bcm_get_resources(bcmdev);
1411 if (!bcmdev->shutdown) {
1412 dev_warn(&serdev->dev,
1413 "No reset resource, using default baud rate\n");
1414 bcmdev->oper_speed = bcmdev->init_speed;
1417 err = bcm_gpio_set_power(bcmdev, false);
1419 dev_err(&serdev->dev, "Failed to power down\n");
1421 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1424 static void bcm_serdev_remove(struct serdev_device *serdev)
1426 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1428 hci_uart_unregister_device(&bcmdev->serdev_hu);
1432 static const struct of_device_id bcm_bluetooth_of_match[] = {
1433 { .compatible = "brcm,bcm20702a1" },
1434 { .compatible = "brcm,bcm4330-bt" },
1435 { .compatible = "brcm,bcm43438-bt" },
1438 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1441 static struct serdev_device_driver bcm_serdev_driver = {
1442 .probe = bcm_serdev_probe,
1443 .remove = bcm_serdev_remove,
1445 .name = "hci_uart_bcm",
1446 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1447 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1452 int __init bcm_init(void)
1454 /* For now, we need to keep both platform device
1455 * driver (ACPI generated) and serdev driver (DT).
1457 platform_driver_register(&bcm_driver);
1458 serdev_device_driver_register(&bcm_serdev_driver);
1460 return hci_uart_register_proto(&bcm_proto);
1463 int __exit bcm_deinit(void)
1465 platform_driver_unregister(&bcm_driver);
1466 serdev_device_driver_unregister(&bcm_serdev_driver);
1468 return hci_uart_unregister_proto(&bcm_proto);