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>
36 #include <net/bluetooth/bluetooth.h>
37 #include <net/bluetooth/hci_core.h>
43 struct list_head list;
45 struct platform_device *pdev;
48 struct gpio_desc *device_wakeup;
49 struct gpio_desc *shutdown;
58 #ifdef CONFIG_PM_SLEEP
60 bool is_suspended; /* suspend/resume flag */
65 struct sk_buff *rx_skb;
66 struct sk_buff_head txq;
68 struct bcm_device *dev;
71 /* List of BCM BT UART devices */
72 static DEFINE_MUTEX(bcm_device_lock);
73 static LIST_HEAD(bcm_device_list);
75 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
77 struct hci_dev *hdev = hu->hdev;
79 struct bcm_update_uart_baud_rate param;
81 if (speed > 3000000) {
82 struct bcm_write_uart_clock_setting clock;
84 clock.type = BCM_UART_CLOCK_48MHZ;
86 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
88 /* This Broadcom specific command changes the UART's controller
89 * clock for baud rate > 3000000.
91 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
93 int err = PTR_ERR(skb);
94 bt_dev_err(hdev, "BCM: failed to write clock (%d)",
102 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
104 param.zero = cpu_to_le16(0);
105 param.baud_rate = cpu_to_le32(speed);
107 /* This Broadcom specific command changes the UART's controller baud
110 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m,
113 int err = PTR_ERR(skb);
114 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
124 /* bcm_device_exists should be protected by bcm_device_lock */
125 static bool bcm_device_exists(struct bcm_device *device)
129 list_for_each(p, &bcm_device_list) {
130 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
139 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
141 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
142 clk_enable(dev->clk);
144 gpiod_set_value(dev->shutdown, powered);
145 gpiod_set_value(dev->device_wakeup, powered);
147 if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
148 clk_disable(dev->clk);
150 dev->clk_enabled = powered;
155 #ifdef CONFIG_PM_SLEEP
156 static irqreturn_t bcm_host_wake(int irq, void *data)
158 struct bcm_device *bdev = data;
160 bt_dev_dbg(bdev, "Host wake IRQ");
165 static int bcm_request_irq(struct bcm_data *bcm)
167 struct bcm_device *bdev = bcm->dev;
170 /* If this is not a platform device, do not enable PM functionalities */
171 mutex_lock(&bcm_device_lock);
172 if (!bcm_device_exists(bdev)) {
178 err = devm_request_irq(&bdev->pdev->dev, bdev->irq,
179 bcm_host_wake, IRQF_TRIGGER_RISING,
184 device_init_wakeup(&bdev->pdev->dev, true);
188 mutex_unlock(&bcm_device_lock);
193 static const struct bcm_set_sleep_mode default_sleep_params = {
194 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
195 .idle_host = 2, /* idle threshold HOST, in 300ms */
196 .idle_dev = 2, /* idle threshold device, in 300ms */
197 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */
198 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */
199 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */
200 .combine_modes = 0, /* Combine sleep and LPM flag */
201 .tristate_control = 0, /* Allow tri-state control of UART tx flag */
202 /* Irrelevant USB flags */
204 .usb_resume_timeout = 0,
205 .pulsed_host_wake = 0,
209 static int bcm_setup_sleep(struct hci_uart *hu)
211 struct bcm_data *bcm = hu->priv;
213 struct bcm_set_sleep_mode sleep_params = default_sleep_params;
215 sleep_params.host_wake_active = !bcm->dev->irq_polarity;
217 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
218 &sleep_params, HCI_INIT_TIMEOUT);
220 int err = PTR_ERR(skb);
221 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
226 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
231 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
232 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
235 static int bcm_open(struct hci_uart *hu)
237 struct bcm_data *bcm;
240 bt_dev_dbg(hu->hdev, "hu %p", hu);
242 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
246 skb_queue_head_init(&bcm->txq);
250 mutex_lock(&bcm_device_lock);
251 list_for_each(p, &bcm_device_list) {
252 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
254 /* Retrieve saved bcm_device based on parent of the
255 * platform device (saved during device probe) and
256 * parent of tty device used by hci_uart
258 if (hu->tty->dev->parent == dev->pdev->dev.parent) {
260 hu->init_speed = dev->init_speed;
261 #ifdef CONFIG_PM_SLEEP
264 bcm_gpio_set_power(bcm->dev, true);
269 mutex_unlock(&bcm_device_lock);
274 static int bcm_close(struct hci_uart *hu)
276 struct bcm_data *bcm = hu->priv;
277 struct bcm_device *bdev = bcm->dev;
279 bt_dev_dbg(hu->hdev, "hu %p", hu);
281 /* Protect bcm->dev against removal of the device or driver */
282 mutex_lock(&bcm_device_lock);
283 if (bcm_device_exists(bdev)) {
284 bcm_gpio_set_power(bdev, false);
285 #ifdef CONFIG_PM_SLEEP
286 if (device_can_wakeup(&bdev->pdev->dev)) {
287 devm_free_irq(&bdev->pdev->dev, bdev->irq, bdev);
288 device_init_wakeup(&bdev->pdev->dev, false);
294 mutex_unlock(&bcm_device_lock);
296 skb_queue_purge(&bcm->txq);
297 kfree_skb(bcm->rx_skb);
304 static int bcm_flush(struct hci_uart *hu)
306 struct bcm_data *bcm = hu->priv;
308 bt_dev_dbg(hu->hdev, "hu %p", hu);
310 skb_queue_purge(&bcm->txq);
315 static int bcm_setup(struct hci_uart *hu)
317 struct bcm_data *bcm = hu->priv;
319 const struct firmware *fw;
323 bt_dev_dbg(hu->hdev, "hu %p", hu);
325 hu->hdev->set_bdaddr = btbcm_set_bdaddr;
327 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
331 err = request_firmware(&fw, fw_name, &hu->hdev->dev);
333 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
337 err = btbcm_patchram(hu->hdev, fw);
339 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
343 /* Init speed if any */
345 speed = hu->init_speed;
346 else if (hu->proto->init_speed)
347 speed = hu->proto->init_speed;
352 hci_uart_set_baudrate(hu, speed);
354 /* Operational speed if any */
356 speed = hu->oper_speed;
357 else if (hu->proto->oper_speed)
358 speed = hu->proto->oper_speed;
363 err = bcm_set_baudrate(hu, speed);
365 hci_uart_set_baudrate(hu, speed);
369 release_firmware(fw);
371 err = btbcm_finalize(hu->hdev);
375 err = bcm_request_irq(bcm);
377 err = bcm_setup_sleep(hu);
382 static const struct h4_recv_pkt bcm_recv_pkts[] = {
383 { H4_RECV_ACL, .recv = hci_recv_frame },
384 { H4_RECV_SCO, .recv = hci_recv_frame },
385 { H4_RECV_EVENT, .recv = hci_recv_frame },
388 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
390 struct bcm_data *bcm = hu->priv;
392 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
395 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
396 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
397 if (IS_ERR(bcm->rx_skb)) {
398 int err = PTR_ERR(bcm->rx_skb);
399 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
407 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
409 struct bcm_data *bcm = hu->priv;
411 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
413 /* Prepend skb with frame type */
414 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
415 skb_queue_tail(&bcm->txq, skb);
420 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
422 struct bcm_data *bcm = hu->priv;
424 return skb_dequeue(&bcm->txq);
427 #ifdef CONFIG_PM_SLEEP
428 /* Platform suspend callback */
429 static int bcm_suspend(struct device *dev)
431 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
434 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
436 mutex_lock(&bcm_device_lock);
441 if (!bdev->is_suspended) {
442 hci_uart_set_flow_control(bdev->hu, true);
444 /* Once this callback returns, driver suspends BT via GPIO */
445 bdev->is_suspended = true;
448 /* Suspend the device */
449 if (bdev->device_wakeup) {
450 gpiod_set_value(bdev->device_wakeup, false);
451 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
455 if (device_may_wakeup(&bdev->pdev->dev)) {
456 error = enable_irq_wake(bdev->irq);
458 bt_dev_dbg(bdev, "BCM irq: enabled");
462 mutex_unlock(&bcm_device_lock);
467 /* Platform resume callback */
468 static int bcm_resume(struct device *dev)
470 struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
472 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
474 mutex_lock(&bcm_device_lock);
479 if (device_may_wakeup(&bdev->pdev->dev)) {
480 disable_irq_wake(bdev->irq);
481 bt_dev_dbg(bdev, "BCM irq: disabled");
484 if (bdev->device_wakeup) {
485 gpiod_set_value(bdev->device_wakeup, true);
486 bt_dev_dbg(bdev, "resume, delaying 15 ms");
490 /* When this callback executes, the device has woken up already */
491 if (bdev->is_suspended) {
492 bdev->is_suspended = false;
494 hci_uart_set_flow_control(bdev->hu, false);
498 mutex_unlock(&bcm_device_lock);
504 static const struct acpi_gpio_params device_wakeup_gpios = { 0, 0, false };
505 static const struct acpi_gpio_params shutdown_gpios = { 1, 0, false };
506 static const struct acpi_gpio_params host_wakeup_gpios = { 2, 0, false };
508 static const struct acpi_gpio_mapping acpi_bcm_default_gpios[] = {
509 { "device-wakeup-gpios", &device_wakeup_gpios, 1 },
510 { "shutdown-gpios", &shutdown_gpios, 1 },
511 { "host-wakeup-gpios", &host_wakeup_gpios, 1 },
516 static int bcm_resource(struct acpi_resource *ares, void *data)
518 struct bcm_device *dev = data;
519 struct acpi_resource_extended_irq *irq;
520 struct acpi_resource_gpio *gpio;
521 struct acpi_resource_uart_serialbus *sb;
523 switch (ares->type) {
524 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
525 irq = &ares->data.extended_irq;
526 dev->irq_polarity = irq->polarity;
529 case ACPI_RESOURCE_TYPE_GPIO:
530 gpio = &ares->data.gpio;
531 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
532 dev->irq_polarity = gpio->polarity;
535 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
536 sb = &ares->data.uart_serial_bus;
537 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
538 dev->init_speed = sb->default_baud_rate;
545 /* Always tell the ACPI core to skip this resource */
549 static int bcm_acpi_probe(struct bcm_device *dev)
551 struct platform_device *pdev = dev->pdev;
552 const struct acpi_device_id *id;
553 struct acpi_device *adev;
554 LIST_HEAD(resources);
557 id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
561 /* Retrieve GPIO data */
562 dev->name = dev_name(&pdev->dev);
563 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(&pdev->dev),
564 acpi_bcm_default_gpios);
568 dev->clk = devm_clk_get(&pdev->dev, NULL);
570 dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
573 if (IS_ERR(dev->device_wakeup))
574 return PTR_ERR(dev->device_wakeup);
576 dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
578 if (IS_ERR(dev->shutdown))
579 return PTR_ERR(dev->shutdown);
581 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
582 dev->irq = platform_get_irq(pdev, 0);
584 struct gpio_desc *gpio;
586 gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
589 return PTR_ERR(gpio);
591 dev->irq = gpiod_to_irq(gpio);
594 dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
596 /* Make sure at-least one of the GPIO is defined and that
597 * a name is specified for this instance
599 if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
600 dev_err(&pdev->dev, "invalid platform data\n");
604 /* Retrieve UART ACPI info */
605 adev = ACPI_COMPANION(&dev->pdev->dev);
609 acpi_dev_get_resources(adev, &resources, bcm_resource, dev);
614 static int bcm_acpi_probe(struct bcm_device *dev)
618 #endif /* CONFIG_ACPI */
620 static int bcm_probe(struct platform_device *pdev)
622 struct bcm_device *dev;
623 struct acpi_device_id *pdata = pdev->dev.platform_data;
626 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
632 if (ACPI_HANDLE(&pdev->dev)) {
633 ret = bcm_acpi_probe(dev);
637 dev->name = pdata->id;
642 platform_set_drvdata(pdev, dev);
644 dev_info(&pdev->dev, "%s device registered.\n", dev->name);
646 /* Place this instance on the device list */
647 mutex_lock(&bcm_device_lock);
648 list_add_tail(&dev->list, &bcm_device_list);
649 mutex_unlock(&bcm_device_lock);
651 bcm_gpio_set_power(dev, false);
656 static int bcm_remove(struct platform_device *pdev)
658 struct bcm_device *dev = platform_get_drvdata(pdev);
660 mutex_lock(&bcm_device_lock);
661 list_del(&dev->list);
662 mutex_unlock(&bcm_device_lock);
664 acpi_dev_remove_driver_gpios(ACPI_COMPANION(&pdev->dev));
666 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
671 static const struct hci_uart_proto bcm_proto = {
674 .init_speed = 115200,
675 .oper_speed = 4000000,
680 .set_baudrate = bcm_set_baudrate,
682 .enqueue = bcm_enqueue,
683 .dequeue = bcm_dequeue,
687 static const struct acpi_device_id bcm_acpi_match[] = {
692 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
695 /* Platform suspend and resume callbacks */
696 static SIMPLE_DEV_PM_OPS(bcm_pm_ops, bcm_suspend, bcm_resume);
698 static struct platform_driver bcm_driver = {
700 .remove = bcm_remove,
703 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
708 int __init bcm_init(void)
710 platform_driver_register(&bcm_driver);
712 return hci_uart_register_proto(&bcm_proto);
715 int __exit bcm_deinit(void)
717 platform_driver_unregister(&bcm_driver);
719 return hci_uart_unregister_proto(&bcm_proto);