1 /* 2 * 3 * Bluetooth HCI UART driver for Broadcom devices 4 * 5 * Copyright (C) 2015 Intel Corporation 6 * 7 * 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. 12 * 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. 17 * 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 21 * 22 */ 23 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/of.h> 31 #include <linux/property.h> 32 #include <linux/platform_data/x86/apple.h> 33 #include <linux/platform_device.h> 34 #include <linux/clk.h> 35 #include <linux/gpio/consumer.h> 36 #include <linux/tty.h> 37 #include <linux/interrupt.h> 38 #include <linux/dmi.h> 39 #include <linux/pm_runtime.h> 40 #include <linux/serdev.h> 41 42 #include <net/bluetooth/bluetooth.h> 43 #include <net/bluetooth/hci_core.h> 44 45 #include "btbcm.h" 46 #include "hci_uart.h" 47 48 #define BCM_NULL_PKT 0x00 49 #define BCM_NULL_SIZE 0 50 51 #define BCM_LM_DIAG_PKT 0x07 52 #define BCM_LM_DIAG_SIZE 63 53 54 #define BCM_AUTOSUSPEND_DELAY 5000 /* default autosleep delay */ 55 56 /** 57 * struct bcm_device - device driver resources 58 * @serdev_hu: HCI UART controller struct 59 * @list: bcm_device_list node 60 * @dev: physical UART slave 61 * @name: device name logged by bt_dev_*() functions 62 * @device_wakeup: BT_WAKE pin, 63 * assert = Bluetooth device must wake up or remain awake, 64 * deassert = Bluetooth device may sleep when sleep criteria are met 65 * @shutdown: BT_REG_ON pin, 66 * power up or power down Bluetooth device internal regulators 67 * @set_device_wakeup: callback to toggle BT_WAKE pin 68 * either by accessing @device_wakeup or by calling @btlp 69 * @set_shutdown: callback to toggle BT_REG_ON pin 70 * either by accessing @shutdown or by calling @btpu/@btpd 71 * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power") 72 * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up") 73 * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down") 74 * @clk: clock used by Bluetooth device 75 * @clk_enabled: whether @clk is prepared and enabled 76 * @init_speed: default baudrate of Bluetooth device; 77 * the host UART is initially set to this baudrate so that 78 * it can configure the Bluetooth device for @oper_speed 79 * @oper_speed: preferred baudrate of Bluetooth device; 80 * set to 0 if @init_speed is already the preferred baudrate 81 * @irq: interrupt triggered by HOST_WAKE_BT pin 82 * @irq_active_low: whether @irq is active low 83 * @hu: pointer to HCI UART controller struct, 84 * used to disable flow control during runtime suspend and system sleep 85 * @is_suspended: whether flow control is currently disabled 86 */ 87 struct bcm_device { 88 /* Must be the first member, hci_serdev.c expects this. */ 89 struct hci_uart serdev_hu; 90 struct list_head list; 91 92 struct device *dev; 93 94 const char *name; 95 struct gpio_desc *device_wakeup; 96 struct gpio_desc *shutdown; 97 int (*set_device_wakeup)(struct bcm_device *, bool); 98 int (*set_shutdown)(struct bcm_device *, bool); 99 #ifdef CONFIG_ACPI 100 acpi_handle btlp, btpu, btpd; 101 int gpio_count; 102 int gpio_int_idx; 103 #endif 104 105 struct clk *clk; 106 bool clk_enabled; 107 108 u32 init_speed; 109 u32 oper_speed; 110 int irq; 111 bool irq_active_low; 112 113 #ifdef CONFIG_PM 114 struct hci_uart *hu; 115 bool is_suspended; 116 #endif 117 }; 118 119 /* generic bcm uart resources */ 120 struct bcm_data { 121 struct sk_buff *rx_skb; 122 struct sk_buff_head txq; 123 124 struct bcm_device *dev; 125 }; 126 127 /* List of BCM BT UART devices */ 128 static DEFINE_MUTEX(bcm_device_lock); 129 static LIST_HEAD(bcm_device_list); 130 131 static int irq_polarity = -1; 132 module_param(irq_polarity, int, 0444); 133 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low"); 134 135 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed) 136 { 137 if (hu->serdev) 138 serdev_device_set_baudrate(hu->serdev, speed); 139 else 140 hci_uart_set_baudrate(hu, speed); 141 } 142 143 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed) 144 { 145 struct hci_dev *hdev = hu->hdev; 146 struct sk_buff *skb; 147 struct bcm_update_uart_baud_rate param; 148 149 if (speed > 3000000) { 150 struct bcm_write_uart_clock_setting clock; 151 152 clock.type = BCM_UART_CLOCK_48MHZ; 153 154 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type); 155 156 /* This Broadcom specific command changes the UART's controller 157 * clock for baud rate > 3000000. 158 */ 159 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT); 160 if (IS_ERR(skb)) { 161 int err = PTR_ERR(skb); 162 bt_dev_err(hdev, "BCM: failed to write clock (%d)", 163 err); 164 return err; 165 } 166 167 kfree_skb(skb); 168 } 169 170 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed); 171 172 param.zero = cpu_to_le16(0); 173 param.baud_rate = cpu_to_le32(speed); 174 175 /* This Broadcom specific command changes the UART's controller baud 176 * rate. 177 */ 178 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m, 179 HCI_INIT_TIMEOUT); 180 if (IS_ERR(skb)) { 181 int err = PTR_ERR(skb); 182 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)", 183 err); 184 return err; 185 } 186 187 kfree_skb(skb); 188 189 return 0; 190 } 191 192 /* bcm_device_exists should be protected by bcm_device_lock */ 193 static bool bcm_device_exists(struct bcm_device *device) 194 { 195 struct list_head *p; 196 197 #ifdef CONFIG_PM 198 /* Devices using serdev always exist */ 199 if (device && device->hu && device->hu->serdev) 200 return true; 201 #endif 202 203 list_for_each(p, &bcm_device_list) { 204 struct bcm_device *dev = list_entry(p, struct bcm_device, list); 205 206 if (device == dev) 207 return true; 208 } 209 210 return false; 211 } 212 213 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered) 214 { 215 int err; 216 217 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled) { 218 err = clk_prepare_enable(dev->clk); 219 if (err) 220 return err; 221 } 222 223 err = dev->set_shutdown(dev, powered); 224 if (err) 225 goto err_clk_disable; 226 227 err = dev->set_device_wakeup(dev, powered); 228 if (err) 229 goto err_revert_shutdown; 230 231 if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled) 232 clk_disable_unprepare(dev->clk); 233 234 dev->clk_enabled = powered; 235 236 return 0; 237 238 err_revert_shutdown: 239 dev->set_shutdown(dev, !powered); 240 err_clk_disable: 241 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled) 242 clk_disable_unprepare(dev->clk); 243 return err; 244 } 245 246 #ifdef CONFIG_PM 247 static irqreturn_t bcm_host_wake(int irq, void *data) 248 { 249 struct bcm_device *bdev = data; 250 251 bt_dev_dbg(bdev, "Host wake IRQ"); 252 253 pm_runtime_get(bdev->dev); 254 pm_runtime_mark_last_busy(bdev->dev); 255 pm_runtime_put_autosuspend(bdev->dev); 256 257 return IRQ_HANDLED; 258 } 259 260 static int bcm_request_irq(struct bcm_data *bcm) 261 { 262 struct bcm_device *bdev = bcm->dev; 263 int err; 264 265 mutex_lock(&bcm_device_lock); 266 if (!bcm_device_exists(bdev)) { 267 err = -ENODEV; 268 goto unlock; 269 } 270 271 if (bdev->irq <= 0) { 272 err = -EOPNOTSUPP; 273 goto unlock; 274 } 275 276 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake, 277 bdev->irq_active_low ? IRQF_TRIGGER_FALLING : 278 IRQF_TRIGGER_RISING, 279 "host_wake", bdev); 280 if (err) { 281 bdev->irq = err; 282 goto unlock; 283 } 284 285 device_init_wakeup(bdev->dev, true); 286 287 pm_runtime_set_autosuspend_delay(bdev->dev, 288 BCM_AUTOSUSPEND_DELAY); 289 pm_runtime_use_autosuspend(bdev->dev); 290 pm_runtime_set_active(bdev->dev); 291 pm_runtime_enable(bdev->dev); 292 293 unlock: 294 mutex_unlock(&bcm_device_lock); 295 296 return err; 297 } 298 299 static const struct bcm_set_sleep_mode default_sleep_params = { 300 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */ 301 .idle_host = 2, /* idle threshold HOST, in 300ms */ 302 .idle_dev = 2, /* idle threshold device, in 300ms */ 303 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */ 304 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */ 305 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */ 306 .combine_modes = 1, /* Combine sleep and LPM flag */ 307 .tristate_control = 0, /* Allow tri-state control of UART tx flag */ 308 /* Irrelevant USB flags */ 309 .usb_auto_sleep = 0, 310 .usb_resume_timeout = 0, 311 .break_to_host = 0, 312 .pulsed_host_wake = 1, 313 }; 314 315 static int bcm_setup_sleep(struct hci_uart *hu) 316 { 317 struct bcm_data *bcm = hu->priv; 318 struct sk_buff *skb; 319 struct bcm_set_sleep_mode sleep_params = default_sleep_params; 320 321 sleep_params.host_wake_active = !bcm->dev->irq_active_low; 322 323 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params), 324 &sleep_params, HCI_INIT_TIMEOUT); 325 if (IS_ERR(skb)) { 326 int err = PTR_ERR(skb); 327 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err); 328 return err; 329 } 330 kfree_skb(skb); 331 332 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded"); 333 334 return 0; 335 } 336 #else 337 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; } 338 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; } 339 #endif 340 341 static int bcm_set_diag(struct hci_dev *hdev, bool enable) 342 { 343 struct hci_uart *hu = hci_get_drvdata(hdev); 344 struct bcm_data *bcm = hu->priv; 345 struct sk_buff *skb; 346 347 if (!test_bit(HCI_RUNNING, &hdev->flags)) 348 return -ENETDOWN; 349 350 skb = bt_skb_alloc(3, GFP_KERNEL); 351 if (!skb) 352 return -ENOMEM; 353 354 skb_put_u8(skb, BCM_LM_DIAG_PKT); 355 skb_put_u8(skb, 0xf0); 356 skb_put_u8(skb, enable); 357 358 skb_queue_tail(&bcm->txq, skb); 359 hci_uart_tx_wakeup(hu); 360 361 return 0; 362 } 363 364 static int bcm_open(struct hci_uart *hu) 365 { 366 struct bcm_data *bcm; 367 struct list_head *p; 368 int err; 369 370 bt_dev_dbg(hu->hdev, "hu %p", hu); 371 372 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL); 373 if (!bcm) 374 return -ENOMEM; 375 376 skb_queue_head_init(&bcm->txq); 377 378 hu->priv = bcm; 379 380 mutex_lock(&bcm_device_lock); 381 382 if (hu->serdev) { 383 bcm->dev = serdev_device_get_drvdata(hu->serdev); 384 goto out; 385 } 386 387 if (!hu->tty->dev) 388 goto out; 389 390 list_for_each(p, &bcm_device_list) { 391 struct bcm_device *dev = list_entry(p, struct bcm_device, list); 392 393 /* Retrieve saved bcm_device based on parent of the 394 * platform device (saved during device probe) and 395 * parent of tty device used by hci_uart 396 */ 397 if (hu->tty->dev->parent == dev->dev->parent) { 398 bcm->dev = dev; 399 #ifdef CONFIG_PM 400 dev->hu = hu; 401 #endif 402 break; 403 } 404 } 405 406 out: 407 if (bcm->dev) { 408 hu->init_speed = bcm->dev->init_speed; 409 hu->oper_speed = bcm->dev->oper_speed; 410 err = bcm_gpio_set_power(bcm->dev, true); 411 if (err) 412 goto err_unset_hu; 413 } 414 415 mutex_unlock(&bcm_device_lock); 416 return 0; 417 418 err_unset_hu: 419 #ifdef CONFIG_PM 420 if (!hu->serdev) 421 bcm->dev->hu = NULL; 422 #endif 423 mutex_unlock(&bcm_device_lock); 424 hu->priv = NULL; 425 kfree(bcm); 426 return err; 427 } 428 429 static int bcm_close(struct hci_uart *hu) 430 { 431 struct bcm_data *bcm = hu->priv; 432 struct bcm_device *bdev = NULL; 433 int err; 434 435 bt_dev_dbg(hu->hdev, "hu %p", hu); 436 437 /* Protect bcm->dev against removal of the device or driver */ 438 mutex_lock(&bcm_device_lock); 439 440 if (hu->serdev) { 441 bdev = serdev_device_get_drvdata(hu->serdev); 442 } else if (bcm_device_exists(bcm->dev)) { 443 bdev = bcm->dev; 444 #ifdef CONFIG_PM 445 bdev->hu = NULL; 446 #endif 447 } 448 449 if (bdev) { 450 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) { 451 devm_free_irq(bdev->dev, bdev->irq, bdev); 452 device_init_wakeup(bdev->dev, false); 453 pm_runtime_disable(bdev->dev); 454 } 455 456 err = bcm_gpio_set_power(bdev, false); 457 if (err) 458 bt_dev_err(hu->hdev, "Failed to power down"); 459 else 460 pm_runtime_set_suspended(bdev->dev); 461 } 462 mutex_unlock(&bcm_device_lock); 463 464 skb_queue_purge(&bcm->txq); 465 kfree_skb(bcm->rx_skb); 466 kfree(bcm); 467 468 hu->priv = NULL; 469 return 0; 470 } 471 472 static int bcm_flush(struct hci_uart *hu) 473 { 474 struct bcm_data *bcm = hu->priv; 475 476 bt_dev_dbg(hu->hdev, "hu %p", hu); 477 478 skb_queue_purge(&bcm->txq); 479 480 return 0; 481 } 482 483 static int bcm_setup(struct hci_uart *hu) 484 { 485 struct bcm_data *bcm = hu->priv; 486 char fw_name[64]; 487 const struct firmware *fw; 488 unsigned int speed; 489 int err; 490 491 bt_dev_dbg(hu->hdev, "hu %p", hu); 492 493 hu->hdev->set_diag = bcm_set_diag; 494 hu->hdev->set_bdaddr = btbcm_set_bdaddr; 495 496 err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false); 497 if (err) 498 return err; 499 500 err = request_firmware(&fw, fw_name, &hu->hdev->dev); 501 if (err < 0) { 502 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name); 503 return 0; 504 } 505 506 err = btbcm_patchram(hu->hdev, fw); 507 if (err) { 508 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err); 509 goto finalize; 510 } 511 512 /* Init speed if any */ 513 if (hu->init_speed) 514 speed = hu->init_speed; 515 else if (hu->proto->init_speed) 516 speed = hu->proto->init_speed; 517 else 518 speed = 0; 519 520 if (speed) 521 host_set_baudrate(hu, speed); 522 523 /* Operational speed if any */ 524 if (hu->oper_speed) 525 speed = hu->oper_speed; 526 else if (hu->proto->oper_speed) 527 speed = hu->proto->oper_speed; 528 else 529 speed = 0; 530 531 if (speed) { 532 err = bcm_set_baudrate(hu, speed); 533 if (!err) 534 host_set_baudrate(hu, speed); 535 } 536 537 finalize: 538 release_firmware(fw); 539 540 err = btbcm_finalize(hu->hdev); 541 if (err) 542 return err; 543 544 if (!bcm_request_irq(bcm)) 545 err = bcm_setup_sleep(hu); 546 547 return err; 548 } 549 550 #define BCM_RECV_LM_DIAG \ 551 .type = BCM_LM_DIAG_PKT, \ 552 .hlen = BCM_LM_DIAG_SIZE, \ 553 .loff = 0, \ 554 .lsize = 0, \ 555 .maxlen = BCM_LM_DIAG_SIZE 556 557 #define BCM_RECV_NULL \ 558 .type = BCM_NULL_PKT, \ 559 .hlen = BCM_NULL_SIZE, \ 560 .loff = 0, \ 561 .lsize = 0, \ 562 .maxlen = BCM_NULL_SIZE 563 564 static const struct h4_recv_pkt bcm_recv_pkts[] = { 565 { H4_RECV_ACL, .recv = hci_recv_frame }, 566 { H4_RECV_SCO, .recv = hci_recv_frame }, 567 { H4_RECV_EVENT, .recv = hci_recv_frame }, 568 { BCM_RECV_LM_DIAG, .recv = hci_recv_diag }, 569 { BCM_RECV_NULL, .recv = hci_recv_diag }, 570 }; 571 572 static int bcm_recv(struct hci_uart *hu, const void *data, int count) 573 { 574 struct bcm_data *bcm = hu->priv; 575 576 if (!test_bit(HCI_UART_REGISTERED, &hu->flags)) 577 return -EUNATCH; 578 579 bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count, 580 bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts)); 581 if (IS_ERR(bcm->rx_skb)) { 582 int err = PTR_ERR(bcm->rx_skb); 583 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err); 584 bcm->rx_skb = NULL; 585 return err; 586 } else if (!bcm->rx_skb) { 587 /* Delay auto-suspend when receiving completed packet */ 588 mutex_lock(&bcm_device_lock); 589 if (bcm->dev && bcm_device_exists(bcm->dev)) { 590 pm_runtime_get(bcm->dev->dev); 591 pm_runtime_mark_last_busy(bcm->dev->dev); 592 pm_runtime_put_autosuspend(bcm->dev->dev); 593 } 594 mutex_unlock(&bcm_device_lock); 595 } 596 597 return count; 598 } 599 600 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb) 601 { 602 struct bcm_data *bcm = hu->priv; 603 604 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb); 605 606 /* Prepend skb with frame type */ 607 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1); 608 skb_queue_tail(&bcm->txq, skb); 609 610 return 0; 611 } 612 613 static struct sk_buff *bcm_dequeue(struct hci_uart *hu) 614 { 615 struct bcm_data *bcm = hu->priv; 616 struct sk_buff *skb = NULL; 617 struct bcm_device *bdev = NULL; 618 619 mutex_lock(&bcm_device_lock); 620 621 if (bcm_device_exists(bcm->dev)) { 622 bdev = bcm->dev; 623 pm_runtime_get_sync(bdev->dev); 624 /* Shall be resumed here */ 625 } 626 627 skb = skb_dequeue(&bcm->txq); 628 629 if (bdev) { 630 pm_runtime_mark_last_busy(bdev->dev); 631 pm_runtime_put_autosuspend(bdev->dev); 632 } 633 634 mutex_unlock(&bcm_device_lock); 635 636 return skb; 637 } 638 639 #ifdef CONFIG_PM 640 static int bcm_suspend_device(struct device *dev) 641 { 642 struct bcm_device *bdev = dev_get_drvdata(dev); 643 int err; 644 645 bt_dev_dbg(bdev, ""); 646 647 if (!bdev->is_suspended && bdev->hu) { 648 hci_uart_set_flow_control(bdev->hu, true); 649 650 /* Once this returns, driver suspends BT via GPIO */ 651 bdev->is_suspended = true; 652 } 653 654 /* Suspend the device */ 655 err = bdev->set_device_wakeup(bdev, false); 656 if (err) { 657 if (bdev->is_suspended && bdev->hu) { 658 bdev->is_suspended = false; 659 hci_uart_set_flow_control(bdev->hu, false); 660 } 661 return -EBUSY; 662 } 663 664 bt_dev_dbg(bdev, "suspend, delaying 15 ms"); 665 msleep(15); 666 667 return 0; 668 } 669 670 static int bcm_resume_device(struct device *dev) 671 { 672 struct bcm_device *bdev = dev_get_drvdata(dev); 673 int err; 674 675 bt_dev_dbg(bdev, ""); 676 677 err = bdev->set_device_wakeup(bdev, true); 678 if (err) { 679 dev_err(dev, "Failed to power up\n"); 680 return err; 681 } 682 683 bt_dev_dbg(bdev, "resume, delaying 15 ms"); 684 msleep(15); 685 686 /* When this executes, the device has woken up already */ 687 if (bdev->is_suspended && bdev->hu) { 688 bdev->is_suspended = false; 689 690 hci_uart_set_flow_control(bdev->hu, false); 691 } 692 693 return 0; 694 } 695 #endif 696 697 #ifdef CONFIG_PM_SLEEP 698 /* suspend callback */ 699 static int bcm_suspend(struct device *dev) 700 { 701 struct bcm_device *bdev = dev_get_drvdata(dev); 702 int error; 703 704 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended); 705 706 /* 707 * When used with a device instantiated as platform_device, bcm_suspend 708 * can be called at any time as long as the platform device is bound, 709 * so it should use bcm_device_lock to protect access to hci_uart 710 * and device_wake-up GPIO. 711 */ 712 mutex_lock(&bcm_device_lock); 713 714 if (!bdev->hu) 715 goto unlock; 716 717 if (pm_runtime_active(dev)) 718 bcm_suspend_device(dev); 719 720 if (device_may_wakeup(dev) && bdev->irq > 0) { 721 error = enable_irq_wake(bdev->irq); 722 if (!error) 723 bt_dev_dbg(bdev, "BCM irq: enabled"); 724 } 725 726 unlock: 727 mutex_unlock(&bcm_device_lock); 728 729 return 0; 730 } 731 732 /* resume callback */ 733 static int bcm_resume(struct device *dev) 734 { 735 struct bcm_device *bdev = dev_get_drvdata(dev); 736 int err = 0; 737 738 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended); 739 740 /* 741 * When used with a device instantiated as platform_device, bcm_resume 742 * can be called at any time as long as platform device is bound, 743 * so it should use bcm_device_lock to protect access to hci_uart 744 * and device_wake-up GPIO. 745 */ 746 mutex_lock(&bcm_device_lock); 747 748 if (!bdev->hu) 749 goto unlock; 750 751 if (device_may_wakeup(dev) && bdev->irq > 0) { 752 disable_irq_wake(bdev->irq); 753 bt_dev_dbg(bdev, "BCM irq: disabled"); 754 } 755 756 err = bcm_resume_device(dev); 757 758 unlock: 759 mutex_unlock(&bcm_device_lock); 760 761 if (!err) { 762 pm_runtime_disable(dev); 763 pm_runtime_set_active(dev); 764 pm_runtime_enable(dev); 765 } 766 767 return 0; 768 } 769 #endif 770 771 static const struct acpi_gpio_params first_gpio = { 0, 0, false }; 772 static const struct acpi_gpio_params second_gpio = { 1, 0, false }; 773 static const struct acpi_gpio_params third_gpio = { 2, 0, false }; 774 775 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = { 776 { "device-wakeup-gpios", &first_gpio, 1 }, 777 { "shutdown-gpios", &second_gpio, 1 }, 778 { "host-wakeup-gpios", &third_gpio, 1 }, 779 { }, 780 }; 781 782 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = { 783 { "host-wakeup-gpios", &first_gpio, 1 }, 784 { "device-wakeup-gpios", &second_gpio, 1 }, 785 { "shutdown-gpios", &third_gpio, 1 }, 786 { }, 787 }; 788 789 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */ 790 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = { 791 { 792 .ident = "Meegopad T08", 793 .matches = { 794 DMI_EXACT_MATCH(DMI_BOARD_VENDOR, 795 "To be filled by OEM."), 796 DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"), 797 DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"), 798 }, 799 }, 800 { } 801 }; 802 803 #ifdef CONFIG_ACPI 804 static int bcm_resource(struct acpi_resource *ares, void *data) 805 { 806 struct bcm_device *dev = data; 807 struct acpi_resource_extended_irq *irq; 808 struct acpi_resource_gpio *gpio; 809 struct acpi_resource_uart_serialbus *sb; 810 811 switch (ares->type) { 812 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ: 813 irq = &ares->data.extended_irq; 814 if (irq->polarity != ACPI_ACTIVE_LOW) 815 dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n"); 816 dev->irq_active_low = true; 817 break; 818 819 case ACPI_RESOURCE_TYPE_GPIO: 820 gpio = &ares->data.gpio; 821 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) { 822 dev->gpio_int_idx = dev->gpio_count; 823 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW; 824 } 825 dev->gpio_count++; 826 break; 827 828 case ACPI_RESOURCE_TYPE_SERIAL_BUS: 829 sb = &ares->data.uart_serial_bus; 830 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) { 831 dev->init_speed = sb->default_baud_rate; 832 dev->oper_speed = 4000000; 833 } 834 break; 835 836 default: 837 break; 838 } 839 840 return 0; 841 } 842 843 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake) 844 { 845 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake))) 846 return -EIO; 847 848 return 0; 849 } 850 851 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered) 852 { 853 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd, 854 NULL, NULL, NULL))) 855 return -EIO; 856 857 return 0; 858 } 859 860 static int bcm_apple_get_resources(struct bcm_device *dev) 861 { 862 struct acpi_device *adev = ACPI_COMPANION(dev->dev); 863 const union acpi_object *obj; 864 865 if (!adev || 866 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) || 867 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) || 868 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd))) 869 return -ENODEV; 870 871 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) && 872 obj->buffer.length == 8) 873 dev->init_speed = *(u64 *)obj->buffer.pointer; 874 875 dev->set_device_wakeup = bcm_apple_set_device_wakeup; 876 dev->set_shutdown = bcm_apple_set_shutdown; 877 878 return 0; 879 } 880 #else 881 static inline int bcm_apple_get_resources(struct bcm_device *dev) 882 { 883 return -EOPNOTSUPP; 884 } 885 #endif /* CONFIG_ACPI */ 886 887 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake) 888 { 889 gpiod_set_value_cansleep(dev->device_wakeup, awake); 890 return 0; 891 } 892 893 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered) 894 { 895 gpiod_set_value_cansleep(dev->shutdown, powered); 896 return 0; 897 } 898 899 static int bcm_get_resources(struct bcm_device *dev) 900 { 901 const struct dmi_system_id *dmi_id; 902 903 dev->name = dev_name(dev->dev); 904 905 if (x86_apple_machine && !bcm_apple_get_resources(dev)) 906 return 0; 907 908 dev->clk = devm_clk_get(dev->dev, NULL); 909 910 dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup", 911 GPIOD_OUT_LOW); 912 if (IS_ERR(dev->device_wakeup)) 913 return PTR_ERR(dev->device_wakeup); 914 915 dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown", 916 GPIOD_OUT_LOW); 917 if (IS_ERR(dev->shutdown)) 918 return PTR_ERR(dev->shutdown); 919 920 dev->set_device_wakeup = bcm_gpio_set_device_wakeup; 921 dev->set_shutdown = bcm_gpio_set_shutdown; 922 923 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */ 924 if (dev->irq <= 0) { 925 struct gpio_desc *gpio; 926 927 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup", 928 GPIOD_IN); 929 if (IS_ERR(gpio)) 930 return PTR_ERR(gpio); 931 932 dev->irq = gpiod_to_irq(gpio); 933 } 934 935 dmi_id = dmi_first_match(bcm_broken_irq_dmi_table); 936 if (dmi_id) { 937 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n", 938 dmi_id->ident); 939 dev->irq = 0; 940 } 941 942 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq); 943 return 0; 944 } 945 946 #ifdef CONFIG_ACPI 947 static int bcm_acpi_probe(struct bcm_device *dev) 948 { 949 LIST_HEAD(resources); 950 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios; 951 struct resource_entry *entry; 952 int ret; 953 954 /* Retrieve UART ACPI info */ 955 dev->gpio_int_idx = -1; 956 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev), 957 &resources, bcm_resource, dev); 958 if (ret < 0) 959 return ret; 960 961 resource_list_for_each_entry(entry, &resources) { 962 if (resource_type(entry->res) == IORESOURCE_IRQ) { 963 dev->irq = entry->res->start; 964 break; 965 } 966 } 967 acpi_dev_free_resource_list(&resources); 968 969 /* If the DSDT uses an Interrupt resource for the IRQ, then there are 970 * only 2 GPIO resources, we use the irq-last mapping for this, since 971 * we already have an irq the 3th / last mapping will not be used. 972 */ 973 if (dev->irq) 974 gpio_mapping = acpi_bcm_int_last_gpios; 975 else if (dev->gpio_int_idx == 0) 976 gpio_mapping = acpi_bcm_int_first_gpios; 977 else if (dev->gpio_int_idx == 2) 978 gpio_mapping = acpi_bcm_int_last_gpios; 979 else 980 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n", 981 dev->gpio_int_idx); 982 983 /* Warn if our expectations are not met. */ 984 if (dev->gpio_count != (dev->irq ? 2 : 3)) 985 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n", 986 dev->gpio_count); 987 988 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping); 989 if (ret) 990 return ret; 991 992 if (irq_polarity != -1) { 993 dev->irq_active_low = irq_polarity; 994 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n", 995 dev->irq_active_low ? "low" : "high"); 996 } 997 998 return 0; 999 } 1000 #else 1001 static int bcm_acpi_probe(struct bcm_device *dev) 1002 { 1003 return -EINVAL; 1004 } 1005 #endif /* CONFIG_ACPI */ 1006 1007 static int bcm_of_probe(struct bcm_device *bdev) 1008 { 1009 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed); 1010 return 0; 1011 } 1012 1013 static int bcm_probe(struct platform_device *pdev) 1014 { 1015 struct bcm_device *dev; 1016 int ret; 1017 1018 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL); 1019 if (!dev) 1020 return -ENOMEM; 1021 1022 dev->dev = &pdev->dev; 1023 dev->irq = platform_get_irq(pdev, 0); 1024 1025 if (has_acpi_companion(&pdev->dev)) { 1026 ret = bcm_acpi_probe(dev); 1027 if (ret) 1028 return ret; 1029 } 1030 1031 ret = bcm_get_resources(dev); 1032 if (ret) 1033 return ret; 1034 1035 platform_set_drvdata(pdev, dev); 1036 1037 dev_info(&pdev->dev, "%s device registered.\n", dev->name); 1038 1039 /* Place this instance on the device list */ 1040 mutex_lock(&bcm_device_lock); 1041 list_add_tail(&dev->list, &bcm_device_list); 1042 mutex_unlock(&bcm_device_lock); 1043 1044 ret = bcm_gpio_set_power(dev, false); 1045 if (ret) 1046 dev_err(&pdev->dev, "Failed to power down\n"); 1047 1048 return 0; 1049 } 1050 1051 static int bcm_remove(struct platform_device *pdev) 1052 { 1053 struct bcm_device *dev = platform_get_drvdata(pdev); 1054 1055 mutex_lock(&bcm_device_lock); 1056 list_del(&dev->list); 1057 mutex_unlock(&bcm_device_lock); 1058 1059 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name); 1060 1061 return 0; 1062 } 1063 1064 static const struct hci_uart_proto bcm_proto = { 1065 .id = HCI_UART_BCM, 1066 .name = "Broadcom", 1067 .manufacturer = 15, 1068 .init_speed = 115200, 1069 .open = bcm_open, 1070 .close = bcm_close, 1071 .flush = bcm_flush, 1072 .setup = bcm_setup, 1073 .set_baudrate = bcm_set_baudrate, 1074 .recv = bcm_recv, 1075 .enqueue = bcm_enqueue, 1076 .dequeue = bcm_dequeue, 1077 }; 1078 1079 #ifdef CONFIG_ACPI 1080 static const struct acpi_device_id bcm_acpi_match[] = { 1081 { "BCM2E00" }, 1082 { "BCM2E01" }, 1083 { "BCM2E02" }, 1084 { "BCM2E03" }, 1085 { "BCM2E04" }, 1086 { "BCM2E05" }, 1087 { "BCM2E06" }, 1088 { "BCM2E07" }, 1089 { "BCM2E08" }, 1090 { "BCM2E09" }, 1091 { "BCM2E0A" }, 1092 { "BCM2E0B" }, 1093 { "BCM2E0C" }, 1094 { "BCM2E0D" }, 1095 { "BCM2E0E" }, 1096 { "BCM2E0F" }, 1097 { "BCM2E10" }, 1098 { "BCM2E11" }, 1099 { "BCM2E12" }, 1100 { "BCM2E13" }, 1101 { "BCM2E14" }, 1102 { "BCM2E15" }, 1103 { "BCM2E16" }, 1104 { "BCM2E17" }, 1105 { "BCM2E18" }, 1106 { "BCM2E19" }, 1107 { "BCM2E1A" }, 1108 { "BCM2E1B" }, 1109 { "BCM2E1C" }, 1110 { "BCM2E1D" }, 1111 { "BCM2E1F" }, 1112 { "BCM2E20" }, 1113 { "BCM2E21" }, 1114 { "BCM2E22" }, 1115 { "BCM2E23" }, 1116 { "BCM2E24" }, 1117 { "BCM2E25" }, 1118 { "BCM2E26" }, 1119 { "BCM2E27" }, 1120 { "BCM2E28" }, 1121 { "BCM2E29" }, 1122 { "BCM2E2A" }, 1123 { "BCM2E2B" }, 1124 { "BCM2E2C" }, 1125 { "BCM2E2D" }, 1126 { "BCM2E2E" }, 1127 { "BCM2E2F" }, 1128 { "BCM2E30" }, 1129 { "BCM2E31" }, 1130 { "BCM2E32" }, 1131 { "BCM2E33" }, 1132 { "BCM2E34" }, 1133 { "BCM2E35" }, 1134 { "BCM2E36" }, 1135 { "BCM2E37" }, 1136 { "BCM2E38" }, 1137 { "BCM2E39" }, 1138 { "BCM2E3A" }, 1139 { "BCM2E3B" }, 1140 { "BCM2E3C" }, 1141 { "BCM2E3D" }, 1142 { "BCM2E3E" }, 1143 { "BCM2E3F" }, 1144 { "BCM2E40" }, 1145 { "BCM2E41" }, 1146 { "BCM2E42" }, 1147 { "BCM2E43" }, 1148 { "BCM2E44" }, 1149 { "BCM2E45" }, 1150 { "BCM2E46" }, 1151 { "BCM2E47" }, 1152 { "BCM2E48" }, 1153 { "BCM2E49" }, 1154 { "BCM2E4A" }, 1155 { "BCM2E4B" }, 1156 { "BCM2E4C" }, 1157 { "BCM2E4D" }, 1158 { "BCM2E4E" }, 1159 { "BCM2E4F" }, 1160 { "BCM2E50" }, 1161 { "BCM2E51" }, 1162 { "BCM2E52" }, 1163 { "BCM2E53" }, 1164 { "BCM2E54" }, 1165 { "BCM2E55" }, 1166 { "BCM2E56" }, 1167 { "BCM2E57" }, 1168 { "BCM2E58" }, 1169 { "BCM2E59" }, 1170 { "BCM2E5A" }, 1171 { "BCM2E5B" }, 1172 { "BCM2E5C" }, 1173 { "BCM2E5D" }, 1174 { "BCM2E5E" }, 1175 { "BCM2E5F" }, 1176 { "BCM2E60" }, 1177 { "BCM2E61" }, 1178 { "BCM2E62" }, 1179 { "BCM2E63" }, 1180 { "BCM2E64" }, 1181 { "BCM2E65" }, 1182 { "BCM2E66" }, 1183 { "BCM2E67" }, 1184 { "BCM2E68" }, 1185 { "BCM2E69" }, 1186 { "BCM2E6B" }, 1187 { "BCM2E6D" }, 1188 { "BCM2E6E" }, 1189 { "BCM2E6F" }, 1190 { "BCM2E70" }, 1191 { "BCM2E71" }, 1192 { "BCM2E72" }, 1193 { "BCM2E73" }, 1194 { "BCM2E74" }, 1195 { "BCM2E75" }, 1196 { "BCM2E76" }, 1197 { "BCM2E77" }, 1198 { "BCM2E78" }, 1199 { "BCM2E79" }, 1200 { "BCM2E7A" }, 1201 { "BCM2E7B" }, 1202 { "BCM2E7C" }, 1203 { "BCM2E7D" }, 1204 { "BCM2E7E" }, 1205 { "BCM2E7F" }, 1206 { "BCM2E80" }, 1207 { "BCM2E81" }, 1208 { "BCM2E82" }, 1209 { "BCM2E83" }, 1210 { "BCM2E84" }, 1211 { "BCM2E85" }, 1212 { "BCM2E86" }, 1213 { "BCM2E87" }, 1214 { "BCM2E88" }, 1215 { "BCM2E89" }, 1216 { "BCM2E8A" }, 1217 { "BCM2E8B" }, 1218 { "BCM2E8C" }, 1219 { "BCM2E8D" }, 1220 { "BCM2E8E" }, 1221 { "BCM2E90" }, 1222 { "BCM2E92" }, 1223 { "BCM2E93" }, 1224 { "BCM2E94" }, 1225 { "BCM2E95" }, 1226 { "BCM2E96" }, 1227 { "BCM2E97" }, 1228 { "BCM2E98" }, 1229 { "BCM2E99" }, 1230 { "BCM2E9A" }, 1231 { "BCM2E9B" }, 1232 { "BCM2E9C" }, 1233 { "BCM2E9D" }, 1234 { "BCM2EA0" }, 1235 { "BCM2EA1" }, 1236 { "BCM2EA2" }, 1237 { "BCM2EA3" }, 1238 { "BCM2EA4" }, 1239 { "BCM2EA5" }, 1240 { "BCM2EA6" }, 1241 { "BCM2EA7" }, 1242 { "BCM2EA8" }, 1243 { "BCM2EA9" }, 1244 { "BCM2EAA" }, 1245 { "BCM2EAB" }, 1246 { "BCM2EAC" }, 1247 { }, 1248 }; 1249 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match); 1250 #endif 1251 1252 /* suspend and resume callbacks */ 1253 static const struct dev_pm_ops bcm_pm_ops = { 1254 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume) 1255 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL) 1256 }; 1257 1258 static struct platform_driver bcm_driver = { 1259 .probe = bcm_probe, 1260 .remove = bcm_remove, 1261 .driver = { 1262 .name = "hci_bcm", 1263 .acpi_match_table = ACPI_PTR(bcm_acpi_match), 1264 .pm = &bcm_pm_ops, 1265 }, 1266 }; 1267 1268 static int bcm_serdev_probe(struct serdev_device *serdev) 1269 { 1270 struct bcm_device *bcmdev; 1271 int err; 1272 1273 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL); 1274 if (!bcmdev) 1275 return -ENOMEM; 1276 1277 bcmdev->dev = &serdev->dev; 1278 #ifdef CONFIG_PM 1279 bcmdev->hu = &bcmdev->serdev_hu; 1280 #endif 1281 bcmdev->serdev_hu.serdev = serdev; 1282 serdev_device_set_drvdata(serdev, bcmdev); 1283 1284 if (has_acpi_companion(&serdev->dev)) 1285 err = bcm_acpi_probe(bcmdev); 1286 else 1287 err = bcm_of_probe(bcmdev); 1288 if (err) 1289 return err; 1290 1291 err = bcm_get_resources(bcmdev); 1292 if (err) 1293 return err; 1294 1295 if (!bcmdev->shutdown) { 1296 dev_warn(&serdev->dev, 1297 "No reset resource, using default baud rate\n"); 1298 bcmdev->oper_speed = bcmdev->init_speed; 1299 } 1300 1301 err = bcm_gpio_set_power(bcmdev, false); 1302 if (err) 1303 dev_err(&serdev->dev, "Failed to power down\n"); 1304 1305 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto); 1306 } 1307 1308 static void bcm_serdev_remove(struct serdev_device *serdev) 1309 { 1310 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev); 1311 1312 hci_uart_unregister_device(&bcmdev->serdev_hu); 1313 } 1314 1315 #ifdef CONFIG_OF 1316 static const struct of_device_id bcm_bluetooth_of_match[] = { 1317 { .compatible = "brcm,bcm43438-bt" }, 1318 { }, 1319 }; 1320 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match); 1321 #endif 1322 1323 static struct serdev_device_driver bcm_serdev_driver = { 1324 .probe = bcm_serdev_probe, 1325 .remove = bcm_serdev_remove, 1326 .driver = { 1327 .name = "hci_uart_bcm", 1328 .of_match_table = of_match_ptr(bcm_bluetooth_of_match), 1329 .acpi_match_table = ACPI_PTR(bcm_acpi_match), 1330 .pm = &bcm_pm_ops, 1331 }, 1332 }; 1333 1334 int __init bcm_init(void) 1335 { 1336 /* For now, we need to keep both platform device 1337 * driver (ACPI generated) and serdev driver (DT). 1338 */ 1339 platform_driver_register(&bcm_driver); 1340 serdev_device_driver_register(&bcm_serdev_driver); 1341 1342 return hci_uart_register_proto(&bcm_proto); 1343 } 1344 1345 int __exit bcm_deinit(void) 1346 { 1347 platform_driver_unregister(&bcm_driver); 1348 serdev_device_driver_unregister(&bcm_serdev_driver); 1349 1350 return hci_uart_unregister_proto(&bcm_proto); 1351 } 1352