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
];
126 bool no_early_set_baudrate
;
127 bool drive_rts_on_open
;
128 u8 pcm_int_params
[5];
131 /* generic bcm uart resources */
133 struct sk_buff
*rx_skb
;
134 struct sk_buff_head txq
;
136 struct bcm_device
*dev
;
139 /* List of BCM BT UART devices */
140 static DEFINE_MUTEX(bcm_device_lock
);
141 static LIST_HEAD(bcm_device_list
);
143 static int irq_polarity
= -1;
144 module_param(irq_polarity
, int, 0444);
145 MODULE_PARM_DESC(irq_polarity
, "IRQ polarity 0: active-high 1: active-low");
147 static inline void host_set_baudrate(struct hci_uart
*hu
, unsigned int speed
)
150 serdev_device_set_baudrate(hu
->serdev
, speed
);
152 hci_uart_set_baudrate(hu
, speed
);
155 static int bcm_set_baudrate(struct hci_uart
*hu
, unsigned int speed
)
157 struct hci_dev
*hdev
= hu
->hdev
;
159 struct bcm_update_uart_baud_rate param
;
161 if (speed
> 3000000) {
162 struct bcm_write_uart_clock_setting clock
;
164 clock
.type
= BCM_UART_CLOCK_48MHZ
;
166 bt_dev_dbg(hdev
, "Set Controller clock (%d)", clock
.type
);
168 /* This Broadcom specific command changes the UART's controller
169 * clock for baud rate > 3000000.
171 skb
= __hci_cmd_sync(hdev
, 0xfc45, 1, &clock
, HCI_INIT_TIMEOUT
);
173 int err
= PTR_ERR(skb
);
174 bt_dev_err(hdev
, "BCM: failed to write clock (%d)",
182 bt_dev_dbg(hdev
, "Set Controller UART speed to %d bit/s", speed
);
184 param
.zero
= cpu_to_le16(0);
185 param
.baud_rate
= cpu_to_le32(speed
);
187 /* This Broadcom specific command changes the UART's controller baud
190 skb
= __hci_cmd_sync(hdev
, 0xfc18, sizeof(param
), ¶m
,
193 int err
= PTR_ERR(skb
);
194 bt_dev_err(hdev
, "BCM: failed to write update baudrate (%d)",
204 /* bcm_device_exists should be protected by bcm_device_lock */
205 static bool bcm_device_exists(struct bcm_device
*device
)
210 /* Devices using serdev always exist */
211 if (device
&& device
->hu
&& device
->hu
->serdev
)
215 list_for_each(p
, &bcm_device_list
) {
216 struct bcm_device
*dev
= list_entry(p
, struct bcm_device
, list
);
225 static int bcm_gpio_set_power(struct bcm_device
*dev
, bool powered
)
229 if (powered
&& !dev
->res_enabled
) {
230 /* Intel Macs use bcm_apple_get_resources() and don't
231 * have regulator supplies configured.
233 if (dev
->supplies
[0].supply
) {
234 err
= regulator_bulk_enable(BCM_NUM_SUPPLIES
,
240 /* LPO clock needs to be 32.768 kHz */
241 err
= clk_set_rate(dev
->lpo_clk
, 32768);
243 dev_err(dev
->dev
, "Could not set LPO clock rate\n");
244 goto err_regulator_disable
;
247 err
= clk_prepare_enable(dev
->lpo_clk
);
249 goto err_regulator_disable
;
251 err
= clk_prepare_enable(dev
->txco_clk
);
253 goto err_lpo_clk_disable
;
256 err
= dev
->set_shutdown(dev
, powered
);
258 goto err_txco_clk_disable
;
260 err
= dev
->set_device_wakeup(dev
, powered
);
262 goto err_revert_shutdown
;
264 if (!powered
&& dev
->res_enabled
) {
265 clk_disable_unprepare(dev
->txco_clk
);
266 clk_disable_unprepare(dev
->lpo_clk
);
268 /* Intel Macs use bcm_apple_get_resources() and don't
269 * have regulator supplies configured.
271 if (dev
->supplies
[0].supply
)
272 regulator_bulk_disable(BCM_NUM_SUPPLIES
,
276 /* wait for device to power on and come out of reset */
277 usleep_range(100000, 120000);
279 dev
->res_enabled
= powered
;
284 dev
->set_shutdown(dev
, !powered
);
285 err_txco_clk_disable
:
286 if (powered
&& !dev
->res_enabled
)
287 clk_disable_unprepare(dev
->txco_clk
);
289 if (powered
&& !dev
->res_enabled
)
290 clk_disable_unprepare(dev
->lpo_clk
);
291 err_regulator_disable
:
292 if (powered
&& !dev
->res_enabled
)
293 regulator_bulk_disable(BCM_NUM_SUPPLIES
, dev
->supplies
);
298 static irqreturn_t
bcm_host_wake(int irq
, void *data
)
300 struct bcm_device
*bdev
= data
;
302 bt_dev_dbg(bdev
, "Host wake IRQ");
304 pm_runtime_get(bdev
->dev
);
305 pm_runtime_mark_last_busy(bdev
->dev
);
306 pm_runtime_put_autosuspend(bdev
->dev
);
311 static int bcm_request_irq(struct bcm_data
*bcm
)
313 struct bcm_device
*bdev
= bcm
->dev
;
316 mutex_lock(&bcm_device_lock
);
317 if (!bcm_device_exists(bdev
)) {
322 if (bdev
->irq
<= 0) {
327 err
= devm_request_irq(bdev
->dev
, bdev
->irq
, bcm_host_wake
,
328 bdev
->irq_active_low
? IRQF_TRIGGER_FALLING
:
336 device_init_wakeup(bdev
->dev
, true);
338 pm_runtime_set_autosuspend_delay(bdev
->dev
,
339 BCM_AUTOSUSPEND_DELAY
);
340 pm_runtime_use_autosuspend(bdev
->dev
);
341 pm_runtime_set_active(bdev
->dev
);
342 pm_runtime_enable(bdev
->dev
);
345 mutex_unlock(&bcm_device_lock
);
350 static const struct bcm_set_sleep_mode default_sleep_params
= {
351 .sleep_mode
= 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
352 .idle_host
= 2, /* idle threshold HOST, in 300ms */
353 .idle_dev
= 2, /* idle threshold device, in 300ms */
354 .bt_wake_active
= 1, /* BT_WAKE active mode: 1 = high, 0 = low */
355 .host_wake_active
= 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
356 .allow_host_sleep
= 1, /* Allow host sleep in SCO flag */
357 .combine_modes
= 1, /* Combine sleep and LPM flag */
358 .tristate_control
= 0, /* Allow tri-state control of UART tx flag */
359 /* Irrelevant USB flags */
361 .usb_resume_timeout
= 0,
363 .pulsed_host_wake
= 1,
366 static int bcm_setup_sleep(struct hci_uart
*hu
)
368 struct bcm_data
*bcm
= hu
->priv
;
370 struct bcm_set_sleep_mode sleep_params
= default_sleep_params
;
372 sleep_params
.host_wake_active
= !bcm
->dev
->irq_active_low
;
374 skb
= __hci_cmd_sync(hu
->hdev
, 0xfc27, sizeof(sleep_params
),
375 &sleep_params
, HCI_INIT_TIMEOUT
);
377 int err
= PTR_ERR(skb
);
378 bt_dev_err(hu
->hdev
, "Sleep VSC failed (%d)", err
);
383 bt_dev_dbg(hu
->hdev
, "Set Sleep Parameters VSC succeeded");
388 static inline int bcm_request_irq(struct bcm_data
*bcm
) { return 0; }
389 static inline int bcm_setup_sleep(struct hci_uart
*hu
) { return 0; }
392 static int bcm_set_diag(struct hci_dev
*hdev
, bool enable
)
394 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
395 struct bcm_data
*bcm
= hu
->priv
;
398 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
401 skb
= bt_skb_alloc(3, GFP_KERNEL
);
405 skb_put_u8(skb
, BCM_LM_DIAG_PKT
);
406 skb_put_u8(skb
, 0xf0);
407 skb_put_u8(skb
, enable
);
409 skb_queue_tail(&bcm
->txq
, skb
);
410 hci_uart_tx_wakeup(hu
);
415 static int bcm_open(struct hci_uart
*hu
)
417 struct bcm_data
*bcm
;
421 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
423 if (!hci_uart_has_flow_control(hu
))
426 bcm
= kzalloc(sizeof(*bcm
), GFP_KERNEL
);
430 skb_queue_head_init(&bcm
->txq
);
434 mutex_lock(&bcm_device_lock
);
437 bcm
->dev
= serdev_device_get_drvdata(hu
->serdev
);
444 list_for_each(p
, &bcm_device_list
) {
445 struct bcm_device
*dev
= list_entry(p
, struct bcm_device
, list
);
447 /* Retrieve saved bcm_device based on parent of the
448 * platform device (saved during device probe) and
449 * parent of tty device used by hci_uart
451 if (hu
->tty
->dev
->parent
== dev
->dev
->parent
) {
462 if (bcm
->dev
->drive_rts_on_open
)
463 hci_uart_set_flow_control(hu
, true);
465 hu
->init_speed
= bcm
->dev
->init_speed
;
467 /* If oper_speed is set, ldisc/serdev will set the baudrate
468 * before calling setup()
470 if (!bcm
->dev
->no_early_set_baudrate
)
471 hu
->oper_speed
= bcm
->dev
->oper_speed
;
473 err
= bcm_gpio_set_power(bcm
->dev
, true);
475 if (bcm
->dev
->drive_rts_on_open
)
476 hci_uart_set_flow_control(hu
, false);
482 mutex_unlock(&bcm_device_lock
);
490 mutex_unlock(&bcm_device_lock
);
496 static int bcm_close(struct hci_uart
*hu
)
498 struct bcm_data
*bcm
= hu
->priv
;
499 struct bcm_device
*bdev
= NULL
;
502 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
504 /* Protect bcm->dev against removal of the device or driver */
505 mutex_lock(&bcm_device_lock
);
508 bdev
= serdev_device_get_drvdata(hu
->serdev
);
509 } else if (bcm_device_exists(bcm
->dev
)) {
517 if (IS_ENABLED(CONFIG_PM
) && bdev
->irq
> 0) {
518 devm_free_irq(bdev
->dev
, bdev
->irq
, bdev
);
519 device_init_wakeup(bdev
->dev
, false);
520 pm_runtime_disable(bdev
->dev
);
523 err
= bcm_gpio_set_power(bdev
, false);
525 bt_dev_err(hu
->hdev
, "Failed to power down");
527 pm_runtime_set_suspended(bdev
->dev
);
529 mutex_unlock(&bcm_device_lock
);
531 skb_queue_purge(&bcm
->txq
);
532 kfree_skb(bcm
->rx_skb
);
539 static int bcm_flush(struct hci_uart
*hu
)
541 struct bcm_data
*bcm
= hu
->priv
;
543 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
545 skb_queue_purge(&bcm
->txq
);
550 static int bcm_setup(struct hci_uart
*hu
)
552 struct bcm_data
*bcm
= hu
->priv
;
554 const struct firmware
*fw
;
558 bt_dev_dbg(hu
->hdev
, "hu %p", hu
);
560 hu
->hdev
->set_diag
= bcm_set_diag
;
561 hu
->hdev
->set_bdaddr
= btbcm_set_bdaddr
;
563 err
= btbcm_initialize(hu
->hdev
, fw_name
, sizeof(fw_name
), false);
567 err
= request_firmware(&fw
, fw_name
, &hu
->hdev
->dev
);
569 bt_dev_info(hu
->hdev
, "BCM: Patch %s not found", fw_name
);
573 err
= btbcm_patchram(hu
->hdev
, fw
);
575 bt_dev_info(hu
->hdev
, "BCM: Patch failed (%d)", err
);
579 /* Init speed if any */
581 speed
= hu
->init_speed
;
582 else if (hu
->proto
->init_speed
)
583 speed
= hu
->proto
->init_speed
;
588 host_set_baudrate(hu
, speed
);
590 /* Operational speed if any */
592 speed
= hu
->oper_speed
;
593 else if (bcm
->dev
&& bcm
->dev
->oper_speed
)
594 speed
= bcm
->dev
->oper_speed
;
595 else if (hu
->proto
->oper_speed
)
596 speed
= hu
->proto
->oper_speed
;
601 err
= bcm_set_baudrate(hu
, speed
);
603 host_set_baudrate(hu
, speed
);
606 /* PCM parameters if provided */
607 if (bcm
->dev
&& bcm
->dev
->pcm_int_params
[0] != 0xff) {
608 struct bcm_set_pcm_int_params params
;
610 btbcm_read_pcm_int_params(hu
->hdev
, ¶ms
);
612 memcpy(¶ms
, bcm
->dev
->pcm_int_params
, 5);
613 btbcm_write_pcm_int_params(hu
->hdev
, ¶ms
);
617 release_firmware(fw
);
619 err
= btbcm_finalize(hu
->hdev
);
623 if (!bcm_request_irq(bcm
))
624 err
= bcm_setup_sleep(hu
);
629 #define BCM_RECV_LM_DIAG \
630 .type = BCM_LM_DIAG_PKT, \
631 .hlen = BCM_LM_DIAG_SIZE, \
634 .maxlen = BCM_LM_DIAG_SIZE
636 #define BCM_RECV_NULL \
637 .type = BCM_NULL_PKT, \
638 .hlen = BCM_NULL_SIZE, \
641 .maxlen = BCM_NULL_SIZE
643 #define BCM_RECV_TYPE49 \
644 .type = BCM_TYPE49_PKT, \
645 .hlen = BCM_TYPE49_SIZE, \
648 .maxlen = BCM_TYPE49_SIZE
650 #define BCM_RECV_TYPE52 \
651 .type = BCM_TYPE52_PKT, \
652 .hlen = BCM_TYPE52_SIZE, \
655 .maxlen = BCM_TYPE52_SIZE
657 static const struct h4_recv_pkt bcm_recv_pkts
[] = {
658 { H4_RECV_ACL
, .recv
= hci_recv_frame
},
659 { H4_RECV_SCO
, .recv
= hci_recv_frame
},
660 { H4_RECV_EVENT
, .recv
= hci_recv_frame
},
661 { BCM_RECV_LM_DIAG
, .recv
= hci_recv_diag
},
662 { BCM_RECV_NULL
, .recv
= hci_recv_diag
},
663 { BCM_RECV_TYPE49
, .recv
= hci_recv_diag
},
664 { BCM_RECV_TYPE52
, .recv
= hci_recv_diag
},
667 static int bcm_recv(struct hci_uart
*hu
, const void *data
, int count
)
669 struct bcm_data
*bcm
= hu
->priv
;
671 if (!test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
674 bcm
->rx_skb
= h4_recv_buf(hu
->hdev
, bcm
->rx_skb
, data
, count
,
675 bcm_recv_pkts
, ARRAY_SIZE(bcm_recv_pkts
));
676 if (IS_ERR(bcm
->rx_skb
)) {
677 int err
= PTR_ERR(bcm
->rx_skb
);
678 bt_dev_err(hu
->hdev
, "Frame reassembly failed (%d)", err
);
681 } else if (!bcm
->rx_skb
) {
682 /* Delay auto-suspend when receiving completed packet */
683 mutex_lock(&bcm_device_lock
);
684 if (bcm
->dev
&& bcm_device_exists(bcm
->dev
)) {
685 pm_runtime_get(bcm
->dev
->dev
);
686 pm_runtime_mark_last_busy(bcm
->dev
->dev
);
687 pm_runtime_put_autosuspend(bcm
->dev
->dev
);
689 mutex_unlock(&bcm_device_lock
);
695 static int bcm_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
697 struct bcm_data
*bcm
= hu
->priv
;
699 bt_dev_dbg(hu
->hdev
, "hu %p skb %p", hu
, skb
);
701 /* Prepend skb with frame type */
702 memcpy(skb_push(skb
, 1), &hci_skb_pkt_type(skb
), 1);
703 skb_queue_tail(&bcm
->txq
, skb
);
708 static struct sk_buff
*bcm_dequeue(struct hci_uart
*hu
)
710 struct bcm_data
*bcm
= hu
->priv
;
711 struct sk_buff
*skb
= NULL
;
712 struct bcm_device
*bdev
= NULL
;
714 mutex_lock(&bcm_device_lock
);
716 if (bcm_device_exists(bcm
->dev
)) {
718 pm_runtime_get_sync(bdev
->dev
);
719 /* Shall be resumed here */
722 skb
= skb_dequeue(&bcm
->txq
);
725 pm_runtime_mark_last_busy(bdev
->dev
);
726 pm_runtime_put_autosuspend(bdev
->dev
);
729 mutex_unlock(&bcm_device_lock
);
735 static int bcm_suspend_device(struct device
*dev
)
737 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
740 bt_dev_dbg(bdev
, "");
742 if (!bdev
->is_suspended
&& bdev
->hu
) {
743 hci_uart_set_flow_control(bdev
->hu
, true);
745 /* Once this returns, driver suspends BT via GPIO */
746 bdev
->is_suspended
= true;
749 /* Suspend the device */
750 err
= bdev
->set_device_wakeup(bdev
, false);
752 if (bdev
->is_suspended
&& bdev
->hu
) {
753 bdev
->is_suspended
= false;
754 hci_uart_set_flow_control(bdev
->hu
, false);
759 bt_dev_dbg(bdev
, "suspend, delaying 15 ms");
765 static int bcm_resume_device(struct device
*dev
)
767 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
770 bt_dev_dbg(bdev
, "");
772 err
= bdev
->set_device_wakeup(bdev
, true);
774 dev_err(dev
, "Failed to power up\n");
778 bt_dev_dbg(bdev
, "resume, delaying 15 ms");
781 /* When this executes, the device has woken up already */
782 if (bdev
->is_suspended
&& bdev
->hu
) {
783 bdev
->is_suspended
= false;
785 hci_uart_set_flow_control(bdev
->hu
, false);
792 #ifdef CONFIG_PM_SLEEP
793 /* suspend callback */
794 static int bcm_suspend(struct device
*dev
)
796 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
799 bt_dev_dbg(bdev
, "suspend: is_suspended %d", bdev
->is_suspended
);
802 * When used with a device instantiated as platform_device, bcm_suspend
803 * can be called at any time as long as the platform device is bound,
804 * so it should use bcm_device_lock to protect access to hci_uart
805 * and device_wake-up GPIO.
807 mutex_lock(&bcm_device_lock
);
812 if (pm_runtime_active(dev
))
813 bcm_suspend_device(dev
);
815 if (device_may_wakeup(dev
) && bdev
->irq
> 0) {
816 error
= enable_irq_wake(bdev
->irq
);
818 bt_dev_dbg(bdev
, "BCM irq: enabled");
822 mutex_unlock(&bcm_device_lock
);
827 /* resume callback */
828 static int bcm_resume(struct device
*dev
)
830 struct bcm_device
*bdev
= dev_get_drvdata(dev
);
833 bt_dev_dbg(bdev
, "resume: is_suspended %d", bdev
->is_suspended
);
836 * When used with a device instantiated as platform_device, bcm_resume
837 * can be called at any time as long as platform device is bound,
838 * so it should use bcm_device_lock to protect access to hci_uart
839 * and device_wake-up GPIO.
841 mutex_lock(&bcm_device_lock
);
846 if (device_may_wakeup(dev
) && bdev
->irq
> 0) {
847 disable_irq_wake(bdev
->irq
);
848 bt_dev_dbg(bdev
, "BCM irq: disabled");
851 err
= bcm_resume_device(dev
);
854 mutex_unlock(&bcm_device_lock
);
857 pm_runtime_disable(dev
);
858 pm_runtime_set_active(dev
);
859 pm_runtime_enable(dev
);
866 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
867 static const struct dmi_system_id bcm_broken_irq_dmi_table
[] = {
869 .ident
= "Meegopad T08",
871 DMI_EXACT_MATCH(DMI_BOARD_VENDOR
,
872 "To be filled by OEM."),
873 DMI_EXACT_MATCH(DMI_BOARD_NAME
, "T3 MRD"),
874 DMI_EXACT_MATCH(DMI_BOARD_VERSION
, "V1.1"),
881 static const struct acpi_gpio_params first_gpio
= { 0, 0, false };
882 static const struct acpi_gpio_params second_gpio
= { 1, 0, false };
883 static const struct acpi_gpio_params third_gpio
= { 2, 0, false };
885 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios
[] = {
886 { "device-wakeup-gpios", &first_gpio
, 1 },
887 { "shutdown-gpios", &second_gpio
, 1 },
888 { "host-wakeup-gpios", &third_gpio
, 1 },
892 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios
[] = {
893 { "host-wakeup-gpios", &first_gpio
, 1 },
894 { "device-wakeup-gpios", &second_gpio
, 1 },
895 { "shutdown-gpios", &third_gpio
, 1 },
899 static int bcm_resource(struct acpi_resource
*ares
, void *data
)
901 struct bcm_device
*dev
= data
;
902 struct acpi_resource_extended_irq
*irq
;
903 struct acpi_resource_gpio
*gpio
;
904 struct acpi_resource_uart_serialbus
*sb
;
906 switch (ares
->type
) {
907 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ
:
908 irq
= &ares
->data
.extended_irq
;
909 if (irq
->polarity
!= ACPI_ACTIVE_LOW
)
910 dev_info(dev
->dev
, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
911 dev
->irq_active_low
= true;
914 case ACPI_RESOURCE_TYPE_GPIO
:
915 gpio
= &ares
->data
.gpio
;
916 if (gpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
) {
917 dev
->gpio_int_idx
= dev
->gpio_count
;
918 dev
->irq_active_low
= gpio
->polarity
== ACPI_ACTIVE_LOW
;
923 case ACPI_RESOURCE_TYPE_SERIAL_BUS
:
924 sb
= &ares
->data
.uart_serial_bus
;
925 if (sb
->type
== ACPI_RESOURCE_SERIAL_TYPE_UART
) {
926 dev
->init_speed
= sb
->default_baud_rate
;
927 dev
->oper_speed
= 4000000;
938 static int bcm_apple_set_device_wakeup(struct bcm_device
*dev
, bool awake
)
940 if (ACPI_FAILURE(acpi_execute_simple_method(dev
->btlp
, NULL
, !awake
)))
946 static int bcm_apple_set_shutdown(struct bcm_device
*dev
, bool powered
)
948 if (ACPI_FAILURE(acpi_evaluate_object(powered
? dev
->btpu
: dev
->btpd
,
955 static int bcm_apple_get_resources(struct bcm_device
*dev
)
957 struct acpi_device
*adev
= ACPI_COMPANION(dev
->dev
);
958 const union acpi_object
*obj
;
961 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTLP", &dev
->btlp
)) ||
962 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTPU", &dev
->btpu
)) ||
963 ACPI_FAILURE(acpi_get_handle(adev
->handle
, "BTPD", &dev
->btpd
)))
966 if (!acpi_dev_get_property(adev
, "baud", ACPI_TYPE_BUFFER
, &obj
) &&
967 obj
->buffer
.length
== 8)
968 dev
->init_speed
= *(u64
*)obj
->buffer
.pointer
;
970 dev
->set_device_wakeup
= bcm_apple_set_device_wakeup
;
971 dev
->set_shutdown
= bcm_apple_set_shutdown
;
976 static inline int bcm_apple_get_resources(struct bcm_device
*dev
)
980 #endif /* CONFIG_ACPI */
982 static int bcm_gpio_set_device_wakeup(struct bcm_device
*dev
, bool awake
)
984 gpiod_set_value_cansleep(dev
->device_wakeup
, awake
);
988 static int bcm_gpio_set_shutdown(struct bcm_device
*dev
, bool powered
)
990 gpiod_set_value_cansleep(dev
->shutdown
, powered
);
994 /* Try a bunch of names for TXCO */
995 static struct clk
*bcm_get_txco(struct device
*dev
)
999 /* New explicit name */
1000 clk
= devm_clk_get(dev
, "txco");
1001 if (!IS_ERR(clk
) || PTR_ERR(clk
) == -EPROBE_DEFER
)
1004 /* Deprecated name */
1005 clk
= devm_clk_get(dev
, "extclk");
1006 if (!IS_ERR(clk
) || PTR_ERR(clk
) == -EPROBE_DEFER
)
1009 /* Original code used no name at all */
1010 return devm_clk_get(dev
, NULL
);
1013 static int bcm_get_resources(struct bcm_device
*dev
)
1015 const struct dmi_system_id
*dmi_id
;
1018 dev
->name
= dev_name(dev
->dev
);
1020 if (x86_apple_machine
&& !bcm_apple_get_resources(dev
))
1023 dev
->txco_clk
= bcm_get_txco(dev
->dev
);
1025 /* Handle deferred probing */
1026 if (dev
->txco_clk
== ERR_PTR(-EPROBE_DEFER
))
1027 return PTR_ERR(dev
->txco_clk
);
1029 /* Ignore all other errors as before */
1030 if (IS_ERR(dev
->txco_clk
))
1031 dev
->txco_clk
= NULL
;
1033 dev
->lpo_clk
= devm_clk_get(dev
->dev
, "lpo");
1034 if (dev
->lpo_clk
== ERR_PTR(-EPROBE_DEFER
))
1035 return PTR_ERR(dev
->lpo_clk
);
1037 if (IS_ERR(dev
->lpo_clk
))
1038 dev
->lpo_clk
= NULL
;
1040 /* Check if we accidentally fetched the lpo clock twice */
1041 if (dev
->lpo_clk
&& clk_is_match(dev
->lpo_clk
, dev
->txco_clk
)) {
1042 devm_clk_put(dev
->dev
, dev
->txco_clk
);
1043 dev
->txco_clk
= NULL
;
1046 dev
->device_wakeup
= devm_gpiod_get_optional(dev
->dev
, "device-wakeup",
1048 if (IS_ERR(dev
->device_wakeup
))
1049 return PTR_ERR(dev
->device_wakeup
);
1051 dev
->shutdown
= devm_gpiod_get_optional(dev
->dev
, "shutdown",
1053 if (IS_ERR(dev
->shutdown
))
1054 return PTR_ERR(dev
->shutdown
);
1056 dev
->set_device_wakeup
= bcm_gpio_set_device_wakeup
;
1057 dev
->set_shutdown
= bcm_gpio_set_shutdown
;
1059 dev
->supplies
[0].supply
= "vbat";
1060 dev
->supplies
[1].supply
= "vddio";
1061 err
= devm_regulator_bulk_get(dev
->dev
, BCM_NUM_SUPPLIES
,
1066 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1067 if (dev
->irq
<= 0) {
1068 struct gpio_desc
*gpio
;
1070 gpio
= devm_gpiod_get_optional(dev
->dev
, "host-wakeup",
1073 return PTR_ERR(gpio
);
1075 dev
->irq
= gpiod_to_irq(gpio
);
1078 dmi_id
= dmi_first_match(bcm_broken_irq_dmi_table
);
1080 dev_info(dev
->dev
, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1085 dev_dbg(dev
->dev
, "BCM irq: %d\n", dev
->irq
);
1090 static int bcm_acpi_probe(struct bcm_device
*dev
)
1092 LIST_HEAD(resources
);
1093 const struct acpi_gpio_mapping
*gpio_mapping
= acpi_bcm_int_last_gpios
;
1094 struct resource_entry
*entry
;
1097 /* Retrieve UART ACPI info */
1098 dev
->gpio_int_idx
= -1;
1099 ret
= acpi_dev_get_resources(ACPI_COMPANION(dev
->dev
),
1100 &resources
, bcm_resource
, dev
);
1104 resource_list_for_each_entry(entry
, &resources
) {
1105 if (resource_type(entry
->res
) == IORESOURCE_IRQ
) {
1106 dev
->irq
= entry
->res
->start
;
1110 acpi_dev_free_resource_list(&resources
);
1112 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1113 * only 2 GPIO resources, we use the irq-last mapping for this, since
1114 * we already have an irq the 3th / last mapping will not be used.
1117 gpio_mapping
= acpi_bcm_int_last_gpios
;
1118 else if (dev
->gpio_int_idx
== 0)
1119 gpio_mapping
= acpi_bcm_int_first_gpios
;
1120 else if (dev
->gpio_int_idx
== 2)
1121 gpio_mapping
= acpi_bcm_int_last_gpios
;
1123 dev_warn(dev
->dev
, "Unexpected ACPI gpio_int_idx: %d\n",
1126 /* Warn if our expectations are not met. */
1127 if (dev
->gpio_count
!= (dev
->irq
? 2 : 3))
1128 dev_warn(dev
->dev
, "Unexpected number of ACPI GPIOs: %d\n",
1131 ret
= devm_acpi_dev_add_driver_gpios(dev
->dev
, gpio_mapping
);
1135 if (irq_polarity
!= -1) {
1136 dev
->irq_active_low
= irq_polarity
;
1137 dev_warn(dev
->dev
, "Overwriting IRQ polarity to active %s by module-param\n",
1138 dev
->irq_active_low
? "low" : "high");
1144 static int bcm_acpi_probe(struct bcm_device
*dev
)
1148 #endif /* CONFIG_ACPI */
1150 static int bcm_of_probe(struct bcm_device
*bdev
)
1152 device_property_read_u32(bdev
->dev
, "max-speed", &bdev
->oper_speed
);
1153 device_property_read_u8_array(bdev
->dev
, "brcm,bt-pcm-int-params",
1154 bdev
->pcm_int_params
, 5);
1155 bdev
->irq
= of_irq_get_byname(bdev
->dev
->of_node
, "host-wakeup");
1160 static int bcm_probe(struct platform_device
*pdev
)
1162 struct bcm_device
*dev
;
1165 dev
= devm_kzalloc(&pdev
->dev
, sizeof(*dev
), GFP_KERNEL
);
1169 dev
->dev
= &pdev
->dev
;
1170 dev
->irq
= platform_get_irq(pdev
, 0);
1172 /* Initialize routing field to an unused value */
1173 dev
->pcm_int_params
[0] = 0xff;
1175 if (has_acpi_companion(&pdev
->dev
)) {
1176 ret
= bcm_acpi_probe(dev
);
1181 ret
= bcm_get_resources(dev
);
1185 platform_set_drvdata(pdev
, dev
);
1187 dev_info(&pdev
->dev
, "%s device registered.\n", dev
->name
);
1189 /* Place this instance on the device list */
1190 mutex_lock(&bcm_device_lock
);
1191 list_add_tail(&dev
->list
, &bcm_device_list
);
1192 mutex_unlock(&bcm_device_lock
);
1194 ret
= bcm_gpio_set_power(dev
, false);
1196 dev_err(&pdev
->dev
, "Failed to power down\n");
1201 static int bcm_remove(struct platform_device
*pdev
)
1203 struct bcm_device
*dev
= platform_get_drvdata(pdev
);
1205 mutex_lock(&bcm_device_lock
);
1206 list_del(&dev
->list
);
1207 mutex_unlock(&bcm_device_lock
);
1209 dev_info(&pdev
->dev
, "%s device unregistered.\n", dev
->name
);
1214 static const struct hci_uart_proto bcm_proto
= {
1218 .init_speed
= 115200,
1223 .set_baudrate
= bcm_set_baudrate
,
1225 .enqueue
= bcm_enqueue
,
1226 .dequeue
= bcm_dequeue
,
1230 static const struct acpi_device_id bcm_acpi_match
[] = {
1399 MODULE_DEVICE_TABLE(acpi
, bcm_acpi_match
);
1402 /* suspend and resume callbacks */
1403 static const struct dev_pm_ops bcm_pm_ops
= {
1404 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend
, bcm_resume
)
1405 SET_RUNTIME_PM_OPS(bcm_suspend_device
, bcm_resume_device
, NULL
)
1408 static struct platform_driver bcm_driver
= {
1410 .remove
= bcm_remove
,
1413 .acpi_match_table
= ACPI_PTR(bcm_acpi_match
),
1418 static int bcm_serdev_probe(struct serdev_device
*serdev
)
1420 struct bcm_device
*bcmdev
;
1421 const struct bcm_device_data
*data
;
1424 bcmdev
= devm_kzalloc(&serdev
->dev
, sizeof(*bcmdev
), GFP_KERNEL
);
1428 bcmdev
->dev
= &serdev
->dev
;
1430 bcmdev
->hu
= &bcmdev
->serdev_hu
;
1432 bcmdev
->serdev_hu
.serdev
= serdev
;
1433 serdev_device_set_drvdata(serdev
, bcmdev
);
1435 /* Initialize routing field to an unused value */
1436 bcmdev
->pcm_int_params
[0] = 0xff;
1438 if (has_acpi_companion(&serdev
->dev
))
1439 err
= bcm_acpi_probe(bcmdev
);
1441 err
= bcm_of_probe(bcmdev
);
1445 err
= bcm_get_resources(bcmdev
);
1449 if (!bcmdev
->shutdown
) {
1450 dev_warn(&serdev
->dev
,
1451 "No reset resource, using default baud rate\n");
1452 bcmdev
->oper_speed
= bcmdev
->init_speed
;
1455 err
= bcm_gpio_set_power(bcmdev
, false);
1457 dev_err(&serdev
->dev
, "Failed to power down\n");
1459 data
= device_get_match_data(bcmdev
->dev
);
1461 bcmdev
->no_early_set_baudrate
= data
->no_early_set_baudrate
;
1462 bcmdev
->drive_rts_on_open
= data
->drive_rts_on_open
;
1465 return hci_uart_register_device(&bcmdev
->serdev_hu
, &bcm_proto
);
1468 static void bcm_serdev_remove(struct serdev_device
*serdev
)
1470 struct bcm_device
*bcmdev
= serdev_device_get_drvdata(serdev
);
1472 hci_uart_unregister_device(&bcmdev
->serdev_hu
);
1476 static struct bcm_device_data bcm4354_device_data
= {
1477 .no_early_set_baudrate
= true,
1480 static struct bcm_device_data bcm43438_device_data
= {
1481 .drive_rts_on_open
= true,
1484 static const struct of_device_id bcm_bluetooth_of_match
[] = {
1485 { .compatible
= "brcm,bcm20702a1" },
1486 { .compatible
= "brcm,bcm4329-bt" },
1487 { .compatible
= "brcm,bcm4345c5" },
1488 { .compatible
= "brcm,bcm4330-bt" },
1489 { .compatible
= "brcm,bcm43438-bt", .data
= &bcm43438_device_data
},
1490 { .compatible
= "brcm,bcm43540-bt", .data
= &bcm4354_device_data
},
1491 { .compatible
= "brcm,bcm4335a0" },
1494 MODULE_DEVICE_TABLE(of
, bcm_bluetooth_of_match
);
1497 static struct serdev_device_driver bcm_serdev_driver
= {
1498 .probe
= bcm_serdev_probe
,
1499 .remove
= bcm_serdev_remove
,
1501 .name
= "hci_uart_bcm",
1502 .of_match_table
= of_match_ptr(bcm_bluetooth_of_match
),
1503 .acpi_match_table
= ACPI_PTR(bcm_acpi_match
),
1508 int __init
bcm_init(void)
1510 /* For now, we need to keep both platform device
1511 * driver (ACPI generated) and serdev driver (DT).
1513 platform_driver_register(&bcm_driver
);
1514 serdev_device_driver_register(&bcm_serdev_driver
);
1516 return hci_uart_register_proto(&bcm_proto
);
1519 int __exit
bcm_deinit(void)
1521 platform_driver_unregister(&bcm_driver
);
1522 serdev_device_driver_unregister(&bcm_serdev_driver
);
1524 return hci_uart_unregister_proto(&bcm_proto
);