Merge tag 'for-linus-20190706' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / bluetooth / hci_bcm.c
blob8905ad2edde743742f9706fccfd7350d5fb2709e
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
4 * Bluetooth HCI UART driver for Broadcom devices
6 * Copyright (C) 2015 Intel Corporation
7 */
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>
15 #include <linux/of.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>
31 #include "btbcm.h"
32 #include "hci_uart.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
50 /**
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
83 struct bcm_device {
84 /* Must be the first member, hci_serdev.c expects this. */
85 struct hci_uart serdev_hu;
86 struct list_head list;
88 struct device *dev;
90 const char *name;
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);
95 #ifdef CONFIG_ACPI
96 acpi_handle btlp, btpu, btpd;
97 int gpio_count;
98 int gpio_int_idx;
99 #endif
101 struct clk *txco_clk;
102 struct clk *lpo_clk;
103 struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
104 bool res_enabled;
106 u32 init_speed;
107 u32 oper_speed;
108 int irq;
109 bool irq_active_low;
111 #ifdef CONFIG_PM
112 struct hci_uart *hu;
113 bool is_suspended;
114 #endif
117 /* generic bcm uart resources */
118 struct bcm_data {
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)
135 if (hu->serdev)
136 serdev_device_set_baudrate(hu->serdev, speed);
137 else
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;
144 struct sk_buff *skb;
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);
158 if (IS_ERR(skb)) {
159 int err = PTR_ERR(skb);
160 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
161 err);
162 return err;
165 kfree_skb(skb);
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
174 * rate.
176 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), &param,
177 HCI_INIT_TIMEOUT);
178 if (IS_ERR(skb)) {
179 int err = PTR_ERR(skb);
180 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
181 err);
182 return err;
185 kfree_skb(skb);
187 return 0;
190 /* bcm_device_exists should be protected by bcm_device_lock */
191 static bool bcm_device_exists(struct bcm_device *device)
193 struct list_head *p;
195 #ifdef CONFIG_PM
196 /* Devices using serdev always exist */
197 if (device && device->hu && device->hu->serdev)
198 return true;
199 #endif
201 list_for_each(p, &bcm_device_list) {
202 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
204 if (device == dev)
205 return true;
208 return false;
211 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
213 int err;
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,
221 dev->supplies);
222 if (err)
223 return err;
226 /* LPO clock needs to be 32.768 kHz */
227 err = clk_set_rate(dev->lpo_clk, 32768);
228 if (err) {
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);
234 if (err)
235 goto err_regulator_disable;
237 err = clk_prepare_enable(dev->txco_clk);
238 if (err)
239 goto err_lpo_clk_disable;
242 err = dev->set_shutdown(dev, powered);
243 if (err)
244 goto err_txco_clk_disable;
246 err = dev->set_device_wakeup(dev, powered);
247 if (err)
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,
259 dev->supplies);
262 /* wait for device to power on and come out of reset */
263 usleep_range(10000, 20000);
265 dev->res_enabled = powered;
267 return 0;
269 err_revert_shutdown:
270 dev->set_shutdown(dev, !powered);
271 err_txco_clk_disable:
272 if (powered && !dev->res_enabled)
273 clk_disable_unprepare(dev->txco_clk);
274 err_lpo_clk_disable:
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);
280 return err;
283 #ifdef CONFIG_PM
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);
294 return IRQ_HANDLED;
297 static int bcm_request_irq(struct bcm_data *bcm)
299 struct bcm_device *bdev = bcm->dev;
300 int err;
302 mutex_lock(&bcm_device_lock);
303 if (!bcm_device_exists(bdev)) {
304 err = -ENODEV;
305 goto unlock;
308 if (bdev->irq <= 0) {
309 err = -EOPNOTSUPP;
310 goto unlock;
313 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
314 bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
315 IRQF_TRIGGER_RISING,
316 "host_wake", bdev);
317 if (err) {
318 bdev->irq = err;
319 goto unlock;
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);
330 unlock:
331 mutex_unlock(&bcm_device_lock);
333 return err;
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 */
346 .usb_auto_sleep = 0,
347 .usb_resume_timeout = 0,
348 .break_to_host = 0,
349 .pulsed_host_wake = 1,
352 static int bcm_setup_sleep(struct hci_uart *hu)
354 struct bcm_data *bcm = hu->priv;
355 struct sk_buff *skb;
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);
362 if (IS_ERR(skb)) {
363 int err = PTR_ERR(skb);
364 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
365 return err;
367 kfree_skb(skb);
369 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
371 return 0;
373 #else
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; }
376 #endif
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;
382 struct sk_buff *skb;
384 if (!test_bit(HCI_RUNNING, &hdev->flags))
385 return -ENETDOWN;
387 skb = bt_skb_alloc(3, GFP_KERNEL);
388 if (!skb)
389 return -ENOMEM;
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);
398 return 0;
401 static int bcm_open(struct hci_uart *hu)
403 struct bcm_data *bcm;
404 struct list_head *p;
405 int err;
407 bt_dev_dbg(hu->hdev, "hu %p", hu);
409 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
410 if (!bcm)
411 return -ENOMEM;
413 skb_queue_head_init(&bcm->txq);
415 hu->priv = bcm;
417 mutex_lock(&bcm_device_lock);
419 if (hu->serdev) {
420 bcm->dev = serdev_device_get_drvdata(hu->serdev);
421 goto out;
424 if (!hu->tty->dev)
425 goto out;
427 list_for_each(p, &bcm_device_list) {
428 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
430 /* Retrieve saved bcm_device based on parent of the
431 * platform device (saved during device probe) and
432 * parent of tty device used by hci_uart
434 if (hu->tty->dev->parent == dev->dev->parent) {
435 bcm->dev = dev;
436 #ifdef CONFIG_PM
437 dev->hu = hu;
438 #endif
439 break;
443 out:
444 if (bcm->dev) {
445 hu->init_speed = bcm->dev->init_speed;
446 hu->oper_speed = bcm->dev->oper_speed;
447 err = bcm_gpio_set_power(bcm->dev, true);
448 if (err)
449 goto err_unset_hu;
452 mutex_unlock(&bcm_device_lock);
453 return 0;
455 err_unset_hu:
456 #ifdef CONFIG_PM
457 if (!hu->serdev)
458 bcm->dev->hu = NULL;
459 #endif
460 mutex_unlock(&bcm_device_lock);
461 hu->priv = NULL;
462 kfree(bcm);
463 return err;
466 static int bcm_close(struct hci_uart *hu)
468 struct bcm_data *bcm = hu->priv;
469 struct bcm_device *bdev = NULL;
470 int err;
472 bt_dev_dbg(hu->hdev, "hu %p", hu);
474 /* Protect bcm->dev against removal of the device or driver */
475 mutex_lock(&bcm_device_lock);
477 if (hu->serdev) {
478 bdev = serdev_device_get_drvdata(hu->serdev);
479 } else if (bcm_device_exists(bcm->dev)) {
480 bdev = bcm->dev;
481 #ifdef CONFIG_PM
482 bdev->hu = NULL;
483 #endif
486 if (bdev) {
487 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) {
488 devm_free_irq(bdev->dev, bdev->irq, bdev);
489 device_init_wakeup(bdev->dev, false);
490 pm_runtime_disable(bdev->dev);
493 err = bcm_gpio_set_power(bdev, false);
494 if (err)
495 bt_dev_err(hu->hdev, "Failed to power down");
496 else
497 pm_runtime_set_suspended(bdev->dev);
499 mutex_unlock(&bcm_device_lock);
501 skb_queue_purge(&bcm->txq);
502 kfree_skb(bcm->rx_skb);
503 kfree(bcm);
505 hu->priv = NULL;
506 return 0;
509 static int bcm_flush(struct hci_uart *hu)
511 struct bcm_data *bcm = hu->priv;
513 bt_dev_dbg(hu->hdev, "hu %p", hu);
515 skb_queue_purge(&bcm->txq);
517 return 0;
520 static int bcm_setup(struct hci_uart *hu)
522 struct bcm_data *bcm = hu->priv;
523 char fw_name[64];
524 const struct firmware *fw;
525 unsigned int speed;
526 int err;
528 bt_dev_dbg(hu->hdev, "hu %p", hu);
530 hu->hdev->set_diag = bcm_set_diag;
531 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
533 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false);
534 if (err)
535 return err;
537 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
538 if (err < 0) {
539 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
540 return 0;
543 err = btbcm_patchram(hu->hdev, fw);
544 if (err) {
545 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
546 goto finalize;
549 /* Init speed if any */
550 if (hu->init_speed)
551 speed = hu->init_speed;
552 else if (hu->proto->init_speed)
553 speed = hu->proto->init_speed;
554 else
555 speed = 0;
557 if (speed)
558 host_set_baudrate(hu, speed);
560 /* Operational speed if any */
561 if (hu->oper_speed)
562 speed = hu->oper_speed;
563 else if (hu->proto->oper_speed)
564 speed = hu->proto->oper_speed;
565 else
566 speed = 0;
568 if (speed) {
569 err = bcm_set_baudrate(hu, speed);
570 if (!err)
571 host_set_baudrate(hu, speed);
574 finalize:
575 release_firmware(fw);
577 err = btbcm_finalize(hu->hdev);
578 if (err)
579 return err;
581 if (!bcm_request_irq(bcm))
582 err = bcm_setup_sleep(hu);
584 return err;
587 #define BCM_RECV_LM_DIAG \
588 .type = BCM_LM_DIAG_PKT, \
589 .hlen = BCM_LM_DIAG_SIZE, \
590 .loff = 0, \
591 .lsize = 0, \
592 .maxlen = BCM_LM_DIAG_SIZE
594 #define BCM_RECV_NULL \
595 .type = BCM_NULL_PKT, \
596 .hlen = BCM_NULL_SIZE, \
597 .loff = 0, \
598 .lsize = 0, \
599 .maxlen = BCM_NULL_SIZE
601 #define BCM_RECV_TYPE49 \
602 .type = BCM_TYPE49_PKT, \
603 .hlen = BCM_TYPE49_SIZE, \
604 .loff = 0, \
605 .lsize = 0, \
606 .maxlen = BCM_TYPE49_SIZE
608 #define BCM_RECV_TYPE52 \
609 .type = BCM_TYPE52_PKT, \
610 .hlen = BCM_TYPE52_SIZE, \
611 .loff = 0, \
612 .lsize = 0, \
613 .maxlen = BCM_TYPE52_SIZE
615 static const struct h4_recv_pkt bcm_recv_pkts[] = {
616 { H4_RECV_ACL, .recv = hci_recv_frame },
617 { H4_RECV_SCO, .recv = hci_recv_frame },
618 { H4_RECV_EVENT, .recv = hci_recv_frame },
619 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
620 { BCM_RECV_NULL, .recv = hci_recv_diag },
621 { BCM_RECV_TYPE49, .recv = hci_recv_diag },
622 { BCM_RECV_TYPE52, .recv = hci_recv_diag },
625 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
627 struct bcm_data *bcm = hu->priv;
629 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
630 return -EUNATCH;
632 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
633 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
634 if (IS_ERR(bcm->rx_skb)) {
635 int err = PTR_ERR(bcm->rx_skb);
636 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
637 bcm->rx_skb = NULL;
638 return err;
639 } else if (!bcm->rx_skb) {
640 /* Delay auto-suspend when receiving completed packet */
641 mutex_lock(&bcm_device_lock);
642 if (bcm->dev && bcm_device_exists(bcm->dev)) {
643 pm_runtime_get(bcm->dev->dev);
644 pm_runtime_mark_last_busy(bcm->dev->dev);
645 pm_runtime_put_autosuspend(bcm->dev->dev);
647 mutex_unlock(&bcm_device_lock);
650 return count;
653 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
655 struct bcm_data *bcm = hu->priv;
657 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
659 /* Prepend skb with frame type */
660 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
661 skb_queue_tail(&bcm->txq, skb);
663 return 0;
666 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
668 struct bcm_data *bcm = hu->priv;
669 struct sk_buff *skb = NULL;
670 struct bcm_device *bdev = NULL;
672 mutex_lock(&bcm_device_lock);
674 if (bcm_device_exists(bcm->dev)) {
675 bdev = bcm->dev;
676 pm_runtime_get_sync(bdev->dev);
677 /* Shall be resumed here */
680 skb = skb_dequeue(&bcm->txq);
682 if (bdev) {
683 pm_runtime_mark_last_busy(bdev->dev);
684 pm_runtime_put_autosuspend(bdev->dev);
687 mutex_unlock(&bcm_device_lock);
689 return skb;
692 #ifdef CONFIG_PM
693 static int bcm_suspend_device(struct device *dev)
695 struct bcm_device *bdev = dev_get_drvdata(dev);
696 int err;
698 bt_dev_dbg(bdev, "");
700 if (!bdev->is_suspended && bdev->hu) {
701 hci_uart_set_flow_control(bdev->hu, true);
703 /* Once this returns, driver suspends BT via GPIO */
704 bdev->is_suspended = true;
707 /* Suspend the device */
708 err = bdev->set_device_wakeup(bdev, false);
709 if (err) {
710 if (bdev->is_suspended && bdev->hu) {
711 bdev->is_suspended = false;
712 hci_uart_set_flow_control(bdev->hu, false);
714 return -EBUSY;
717 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
718 msleep(15);
720 return 0;
723 static int bcm_resume_device(struct device *dev)
725 struct bcm_device *bdev = dev_get_drvdata(dev);
726 int err;
728 bt_dev_dbg(bdev, "");
730 err = bdev->set_device_wakeup(bdev, true);
731 if (err) {
732 dev_err(dev, "Failed to power up\n");
733 return err;
736 bt_dev_dbg(bdev, "resume, delaying 15 ms");
737 msleep(15);
739 /* When this executes, the device has woken up already */
740 if (bdev->is_suspended && bdev->hu) {
741 bdev->is_suspended = false;
743 hci_uart_set_flow_control(bdev->hu, false);
746 return 0;
748 #endif
750 #ifdef CONFIG_PM_SLEEP
751 /* suspend callback */
752 static int bcm_suspend(struct device *dev)
754 struct bcm_device *bdev = dev_get_drvdata(dev);
755 int error;
757 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
760 * When used with a device instantiated as platform_device, bcm_suspend
761 * can be called at any time as long as the platform device is bound,
762 * so it should use bcm_device_lock to protect access to hci_uart
763 * and device_wake-up GPIO.
765 mutex_lock(&bcm_device_lock);
767 if (!bdev->hu)
768 goto unlock;
770 if (pm_runtime_active(dev))
771 bcm_suspend_device(dev);
773 if (device_may_wakeup(dev) && bdev->irq > 0) {
774 error = enable_irq_wake(bdev->irq);
775 if (!error)
776 bt_dev_dbg(bdev, "BCM irq: enabled");
779 unlock:
780 mutex_unlock(&bcm_device_lock);
782 return 0;
785 /* resume callback */
786 static int bcm_resume(struct device *dev)
788 struct bcm_device *bdev = dev_get_drvdata(dev);
789 int err = 0;
791 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
794 * When used with a device instantiated as platform_device, bcm_resume
795 * can be called at any time as long as platform device is bound,
796 * so it should use bcm_device_lock to protect access to hci_uart
797 * and device_wake-up GPIO.
799 mutex_lock(&bcm_device_lock);
801 if (!bdev->hu)
802 goto unlock;
804 if (device_may_wakeup(dev) && bdev->irq > 0) {
805 disable_irq_wake(bdev->irq);
806 bt_dev_dbg(bdev, "BCM irq: disabled");
809 err = bcm_resume_device(dev);
811 unlock:
812 mutex_unlock(&bcm_device_lock);
814 if (!err) {
815 pm_runtime_disable(dev);
816 pm_runtime_set_active(dev);
817 pm_runtime_enable(dev);
820 return 0;
822 #endif
824 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
825 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
826 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
828 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
829 { "device-wakeup-gpios", &first_gpio, 1 },
830 { "shutdown-gpios", &second_gpio, 1 },
831 { "host-wakeup-gpios", &third_gpio, 1 },
832 { },
835 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
836 { "host-wakeup-gpios", &first_gpio, 1 },
837 { "device-wakeup-gpios", &second_gpio, 1 },
838 { "shutdown-gpios", &third_gpio, 1 },
839 { },
842 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
843 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
845 .ident = "Meegopad T08",
846 .matches = {
847 DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
848 "To be filled by OEM."),
849 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
850 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
856 #ifdef CONFIG_ACPI
857 static int bcm_resource(struct acpi_resource *ares, void *data)
859 struct bcm_device *dev = data;
860 struct acpi_resource_extended_irq *irq;
861 struct acpi_resource_gpio *gpio;
862 struct acpi_resource_uart_serialbus *sb;
864 switch (ares->type) {
865 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
866 irq = &ares->data.extended_irq;
867 if (irq->polarity != ACPI_ACTIVE_LOW)
868 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
869 dev->irq_active_low = true;
870 break;
872 case ACPI_RESOURCE_TYPE_GPIO:
873 gpio = &ares->data.gpio;
874 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
875 dev->gpio_int_idx = dev->gpio_count;
876 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
878 dev->gpio_count++;
879 break;
881 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
882 sb = &ares->data.uart_serial_bus;
883 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
884 dev->init_speed = sb->default_baud_rate;
885 dev->oper_speed = 4000000;
887 break;
889 default:
890 break;
893 return 0;
896 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
898 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
899 return -EIO;
901 return 0;
904 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
906 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
907 NULL, NULL, NULL)))
908 return -EIO;
910 return 0;
913 static int bcm_apple_get_resources(struct bcm_device *dev)
915 struct acpi_device *adev = ACPI_COMPANION(dev->dev);
916 const union acpi_object *obj;
918 if (!adev ||
919 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
920 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
921 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
922 return -ENODEV;
924 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
925 obj->buffer.length == 8)
926 dev->init_speed = *(u64 *)obj->buffer.pointer;
928 dev->set_device_wakeup = bcm_apple_set_device_wakeup;
929 dev->set_shutdown = bcm_apple_set_shutdown;
931 return 0;
933 #else
934 static inline int bcm_apple_get_resources(struct bcm_device *dev)
936 return -EOPNOTSUPP;
938 #endif /* CONFIG_ACPI */
940 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
942 gpiod_set_value_cansleep(dev->device_wakeup, awake);
943 return 0;
946 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
948 gpiod_set_value_cansleep(dev->shutdown, powered);
949 return 0;
952 /* Try a bunch of names for TXCO */
953 static struct clk *bcm_get_txco(struct device *dev)
955 struct clk *clk;
957 /* New explicit name */
958 clk = devm_clk_get(dev, "txco");
959 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
960 return clk;
962 /* Deprecated name */
963 clk = devm_clk_get(dev, "extclk");
964 if (!IS_ERR(clk) || PTR_ERR(clk) == -EPROBE_DEFER)
965 return clk;
967 /* Original code used no name at all */
968 return devm_clk_get(dev, NULL);
971 static int bcm_get_resources(struct bcm_device *dev)
973 const struct dmi_system_id *dmi_id;
974 int err;
976 dev->name = dev_name(dev->dev);
978 if (x86_apple_machine && !bcm_apple_get_resources(dev))
979 return 0;
981 dev->txco_clk = bcm_get_txco(dev->dev);
983 /* Handle deferred probing */
984 if (dev->txco_clk == ERR_PTR(-EPROBE_DEFER))
985 return PTR_ERR(dev->txco_clk);
987 /* Ignore all other errors as before */
988 if (IS_ERR(dev->txco_clk))
989 dev->txco_clk = NULL;
991 dev->lpo_clk = devm_clk_get(dev->dev, "lpo");
992 if (dev->lpo_clk == ERR_PTR(-EPROBE_DEFER))
993 return PTR_ERR(dev->lpo_clk);
995 if (IS_ERR(dev->lpo_clk))
996 dev->lpo_clk = NULL;
998 /* Check if we accidentally fetched the lpo clock twice */
999 if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1000 devm_clk_put(dev->dev, dev->txco_clk);
1001 dev->txco_clk = NULL;
1004 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1005 GPIOD_OUT_LOW);
1006 if (IS_ERR(dev->device_wakeup))
1007 return PTR_ERR(dev->device_wakeup);
1009 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1010 GPIOD_OUT_LOW);
1011 if (IS_ERR(dev->shutdown))
1012 return PTR_ERR(dev->shutdown);
1014 dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1015 dev->set_shutdown = bcm_gpio_set_shutdown;
1017 dev->supplies[0].supply = "vbat";
1018 dev->supplies[1].supply = "vddio";
1019 err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1020 dev->supplies);
1021 if (err)
1022 return err;
1024 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1025 if (dev->irq <= 0) {
1026 struct gpio_desc *gpio;
1028 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
1029 GPIOD_IN);
1030 if (IS_ERR(gpio))
1031 return PTR_ERR(gpio);
1033 dev->irq = gpiod_to_irq(gpio);
1036 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1037 if (dmi_id) {
1038 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1039 dmi_id->ident);
1040 dev->irq = 0;
1043 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1044 return 0;
1047 #ifdef CONFIG_ACPI
1048 static int bcm_acpi_probe(struct bcm_device *dev)
1050 LIST_HEAD(resources);
1051 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1052 struct resource_entry *entry;
1053 int ret;
1055 /* Retrieve UART ACPI info */
1056 dev->gpio_int_idx = -1;
1057 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1058 &resources, bcm_resource, dev);
1059 if (ret < 0)
1060 return ret;
1062 resource_list_for_each_entry(entry, &resources) {
1063 if (resource_type(entry->res) == IORESOURCE_IRQ) {
1064 dev->irq = entry->res->start;
1065 break;
1068 acpi_dev_free_resource_list(&resources);
1070 /* If the DSDT uses an Interrupt resource for the IRQ, then there are
1071 * only 2 GPIO resources, we use the irq-last mapping for this, since
1072 * we already have an irq the 3th / last mapping will not be used.
1074 if (dev->irq)
1075 gpio_mapping = acpi_bcm_int_last_gpios;
1076 else if (dev->gpio_int_idx == 0)
1077 gpio_mapping = acpi_bcm_int_first_gpios;
1078 else if (dev->gpio_int_idx == 2)
1079 gpio_mapping = acpi_bcm_int_last_gpios;
1080 else
1081 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1082 dev->gpio_int_idx);
1084 /* Warn if our expectations are not met. */
1085 if (dev->gpio_count != (dev->irq ? 2 : 3))
1086 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1087 dev->gpio_count);
1089 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1090 if (ret)
1091 return ret;
1093 if (irq_polarity != -1) {
1094 dev->irq_active_low = irq_polarity;
1095 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1096 dev->irq_active_low ? "low" : "high");
1099 return 0;
1101 #else
1102 static int bcm_acpi_probe(struct bcm_device *dev)
1104 return -EINVAL;
1106 #endif /* CONFIG_ACPI */
1108 static int bcm_of_probe(struct bcm_device *bdev)
1110 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1111 return 0;
1114 static int bcm_probe(struct platform_device *pdev)
1116 struct bcm_device *dev;
1117 int ret;
1119 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1120 if (!dev)
1121 return -ENOMEM;
1123 dev->dev = &pdev->dev;
1124 dev->irq = platform_get_irq(pdev, 0);
1126 if (has_acpi_companion(&pdev->dev)) {
1127 ret = bcm_acpi_probe(dev);
1128 if (ret)
1129 return ret;
1132 ret = bcm_get_resources(dev);
1133 if (ret)
1134 return ret;
1136 platform_set_drvdata(pdev, dev);
1138 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1140 /* Place this instance on the device list */
1141 mutex_lock(&bcm_device_lock);
1142 list_add_tail(&dev->list, &bcm_device_list);
1143 mutex_unlock(&bcm_device_lock);
1145 ret = bcm_gpio_set_power(dev, false);
1146 if (ret)
1147 dev_err(&pdev->dev, "Failed to power down\n");
1149 return 0;
1152 static int bcm_remove(struct platform_device *pdev)
1154 struct bcm_device *dev = platform_get_drvdata(pdev);
1156 mutex_lock(&bcm_device_lock);
1157 list_del(&dev->list);
1158 mutex_unlock(&bcm_device_lock);
1160 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1162 return 0;
1165 static const struct hci_uart_proto bcm_proto = {
1166 .id = HCI_UART_BCM,
1167 .name = "Broadcom",
1168 .manufacturer = 15,
1169 .init_speed = 115200,
1170 .open = bcm_open,
1171 .close = bcm_close,
1172 .flush = bcm_flush,
1173 .setup = bcm_setup,
1174 .set_baudrate = bcm_set_baudrate,
1175 .recv = bcm_recv,
1176 .enqueue = bcm_enqueue,
1177 .dequeue = bcm_dequeue,
1180 #ifdef CONFIG_ACPI
1181 static const struct acpi_device_id bcm_acpi_match[] = {
1182 { "BCM2E00" },
1183 { "BCM2E01" },
1184 { "BCM2E02" },
1185 { "BCM2E03" },
1186 { "BCM2E04" },
1187 { "BCM2E05" },
1188 { "BCM2E06" },
1189 { "BCM2E07" },
1190 { "BCM2E08" },
1191 { "BCM2E09" },
1192 { "BCM2E0A" },
1193 { "BCM2E0B" },
1194 { "BCM2E0C" },
1195 { "BCM2E0D" },
1196 { "BCM2E0E" },
1197 { "BCM2E0F" },
1198 { "BCM2E10" },
1199 { "BCM2E11" },
1200 { "BCM2E12" },
1201 { "BCM2E13" },
1202 { "BCM2E14" },
1203 { "BCM2E15" },
1204 { "BCM2E16" },
1205 { "BCM2E17" },
1206 { "BCM2E18" },
1207 { "BCM2E19" },
1208 { "BCM2E1A" },
1209 { "BCM2E1B" },
1210 { "BCM2E1C" },
1211 { "BCM2E1D" },
1212 { "BCM2E1F" },
1213 { "BCM2E20" },
1214 { "BCM2E21" },
1215 { "BCM2E22" },
1216 { "BCM2E23" },
1217 { "BCM2E24" },
1218 { "BCM2E25" },
1219 { "BCM2E26" },
1220 { "BCM2E27" },
1221 { "BCM2E28" },
1222 { "BCM2E29" },
1223 { "BCM2E2A" },
1224 { "BCM2E2B" },
1225 { "BCM2E2C" },
1226 { "BCM2E2D" },
1227 { "BCM2E2E" },
1228 { "BCM2E2F" },
1229 { "BCM2E30" },
1230 { "BCM2E31" },
1231 { "BCM2E32" },
1232 { "BCM2E33" },
1233 { "BCM2E34" },
1234 { "BCM2E35" },
1235 { "BCM2E36" },
1236 { "BCM2E37" },
1237 { "BCM2E38" },
1238 { "BCM2E39" },
1239 { "BCM2E3A" },
1240 { "BCM2E3B" },
1241 { "BCM2E3C" },
1242 { "BCM2E3D" },
1243 { "BCM2E3E" },
1244 { "BCM2E3F" },
1245 { "BCM2E40" },
1246 { "BCM2E41" },
1247 { "BCM2E42" },
1248 { "BCM2E43" },
1249 { "BCM2E44" },
1250 { "BCM2E45" },
1251 { "BCM2E46" },
1252 { "BCM2E47" },
1253 { "BCM2E48" },
1254 { "BCM2E49" },
1255 { "BCM2E4A" },
1256 { "BCM2E4B" },
1257 { "BCM2E4C" },
1258 { "BCM2E4D" },
1259 { "BCM2E4E" },
1260 { "BCM2E4F" },
1261 { "BCM2E50" },
1262 { "BCM2E51" },
1263 { "BCM2E52" },
1264 { "BCM2E53" },
1265 { "BCM2E54" },
1266 { "BCM2E55" },
1267 { "BCM2E56" },
1268 { "BCM2E57" },
1269 { "BCM2E58" },
1270 { "BCM2E59" },
1271 { "BCM2E5A" },
1272 { "BCM2E5B" },
1273 { "BCM2E5C" },
1274 { "BCM2E5D" },
1275 { "BCM2E5E" },
1276 { "BCM2E5F" },
1277 { "BCM2E60" },
1278 { "BCM2E61" },
1279 { "BCM2E62" },
1280 { "BCM2E63" },
1281 { "BCM2E64" },
1282 { "BCM2E65" },
1283 { "BCM2E66" },
1284 { "BCM2E67" },
1285 { "BCM2E68" },
1286 { "BCM2E69" },
1287 { "BCM2E6B" },
1288 { "BCM2E6D" },
1289 { "BCM2E6E" },
1290 { "BCM2E6F" },
1291 { "BCM2E70" },
1292 { "BCM2E71" },
1293 { "BCM2E72" },
1294 { "BCM2E73" },
1295 { "BCM2E74" },
1296 { "BCM2E75" },
1297 { "BCM2E76" },
1298 { "BCM2E77" },
1299 { "BCM2E78" },
1300 { "BCM2E79" },
1301 { "BCM2E7A" },
1302 { "BCM2E7B" },
1303 { "BCM2E7C" },
1304 { "BCM2E7D" },
1305 { "BCM2E7E" },
1306 { "BCM2E7F" },
1307 { "BCM2E80" },
1308 { "BCM2E81" },
1309 { "BCM2E82" },
1310 { "BCM2E83" },
1311 { "BCM2E84" },
1312 { "BCM2E85" },
1313 { "BCM2E86" },
1314 { "BCM2E87" },
1315 { "BCM2E88" },
1316 { "BCM2E89" },
1317 { "BCM2E8A" },
1318 { "BCM2E8B" },
1319 { "BCM2E8C" },
1320 { "BCM2E8D" },
1321 { "BCM2E8E" },
1322 { "BCM2E90" },
1323 { "BCM2E92" },
1324 { "BCM2E93" },
1325 { "BCM2E94" },
1326 { "BCM2E95" },
1327 { "BCM2E96" },
1328 { "BCM2E97" },
1329 { "BCM2E98" },
1330 { "BCM2E99" },
1331 { "BCM2E9A" },
1332 { "BCM2E9B" },
1333 { "BCM2E9C" },
1334 { "BCM2E9D" },
1335 { "BCM2EA0" },
1336 { "BCM2EA1" },
1337 { "BCM2EA2" },
1338 { "BCM2EA3" },
1339 { "BCM2EA4" },
1340 { "BCM2EA5" },
1341 { "BCM2EA6" },
1342 { "BCM2EA7" },
1343 { "BCM2EA8" },
1344 { "BCM2EA9" },
1345 { "BCM2EAA" },
1346 { "BCM2EAB" },
1347 { "BCM2EAC" },
1348 { },
1350 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1351 #endif
1353 /* suspend and resume callbacks */
1354 static const struct dev_pm_ops bcm_pm_ops = {
1355 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1356 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1359 static struct platform_driver bcm_driver = {
1360 .probe = bcm_probe,
1361 .remove = bcm_remove,
1362 .driver = {
1363 .name = "hci_bcm",
1364 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1365 .pm = &bcm_pm_ops,
1369 static int bcm_serdev_probe(struct serdev_device *serdev)
1371 struct bcm_device *bcmdev;
1372 int err;
1374 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1375 if (!bcmdev)
1376 return -ENOMEM;
1378 bcmdev->dev = &serdev->dev;
1379 #ifdef CONFIG_PM
1380 bcmdev->hu = &bcmdev->serdev_hu;
1381 #endif
1382 bcmdev->serdev_hu.serdev = serdev;
1383 serdev_device_set_drvdata(serdev, bcmdev);
1385 if (has_acpi_companion(&serdev->dev))
1386 err = bcm_acpi_probe(bcmdev);
1387 else
1388 err = bcm_of_probe(bcmdev);
1389 if (err)
1390 return err;
1392 err = bcm_get_resources(bcmdev);
1393 if (err)
1394 return err;
1396 if (!bcmdev->shutdown) {
1397 dev_warn(&serdev->dev,
1398 "No reset resource, using default baud rate\n");
1399 bcmdev->oper_speed = bcmdev->init_speed;
1402 err = bcm_gpio_set_power(bcmdev, false);
1403 if (err)
1404 dev_err(&serdev->dev, "Failed to power down\n");
1406 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1409 static void bcm_serdev_remove(struct serdev_device *serdev)
1411 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1413 hci_uart_unregister_device(&bcmdev->serdev_hu);
1416 #ifdef CONFIG_OF
1417 static const struct of_device_id bcm_bluetooth_of_match[] = {
1418 { .compatible = "brcm,bcm20702a1" },
1419 { .compatible = "brcm,bcm4330-bt" },
1420 { .compatible = "brcm,bcm43438-bt" },
1421 { },
1423 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1424 #endif
1426 static struct serdev_device_driver bcm_serdev_driver = {
1427 .probe = bcm_serdev_probe,
1428 .remove = bcm_serdev_remove,
1429 .driver = {
1430 .name = "hci_uart_bcm",
1431 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1432 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1433 .pm = &bcm_pm_ops,
1437 int __init bcm_init(void)
1439 /* For now, we need to keep both platform device
1440 * driver (ACPI generated) and serdev driver (DT).
1442 platform_driver_register(&bcm_driver);
1443 serdev_device_driver_register(&bcm_serdev_driver);
1445 return hci_uart_register_proto(&bcm_proto);
1448 int __exit bcm_deinit(void)
1450 platform_driver_unregister(&bcm_driver);
1451 serdev_device_driver_unregister(&bcm_serdev_driver);
1453 return hci_uart_unregister_proto(&bcm_proto);