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>
37 #include <net/bluetooth/bluetooth.h>
38 #include <net/bluetooth/hci_core.h>
44 struct list_head list;
46 struct platform_device *pdev;
49 struct gpio_desc *device_wakeup;
50 struct gpio_desc *shutdown;
61 bool is_suspended; /* suspend/resume flag */
66 struct sk_buff *rx_skb;
67 struct sk_buff_head txq;
69 struct bcm_device *dev;
72 /* List of BCM BT UART devices */
73 static DEFINE_MUTEX(bcm_device_lock);
74 static LIST_HEAD(bcm_device_list);
76 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
78 struct hci_dev *hdev = hu->hdev;
80 struct bcm_update_uart_baud_rate param;
82 if (speed > 3000000) {
83 struct bcm_write_uart_clock_setting clock;
85 clock.type = BCM_UART_CLOCK_48MHZ;
87 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
89 /* This Broadcom specific command changes the UART's controller
90 * clock for baud rate > 3000000.
92 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
94 int err = PTR_ERR(skb);
95 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
103 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
105 param.zero = cpu_to_le16(0);
106 param.baud_rate = cpu_to_le32(speed);
108 /* This Broadcom specific command changes the UART's controller baud
111 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
114 int err = PTR_ERR(skb);
115 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
125 /* bcm_device_exists should be protected by bcm_device_lock */
126 static bool bcm_device_exists(struct bcm_device *device)
130 list_for_each(p, &bcm_device_list) {
131 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
140 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
142 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
143 clk_enable(dev->clk);
145 gpiod_set_value(dev->shutdown, powered);
146 gpiod_set_value(dev->device_wakeup, powered);
148 if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
149 clk_disable(dev->clk);
151 dev->clk_enabled = powered;
157 static irqreturn_t bcm_host_wake(int irq, void *data)
159 struct bcm_device *bdev = data;
161 bt_dev_dbg(bdev, "Host wake IRQ");
166 static int bcm_request_irq(struct bcm_data *bcm)
168 struct bcm_device *bdev = bcm->dev;
171 /* If this is not a platform device, do not enable PM functionalities */
172 mutex_lock(&bcm_device_lock);
173 if (!bcm_device_exists(bdev)) {
179 err = devm_request_irq(&bdev->pdev->dev, bdev->irq,
180 bcm_host_wake, IRQF_TRIGGER_RISING,
185 device_init_wakeup(&bdev->pdev->dev, true);
189 mutex_unlock(&bcm_device_lock);
194 static const struct bcm_set_sleep_mode default_sleep_params = {
195 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
196 .idle_host = 2, /* idle threshold HOST, in 300ms */
197 .idle_dev = 2, /* idle threshold device, in 300ms */
198 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
199 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
200 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
201 .combine_modes = 0, /* Combine sleep and LPM flag */
202 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
203 /* Irrelevant USB flags */
205 .usb_resume_timeout = 0,
206 .pulsed_host_wake = 0,
210 static int bcm_setup_sleep(struct hci_uart *hu)
212 struct bcm_data *bcm = hu->priv;
214 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
216 sleep_params.host_wake_active = !bcm->dev->irq_polarity;
218 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
219 &sleep_params, HCI_INIT_TIMEOUT);
221 int err = PTR_ERR(skb);
222 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
227 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
232 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
233 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
236 static int bcm_open(struct hci_uart *hu)
238 struct bcm_data *bcm;
241 bt_dev_dbg(hu->hdev, "hu %p", hu);
243 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
247 skb_queue_head_init(&bcm->txq);
251 mutex_lock(&bcm_device_lock);
252 list_for_each(p, &bcm_device_list) {
253 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
255 /* Retrieve saved bcm_device based on parent of the
256 * platform device (saved during device probe) and
257 * parent of tty device used by hci_uart
259 if (hu->tty->dev->parent == dev->pdev->dev.parent) {
261 hu->init_speed = dev->init_speed;
265 bcm_gpio_set_power(bcm->dev, true);
270 mutex_unlock(&bcm_device_lock);
275 static int bcm_close(struct hci_uart *hu)
277 struct bcm_data *bcm = hu->priv;
278 struct bcm_device *bdev = bcm->dev;
280 bt_dev_dbg(hu->hdev, "hu %p", hu);
282 /* Protect bcm->dev against removal of the device or driver */
283 mutex_lock(&bcm_device_lock);
284 if (bcm_device_exists(bdev)) {
285 bcm_gpio_set_power(bdev, false);
287 if (device_can_wakeup(&bdev->pdev->dev)) {
288 devm_free_irq(&bdev->pdev->dev, bdev->irq, bdev);
289 device_init_wakeup(&bdev->pdev->dev, false);
295 mutex_unlock(&bcm_device_lock);
297 skb_queue_purge(&bcm->txq);
298 kfree_skb(bcm->rx_skb);
305 static int bcm_flush(struct hci_uart *hu)
307 struct bcm_data *bcm = hu->priv;
309 bt_dev_dbg(hu->hdev, "hu %p", hu);
311 skb_queue_purge(&bcm->txq);
316 static int bcm_setup(struct hci_uart *hu)
318 struct bcm_data *bcm = hu->priv;
320 const struct firmware *fw;
324 bt_dev_dbg(hu->hdev, "hu %p", hu);
326 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
328 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
332 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
334 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
338 err = btbcm_patchram(hu->hdev, fw);
340 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
344 /* Init speed if any */
346 speed = hu->init_speed;
347 else if (hu->proto->init_speed)
348 speed = hu->proto->init_speed;
353 hci_uart_set_baudrate(hu, speed);
355 /* Operational speed if any */
357 speed = hu->oper_speed;
358 else if (hu->proto->oper_speed)
359 speed = hu->proto->oper_speed;
364 err = bcm_set_baudrate(hu, speed);
366 hci_uart_set_baudrate(hu, speed);
370 release_firmware(fw);
372 err = btbcm_finalize(hu->hdev);
376 err = bcm_request_irq(bcm);
378 err = bcm_setup_sleep(hu);
383 static const struct h4_recv_pkt bcm_recv_pkts[] = {
384 { H4_RECV_ACL, .recv = hci_recv_frame },
385 { H4_RECV_SCO, .recv = hci_recv_frame },
386 { H4_RECV_EVENT, .recv = hci_recv_frame },
389 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
391 struct bcm_data *bcm = hu->priv;
393 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
396 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
397 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
398 if (IS_ERR(bcm->rx_skb)) {
399 int err = PTR_ERR(bcm->rx_skb);
400 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
408 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
410 struct bcm_data *bcm = hu->priv;
412 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
414 /* Prepend skb with frame type */
415 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
416 skb_queue_tail(&bcm->txq, skb);
421 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
423 struct bcm_data *bcm = hu->priv;
425 return skb_dequeue(&bcm->txq);
429 static int bcm_suspend_device(struct device *dev)
431 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
433 bt_dev_dbg(bdev, "");
435 if (!bdev->is_suspended && bdev->hu) {
436 hci_uart_set_flow_control(bdev->hu, true);
438 /* Once this returns, driver suspends BT via GPIO */
439 bdev->is_suspended = true;
442 /* Suspend the device */
443 if (bdev->device_wakeup) {
444 gpiod_set_value(bdev->device_wakeup, false);
445 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
452 static int bcm_resume_device(struct device *dev)
454 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
456 bt_dev_dbg(bdev, "");
458 if (bdev->device_wakeup) {
459 gpiod_set_value(bdev->device_wakeup, true);
460 bt_dev_dbg(bdev, "resume, delaying 15 ms");
464 /* When this executes, the device has woken up already */
465 if (bdev->is_suspended && bdev->hu) {
466 bdev->is_suspended = false;
468 hci_uart_set_flow_control(bdev->hu, false);
475 #ifdef CONFIG_PM_SLEEP
476 /* Platform suspend callback */
477 static int bcm_suspend(struct device *dev)
479 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
482 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
484 /* bcm_suspend can be called at any time as long as platform device is
485 * bound, so it should use bcm_device_lock to protect access to hci_uart
486 * and device_wake-up GPIO.
488 mutex_lock(&bcm_device_lock);
493 bcm_suspend_device(dev);
495 if (device_may_wakeup(&bdev->pdev->dev)) {
496 error = enable_irq_wake(bdev->irq);
498 bt_dev_dbg(bdev, "BCM irq: enabled");
502 mutex_unlock(&bcm_device_lock);
507 /* Platform resume callback */
508 static int bcm_resume(struct device *dev)
510 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
512 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
514 /* bcm_resume can be called at any time as long as platform device is
515 * bound, so it should use bcm_device_lock to protect access to hci_uart
516 * and device_wake-up GPIO.
518 mutex_lock(&bcm_device_lock);
523 if (device_may_wakeup(&bdev->pdev->dev)) {
524 disable_irq_wake(bdev->irq);
525 bt_dev_dbg(bdev, "BCM irq: disabled");
528 bcm_resume_device(dev);
531 mutex_unlock(&bcm_device_lock);
537 static const struct acpi_gpio_params device_wakeup_gpios = { 0, 0, false };
538 static const struct acpi_gpio_params shutdown_gpios = { 1, 0, false };
539 static const struct acpi_gpio_params host_wakeup_gpios = { 2, 0, false };
541 static const struct acpi_gpio_mapping acpi_bcm_default_gpios[] = {
542 { "device-wakeup-gpios", &device_wakeup_gpios, 1 },
543 { "shutdown-gpios", &shutdown_gpios, 1 },
544 { "host-wakeup-gpios", &host_wakeup_gpios, 1 },
549 static u8 acpi_active_low = ACPI_ACTIVE_LOW;
551 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */
552 static const struct dmi_system_id bcm_wrong_irq_dmi_table[] = {
554 .ident = "Asus T100TA",
556 DMI_EXACT_MATCH(DMI_SYS_VENDOR,
557 "ASUSTeK COMPUTER INC."),
558 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100TA"),
560 .driver_data = &acpi_active_low,
565 static int bcm_resource(struct acpi_resource *ares, void *data)
567 struct bcm_device *dev = data;
568 struct acpi_resource_extended_irq *irq;
569 struct acpi_resource_gpio *gpio;
570 struct acpi_resource_uart_serialbus *sb;
572 switch (ares->type) {
573 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
574 irq = &ares->data.extended_irq;
575 dev->irq_polarity = irq->polarity;
578 case ACPI_RESOURCE_TYPE_GPIO:
579 gpio = &ares->data.gpio;
580 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
581 dev->irq_polarity = gpio->polarity;
584 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
585 sb = &ares->data.uart_serial_bus;
586 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
587 dev->init_speed = sb->default_baud_rate;
594 /* Always tell the ACPI core to skip this resource */
598 static int bcm_acpi_probe(struct bcm_device *dev)
600 struct platform_device *pdev = dev->pdev;
601 const struct acpi_device_id *id;
602 struct acpi_device *adev;
603 LIST_HEAD(resources);
604 const struct dmi_system_id *dmi_id;
607 id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
611 /* Retrieve GPIO data */
612 dev->name = dev_name(&pdev->dev);
613 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(&pdev->dev),
614 acpi_bcm_default_gpios);
618 dev->clk = devm_clk_get(&pdev->dev, NULL);
620 dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
623 if (IS_ERR(dev->device_wakeup))
624 return PTR_ERR(dev->device_wakeup);
626 dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
628 if (IS_ERR(dev->shutdown))
629 return PTR_ERR(dev->shutdown);
631 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
632 dev->irq = platform_get_irq(pdev, 0);
634 struct gpio_desc *gpio;
636 gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
639 return PTR_ERR(gpio);
641 dev->irq = gpiod_to_irq(gpio);
644 dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
646 /* Make sure at-least one of the GPIO is defined and that
647 * a name is specified for this instance
649 if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
650 dev_err(&pdev->dev, "invalid platform data\n");
654 /* Retrieve UART ACPI info */
655 adev = ACPI_COMPANION(&dev->pdev->dev);
659 acpi_dev_get_resources(adev, &resources, bcm_resource, dev);
661 dmi_id = dmi_first_match(bcm_wrong_irq_dmi_table);
663 bt_dev_warn(dev, "%s: Overwriting IRQ polarity to active low",
665 dev->irq_polarity = *(u8 *)dmi_id->driver_data;
671 static int bcm_acpi_probe(struct bcm_device *dev)
675 #endif /* CONFIG_ACPI */
677 static int bcm_probe(struct platform_device *pdev)
679 struct bcm_device *dev;
680 struct acpi_device_id *pdata = pdev->dev.platform_data;
683 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
689 if (ACPI_HANDLE(&pdev->dev)) {
690 ret = bcm_acpi_probe(dev);
694 dev->name = pdata->id;
699 platform_set_drvdata(pdev, dev);
701 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
703 /* Place this instance on the device list */
704 mutex_lock(&bcm_device_lock);
705 list_add_tail(&dev->list, &bcm_device_list);
706 mutex_unlock(&bcm_device_lock);
708 bcm_gpio_set_power(dev, false);
713 static int bcm_remove(struct platform_device *pdev)
715 struct bcm_device *dev = platform_get_drvdata(pdev);
717 mutex_lock(&bcm_device_lock);
718 list_del(&dev->list);
719 mutex_unlock(&bcm_device_lock);
721 acpi_dev_remove_driver_gpios(ACPI_COMPANION(&pdev->dev));
723 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
728 static const struct hci_uart_proto bcm_proto = {
731 .init_speed = 115200,
732 .oper_speed = 4000000,
737 .set_baudrate = bcm_set_baudrate,
739 .enqueue = bcm_enqueue,
740 .dequeue = bcm_dequeue,
744 static const struct acpi_device_id bcm_acpi_match[] = {
749 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
752 /* Platform suspend and resume callbacks */
753 static SIMPLE_DEV_PM_OPS(bcm_pm_ops, bcm_suspend, bcm_resume);
755 static struct platform_driver bcm_driver = {
757 .remove = bcm_remove,
760 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
765 int __init bcm_init(void)
767 platform_driver_register(&bcm_driver);
769 return hci_uart_register_proto(&bcm_proto);
772 int __exit bcm_deinit(void)
774 platform_driver_unregister(&bcm_driver);
776 return hci_uart_unregister_proto(&bcm_proto);