3 * Bluetooth HCI UART driver for Broadcom devices
5 * Copyright (C) 2015 Intel Corporation
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/skbuff.h>
27 #include <linux/firmware.h>
28 #include <linux/module.h>
29 #include <linux/acpi.h>
30 #include <linux/platform_device.h>
31 #include <linux/clk.h>
32 #include <linux/gpio/consumer.h>
33 #include <linux/tty.h>
34 #include <linux/interrupt.h>
35 #include <linux/dmi.h>
36 #include <linux/pm_runtime.h>
38 #include <net/bluetooth/bluetooth.h>
39 #include <net/bluetooth/hci_core.h>
44 #define BCM_LM_DIAG_PKT 0x07
45 #define BCM_LM_DIAG_SIZE 63
47 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */
50 struct list_head list;
52 struct platform_device *pdev;
55 struct gpio_desc *device_wakeup;
56 struct gpio_desc *shutdown;
67 bool is_suspended; /* suspend/resume flag */
72 struct sk_buff *rx_skb;
73 struct sk_buff_head txq;
75 struct bcm_device *dev;
78 /* List of BCM BT UART devices */
79 static DEFINE_MUTEX(bcm_device_lock);
80 static LIST_HEAD(bcm_device_list);
82 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
84 struct hci_dev *hdev = hu->hdev;
86 struct bcm_update_uart_baud_rate param;
88 if (speed > 3000000) {
89 struct bcm_write_uart_clock_setting clock;
91 clock.type = BCM_UART_CLOCK_48MHZ;
93 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
95 /* This Broadcom specific command changes the UART's controller
96 * clock for baud rate > 3000000.
98 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
100 int err = PTR_ERR(skb);
101 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
109 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
111 param.zero = cpu_to_le16(0);
112 param.baud_rate = cpu_to_le32(speed);
114 /* This Broadcom specific command changes the UART's controller baud
117 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
120 int err = PTR_ERR(skb);
121 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
131 /* bcm_device_exists should be protected by bcm_device_lock */
132 static bool bcm_device_exists(struct bcm_device *device)
136 list_for_each(p, &bcm_device_list) {
137 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
146 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
148 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
149 clk_enable(dev->clk);
151 gpiod_set_value(dev->shutdown, powered);
152 gpiod_set_value(dev->device_wakeup, powered);
154 if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
155 clk_disable(dev->clk);
157 dev->clk_enabled = powered;
163 static irqreturn_t bcm_host_wake(int irq, void *data)
165 struct bcm_device *bdev = data;
167 bt_dev_dbg(bdev, "Host wake IRQ");
169 pm_runtime_get(&bdev->pdev->dev);
170 pm_runtime_mark_last_busy(&bdev->pdev->dev);
171 pm_runtime_put_autosuspend(&bdev->pdev->dev);
176 static int bcm_request_irq(struct bcm_data *bcm)
178 struct bcm_device *bdev = bcm->dev;
181 /* If this is not a platform device, do not enable PM functionalities */
182 mutex_lock(&bcm_device_lock);
183 if (!bcm_device_exists(bdev)) {
189 err = devm_request_irq(&bdev->pdev->dev, bdev->irq,
190 bcm_host_wake, IRQF_TRIGGER_RISING,
195 device_init_wakeup(&bdev->pdev->dev, true);
197 pm_runtime_set_autosuspend_delay(&bdev->pdev->dev,
198 BCM_AUTOSUSPEND_DELAY);
199 pm_runtime_use_autosuspend(&bdev->pdev->dev);
200 pm_runtime_set_active(&bdev->pdev->dev);
201 pm_runtime_enable(&bdev->pdev->dev);
205 mutex_unlock(&bcm_device_lock);
210 static const struct bcm_set_sleep_mode default_sleep_params = {
211 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
212 .idle_host = 2, /* idle threshold HOST, in 300ms */
213 .idle_dev = 2, /* idle threshold device, in 300ms */
214 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
215 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
216 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
217 .combine_modes = 1, /* Combine sleep and LPM flag */
218 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
219 /* Irrelevant USB flags */
221 .usb_resume_timeout = 0,
222 .pulsed_host_wake = 0,
226 static int bcm_setup_sleep(struct hci_uart *hu)
228 struct bcm_data *bcm = hu->priv;
230 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
232 sleep_params.host_wake_active = !bcm->dev->irq_polarity;
234 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
235 &sleep_params, HCI_INIT_TIMEOUT);
237 int err = PTR_ERR(skb);
238 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
243 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
248 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
249 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
252 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
254 struct hci_uart *hu = hci_get_drvdata(hdev);
255 struct bcm_data *bcm = hu->priv;
258 if (!test_bit(HCI_RUNNING, &hdev->flags))
261 skb = bt_skb_alloc(3, GFP_KERNEL);
265 *skb_put(skb, 1) = BCM_LM_DIAG_PKT;
266 *skb_put(skb, 1) = 0xf0;
267 *skb_put(skb, 1) = enable;
269 skb_queue_tail(&bcm->txq, skb);
270 hci_uart_tx_wakeup(hu);
275 static int bcm_open(struct hci_uart *hu)
277 struct bcm_data *bcm;
280 bt_dev_dbg(hu->hdev, "hu %p", hu);
282 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
286 skb_queue_head_init(&bcm->txq);
290 mutex_lock(&bcm_device_lock);
291 list_for_each(p, &bcm_device_list) {
292 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
294 /* Retrieve saved bcm_device based on parent of the
295 * platform device (saved during device probe) and
296 * parent of tty device used by hci_uart
298 if (hu->tty->dev->parent == dev->pdev->dev.parent) {
300 hu->init_speed = dev->init_speed;
304 bcm_gpio_set_power(bcm->dev, true);
309 mutex_unlock(&bcm_device_lock);
314 static int bcm_close(struct hci_uart *hu)
316 struct bcm_data *bcm = hu->priv;
317 struct bcm_device *bdev = bcm->dev;
319 bt_dev_dbg(hu->hdev, "hu %p", hu);
321 /* Protect bcm->dev against removal of the device or driver */
322 mutex_lock(&bcm_device_lock);
323 if (bcm_device_exists(bdev)) {
324 bcm_gpio_set_power(bdev, false);
326 pm_runtime_disable(&bdev->pdev->dev);
327 pm_runtime_set_suspended(&bdev->pdev->dev);
329 if (device_can_wakeup(&bdev->pdev->dev)) {
330 devm_free_irq(&bdev->pdev->dev, bdev->irq, bdev);
331 device_init_wakeup(&bdev->pdev->dev, false);
337 mutex_unlock(&bcm_device_lock);
339 skb_queue_purge(&bcm->txq);
340 kfree_skb(bcm->rx_skb);
347 static int bcm_flush(struct hci_uart *hu)
349 struct bcm_data *bcm = hu->priv;
351 bt_dev_dbg(hu->hdev, "hu %p", hu);
353 skb_queue_purge(&bcm->txq);
358 static int bcm_setup(struct hci_uart *hu)
360 struct bcm_data *bcm = hu->priv;
362 const struct firmware *fw;
366 bt_dev_dbg(hu->hdev, "hu %p", hu);
368 hu->hdev->set_diag = bcm_set_diag;
369 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
371 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
375 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
377 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
381 err = btbcm_patchram(hu->hdev, fw);
383 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
387 /* Init speed if any */
389 speed = hu->init_speed;
390 else if (hu->proto->init_speed)
391 speed = hu->proto->init_speed;
396 hci_uart_set_baudrate(hu, speed);
398 /* Operational speed if any */
400 speed = hu->oper_speed;
401 else if (hu->proto->oper_speed)
402 speed = hu->proto->oper_speed;
407 err = bcm_set_baudrate(hu, speed);
409 hci_uart_set_baudrate(hu, speed);
413 release_firmware(fw);
415 err = btbcm_finalize(hu->hdev);
419 err = bcm_request_irq(bcm);
421 err = bcm_setup_sleep(hu);
426 #define BCM_RECV_LM_DIAG \
427 .type = BCM_LM_DIAG_PKT, \
428 .hlen = BCM_LM_DIAG_SIZE, \
431 .maxlen = BCM_LM_DIAG_SIZE
433 static const struct h4_recv_pkt bcm_recv_pkts[] = {
434 { H4_RECV_ACL, .recv = hci_recv_frame },
435 { H4_RECV_SCO, .recv = hci_recv_frame },
436 { H4_RECV_EVENT, .recv = hci_recv_frame },
437 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag },
440 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
442 struct bcm_data *bcm = hu->priv;
444 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
447 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
448 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
449 if (IS_ERR(bcm->rx_skb)) {
450 int err = PTR_ERR(bcm->rx_skb);
451 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
454 } else if (!bcm->rx_skb) {
455 /* Delay auto-suspend when receiving completed packet */
456 mutex_lock(&bcm_device_lock);
457 if (bcm->dev && bcm_device_exists(bcm->dev)) {
458 pm_runtime_get(&bcm->dev->pdev->dev);
459 pm_runtime_mark_last_busy(&bcm->dev->pdev->dev);
460 pm_runtime_put_autosuspend(&bcm->dev->pdev->dev);
462 mutex_unlock(&bcm_device_lock);
468 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
470 struct bcm_data *bcm = hu->priv;
472 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
474 /* Prepend skb with frame type */
475 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
476 skb_queue_tail(&bcm->txq, skb);
481 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
483 struct bcm_data *bcm = hu->priv;
484 struct sk_buff *skb = NULL;
485 struct bcm_device *bdev = NULL;
487 mutex_lock(&bcm_device_lock);
489 if (bcm_device_exists(bcm->dev)) {
491 pm_runtime_get_sync(&bdev->pdev->dev);
492 /* Shall be resumed here */
495 skb = skb_dequeue(&bcm->txq);
498 pm_runtime_mark_last_busy(&bdev->pdev->dev);
499 pm_runtime_put_autosuspend(&bdev->pdev->dev);
502 mutex_unlock(&bcm_device_lock);
508 static int bcm_suspend_device(struct device *dev)
510 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
512 bt_dev_dbg(bdev, "");
514 if (!bdev->is_suspended && bdev->hu) {
515 hci_uart_set_flow_control(bdev->hu, true);
517 /* Once this returns, driver suspends BT via GPIO */
518 bdev->is_suspended = true;
521 /* Suspend the device */
522 if (bdev->device_wakeup) {
523 gpiod_set_value(bdev->device_wakeup, false);
524 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
531 static int bcm_resume_device(struct device *dev)
533 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
535 bt_dev_dbg(bdev, "");
537 if (bdev->device_wakeup) {
538 gpiod_set_value(bdev->device_wakeup, true);
539 bt_dev_dbg(bdev, "resume, delaying 15 ms");
543 /* When this executes, the device has woken up already */
544 if (bdev->is_suspended && bdev->hu) {
545 bdev->is_suspended = false;
547 hci_uart_set_flow_control(bdev->hu, false);
554 #ifdef CONFIG_PM_SLEEP
555 /* Platform suspend callback */
556 static int bcm_suspend(struct device *dev)
558 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
561 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
563 /* bcm_suspend can be called at any time as long as platform device is
564 * bound, so it should use bcm_device_lock to protect access to hci_uart
565 * and device_wake-up GPIO.
567 mutex_lock(&bcm_device_lock);
572 if (pm_runtime_active(dev))
573 bcm_suspend_device(dev);
575 if (device_may_wakeup(&bdev->pdev->dev)) {
576 error = enable_irq_wake(bdev->irq);
578 bt_dev_dbg(bdev, "BCM irq: enabled");
582 mutex_unlock(&bcm_device_lock);
587 /* Platform resume callback */
588 static int bcm_resume(struct device *dev)
590 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
592 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
594 /* bcm_resume can be called at any time as long as platform device is
595 * bound, so it should use bcm_device_lock to protect access to hci_uart
596 * and device_wake-up GPIO.
598 mutex_lock(&bcm_device_lock);
603 if (device_may_wakeup(&bdev->pdev->dev)) {
604 disable_irq_wake(bdev->irq);
605 bt_dev_dbg(bdev, "BCM irq: disabled");
608 bcm_resume_device(dev);
611 mutex_unlock(&bcm_device_lock);
613 pm_runtime_disable(dev);
614 pm_runtime_set_active(dev);
615 pm_runtime_enable(dev);
621 static const struct acpi_gpio_params device_wakeup_gpios = { 0, 0, false };
622 static const struct acpi_gpio_params shutdown_gpios = { 1, 0, false };
623 static const struct acpi_gpio_params host_wakeup_gpios = { 2, 0, false };
625 static const struct acpi_gpio_mapping acpi_bcm_default_gpios[] = {
626 { "device-wakeup-gpios", &device_wakeup_gpios, 1 },
627 { "shutdown-gpios", &shutdown_gpios, 1 },
628 { "host-wakeup-gpios", &host_wakeup_gpios, 1 },
633 static u8 acpi_active_low = ACPI_ACTIVE_LOW;
635 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */
636 static const struct dmi_system_id bcm_wrong_irq_dmi_table[] = {
638 .ident = "Asus T100TA",
640 DMI_EXACT_MATCH(DMI_SYS_VENDOR,
641 "ASUSTeK COMPUTER INC."),
642 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100TA"),
644 .driver_data = &acpi_active_low,
649 static int bcm_resource(struct acpi_resource *ares, void *data)
651 struct bcm_device *dev = data;
652 struct acpi_resource_extended_irq *irq;
653 struct acpi_resource_gpio *gpio;
654 struct acpi_resource_uart_serialbus *sb;
656 switch (ares->type) {
657 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
658 irq = &ares->data.extended_irq;
659 dev->irq_polarity = irq->polarity;
662 case ACPI_RESOURCE_TYPE_GPIO:
663 gpio = &ares->data.gpio;
664 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
665 dev->irq_polarity = gpio->polarity;
668 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
669 sb = &ares->data.uart_serial_bus;
670 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
671 dev->init_speed = sb->default_baud_rate;
678 /* Always tell the ACPI core to skip this resource */
682 static int bcm_acpi_probe(struct bcm_device *dev)
684 struct platform_device *pdev = dev->pdev;
685 LIST_HEAD(resources);
686 const struct dmi_system_id *dmi_id;
689 /* Retrieve GPIO data */
690 dev->name = dev_name(&pdev->dev);
691 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(&pdev->dev),
692 acpi_bcm_default_gpios);
696 dev->clk = devm_clk_get(&pdev->dev, NULL);
698 dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
701 if (IS_ERR(dev->device_wakeup))
702 return PTR_ERR(dev->device_wakeup);
704 dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
706 if (IS_ERR(dev->shutdown))
707 return PTR_ERR(dev->shutdown);
709 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
710 dev->irq = platform_get_irq(pdev, 0);
712 struct gpio_desc *gpio;
714 gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
717 return PTR_ERR(gpio);
719 dev->irq = gpiod_to_irq(gpio);
722 dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
724 /* Make sure at-least one of the GPIO is defined and that
725 * a name is specified for this instance
727 if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
728 dev_err(&pdev->dev, "invalid platform data\n");
732 /* Retrieve UART ACPI info */
733 ret = acpi_dev_get_resources(ACPI_COMPANION(&dev->pdev->dev),
734 &resources, bcm_resource, dev);
737 acpi_dev_free_resource_list(&resources);
739 dmi_id = dmi_first_match(bcm_wrong_irq_dmi_table);
741 bt_dev_warn(dev, "%s: Overwriting IRQ polarity to active low",
743 dev->irq_polarity = *(u8 *)dmi_id->driver_data;
749 static int bcm_acpi_probe(struct bcm_device *dev)
753 #endif /* CONFIG_ACPI */
755 static int bcm_probe(struct platform_device *pdev)
757 struct bcm_device *dev;
760 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
766 ret = bcm_acpi_probe(dev);
770 platform_set_drvdata(pdev, dev);
772 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
774 /* Place this instance on the device list */
775 mutex_lock(&bcm_device_lock);
776 list_add_tail(&dev->list, &bcm_device_list);
777 mutex_unlock(&bcm_device_lock);
779 bcm_gpio_set_power(dev, false);
784 static int bcm_remove(struct platform_device *pdev)
786 struct bcm_device *dev = platform_get_drvdata(pdev);
788 mutex_lock(&bcm_device_lock);
789 list_del(&dev->list);
790 mutex_unlock(&bcm_device_lock);
792 acpi_dev_remove_driver_gpios(ACPI_COMPANION(&pdev->dev));
794 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
799 static const struct hci_uart_proto bcm_proto = {
803 .init_speed = 115200,
804 .oper_speed = 4000000,
809 .set_baudrate = bcm_set_baudrate,
811 .enqueue = bcm_enqueue,
812 .dequeue = bcm_dequeue,
816 static const struct acpi_device_id bcm_acpi_match[] = {
822 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
825 /* Platform suspend and resume callbacks */
826 static const struct dev_pm_ops bcm_pm_ops = {
827 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
828 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
831 static struct platform_driver bcm_driver = {
833 .remove = bcm_remove,
836 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
841 int __init bcm_init(void)
843 platform_driver_register(&bcm_driver);
845 return hci_uart_register_proto(&bcm_proto);
848 int __exit bcm_deinit(void)
850 platform_driver_unregister(&bcm_driver);
852 return hci_uart_unregister_proto(&bcm_proto);