1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Bluetooth HCI UART driver for Broadcom devices
6 * Copyright (C) 2015 Intel Corporation
9 #include <linux/kernel.h>
10 #include <linux/errno.h>
11 #include <linux/skbuff.h>
12 #include <linux/firmware.h>
13 #include <linux/module.h>
14 #include <linux/acpi.h>
16 #include <linux/of_irq.h>
17 #include <linux/property.h>
18 #include <linux/platform_data/x86/apple.h>
19 #include <linux/platform_device.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/clk.h>
22 #include <linux/gpio/consumer.h>
23 #include <linux/tty.h>
24 #include <linux/interrupt.h>
25 #include <linux/dmi.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/serdev.h>
29 #include <net/bluetooth/bluetooth.h>
30 #include <net/bluetooth/hci_core.h>
35 #define BCM_NULL_PKT 0x00
36 #define BCM_NULL_SIZE 0
38 #define BCM_LM_DIAG_PKT 0x07
39 #define BCM_LM_DIAG_SIZE 63
41 #define BCM_TYPE49_PKT 0x31
42 #define BCM_TYPE49_SIZE 0
44 #define BCM_TYPE52_PKT 0x34
45 #define BCM_TYPE52_SIZE 0
47 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
49 #define BCM_NUM_SUPPLIES 2
52 * struct bcm_device_data - device specific data
53 * @no_early_set_baudrate: Disallow set baudrate before driver setup()
55 struct bcm_device_data
{
56 bool no_early_set_baudrate
;
57 bool drive_rts_on_open
;
61 * struct bcm_device - device driver resources
62 * @serdev_hu: HCI UART controller struct
63 * @list: bcm_device_list node
64 * @dev: physical UART slave
65 * @name: device name logged by bt_dev_*() functions
66 * @device_wakeup: BT_WAKE pin,
67 * assert = Bluetooth device must wake up or remain awake,
68 * deassert = Bluetooth device may sleep when sleep criteria are met
69 * @shutdown: BT_REG_ON pin,
70 * power up or power down Bluetooth device internal regulators
71 * @set_device_wakeup: callback to toggle BT_WAKE pin
72 * either by accessing @device_wakeup or by calling @btlp
73 * @set_shutdown: callback to toggle BT_REG_ON pin
74 * either by accessing @shutdown or by calling @btpu/@btpd
75 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
76 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
77 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
78 * @txco_clk: external reference frequency clock used by Bluetooth device
79 * @lpo_clk: external LPO clock used by Bluetooth device
80 * @supplies: VBAT and VDDIO supplies used by Bluetooth device
81 * @res_enabled: whether clocks and supplies are prepared and enabled
82 * @init_speed: default baudrate of Bluetooth device;
83 * the host UART is initially set to this baudrate so that
84 * it can configure the Bluetooth device for @oper_speed
85 * @oper_speed: preferred baudrate of Bluetooth device;
86 * set to 0 if @init_speed is already the preferred baudrate
87 * @irq: interrupt triggered by HOST_WAKE_BT pin
88 * @irq_active_low: whether @irq is active low
89 * @hu: pointer to HCI UART controller struct,
90 * used to disable flow control during runtime suspend and system sleep
91 * @is_suspended: whether flow control is currently disabled
92 * @no_early_set_baudrate: don't set_baudrate before setup()
95 /* Must be the first member, hci_serdev.c expects this. */
96 struct hci_uart serdev_hu
;
97 struct list_head list
;
102 struct gpio_desc
*device_wakeup
;
103 struct gpio_desc
*shutdown
;
104 int (*set_device_wakeup
)(struct bcm_device
*, bool);
105 int (*set_shutdown
)(struct bcm_device
*, bool);
107 acpi_handle btlp
, btpu
, btpd
;
112 struct clk
*txco_clk
;
114 struct regulator_bulk_data supplies
[BCM_NUM_SUPPLIES
];
127 bool no_early_set_baudrate
;
128 bool drive_rts_on_open
;
129 u8 pcm_int_params
[5];
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(100000, 120000);
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 bdev
->irq_acquired
= true;
339 device_init_wakeup(bdev
->dev
, true);
341 pm_runtime_set_autosuspend_delay(bdev
->dev
,
342 BCM_AUTOSUSPEND_DELAY
);
343 pm_runtime_use_autosuspend(bdev
->dev
);
344 pm_runtime_set_active(bdev
->dev
);
345 pm_runtime_enable(bdev
->dev
);
348 mutex_unlock(&bcm_device_lock
);
353 static const struct bcm_set_sleep_mode default_sleep_params
= {
354 .sleep_mode
= 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
355 .idle_host
= 2, /* idle threshold HOST, in 300ms */
356 .idle_dev
= 2, /* idle threshold device, in 300ms */
357 .bt_wake_active
= 1, /* BT_WAKE active mode: 1 = high, 0 = low */
358 .host_wake_active
= 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
359 .allow_host_sleep
= 1, /* Allow host sleep in SCO flag */
360 .combine_modes
= 1, /* Combine sleep and LPM flag */
361 .tristate_control
= 0, /* Allow tri-state control of UART tx flag */
362 /* Irrelevant USB flags */
364 .usb_resume_timeout
= 0,
366 .pulsed_host_wake
= 1,
369 static int bcm_setup_sleep(struct hci_uart
*hu
)
371 struct bcm_data
*bcm
= hu
->priv
;
373 struct bcm_set_sleep_mode sleep_params
= default_sleep_params
;
375 sleep_params
.host_wake_active
= !bcm
->dev
->irq_active_low
;
377 skb
= __hci_cmd_sync(hu
->hdev
, 0xfc27, sizeof(sleep_params
),
378 &sleep_params
, HCI_INIT_TIMEOUT
);
380 int err
= PTR_ERR(skb
);
381 bt_dev_err(hu
->hdev
, "Sleep VSC failed (%d)", err
);
386 bt_dev_dbg(hu
->hdev
, "Set Sleep Parameters VSC succeeded");
391 static inline int bcm_request_irq(struct bcm_data
*bcm
) { return 0; }
392 static inline int bcm_setup_sleep(struct hci_uart
*hu
) { return 0; }
395 static int bcm_set_diag(struct hci_dev
*hdev
, bool enable
)
397 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
398 struct bcm_data
*bcm
= hu
->priv
;
401 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
404 skb
= bt_skb_alloc(3, GFP_KERNEL
);
408 skb_put_u8(skb
, BCM_LM_DIAG_PKT
);
409 skb_put_u8(skb
, 0xf0);
410 skb_put_u8(skb
, enable
);
412 skb_queue_tail(&bcm
->txq
, skb
);
413 hci_uart_tx_wakeup(hu
);
418 static int bcm_open(struct hci_uart
*hu
)
420 struct bcm_data
*bcm
;
424 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
426 if (!hci_uart_has_flow_control(hu
))
429 bcm
= kzalloc(sizeof(*bcm
), GFP_KERNEL
);
433 skb_queue_head_init(&bcm
->txq
);
437 mutex_lock(&bcm_device_lock
);
440 bcm
->dev
= serdev_device_get_drvdata(hu
->serdev
);
447 list_for_each(p
, &bcm_device_list
) {
448 struct bcm_device
*dev
= list_entry(p
, struct bcm_device
, list
);
450 /* Retrieve saved bcm_device based on parent of the
451 * platform device (saved during device probe) and
452 * parent of tty device used by hci_uart
454 if (hu
->tty
->dev
->parent
== dev
->dev
->parent
) {
465 if (bcm
->dev
->drive_rts_on_open
)
466 hci_uart_set_flow_control(hu
, true);
468 hu
->init_speed
= bcm
->dev
->init_speed
;
470 /* If oper_speed is set, ldisc/serdev will set the baudrate
471 * before calling setup()
473 if (!bcm
->dev
->no_early_set_baudrate
)
474 hu
->oper_speed
= bcm
->dev
->oper_speed
;
476 err
= bcm_gpio_set_power(bcm
->dev
, true);
478 if (bcm
->dev
->drive_rts_on_open
)
479 hci_uart_set_flow_control(hu
, false);
485 mutex_unlock(&bcm_device_lock
);
493 mutex_unlock(&bcm_device_lock
);
499 static int bcm_close(struct hci_uart
*hu
)
501 struct bcm_data
*bcm
= hu
->priv
;
502 struct bcm_device
*bdev
= NULL
;
505 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
507 /* Protect bcm->dev against removal of the device or driver */
508 mutex_lock(&bcm_device_lock
);
511 bdev
= serdev_device_get_drvdata(hu
->serdev
);
512 } else if (bcm_device_exists(bcm
->dev
)) {
520 if (IS_ENABLED(CONFIG_PM
) && bdev
->irq_acquired
) {
521 devm_free_irq(bdev
->dev
, bdev
->irq
, bdev
);
522 device_init_wakeup(bdev
->dev
, false);
523 pm_runtime_disable(bdev
->dev
);
526 err
= bcm_gpio_set_power(bdev
, false);
528 bt_dev_err(hu
->hdev
, "Failed to power down");
530 pm_runtime_set_suspended(bdev
->dev
);
532 mutex_unlock(&bcm_device_lock
);
534 skb_queue_purge(&bcm
->txq
);
535 kfree_skb(bcm
->rx_skb
);
542 static int bcm_flush(struct hci_uart
*hu
)
544 struct bcm_data
*bcm
= hu
->priv
;
546 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
548 skb_queue_purge(&bcm
->txq
);
553 static int bcm_setup(struct hci_uart
*hu
)
555 struct bcm_data
*bcm
= hu
->priv
;
556 bool fw_load_done
= false;
560 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
562 hu
->hdev
->set_diag
= bcm_set_diag
;
563 hu
->hdev
->set_bdaddr
= btbcm_set_bdaddr
;
565 err
= btbcm_initialize(hu
->hdev
, &fw_load_done
);
572 /* Init speed if any */
574 speed
= hu
->init_speed
;
575 else if (hu
->proto
->init_speed
)
576 speed
= hu
->proto
->init_speed
;
581 host_set_baudrate(hu
, speed
);
583 /* Operational speed if any */
585 speed
= hu
->oper_speed
;
586 else if (bcm
->dev
&& bcm
->dev
->oper_speed
)
587 speed
= bcm
->dev
->oper_speed
;
588 else if (hu
->proto
->oper_speed
)
589 speed
= hu
->proto
->oper_speed
;
594 err
= bcm_set_baudrate(hu
, speed
);
596 host_set_baudrate(hu
, speed
);
599 /* PCM parameters if provided */
600 if (bcm
->dev
&& bcm
->dev
->pcm_int_params
[0] != 0xff) {
601 struct bcm_set_pcm_int_params params
;
603 btbcm_read_pcm_int_params(hu
->hdev
, ¶ms
);
605 memcpy(¶ms
, bcm
->dev
->pcm_int_params
, 5);
606 btbcm_write_pcm_int_params(hu
->hdev
, ¶ms
);
609 err
= btbcm_finalize(hu
->hdev
, &fw_load_done
);
613 /* Some devices ship with the controller default address.
614 * Allow the bootloader to set a valid address through the
617 set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY
, &hu
->hdev
->quirks
);
619 if (!bcm_request_irq(bcm
))
620 err
= bcm_setup_sleep(hu
);
625 #define BCM_RECV_LM_DIAG \
626 .type = BCM_LM_DIAG_PKT, \
627 .hlen = BCM_LM_DIAG_SIZE, \
630 .maxlen = BCM_LM_DIAG_SIZE
632 #define BCM_RECV_NULL \
633 .type = BCM_NULL_PKT, \
634 .hlen = BCM_NULL_SIZE, \
637 .maxlen = BCM_NULL_SIZE
639 #define BCM_RECV_TYPE49 \
640 .type = BCM_TYPE49_PKT, \
641 .hlen = BCM_TYPE49_SIZE, \
644 .maxlen = BCM_TYPE49_SIZE
646 #define BCM_RECV_TYPE52 \
647 .type = BCM_TYPE52_PKT, \
648 .hlen = BCM_TYPE52_SIZE, \
651 .maxlen = BCM_TYPE52_SIZE
653 static const struct h4_recv_pkt bcm_recv_pkts
[] = {
654 { H4_RECV_ACL
, .recv
= hci_recv_frame
},
655 { H4_RECV_SCO
, .recv
= hci_recv_frame
},
656 { H4_RECV_EVENT
, .recv
= hci_recv_frame
},
657 { BCM_RECV_LM_DIAG
, .recv
= hci_recv_diag
},
658 { BCM_RECV_NULL
, .recv
= hci_recv_diag
},
659 { BCM_RECV_TYPE49
, .recv
= hci_recv_diag
},
660 { BCM_RECV_TYPE52
, .recv
= hci_recv_diag
},
663 static int bcm_recv(struct hci_uart
*hu
, const void *data
, int count
)
665 struct bcm_data
*bcm
= hu
->priv
;
667 if (!test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
670 bcm
->rx_skb
= h4_recv_buf(hu
->hdev
, bcm
->rx_skb
, data
, count
,
671 bcm_recv_pkts
, ARRAY_SIZE(bcm_recv_pkts
));
672 if (IS_ERR(bcm
->rx_skb
)) {
673 int err
= PTR_ERR(bcm
->rx_skb
);
674 bt_dev_err(hu
->hdev
, "Frame reassembly failed (%d)", err
);
677 } else if (!bcm
->rx_skb
) {
678 /* Delay auto-suspend when receiving completed packet */
679 mutex_lock(&bcm_device_lock
);
680 if (bcm
->dev
&& bcm_device_exists(bcm
->dev
)) {
681 pm_runtime_get(bcm
->dev
->dev
);
682 pm_runtime_mark_last_busy(bcm
->dev
->dev
);
683 pm_runtime_put_autosuspend(bcm
->dev
->dev
);
685 mutex_unlock(&bcm_device_lock
);
691 static int bcm_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
693 struct bcm_data
*bcm
= hu
->priv
;
695 bt_dev_dbg(hu
->hdev
, "hu %p skb %p", hu
, skb
);
697 /* Prepend skb with frame type */
698 memcpy(skb_push(skb
, 1), &hci_skb_pkt_type(skb
), 1);
699 skb_queue_tail(&bcm
->txq
, skb
);
704 static struct sk_buff
*bcm_dequeue(struct hci_uart
*hu
)
706 struct bcm_data
*bcm
= hu
->priv
;
707 struct sk_buff
*skb
= NULL
;
708 struct bcm_device
*bdev
= NULL
;
710 mutex_lock(&bcm_device_lock
);
712 if (bcm_device_exists(bcm
->dev
)) {
714 pm_runtime_get_sync(bdev
->dev
);
715 /* Shall be resumed here */
718 skb
= skb_dequeue(&bcm
->txq
);
721 pm_runtime_mark_last_busy(bdev
->dev
);
722 pm_runtime_put_autosuspend(bdev
->dev
);
725 mutex_unlock(&bcm_device_lock
);
731 static int bcm_suspend_device(struct device
*dev
)
733 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
736 bt_dev_dbg(bdev
, "");
738 if (!bdev
->is_suspended
&& bdev
->hu
) {
739 hci_uart_set_flow_control(bdev
->hu
, true);
741 /* Once this returns, driver suspends BT via GPIO */
742 bdev
->is_suspended
= true;
745 /* Suspend the device */
746 err
= bdev
->set_device_wakeup(bdev
, false);
748 if (bdev
->is_suspended
&& bdev
->hu
) {
749 bdev
->is_suspended
= false;
750 hci_uart_set_flow_control(bdev
->hu
, false);
755 bt_dev_dbg(bdev
, "suspend, delaying 15 ms");
761 static int bcm_resume_device(struct device
*dev
)
763 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
766 bt_dev_dbg(bdev
, "");
768 err
= bdev
->set_device_wakeup(bdev
, true);
770 dev_err(dev
, "Failed to power up\n");
774 bt_dev_dbg(bdev
, "resume, delaying 15 ms");
777 /* When this executes, the device has woken up already */
778 if (bdev
->is_suspended
&& bdev
->hu
) {
779 bdev
->is_suspended
= false;
781 hci_uart_set_flow_control(bdev
->hu
, false);
788 #ifdef CONFIG_PM_SLEEP
789 /* suspend callback */
790 static int bcm_suspend(struct device
*dev
)
792 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
795 bt_dev_dbg(bdev
, "suspend: is_suspended %d", bdev
->is_suspended
);
798 * When used with a device instantiated as platform_device, bcm_suspend
799 * can be called at any time as long as the platform device is bound,
800 * so it should use bcm_device_lock to protect access to hci_uart
801 * and device_wake-up GPIO.
803 mutex_lock(&bcm_device_lock
);
808 if (pm_runtime_active(dev
))
809 bcm_suspend_device(dev
);
811 if (device_may_wakeup(dev
) && bdev
->irq
> 0) {
812 error
= enable_irq_wake(bdev
->irq
);
814 bt_dev_dbg(bdev
, "BCM irq: enabled");
818 mutex_unlock(&bcm_device_lock
);
823 /* resume callback */
824 static int bcm_resume(struct device
*dev
)
826 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
829 bt_dev_dbg(bdev
, "resume: is_suspended %d", bdev
->is_suspended
);
832 * When used with a device instantiated as platform_device, bcm_resume
833 * can be called at any time as long as platform device is bound,
834 * so it should use bcm_device_lock to protect access to hci_uart
835 * and device_wake-up GPIO.
837 mutex_lock(&bcm_device_lock
);
842 if (device_may_wakeup(dev
) && bdev
->irq
> 0) {
843 disable_irq_wake(bdev
->irq
);
844 bt_dev_dbg(bdev
, "BCM irq: disabled");
847 err
= bcm_resume_device(dev
);
850 mutex_unlock(&bcm_device_lock
);
853 pm_runtime_disable(dev
);
854 pm_runtime_set_active(dev
);
855 pm_runtime_enable(dev
);
862 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
863 static const struct dmi_system_id bcm_broken_irq_dmi_table
[] = {
865 .ident
= "Meegopad T08",
867 DMI_EXACT_MATCH(DMI_BOARD_VENDOR
,
868 "To be filled by OEM."),
869 DMI_EXACT_MATCH(DMI_BOARD_NAME
, "T3 MRD"),
870 DMI_EXACT_MATCH(DMI_BOARD_VERSION
, "V1.1"),
877 static const struct acpi_gpio_params first_gpio
= { 0, 0, false };
878 static const struct acpi_gpio_params second_gpio
= { 1, 0, false };
879 static const struct acpi_gpio_params third_gpio
= { 2, 0, false };
881 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios
[] = {
882 { "device-wakeup-gpios", &first_gpio
, 1 },
883 { "shutdown-gpios", &second_gpio
, 1 },
884 { "host-wakeup-gpios", &third_gpio
, 1 },
888 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios
[] = {
889 { "host-wakeup-gpios", &first_gpio
, 1 },
890 { "device-wakeup-gpios", &second_gpio
, 1 },
891 { "shutdown-gpios", &third_gpio
, 1 },
895 static int bcm_resource(struct acpi_resource
*ares
, void *data
)
897 struct bcm_device
*dev
= data
;
898 struct acpi_resource_extended_irq
*irq
;
899 struct acpi_resource_gpio
*gpio
;
900 struct acpi_resource_uart_serialbus
*sb
;
902 switch (ares
->type
) {
903 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ
:
904 irq
= &ares
->data
.extended_irq
;
905 if (irq
->polarity
!= ACPI_ACTIVE_LOW
)
906 dev_info(dev
->dev
, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
907 dev
->irq_active_low
= true;
910 case ACPI_RESOURCE_TYPE_GPIO
:
911 gpio
= &ares
->data
.gpio
;
912 if (gpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
) {
913 dev
->gpio_int_idx
= dev
->gpio_count
;
914 dev
->irq_active_low
= gpio
->polarity
== ACPI_ACTIVE_LOW
;
919 case ACPI_RESOURCE_TYPE_SERIAL_BUS
:
920 sb
= &ares
->data
.uart_serial_bus
;
921 if (sb
->type
== ACPI_RESOURCE_SERIAL_TYPE_UART
) {
922 dev
->init_speed
= sb
->default_baud_rate
;
923 dev
->oper_speed
= 4000000;
934 static int bcm_apple_set_device_wakeup(struct bcm_device
*dev
, bool awake
)
936 if (ACPI_FAILURE(acpi_execute_simple_method(dev
->btlp
, NULL
, !awake
)))
942 static int bcm_apple_set_shutdown(struct bcm_device
*dev
, bool powered
)
944 if (ACPI_FAILURE(acpi_evaluate_object(powered
? dev
->btpu
: dev
->btpd
,
951 static int bcm_apple_get_resources(struct bcm_device
*dev
)
953 struct acpi_device
*adev
= ACPI_COMPANION(dev
->dev
);
954 const union acpi_object
*obj
;
957 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTLP", &dev
->btlp
)) ||
958 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTPU", &dev
->btpu
)) ||
959 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTPD", &dev
->btpd
)))
962 if (!acpi_dev_get_property(adev
, "baud", ACPI_TYPE_BUFFER
, &obj
) &&
963 obj
->buffer
.length
== 8)
964 dev
->init_speed
= *(u64
*)obj
->buffer
.pointer
;
966 dev
->set_device_wakeup
= bcm_apple_set_device_wakeup
;
967 dev
->set_shutdown
= bcm_apple_set_shutdown
;
972 static inline int bcm_apple_get_resources(struct bcm_device
*dev
)
976 #endif /* CONFIG_ACPI */
978 static int bcm_gpio_set_device_wakeup(struct bcm_device
*dev
, bool awake
)
980 gpiod_set_value_cansleep(dev
->device_wakeup
, awake
);
984 static int bcm_gpio_set_shutdown(struct bcm_device
*dev
, bool powered
)
986 gpiod_set_value_cansleep(dev
->shutdown
, powered
);
990 /* Try a bunch of names for TXCO */
991 static struct clk
*bcm_get_txco(struct device
*dev
)
995 /* New explicit name */
996 clk
= devm_clk_get(dev
, "txco");
997 if (!IS_ERR(clk
) || PTR_ERR(clk
) == -EPROBE_DEFER
)
1000 /* Deprecated name */
1001 clk
= devm_clk_get(dev
, "extclk");
1002 if (!IS_ERR(clk
) || PTR_ERR(clk
) == -EPROBE_DEFER
)
1005 /* Original code used no name at all */
1006 return devm_clk_get(dev
, NULL
);
1009 static int bcm_get_resources(struct bcm_device
*dev
)
1011 const struct dmi_system_id
*dmi_id
;
1014 dev
->name
= dev_name(dev
->dev
);
1016 if (x86_apple_machine
&& !bcm_apple_get_resources(dev
))
1019 dev
->txco_clk
= bcm_get_txco(dev
->dev
);
1021 /* Handle deferred probing */
1022 if (dev
->txco_clk
== ERR_PTR(-EPROBE_DEFER
))
1023 return PTR_ERR(dev
->txco_clk
);
1025 /* Ignore all other errors as before */
1026 if (IS_ERR(dev
->txco_clk
))
1027 dev
->txco_clk
= NULL
;
1029 dev
->lpo_clk
= devm_clk_get(dev
->dev
, "lpo");
1030 if (dev
->lpo_clk
== ERR_PTR(-EPROBE_DEFER
))
1031 return PTR_ERR(dev
->lpo_clk
);
1033 if (IS_ERR(dev
->lpo_clk
))
1034 dev
->lpo_clk
= NULL
;
1036 /* Check if we accidentally fetched the lpo clock twice */
1037 if (dev
->lpo_clk
&& clk_is_match(dev
->lpo_clk
, dev
->txco_clk
)) {
1038 devm_clk_put(dev
->dev
, dev
->txco_clk
);
1039 dev
->txco_clk
= NULL
;
1042 dev
->device_wakeup
= devm_gpiod_get_optional(dev
->dev
, "device-wakeup",
1044 if (IS_ERR(dev
->device_wakeup
))
1045 return PTR_ERR(dev
->device_wakeup
);
1047 dev
->shutdown
= devm_gpiod_get_optional(dev
->dev
, "shutdown",
1049 if (IS_ERR(dev
->shutdown
))
1050 return PTR_ERR(dev
->shutdown
);
1052 dev
->set_device_wakeup
= bcm_gpio_set_device_wakeup
;
1053 dev
->set_shutdown
= bcm_gpio_set_shutdown
;
1055 dev
->supplies
[0].supply
= "vbat";
1056 dev
->supplies
[1].supply
= "vddio";
1057 err
= devm_regulator_bulk_get(dev
->dev
, BCM_NUM_SUPPLIES
,
1062 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1063 if (dev
->irq
<= 0) {
1064 struct gpio_desc
*gpio
;
1066 gpio
= devm_gpiod_get_optional(dev
->dev
, "host-wakeup",
1069 return PTR_ERR(gpio
);
1071 dev
->irq
= gpiod_to_irq(gpio
);
1074 dmi_id
= dmi_first_match(bcm_broken_irq_dmi_table
);
1076 dev_info(dev
->dev
, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1081 dev_dbg(dev
->dev
, "BCM irq: %d\n", dev
->irq
);
1086 static int bcm_acpi_probe(struct bcm_device
*dev
)
1088 LIST_HEAD(resources
);
1089 const struct acpi_gpio_mapping
*gpio_mapping
= acpi_bcm_int_last_gpios
;
1090 struct resource_entry
*entry
;
1093 /* Retrieve UART ACPI info */
1094 dev
->gpio_int_idx
= -1;
1095 ret
= acpi_dev_get_resources(ACPI_COMPANION(dev
->dev
),
1096 &resources
, bcm_resource
, dev
);
1100 resource_list_for_each_entry(entry
, &resources
) {
1101 if (resource_type(entry
->res
) == IORESOURCE_IRQ
) {
1102 dev
->irq
= entry
->res
->start
;
1106 acpi_dev_free_resource_list(&resources
);
1108 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1109 * only 2 GPIO resources, we use the irq-last mapping for this, since
1110 * we already have an irq the 3th / last mapping will not be used.
1113 gpio_mapping
= acpi_bcm_int_last_gpios
;
1114 else if (dev
->gpio_int_idx
== 0)
1115 gpio_mapping
= acpi_bcm_int_first_gpios
;
1116 else if (dev
->gpio_int_idx
== 2)
1117 gpio_mapping
= acpi_bcm_int_last_gpios
;
1119 dev_warn(dev
->dev
, "Unexpected ACPI gpio_int_idx: %d\n",
1122 /* Warn if our expectations are not met. */
1123 if (dev
->gpio_count
!= (dev
->irq
? 2 : 3))
1124 dev_warn(dev
->dev
, "Unexpected number of ACPI GPIOs: %d\n",
1127 ret
= devm_acpi_dev_add_driver_gpios(dev
->dev
, gpio_mapping
);
1131 if (irq_polarity
!= -1) {
1132 dev
->irq_active_low
= irq_polarity
;
1133 dev_warn(dev
->dev
, "Overwriting IRQ polarity to active %s by module-param\n",
1134 dev
->irq_active_low
? "low" : "high");
1140 static int bcm_acpi_probe(struct bcm_device
*dev
)
1144 #endif /* CONFIG_ACPI */
1146 static int bcm_of_probe(struct bcm_device
*bdev
)
1148 device_property_read_u32(bdev
->dev
, "max-speed", &bdev
->oper_speed
);
1149 device_property_read_u8_array(bdev
->dev
, "brcm,bt-pcm-int-params",
1150 bdev
->pcm_int_params
, 5);
1151 bdev
->irq
= of_irq_get_byname(bdev
->dev
->of_node
, "host-wakeup");
1152 bdev
->irq_active_low
= irq_get_trigger_type(bdev
->irq
)
1153 & (IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_LEVEL_LOW
);
1157 static int bcm_probe(struct platform_device
*pdev
)
1159 struct bcm_device
*dev
;
1162 dev
= devm_kzalloc(&pdev
->dev
, sizeof(*dev
), GFP_KERNEL
);
1166 dev
->dev
= &pdev
->dev
;
1167 dev
->irq
= platform_get_irq(pdev
, 0);
1169 /* Initialize routing field to an unused value */
1170 dev
->pcm_int_params
[0] = 0xff;
1172 if (has_acpi_companion(&pdev
->dev
)) {
1173 ret
= bcm_acpi_probe(dev
);
1178 ret
= bcm_get_resources(dev
);
1182 platform_set_drvdata(pdev
, dev
);
1184 dev_info(&pdev
->dev
, "%s device registered.\n", dev
->name
);
1186 /* Place this instance on the device list */
1187 mutex_lock(&bcm_device_lock
);
1188 list_add_tail(&dev
->list
, &bcm_device_list
);
1189 mutex_unlock(&bcm_device_lock
);
1191 ret
= bcm_gpio_set_power(dev
, false);
1193 dev_err(&pdev
->dev
, "Failed to power down\n");
1198 static int bcm_remove(struct platform_device
*pdev
)
1200 struct bcm_device
*dev
= platform_get_drvdata(pdev
);
1202 mutex_lock(&bcm_device_lock
);
1203 list_del(&dev
->list
);
1204 mutex_unlock(&bcm_device_lock
);
1206 dev_info(&pdev
->dev
, "%s device unregistered.\n", dev
->name
);
1211 static const struct hci_uart_proto bcm_proto
= {
1215 .init_speed
= 115200,
1220 .set_baudrate
= bcm_set_baudrate
,
1222 .enqueue
= bcm_enqueue
,
1223 .dequeue
= bcm_dequeue
,
1227 static const struct acpi_device_id bcm_acpi_match
[] = {
1396 MODULE_DEVICE_TABLE(acpi
, bcm_acpi_match
);
1399 /* suspend and resume callbacks */
1400 static const struct dev_pm_ops bcm_pm_ops
= {
1401 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend
, bcm_resume
)
1402 SET_RUNTIME_PM_OPS(bcm_suspend_device
, bcm_resume_device
, NULL
)
1405 static struct platform_driver bcm_driver
= {
1407 .remove
= bcm_remove
,
1410 .acpi_match_table
= ACPI_PTR(bcm_acpi_match
),
1415 static int bcm_serdev_probe(struct serdev_device
*serdev
)
1417 struct bcm_device
*bcmdev
;
1418 const struct bcm_device_data
*data
;
1421 bcmdev
= devm_kzalloc(&serdev
->dev
, sizeof(*bcmdev
), GFP_KERNEL
);
1425 bcmdev
->dev
= &serdev
->dev
;
1427 bcmdev
->hu
= &bcmdev
->serdev_hu
;
1429 bcmdev
->serdev_hu
.serdev
= serdev
;
1430 serdev_device_set_drvdata(serdev
, bcmdev
);
1432 /* Initialize routing field to an unused value */
1433 bcmdev
->pcm_int_params
[0] = 0xff;
1435 if (has_acpi_companion(&serdev
->dev
))
1436 err
= bcm_acpi_probe(bcmdev
);
1438 err
= bcm_of_probe(bcmdev
);
1442 err
= bcm_get_resources(bcmdev
);
1446 if (!bcmdev
->shutdown
) {
1447 dev_warn(&serdev
->dev
,
1448 "No reset resource, using default baud rate\n");
1449 bcmdev
->oper_speed
= bcmdev
->init_speed
;
1452 err
= bcm_gpio_set_power(bcmdev
, false);
1454 dev_err(&serdev
->dev
, "Failed to power down\n");
1456 data
= device_get_match_data(bcmdev
->dev
);
1458 bcmdev
->no_early_set_baudrate
= data
->no_early_set_baudrate
;
1459 bcmdev
->drive_rts_on_open
= data
->drive_rts_on_open
;
1462 return hci_uart_register_device(&bcmdev
->serdev_hu
, &bcm_proto
);
1465 static void bcm_serdev_remove(struct serdev_device
*serdev
)
1467 struct bcm_device
*bcmdev
= serdev_device_get_drvdata(serdev
);
1469 hci_uart_unregister_device(&bcmdev
->serdev_hu
);
1473 static struct bcm_device_data bcm4354_device_data
= {
1474 .no_early_set_baudrate
= true,
1477 static struct bcm_device_data bcm43438_device_data
= {
1478 .drive_rts_on_open
= true,
1481 static const struct of_device_id bcm_bluetooth_of_match
[] = {
1482 { .compatible
= "brcm,bcm20702a1" },
1483 { .compatible
= "brcm,bcm4329-bt" },
1484 { .compatible
= "brcm,bcm4345c5" },
1485 { .compatible
= "brcm,bcm4330-bt" },
1486 { .compatible
= "brcm,bcm43438-bt", .data
= &bcm43438_device_data
},
1487 { .compatible
= "brcm,bcm43540-bt", .data
= &bcm4354_device_data
},
1488 { .compatible
= "brcm,bcm4335a0" },
1491 MODULE_DEVICE_TABLE(of
, bcm_bluetooth_of_match
);
1494 static struct serdev_device_driver bcm_serdev_driver
= {
1495 .probe
= bcm_serdev_probe
,
1496 .remove
= bcm_serdev_remove
,
1498 .name
= "hci_uart_bcm",
1499 .of_match_table
= of_match_ptr(bcm_bluetooth_of_match
),
1500 .acpi_match_table
= ACPI_PTR(bcm_acpi_match
),
1505 int __init
bcm_init(void)
1507 /* For now, we need to keep both platform device
1508 * driver (ACPI generated) and serdev driver (DT).
1510 platform_driver_register(&bcm_driver
);
1511 serdev_device_driver_register(&bcm_serdev_driver
);
1513 return hci_uart_register_proto(&bcm_proto
);
1516 int __exit
bcm_deinit(void)
1518 platform_driver_unregister(&bcm_driver
);
1519 serdev_device_driver_unregister(&bcm_serdev_driver
);
1521 return hci_uart_unregister_proto(&bcm_proto
);