1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Bluetooth HCI UART driver for Broadcom devices
6 * Copyright (C) 2015 Intel Corporation
9 #include <linux/kernel.h>
10 #include <linux/errno.h>
11 #include <linux/skbuff.h>
12 #include <linux/firmware.h>
13 #include <linux/module.h>
14 #include <linux/acpi.h>
16 #include <linux/property.h>
17 #include <linux/platform_data/x86/apple.h>
18 #include <linux/platform_device.h>
19 #include <linux/regulator/consumer.h>
20 #include <linux/clk.h>
21 #include <linux/gpio/consumer.h>
22 #include <linux/tty.h>
23 #include <linux/interrupt.h>
24 #include <linux/dmi.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/serdev.h>
28 #include <net/bluetooth/bluetooth.h>
29 #include <net/bluetooth/hci_core.h>
34 #define BCM_NULL_PKT 0x00
35 #define BCM_NULL_SIZE 0
37 #define BCM_LM_DIAG_PKT 0x07
38 #define BCM_LM_DIAG_SIZE 63
40 #define BCM_TYPE49_PKT 0x31
41 #define BCM_TYPE49_SIZE 0
43 #define BCM_TYPE52_PKT 0x34
44 #define BCM_TYPE52_SIZE 0
46 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
48 #define BCM_NUM_SUPPLIES 2
51 * struct bcm_device - device driver resources
52 * @serdev_hu: HCI UART controller struct
53 * @list: bcm_device_list node
54 * @dev: physical UART slave
55 * @name: device name logged by bt_dev_*() functions
56 * @device_wakeup: BT_WAKE pin,
57 * assert = Bluetooth device must wake up or remain awake,
58 * deassert = Bluetooth device may sleep when sleep criteria are met
59 * @shutdown: BT_REG_ON pin,
60 * power up or power down Bluetooth device internal regulators
61 * @set_device_wakeup: callback to toggle BT_WAKE pin
62 * either by accessing @device_wakeup or by calling @btlp
63 * @set_shutdown: callback to toggle BT_REG_ON pin
64 * either by accessing @shutdown or by calling @btpu/@btpd
65 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
66 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
67 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
68 * @txco_clk: external reference frequency clock used by Bluetooth device
69 * @lpo_clk: external LPO clock used by Bluetooth device
70 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
71 * @res_enabled: whether clocks and supplies are prepared and enabled
72 * @init_speed: default baudrate of Bluetooth device;
73 * the host UART is initially set to this baudrate so that
74 * it can configure the Bluetooth device for @oper_speed
75 * @oper_speed: preferred baudrate of Bluetooth device;
76 * set to 0 if @init_speed is already the preferred baudrate
77 * @irq: interrupt triggered by HOST_WAKE_BT pin
78 * @irq_active_low: whether @irq is active low
79 * @hu: pointer to HCI UART controller struct,
80 * used to disable flow control during runtime suspend and system sleep
81 * @is_suspended: whether flow control is currently disabled
84 /* Must be the first member, hci_serdev.c expects this. */
85 struct hci_uart serdev_hu
;
86 struct list_head list
;
91 struct gpio_desc
*device_wakeup
;
92 struct gpio_desc
*shutdown
;
93 int (*set_device_wakeup
)(struct bcm_device
*, bool);
94 int (*set_shutdown
)(struct bcm_device
*, bool);
96 acpi_handle btlp
, btpu
, btpd
;
101 struct clk
*txco_clk
;
103 struct regulator_bulk_data supplies
[BCM_NUM_SUPPLIES
];
117 /* generic bcm uart resources */
119 struct sk_buff
*rx_skb
;
120 struct sk_buff_head txq
;
122 struct bcm_device
*dev
;
125 /* List of BCM BT UART devices */
126 static DEFINE_MUTEX(bcm_device_lock
);
127 static LIST_HEAD(bcm_device_list
);
129 static int irq_polarity
= -1;
130 module_param(irq_polarity
, int, 0444);
131 MODULE_PARM_DESC(irq_polarity
, "IRQ polarity 0: active-high 1: active-low");
133 static inline void host_set_baudrate(struct hci_uart
*hu
, unsigned int speed
)
136 serdev_device_set_baudrate(hu
->serdev
, speed
);
138 hci_uart_set_baudrate(hu
, speed
);
141 static int bcm_set_baudrate(struct hci_uart
*hu
, unsigned int speed
)
143 struct hci_dev
*hdev
= hu
->hdev
;
145 struct bcm_update_uart_baud_rate param
;
147 if (speed
> 3000000) {
148 struct bcm_write_uart_clock_setting clock
;
150 clock
.type
= BCM_UART_CLOCK_48MHZ
;
152 bt_dev_dbg(hdev
, "Set Controller clock (%d)", clock
.type
);
154 /* This Broadcom specific command changes the UART's controller
155 * clock for baud rate > 3000000.
157 skb
= __hci_cmd_sync(hdev
, 0xfc45, 1, &clock
, HCI_INIT_TIMEOUT
);
159 int err
= PTR_ERR(skb
);
160 bt_dev_err(hdev
, "BCM: failed to write clock (%d)",
168 bt_dev_dbg(hdev
, "Set Controller UART speed to %d bit/s", speed
);
170 param
.zero
= cpu_to_le16(0);
171 param
.baud_rate
= cpu_to_le32(speed
);
173 /* This Broadcom specific command changes the UART's controller baud
176 skb
= __hci_cmd_sync(hdev
, 0xfc18, sizeof(param
), ¶m
,
179 int err
= PTR_ERR(skb
);
180 bt_dev_err(hdev
, "BCM: failed to write update baudrate (%d)",
190 /* bcm_device_exists should be protected by bcm_device_lock */
191 static bool bcm_device_exists(struct bcm_device
*device
)
196 /* Devices using serdev always exist */
197 if (device
&& device
->hu
&& device
->hu
->serdev
)
201 list_for_each(p
, &bcm_device_list
) {
202 struct bcm_device
*dev
= list_entry(p
, struct bcm_device
, list
);
211 static int bcm_gpio_set_power(struct bcm_device
*dev
, bool powered
)
215 if (powered
&& !dev
->res_enabled
) {
216 /* Intel Macs use bcm_apple_get_resources() and don't
217 * have regulator supplies configured.
219 if (dev
->supplies
[0].supply
) {
220 err
= regulator_bulk_enable(BCM_NUM_SUPPLIES
,
226 /* LPO clock needs to be 32.768 kHz */
227 err
= clk_set_rate(dev
->lpo_clk
, 32768);
229 dev_err(dev
->dev
, "Could not set LPO clock rate\n");
230 goto err_regulator_disable
;
233 err
= clk_prepare_enable(dev
->lpo_clk
);
235 goto err_regulator_disable
;
237 err
= clk_prepare_enable(dev
->txco_clk
);
239 goto err_lpo_clk_disable
;
242 err
= dev
->set_shutdown(dev
, powered
);
244 goto err_txco_clk_disable
;
246 err
= dev
->set_device_wakeup(dev
, powered
);
248 goto err_revert_shutdown
;
250 if (!powered
&& dev
->res_enabled
) {
251 clk_disable_unprepare(dev
->txco_clk
);
252 clk_disable_unprepare(dev
->lpo_clk
);
254 /* Intel Macs use bcm_apple_get_resources() and don't
255 * have regulator supplies configured.
257 if (dev
->supplies
[0].supply
)
258 regulator_bulk_disable(BCM_NUM_SUPPLIES
,
262 /* wait for device to power on and come out of reset */
263 usleep_range(100000, 120000);
265 dev
->res_enabled
= powered
;
270 dev
->set_shutdown(dev
, !powered
);
271 err_txco_clk_disable
:
272 if (powered
&& !dev
->res_enabled
)
273 clk_disable_unprepare(dev
->txco_clk
);
275 if (powered
&& !dev
->res_enabled
)
276 clk_disable_unprepare(dev
->lpo_clk
);
277 err_regulator_disable
:
278 if (powered
&& !dev
->res_enabled
)
279 regulator_bulk_disable(BCM_NUM_SUPPLIES
, dev
->supplies
);
284 static irqreturn_t
bcm_host_wake(int irq
, void *data
)
286 struct bcm_device
*bdev
= data
;
288 bt_dev_dbg(bdev
, "Host wake IRQ");
290 pm_runtime_get(bdev
->dev
);
291 pm_runtime_mark_last_busy(bdev
->dev
);
292 pm_runtime_put_autosuspend(bdev
->dev
);
297 static int bcm_request_irq(struct bcm_data
*bcm
)
299 struct bcm_device
*bdev
= bcm
->dev
;
302 mutex_lock(&bcm_device_lock
);
303 if (!bcm_device_exists(bdev
)) {
308 if (bdev
->irq
<= 0) {
313 err
= devm_request_irq(bdev
->dev
, bdev
->irq
, bcm_host_wake
,
314 bdev
->irq_active_low
? IRQF_TRIGGER_FALLING
:
322 device_init_wakeup(bdev
->dev
, true);
324 pm_runtime_set_autosuspend_delay(bdev
->dev
,
325 BCM_AUTOSUSPEND_DELAY
);
326 pm_runtime_use_autosuspend(bdev
->dev
);
327 pm_runtime_set_active(bdev
->dev
);
328 pm_runtime_enable(bdev
->dev
);
331 mutex_unlock(&bcm_device_lock
);
336 static const struct bcm_set_sleep_mode default_sleep_params
= {
337 .sleep_mode
= 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
338 .idle_host
= 2, /* idle threshold HOST, in 300ms */
339 .idle_dev
= 2, /* idle threshold device, in 300ms */
340 .bt_wake_active
= 1, /* BT_WAKE active mode: 1 = high, 0 = low */
341 .host_wake_active
= 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
342 .allow_host_sleep
= 1, /* Allow host sleep in SCO flag */
343 .combine_modes
= 1, /* Combine sleep and LPM flag */
344 .tristate_control
= 0, /* Allow tri-state control of UART tx flag */
345 /* Irrelevant USB flags */
347 .usb_resume_timeout
= 0,
349 .pulsed_host_wake
= 1,
352 static int bcm_setup_sleep(struct hci_uart
*hu
)
354 struct bcm_data
*bcm
= hu
->priv
;
356 struct bcm_set_sleep_mode sleep_params
= default_sleep_params
;
358 sleep_params
.host_wake_active
= !bcm
->dev
->irq_active_low
;
360 skb
= __hci_cmd_sync(hu
->hdev
, 0xfc27, sizeof(sleep_params
),
361 &sleep_params
, HCI_INIT_TIMEOUT
);
363 int err
= PTR_ERR(skb
);
364 bt_dev_err(hu
->hdev
, "Sleep VSC failed (%d)", err
);
369 bt_dev_dbg(hu
->hdev
, "Set Sleep Parameters VSC succeeded");
374 static inline int bcm_request_irq(struct bcm_data
*bcm
) { return 0; }
375 static inline int bcm_setup_sleep(struct hci_uart
*hu
) { return 0; }
378 static int bcm_set_diag(struct hci_dev
*hdev
, bool enable
)
380 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
381 struct bcm_data
*bcm
= hu
->priv
;
384 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
387 skb
= bt_skb_alloc(3, GFP_KERNEL
);
391 skb_put_u8(skb
, BCM_LM_DIAG_PKT
);
392 skb_put_u8(skb
, 0xf0);
393 skb_put_u8(skb
, enable
);
395 skb_queue_tail(&bcm
->txq
, skb
);
396 hci_uart_tx_wakeup(hu
);
401 static int bcm_open(struct hci_uart
*hu
)
403 struct bcm_data
*bcm
;
407 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
409 if (!hci_uart_has_flow_control(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 hci_uart_set_flow_control(hu
, true);
449 hu
->init_speed
= bcm
->dev
->init_speed
;
450 hu
->oper_speed
= bcm
->dev
->oper_speed
;
451 err
= bcm_gpio_set_power(bcm
->dev
, true);
452 hci_uart_set_flow_control(hu
, false);
457 mutex_unlock(&bcm_device_lock
);
465 mutex_unlock(&bcm_device_lock
);
471 static int bcm_close(struct hci_uart
*hu
)
473 struct bcm_data
*bcm
= hu
->priv
;
474 struct bcm_device
*bdev
= NULL
;
477 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
479 /* Protect bcm->dev against removal of the device or driver */
480 mutex_lock(&bcm_device_lock
);
483 bdev
= serdev_device_get_drvdata(hu
->serdev
);
484 } else if (bcm_device_exists(bcm
->dev
)) {
492 if (IS_ENABLED(CONFIG_PM
) && bdev
->irq
> 0) {
493 devm_free_irq(bdev
->dev
, bdev
->irq
, bdev
);
494 device_init_wakeup(bdev
->dev
, false);
495 pm_runtime_disable(bdev
->dev
);
498 err
= bcm_gpio_set_power(bdev
, false);
500 bt_dev_err(hu
->hdev
, "Failed to power down");
502 pm_runtime_set_suspended(bdev
->dev
);
504 mutex_unlock(&bcm_device_lock
);
506 skb_queue_purge(&bcm
->txq
);
507 kfree_skb(bcm
->rx_skb
);
514 static int bcm_flush(struct hci_uart
*hu
)
516 struct bcm_data
*bcm
= hu
->priv
;
518 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
520 skb_queue_purge(&bcm
->txq
);
525 static int bcm_setup(struct hci_uart
*hu
)
527 struct bcm_data
*bcm
= hu
->priv
;
529 const struct firmware
*fw
;
533 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
535 hu
->hdev
->set_diag
= bcm_set_diag
;
536 hu
->hdev
->set_bdaddr
= btbcm_set_bdaddr
;
538 err
= btbcm_initialize(hu
->hdev
, fw_name
, sizeof(fw_name
), false);
542 err
= request_firmware(&fw
, fw_name
, &hu
->hdev
->dev
);
544 bt_dev_info(hu
->hdev
, "BCM: Patch %s not found", fw_name
);
548 err
= btbcm_patchram(hu
->hdev
, fw
);
550 bt_dev_info(hu
->hdev
, "BCM: Patch failed (%d)", err
);
554 /* Init speed if any */
556 speed
= hu
->init_speed
;
557 else if (hu
->proto
->init_speed
)
558 speed
= hu
->proto
->init_speed
;
563 host_set_baudrate(hu
, speed
);
565 /* Operational speed if any */
567 speed
= hu
->oper_speed
;
568 else if (hu
->proto
->oper_speed
)
569 speed
= hu
->proto
->oper_speed
;
574 err
= bcm_set_baudrate(hu
, speed
);
576 host_set_baudrate(hu
, speed
);
580 release_firmware(fw
);
582 err
= btbcm_finalize(hu
->hdev
);
586 if (!bcm_request_irq(bcm
))
587 err
= bcm_setup_sleep(hu
);
592 #define BCM_RECV_LM_DIAG \
593 .type = BCM_LM_DIAG_PKT, \
594 .hlen = BCM_LM_DIAG_SIZE, \
597 .maxlen = BCM_LM_DIAG_SIZE
599 #define BCM_RECV_NULL \
600 .type = BCM_NULL_PKT, \
601 .hlen = BCM_NULL_SIZE, \
604 .maxlen = BCM_NULL_SIZE
606 #define BCM_RECV_TYPE49 \
607 .type = BCM_TYPE49_PKT, \
608 .hlen = BCM_TYPE49_SIZE, \
611 .maxlen = BCM_TYPE49_SIZE
613 #define BCM_RECV_TYPE52 \
614 .type = BCM_TYPE52_PKT, \
615 .hlen = BCM_TYPE52_SIZE, \
618 .maxlen = BCM_TYPE52_SIZE
620 static const struct h4_recv_pkt bcm_recv_pkts
[] = {
621 { H4_RECV_ACL
, .recv
= hci_recv_frame
},
622 { H4_RECV_SCO
, .recv
= hci_recv_frame
},
623 { H4_RECV_EVENT
, .recv
= hci_recv_frame
},
624 { BCM_RECV_LM_DIAG
, .recv
= hci_recv_diag
},
625 { BCM_RECV_NULL
, .recv
= hci_recv_diag
},
626 { BCM_RECV_TYPE49
, .recv
= hci_recv_diag
},
627 { BCM_RECV_TYPE52
, .recv
= hci_recv_diag
},
630 static int bcm_recv(struct hci_uart
*hu
, const void *data
, int count
)
632 struct bcm_data
*bcm
= hu
->priv
;
634 if (!test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
637 bcm
->rx_skb
= h4_recv_buf(hu
->hdev
, bcm
->rx_skb
, data
, count
,
638 bcm_recv_pkts
, ARRAY_SIZE(bcm_recv_pkts
));
639 if (IS_ERR(bcm
->rx_skb
)) {
640 int err
= PTR_ERR(bcm
->rx_skb
);
641 bt_dev_err(hu
->hdev
, "Frame reassembly failed (%d)", err
);
644 } else if (!bcm
->rx_skb
) {
645 /* Delay auto-suspend when receiving completed packet */
646 mutex_lock(&bcm_device_lock
);
647 if (bcm
->dev
&& bcm_device_exists(bcm
->dev
)) {
648 pm_runtime_get(bcm
->dev
->dev
);
649 pm_runtime_mark_last_busy(bcm
->dev
->dev
);
650 pm_runtime_put_autosuspend(bcm
->dev
->dev
);
652 mutex_unlock(&bcm_device_lock
);
658 static int bcm_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
660 struct bcm_data
*bcm
= hu
->priv
;
662 bt_dev_dbg(hu
->hdev
, "hu %p skb %p", hu
, skb
);
664 /* Prepend skb with frame type */
665 memcpy(skb_push(skb
, 1), &hci_skb_pkt_type(skb
), 1);
666 skb_queue_tail(&bcm
->txq
, skb
);
671 static struct sk_buff
*bcm_dequeue(struct hci_uart
*hu
)
673 struct bcm_data
*bcm
= hu
->priv
;
674 struct sk_buff
*skb
= NULL
;
675 struct bcm_device
*bdev
= NULL
;
677 mutex_lock(&bcm_device_lock
);
679 if (bcm_device_exists(bcm
->dev
)) {
681 pm_runtime_get_sync(bdev
->dev
);
682 /* Shall be resumed here */
685 skb
= skb_dequeue(&bcm
->txq
);
688 pm_runtime_mark_last_busy(bdev
->dev
);
689 pm_runtime_put_autosuspend(bdev
->dev
);
692 mutex_unlock(&bcm_device_lock
);
698 static int bcm_suspend_device(struct device
*dev
)
700 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
703 bt_dev_dbg(bdev
, "");
705 if (!bdev
->is_suspended
&& bdev
->hu
) {
706 hci_uart_set_flow_control(bdev
->hu
, true);
708 /* Once this returns, driver suspends BT via GPIO */
709 bdev
->is_suspended
= true;
712 /* Suspend the device */
713 err
= bdev
->set_device_wakeup(bdev
, false);
715 if (bdev
->is_suspended
&& bdev
->hu
) {
716 bdev
->is_suspended
= false;
717 hci_uart_set_flow_control(bdev
->hu
, false);
722 bt_dev_dbg(bdev
, "suspend, delaying 15 ms");
728 static int bcm_resume_device(struct device
*dev
)
730 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
733 bt_dev_dbg(bdev
, "");
735 err
= bdev
->set_device_wakeup(bdev
, true);
737 dev_err(dev
, "Failed to power up\n");
741 bt_dev_dbg(bdev
, "resume, delaying 15 ms");
744 /* When this executes, the device has woken up already */
745 if (bdev
->is_suspended
&& bdev
->hu
) {
746 bdev
->is_suspended
= false;
748 hci_uart_set_flow_control(bdev
->hu
, false);
755 #ifdef CONFIG_PM_SLEEP
756 /* suspend callback */
757 static int bcm_suspend(struct device
*dev
)
759 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
762 bt_dev_dbg(bdev
, "suspend: is_suspended %d", bdev
->is_suspended
);
765 * When used with a device instantiated as platform_device, bcm_suspend
766 * can be called at any time as long as the platform device is bound,
767 * so it should use bcm_device_lock to protect access to hci_uart
768 * and device_wake-up GPIO.
770 mutex_lock(&bcm_device_lock
);
775 if (pm_runtime_active(dev
))
776 bcm_suspend_device(dev
);
778 if (device_may_wakeup(dev
) && bdev
->irq
> 0) {
779 error
= enable_irq_wake(bdev
->irq
);
781 bt_dev_dbg(bdev
, "BCM irq: enabled");
785 mutex_unlock(&bcm_device_lock
);
790 /* resume callback */
791 static int bcm_resume(struct device
*dev
)
793 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
796 bt_dev_dbg(bdev
, "resume: is_suspended %d", bdev
->is_suspended
);
799 * When used with a device instantiated as platform_device, bcm_resume
800 * can be called at any time as long as platform device is bound,
801 * so it should use bcm_device_lock to protect access to hci_uart
802 * and device_wake-up GPIO.
804 mutex_lock(&bcm_device_lock
);
809 if (device_may_wakeup(dev
) && bdev
->irq
> 0) {
810 disable_irq_wake(bdev
->irq
);
811 bt_dev_dbg(bdev
, "BCM irq: disabled");
814 err
= bcm_resume_device(dev
);
817 mutex_unlock(&bcm_device_lock
);
820 pm_runtime_disable(dev
);
821 pm_runtime_set_active(dev
);
822 pm_runtime_enable(dev
);
829 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
830 static const struct dmi_system_id bcm_broken_irq_dmi_table
[] = {
832 .ident
= "Meegopad T08",
834 DMI_EXACT_MATCH(DMI_BOARD_VENDOR
,
835 "To be filled by OEM."),
836 DMI_EXACT_MATCH(DMI_BOARD_NAME
, "T3 MRD"),
837 DMI_EXACT_MATCH(DMI_BOARD_VERSION
, "V1.1"),
844 static const struct acpi_gpio_params first_gpio
= { 0, 0, false };
845 static const struct acpi_gpio_params second_gpio
= { 1, 0, false };
846 static const struct acpi_gpio_params third_gpio
= { 2, 0, false };
848 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios
[] = {
849 { "device-wakeup-gpios", &first_gpio
, 1 },
850 { "shutdown-gpios", &second_gpio
, 1 },
851 { "host-wakeup-gpios", &third_gpio
, 1 },
855 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios
[] = {
856 { "host-wakeup-gpios", &first_gpio
, 1 },
857 { "device-wakeup-gpios", &second_gpio
, 1 },
858 { "shutdown-gpios", &third_gpio
, 1 },
862 static int bcm_resource(struct acpi_resource
*ares
, void *data
)
864 struct bcm_device
*dev
= data
;
865 struct acpi_resource_extended_irq
*irq
;
866 struct acpi_resource_gpio
*gpio
;
867 struct acpi_resource_uart_serialbus
*sb
;
869 switch (ares
->type
) {
870 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ
:
871 irq
= &ares
->data
.extended_irq
;
872 if (irq
->polarity
!= ACPI_ACTIVE_LOW
)
873 dev_info(dev
->dev
, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
874 dev
->irq_active_low
= true;
877 case ACPI_RESOURCE_TYPE_GPIO
:
878 gpio
= &ares
->data
.gpio
;
879 if (gpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
) {
880 dev
->gpio_int_idx
= dev
->gpio_count
;
881 dev
->irq_active_low
= gpio
->polarity
== ACPI_ACTIVE_LOW
;
886 case ACPI_RESOURCE_TYPE_SERIAL_BUS
:
887 sb
= &ares
->data
.uart_serial_bus
;
888 if (sb
->type
== ACPI_RESOURCE_SERIAL_TYPE_UART
) {
889 dev
->init_speed
= sb
->default_baud_rate
;
890 dev
->oper_speed
= 4000000;
901 static int bcm_apple_set_device_wakeup(struct bcm_device
*dev
, bool awake
)
903 if (ACPI_FAILURE(acpi_execute_simple_method(dev
->btlp
, NULL
, !awake
)))
909 static int bcm_apple_set_shutdown(struct bcm_device
*dev
, bool powered
)
911 if (ACPI_FAILURE(acpi_evaluate_object(powered
? dev
->btpu
: dev
->btpd
,
918 static int bcm_apple_get_resources(struct bcm_device
*dev
)
920 struct acpi_device
*adev
= ACPI_COMPANION(dev
->dev
);
921 const union acpi_object
*obj
;
924 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTLP", &dev
->btlp
)) ||
925 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTPU", &dev
->btpu
)) ||
926 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTPD", &dev
->btpd
)))
929 if (!acpi_dev_get_property(adev
, "baud", ACPI_TYPE_BUFFER
, &obj
) &&
930 obj
->buffer
.length
== 8)
931 dev
->init_speed
= *(u64
*)obj
->buffer
.pointer
;
933 dev
->set_device_wakeup
= bcm_apple_set_device_wakeup
;
934 dev
->set_shutdown
= bcm_apple_set_shutdown
;
939 static inline int bcm_apple_get_resources(struct bcm_device
*dev
)
943 #endif /* CONFIG_ACPI */
945 static int bcm_gpio_set_device_wakeup(struct bcm_device
*dev
, bool awake
)
947 gpiod_set_value_cansleep(dev
->device_wakeup
, awake
);
951 static int bcm_gpio_set_shutdown(struct bcm_device
*dev
, bool powered
)
953 gpiod_set_value_cansleep(dev
->shutdown
, powered
);
957 /* Try a bunch of names for TXCO */
958 static struct clk
*bcm_get_txco(struct device
*dev
)
962 /* New explicit name */
963 clk
= devm_clk_get(dev
, "txco");
964 if (!IS_ERR(clk
) || PTR_ERR(clk
) == -EPROBE_DEFER
)
967 /* Deprecated name */
968 clk
= devm_clk_get(dev
, "extclk");
969 if (!IS_ERR(clk
) || PTR_ERR(clk
) == -EPROBE_DEFER
)
972 /* Original code used no name at all */
973 return devm_clk_get(dev
, NULL
);
976 static int bcm_get_resources(struct bcm_device
*dev
)
978 const struct dmi_system_id
*dmi_id
;
981 dev
->name
= dev_name(dev
->dev
);
983 if (x86_apple_machine
&& !bcm_apple_get_resources(dev
))
986 dev
->txco_clk
= bcm_get_txco(dev
->dev
);
988 /* Handle deferred probing */
989 if (dev
->txco_clk
== ERR_PTR(-EPROBE_DEFER
))
990 return PTR_ERR(dev
->txco_clk
);
992 /* Ignore all other errors as before */
993 if (IS_ERR(dev
->txco_clk
))
994 dev
->txco_clk
= NULL
;
996 dev
->lpo_clk
= devm_clk_get(dev
->dev
, "lpo");
997 if (dev
->lpo_clk
== ERR_PTR(-EPROBE_DEFER
))
998 return PTR_ERR(dev
->lpo_clk
);
1000 if (IS_ERR(dev
->lpo_clk
))
1001 dev
->lpo_clk
= NULL
;
1003 /* Check if we accidentally fetched the lpo clock twice */
1004 if (dev
->lpo_clk
&& clk_is_match(dev
->lpo_clk
, dev
->txco_clk
)) {
1005 devm_clk_put(dev
->dev
, dev
->txco_clk
);
1006 dev
->txco_clk
= NULL
;
1009 dev
->device_wakeup
= devm_gpiod_get_optional(dev
->dev
, "device-wakeup",
1011 if (IS_ERR(dev
->device_wakeup
))
1012 return PTR_ERR(dev
->device_wakeup
);
1014 dev
->shutdown
= devm_gpiod_get_optional(dev
->dev
, "shutdown",
1016 if (IS_ERR(dev
->shutdown
))
1017 return PTR_ERR(dev
->shutdown
);
1019 dev
->set_device_wakeup
= bcm_gpio_set_device_wakeup
;
1020 dev
->set_shutdown
= bcm_gpio_set_shutdown
;
1022 dev
->supplies
[0].supply
= "vbat";
1023 dev
->supplies
[1].supply
= "vddio";
1024 err
= devm_regulator_bulk_get(dev
->dev
, BCM_NUM_SUPPLIES
,
1029 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1030 if (dev
->irq
<= 0) {
1031 struct gpio_desc
*gpio
;
1033 gpio
= devm_gpiod_get_optional(dev
->dev
, "host-wakeup",
1036 return PTR_ERR(gpio
);
1038 dev
->irq
= gpiod_to_irq(gpio
);
1041 dmi_id
= dmi_first_match(bcm_broken_irq_dmi_table
);
1043 dev_info(dev
->dev
, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1048 dev_dbg(dev
->dev
, "BCM irq: %d\n", dev
->irq
);
1053 static int bcm_acpi_probe(struct bcm_device
*dev
)
1055 LIST_HEAD(resources
);
1056 const struct acpi_gpio_mapping
*gpio_mapping
= acpi_bcm_int_last_gpios
;
1057 struct resource_entry
*entry
;
1060 /* Retrieve UART ACPI info */
1061 dev
->gpio_int_idx
= -1;
1062 ret
= acpi_dev_get_resources(ACPI_COMPANION(dev
->dev
),
1063 &resources
, bcm_resource
, dev
);
1067 resource_list_for_each_entry(entry
, &resources
) {
1068 if (resource_type(entry
->res
) == IORESOURCE_IRQ
) {
1069 dev
->irq
= entry
->res
->start
;
1073 acpi_dev_free_resource_list(&resources
);
1075 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1076 * only 2 GPIO resources, we use the irq-last mapping for this, since
1077 * we already have an irq the 3th / last mapping will not be used.
1080 gpio_mapping
= acpi_bcm_int_last_gpios
;
1081 else if (dev
->gpio_int_idx
== 0)
1082 gpio_mapping
= acpi_bcm_int_first_gpios
;
1083 else if (dev
->gpio_int_idx
== 2)
1084 gpio_mapping
= acpi_bcm_int_last_gpios
;
1086 dev_warn(dev
->dev
, "Unexpected ACPI gpio_int_idx: %d\n",
1089 /* Warn if our expectations are not met. */
1090 if (dev
->gpio_count
!= (dev
->irq
? 2 : 3))
1091 dev_warn(dev
->dev
, "Unexpected number of ACPI GPIOs: %d\n",
1094 ret
= devm_acpi_dev_add_driver_gpios(dev
->dev
, gpio_mapping
);
1098 if (irq_polarity
!= -1) {
1099 dev
->irq_active_low
= irq_polarity
;
1100 dev_warn(dev
->dev
, "Overwriting IRQ polarity to active %s by module-param\n",
1101 dev
->irq_active_low
? "low" : "high");
1107 static int bcm_acpi_probe(struct bcm_device
*dev
)
1111 #endif /* CONFIG_ACPI */
1113 static int bcm_of_probe(struct bcm_device
*bdev
)
1115 device_property_read_u32(bdev
->dev
, "max-speed", &bdev
->oper_speed
);
1119 static int bcm_probe(struct platform_device
*pdev
)
1121 struct bcm_device
*dev
;
1124 dev
= devm_kzalloc(&pdev
->dev
, sizeof(*dev
), GFP_KERNEL
);
1128 dev
->dev
= &pdev
->dev
;
1129 dev
->irq
= platform_get_irq(pdev
, 0);
1131 if (has_acpi_companion(&pdev
->dev
)) {
1132 ret
= bcm_acpi_probe(dev
);
1137 ret
= bcm_get_resources(dev
);
1141 platform_set_drvdata(pdev
, dev
);
1143 dev_info(&pdev
->dev
, "%s device registered.\n", dev
->name
);
1145 /* Place this instance on the device list */
1146 mutex_lock(&bcm_device_lock
);
1147 list_add_tail(&dev
->list
, &bcm_device_list
);
1148 mutex_unlock(&bcm_device_lock
);
1150 ret
= bcm_gpio_set_power(dev
, false);
1152 dev_err(&pdev
->dev
, "Failed to power down\n");
1157 static int bcm_remove(struct platform_device
*pdev
)
1159 struct bcm_device
*dev
= platform_get_drvdata(pdev
);
1161 mutex_lock(&bcm_device_lock
);
1162 list_del(&dev
->list
);
1163 mutex_unlock(&bcm_device_lock
);
1165 dev_info(&pdev
->dev
, "%s device unregistered.\n", dev
->name
);
1170 static const struct hci_uart_proto bcm_proto
= {
1174 .init_speed
= 115200,
1179 .set_baudrate
= bcm_set_baudrate
,
1181 .enqueue
= bcm_enqueue
,
1182 .dequeue
= bcm_dequeue
,
1186 static const struct acpi_device_id bcm_acpi_match
[] = {
1355 MODULE_DEVICE_TABLE(acpi
, bcm_acpi_match
);
1358 /* suspend and resume callbacks */
1359 static const struct dev_pm_ops bcm_pm_ops
= {
1360 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend
, bcm_resume
)
1361 SET_RUNTIME_PM_OPS(bcm_suspend_device
, bcm_resume_device
, NULL
)
1364 static struct platform_driver bcm_driver
= {
1366 .remove
= bcm_remove
,
1369 .acpi_match_table
= ACPI_PTR(bcm_acpi_match
),
1374 static int bcm_serdev_probe(struct serdev_device
*serdev
)
1376 struct bcm_device
*bcmdev
;
1379 bcmdev
= devm_kzalloc(&serdev
->dev
, sizeof(*bcmdev
), GFP_KERNEL
);
1383 bcmdev
->dev
= &serdev
->dev
;
1385 bcmdev
->hu
= &bcmdev
->serdev_hu
;
1387 bcmdev
->serdev_hu
.serdev
= serdev
;
1388 serdev_device_set_drvdata(serdev
, bcmdev
);
1390 if (has_acpi_companion(&serdev
->dev
))
1391 err
= bcm_acpi_probe(bcmdev
);
1393 err
= bcm_of_probe(bcmdev
);
1397 err
= bcm_get_resources(bcmdev
);
1401 if (!bcmdev
->shutdown
) {
1402 dev_warn(&serdev
->dev
,
1403 "No reset resource, using default baud rate\n");
1404 bcmdev
->oper_speed
= bcmdev
->init_speed
;
1407 err
= bcm_gpio_set_power(bcmdev
, false);
1409 dev_err(&serdev
->dev
, "Failed to power down\n");
1411 return hci_uart_register_device(&bcmdev
->serdev_hu
, &bcm_proto
);
1414 static void bcm_serdev_remove(struct serdev_device
*serdev
)
1416 struct bcm_device
*bcmdev
= serdev_device_get_drvdata(serdev
);
1418 hci_uart_unregister_device(&bcmdev
->serdev_hu
);
1422 static const struct of_device_id bcm_bluetooth_of_match
[] = {
1423 { .compatible
= "brcm,bcm20702a1" },
1424 { .compatible
= "brcm,bcm4345c5" },
1425 { .compatible
= "brcm,bcm4330-bt" },
1426 { .compatible
= "brcm,bcm43438-bt" },
1427 { .compatible
= "brcm,bcm43540-bt" },
1428 { .compatible
= "brcm,bcm4335a0" },
1431 MODULE_DEVICE_TABLE(of
, bcm_bluetooth_of_match
);
1434 static struct serdev_device_driver bcm_serdev_driver
= {
1435 .probe
= bcm_serdev_probe
,
1436 .remove
= bcm_serdev_remove
,
1438 .name
= "hci_uart_bcm",
1439 .of_match_table
= of_match_ptr(bcm_bluetooth_of_match
),
1440 .acpi_match_table
= ACPI_PTR(bcm_acpi_match
),
1445 int __init
bcm_init(void)
1447 /* For now, we need to keep both platform device
1448 * driver (ACPI generated) and serdev driver (DT).
1450 platform_driver_register(&bcm_driver
);
1451 serdev_device_driver_register(&bcm_serdev_driver
);
1453 return hci_uart_register_proto(&bcm_proto
);
1456 int __exit
bcm_deinit(void)
1458 platform_driver_unregister(&bcm_driver
);
1459 serdev_device_driver_unregister(&bcm_serdev_driver
);
1461 return hci_uart_unregister_proto(&bcm_proto
);