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 #endif 102 103 struct clk *clk; 104 bool clk_enabled; 105 106 u32 init_speed; 107 u32 oper_speed; 108 int irq; 109 bool irq_active_low; 110 111 #ifdef CONFIG_PM 112 struct hci_uart *hu; 113 bool is_suspended; 114 #endif 115 }; 116 117 /* generic bcm uart resources */ 118 struct bcm_data { 119 struct sk_buff *rx_skb; 120 struct sk_buff_head txq; 121 122 struct bcm_device *dev; 123 }; 124 125 /* List of BCM BT UART devices */ 126 static DEFINE_MUTEX(bcm_device_lock); 127 static LIST_HEAD(bcm_device_list); 128 129 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed) 130 { 131 if (hu->serdev) 132 serdev_device_set_baudrate(hu->serdev, speed); 133 else 134 hci_uart_set_baudrate(hu, speed); 135 } 136 137 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed) 138 { 139 struct hci_dev *hdev = hu->hdev; 140 struct sk_buff *skb; 141 struct bcm_update_uart_baud_rate param; 142 143 if (speed > 3000000) { 144 struct bcm_write_uart_clock_setting clock; 145 146 clock.type = BCM_UART_CLOCK_48MHZ; 147 148 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type); 149 150 /* This Broadcom specific command changes the UART's controller 151 * clock for baud rate > 3000000. 152 */ 153 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT); 154 if (IS_ERR(skb)) { 155 int err = PTR_ERR(skb); 156 bt_dev_err(hdev, "BCM: failed to write clock (%d)", 157 err); 158 return err; 159 } 160 161 kfree_skb(skb); 162 } 163 164 bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed); 165 166 param.zero = cpu_to_le16(0); 167 param.baud_rate = cpu_to_le32(speed); 168 169 /* This Broadcom specific command changes the UART's controller baud 170 * rate. 171 */ 172 skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), ¶m, 173 HCI_INIT_TIMEOUT); 174 if (IS_ERR(skb)) { 175 int err = PTR_ERR(skb); 176 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)", 177 err); 178 return err; 179 } 180 181 kfree_skb(skb); 182 183 return 0; 184 } 185 186 /* bcm_device_exists should be protected by bcm_device_lock */ 187 static bool bcm_device_exists(struct bcm_device *device) 188 { 189 struct list_head *p; 190 191 #ifdef CONFIG_PM 192 /* Devices using serdev always exist */ 193 if (device && device->hu && device->hu->serdev) 194 return true; 195 #endif 196 197 list_for_each(p, &bcm_device_list) { 198 struct bcm_device *dev = list_entry(p, struct bcm_device, list); 199 200 if (device == dev) 201 return true; 202 } 203 204 return false; 205 } 206 207 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered) 208 { 209 int err; 210 211 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled) { 212 err = clk_prepare_enable(dev->clk); 213 if (err) 214 return err; 215 } 216 217 err = dev->set_shutdown(dev, powered); 218 if (err) 219 goto err_clk_disable; 220 221 err = dev->set_device_wakeup(dev, powered); 222 if (err) 223 goto err_revert_shutdown; 224 225 if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled) 226 clk_disable_unprepare(dev->clk); 227 228 dev->clk_enabled = powered; 229 230 return 0; 231 232 err_revert_shutdown: 233 dev->set_shutdown(dev, !powered); 234 err_clk_disable: 235 if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled) 236 clk_disable_unprepare(dev->clk); 237 return err; 238 } 239 240 #ifdef CONFIG_PM 241 static irqreturn_t bcm_host_wake(int irq, void *data) 242 { 243 struct bcm_device *bdev = data; 244 245 bt_dev_dbg(bdev, "Host wake IRQ"); 246 247 pm_request_resume(bdev->dev); 248 249 return IRQ_HANDLED; 250 } 251 252 static int bcm_request_irq(struct bcm_data *bcm) 253 { 254 struct bcm_device *bdev = bcm->dev; 255 int err; 256 257 mutex_lock(&bcm_device_lock); 258 if (!bcm_device_exists(bdev)) { 259 err = -ENODEV; 260 goto unlock; 261 } 262 263 if (bdev->irq <= 0) { 264 err = -EOPNOTSUPP; 265 goto unlock; 266 } 267 268 err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake, 269 bdev->irq_active_low ? IRQF_TRIGGER_FALLING : 270 IRQF_TRIGGER_RISING, 271 "host_wake", bdev); 272 if (err) { 273 bdev->irq = err; 274 goto unlock; 275 } 276 277 device_init_wakeup(bdev->dev, true); 278 279 pm_runtime_set_autosuspend_delay(bdev->dev, 280 BCM_AUTOSUSPEND_DELAY); 281 pm_runtime_use_autosuspend(bdev->dev); 282 pm_runtime_set_active(bdev->dev); 283 pm_runtime_enable(bdev->dev); 284 285 unlock: 286 mutex_unlock(&bcm_device_lock); 287 288 return err; 289 } 290 291 static const struct bcm_set_sleep_mode default_sleep_params = { 292 .sleep_mode = 1, /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */ 293 .idle_host = 2, /* idle threshold HOST, in 300ms */ 294 .idle_dev = 2, /* idle threshold device, in 300ms */ 295 .bt_wake_active = 1, /* BT_WAKE active mode: 1 = high, 0 = low */ 296 .host_wake_active = 0, /* HOST_WAKE active mode: 1 = high, 0 = low */ 297 .allow_host_sleep = 1, /* Allow host sleep in SCO flag */ 298 .combine_modes = 1, /* Combine sleep and LPM flag */ 299 .tristate_control = 0, /* Allow tri-state control of UART tx flag */ 300 /* Irrelevant USB flags */ 301 .usb_auto_sleep = 0, 302 .usb_resume_timeout = 0, 303 .break_to_host = 0, 304 .pulsed_host_wake = 0, 305 }; 306 307 static int bcm_setup_sleep(struct hci_uart *hu) 308 { 309 struct bcm_data *bcm = hu->priv; 310 struct sk_buff *skb; 311 struct bcm_set_sleep_mode sleep_params = default_sleep_params; 312 313 sleep_params.host_wake_active = !bcm->dev->irq_active_low; 314 315 skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params), 316 &sleep_params, HCI_INIT_TIMEOUT); 317 if (IS_ERR(skb)) { 318 int err = PTR_ERR(skb); 319 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err); 320 return err; 321 } 322 kfree_skb(skb); 323 324 bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded"); 325 326 return 0; 327 } 328 #else 329 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; } 330 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; } 331 #endif 332 333 static int bcm_set_diag(struct hci_dev *hdev, bool enable) 334 { 335 struct hci_uart *hu = hci_get_drvdata(hdev); 336 struct bcm_data *bcm = hu->priv; 337 struct sk_buff *skb; 338 339 if (!test_bit(HCI_RUNNING, &hdev->flags)) 340 return -ENETDOWN; 341 342 skb = bt_skb_alloc(3, GFP_KERNEL); 343 if (!skb) 344 return -ENOMEM; 345 346 skb_put_u8(skb, BCM_LM_DIAG_PKT); 347 skb_put_u8(skb, 0xf0); 348 skb_put_u8(skb, enable); 349 350 skb_queue_tail(&bcm->txq, skb); 351 hci_uart_tx_wakeup(hu); 352 353 return 0; 354 } 355 356 static int bcm_open(struct hci_uart *hu) 357 { 358 struct bcm_data *bcm; 359 struct list_head *p; 360 int err; 361 362 bt_dev_dbg(hu->hdev, "hu %p", hu); 363 364 bcm = kzalloc(sizeof(*bcm), GFP_KERNEL); 365 if (!bcm) 366 return -ENOMEM; 367 368 skb_queue_head_init(&bcm->txq); 369 370 hu->priv = bcm; 371 372 mutex_lock(&bcm_device_lock); 373 374 if (hu->serdev) { 375 err = serdev_device_open(hu->serdev); 376 if (err) 377 goto err_free; 378 379 bcm->dev = serdev_device_get_drvdata(hu->serdev); 380 goto out; 381 } 382 383 if (!hu->tty->dev) 384 goto out; 385 386 list_for_each(p, &bcm_device_list) { 387 struct bcm_device *dev = list_entry(p, struct bcm_device, list); 388 389 /* Retrieve saved bcm_device based on parent of the 390 * platform device (saved during device probe) and 391 * parent of tty device used by hci_uart 392 */ 393 if (hu->tty->dev->parent == dev->dev->parent) { 394 bcm->dev = dev; 395 #ifdef CONFIG_PM 396 dev->hu = hu; 397 #endif 398 break; 399 } 400 } 401 402 out: 403 if (bcm->dev) { 404 hu->init_speed = bcm->dev->init_speed; 405 hu->oper_speed = bcm->dev->oper_speed; 406 err = bcm_gpio_set_power(bcm->dev, true); 407 if (err) 408 goto err_unset_hu; 409 } 410 411 mutex_unlock(&bcm_device_lock); 412 return 0; 413 414 err_unset_hu: 415 if (hu->serdev) 416 serdev_device_close(hu->serdev); 417 #ifdef CONFIG_PM 418 else 419 bcm->dev->hu = NULL; 420 #endif 421 err_free: 422 mutex_unlock(&bcm_device_lock); 423 hu->priv = NULL; 424 kfree(bcm); 425 return err; 426 } 427 428 static int bcm_close(struct hci_uart *hu) 429 { 430 struct bcm_data *bcm = hu->priv; 431 struct bcm_device *bdev = NULL; 432 int err; 433 434 bt_dev_dbg(hu->hdev, "hu %p", hu); 435 436 /* Protect bcm->dev against removal of the device or driver */ 437 mutex_lock(&bcm_device_lock); 438 439 if (hu->serdev) { 440 serdev_device_close(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)); 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_request_resume(bcm->dev->dev); 591 mutex_unlock(&bcm_device_lock); 592 } 593 594 return count; 595 } 596 597 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb) 598 { 599 struct bcm_data *bcm = hu->priv; 600 601 bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb); 602 603 /* Prepend skb with frame type */ 604 memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1); 605 skb_queue_tail(&bcm->txq, skb); 606 607 return 0; 608 } 609 610 static struct sk_buff *bcm_dequeue(struct hci_uart *hu) 611 { 612 struct bcm_data *bcm = hu->priv; 613 struct sk_buff *skb = NULL; 614 struct bcm_device *bdev = NULL; 615 616 mutex_lock(&bcm_device_lock); 617 618 if (bcm_device_exists(bcm->dev)) { 619 bdev = bcm->dev; 620 pm_runtime_get_sync(bdev->dev); 621 /* Shall be resumed here */ 622 } 623 624 skb = skb_dequeue(&bcm->txq); 625 626 if (bdev) { 627 pm_runtime_mark_last_busy(bdev->dev); 628 pm_runtime_put_autosuspend(bdev->dev); 629 } 630 631 mutex_unlock(&bcm_device_lock); 632 633 return skb; 634 } 635 636 #ifdef CONFIG_PM 637 static int bcm_suspend_device(struct device *dev) 638 { 639 struct bcm_device *bdev = dev_get_drvdata(dev); 640 int err; 641 642 bt_dev_dbg(bdev, ""); 643 644 if (!bdev->is_suspended && bdev->hu) { 645 hci_uart_set_flow_control(bdev->hu, true); 646 647 /* Once this returns, driver suspends BT via GPIO */ 648 bdev->is_suspended = true; 649 } 650 651 /* Suspend the device */ 652 err = bdev->set_device_wakeup(bdev, false); 653 if (err) { 654 if (bdev->is_suspended && bdev->hu) { 655 bdev->is_suspended = false; 656 hci_uart_set_flow_control(bdev->hu, false); 657 } 658 return -EBUSY; 659 } 660 661 bt_dev_dbg(bdev, "suspend, delaying 15 ms"); 662 msleep(15); 663 664 return 0; 665 } 666 667 static int bcm_resume_device(struct device *dev) 668 { 669 struct bcm_device *bdev = dev_get_drvdata(dev); 670 int err; 671 672 bt_dev_dbg(bdev, ""); 673 674 err = bdev->set_device_wakeup(bdev, true); 675 if (err) { 676 dev_err(dev, "Failed to power up\n"); 677 return err; 678 } 679 680 bt_dev_dbg(bdev, "resume, delaying 15 ms"); 681 msleep(15); 682 683 /* When this executes, the device has woken up already */ 684 if (bdev->is_suspended && bdev->hu) { 685 bdev->is_suspended = false; 686 687 hci_uart_set_flow_control(bdev->hu, false); 688 } 689 690 return 0; 691 } 692 #endif 693 694 #ifdef CONFIG_PM_SLEEP 695 /* suspend callback */ 696 static int bcm_suspend(struct device *dev) 697 { 698 struct bcm_device *bdev = dev_get_drvdata(dev); 699 int error; 700 701 bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended); 702 703 /* 704 * When used with a device instantiated as platform_device, bcm_suspend 705 * can be called at any time as long as the platform device is bound, 706 * so it should use bcm_device_lock to protect access to hci_uart 707 * and device_wake-up GPIO. 708 */ 709 mutex_lock(&bcm_device_lock); 710 711 if (!bdev->hu) 712 goto unlock; 713 714 if (pm_runtime_active(dev)) 715 bcm_suspend_device(dev); 716 717 if (device_may_wakeup(dev) && bdev->irq > 0) { 718 error = enable_irq_wake(bdev->irq); 719 if (!error) 720 bt_dev_dbg(bdev, "BCM irq: enabled"); 721 } 722 723 unlock: 724 mutex_unlock(&bcm_device_lock); 725 726 return 0; 727 } 728 729 /* resume callback */ 730 static int bcm_resume(struct device *dev) 731 { 732 struct bcm_device *bdev = dev_get_drvdata(dev); 733 int err = 0; 734 735 bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended); 736 737 /* 738 * When used with a device instantiated as platform_device, bcm_resume 739 * can be called at any time as long as platform device is bound, 740 * so it should use bcm_device_lock to protect access to hci_uart 741 * and device_wake-up GPIO. 742 */ 743 mutex_lock(&bcm_device_lock); 744 745 if (!bdev->hu) 746 goto unlock; 747 748 if (device_may_wakeup(dev) && bdev->irq > 0) { 749 disable_irq_wake(bdev->irq); 750 bt_dev_dbg(bdev, "BCM irq: disabled"); 751 } 752 753 err = bcm_resume_device(dev); 754 755 unlock: 756 mutex_unlock(&bcm_device_lock); 757 758 if (!err) { 759 pm_runtime_disable(dev); 760 pm_runtime_set_active(dev); 761 pm_runtime_enable(dev); 762 } 763 764 return 0; 765 } 766 #endif 767 768 static const struct acpi_gpio_params int_last_device_wakeup_gpios = { 0, 0, false }; 769 static const struct acpi_gpio_params int_last_shutdown_gpios = { 1, 0, false }; 770 static const struct acpi_gpio_params int_last_host_wakeup_gpios = { 2, 0, false }; 771 772 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = { 773 { "device-wakeup-gpios", &int_last_device_wakeup_gpios, 1 }, 774 { "shutdown-gpios", &int_last_shutdown_gpios, 1 }, 775 { "host-wakeup-gpios", &int_last_host_wakeup_gpios, 1 }, 776 { }, 777 }; 778 779 static const struct acpi_gpio_params int_first_host_wakeup_gpios = { 0, 0, false }; 780 static const struct acpi_gpio_params int_first_device_wakeup_gpios = { 1, 0, false }; 781 static const struct acpi_gpio_params int_first_shutdown_gpios = { 2, 0, false }; 782 783 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = { 784 { "device-wakeup-gpios", &int_first_device_wakeup_gpios, 1 }, 785 { "shutdown-gpios", &int_first_shutdown_gpios, 1 }, 786 { "host-wakeup-gpios", &int_first_host_wakeup_gpios, 1 }, 787 { }, 788 }; 789 790 #ifdef CONFIG_ACPI 791 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */ 792 static const struct dmi_system_id bcm_active_low_irq_dmi_table[] = { 793 { 794 .ident = "Asus T100TA", 795 .matches = { 796 DMI_EXACT_MATCH(DMI_SYS_VENDOR, 797 "ASUSTeK COMPUTER INC."), 798 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100TA"), 799 }, 800 }, 801 { 802 .ident = "Asus T100CHI", 803 .matches = { 804 DMI_EXACT_MATCH(DMI_SYS_VENDOR, 805 "ASUSTeK COMPUTER INC."), 806 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100CHI"), 807 }, 808 }, 809 { /* Handle ThinkPad 8 tablets with BCM2E55 chipset ACPI ID */ 810 .ident = "Lenovo ThinkPad 8", 811 .matches = { 812 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "LENOVO"), 813 DMI_EXACT_MATCH(DMI_PRODUCT_VERSION, "ThinkPad 8"), 814 }, 815 }, 816 { 817 .ident = "MINIX Z83-4", 818 .matches = { 819 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "MINIX"), 820 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"), 821 }, 822 }, 823 { } 824 }; 825 826 static int bcm_resource(struct acpi_resource *ares, void *data) 827 { 828 struct bcm_device *dev = data; 829 struct acpi_resource_extended_irq *irq; 830 struct acpi_resource_gpio *gpio; 831 struct acpi_resource_uart_serialbus *sb; 832 833 switch (ares->type) { 834 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ: 835 irq = &ares->data.extended_irq; 836 dev->irq_active_low = irq->polarity == ACPI_ACTIVE_LOW; 837 break; 838 839 case ACPI_RESOURCE_TYPE_GPIO: 840 gpio = &ares->data.gpio; 841 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) 842 dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW; 843 break; 844 845 case ACPI_RESOURCE_TYPE_SERIAL_BUS: 846 sb = &ares->data.uart_serial_bus; 847 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) { 848 dev->init_speed = sb->default_baud_rate; 849 dev->oper_speed = 4000000; 850 } 851 break; 852 853 default: 854 break; 855 } 856 857 return 0; 858 } 859 860 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake) 861 { 862 if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake))) 863 return -EIO; 864 865 return 0; 866 } 867 868 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered) 869 { 870 if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd, 871 NULL, NULL, NULL))) 872 return -EIO; 873 874 return 0; 875 } 876 877 static int bcm_apple_get_resources(struct bcm_device *dev) 878 { 879 struct acpi_device *adev = ACPI_COMPANION(dev->dev); 880 const union acpi_object *obj; 881 882 if (!adev || 883 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) || 884 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) || 885 ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd))) 886 return -ENODEV; 887 888 if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) && 889 obj->buffer.length == 8) 890 dev->init_speed = *(u64 *)obj->buffer.pointer; 891 892 dev->set_device_wakeup = bcm_apple_set_device_wakeup; 893 dev->set_shutdown = bcm_apple_set_shutdown; 894 895 return 0; 896 } 897 #else 898 static inline int bcm_apple_get_resources(struct bcm_device *dev) 899 { 900 return -EOPNOTSUPP; 901 } 902 #endif /* CONFIG_ACPI */ 903 904 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake) 905 { 906 gpiod_set_value(dev->device_wakeup, awake); 907 return 0; 908 } 909 910 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered) 911 { 912 gpiod_set_value(dev->shutdown, powered); 913 return 0; 914 } 915 916 static int bcm_get_resources(struct bcm_device *dev) 917 { 918 dev->name = dev_name(dev->dev); 919 920 if (x86_apple_machine && !bcm_apple_get_resources(dev)) 921 return 0; 922 923 dev->clk = devm_clk_get(dev->dev, NULL); 924 925 dev->device_wakeup = devm_gpiod_get(dev->dev, "device-wakeup", 926 GPIOD_OUT_LOW); 927 if (IS_ERR(dev->device_wakeup)) 928 return PTR_ERR(dev->device_wakeup); 929 930 dev->shutdown = devm_gpiod_get(dev->dev, "shutdown", GPIOD_OUT_LOW); 931 if (IS_ERR(dev->shutdown)) 932 return PTR_ERR(dev->shutdown); 933 934 dev->set_device_wakeup = bcm_gpio_set_device_wakeup; 935 dev->set_shutdown = bcm_gpio_set_shutdown; 936 937 /* IRQ can be declared in ACPI table as Interrupt or GpioInt */ 938 if (dev->irq <= 0) { 939 struct gpio_desc *gpio; 940 941 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup", 942 GPIOD_IN); 943 if (IS_ERR(gpio)) 944 return PTR_ERR(gpio); 945 946 dev->irq = gpiod_to_irq(gpio); 947 } 948 949 dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq); 950 return 0; 951 } 952 953 #ifdef CONFIG_ACPI 954 static int bcm_acpi_probe(struct bcm_device *dev) 955 { 956 LIST_HEAD(resources); 957 const struct dmi_system_id *dmi_id; 958 const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios; 959 const struct acpi_device_id *id; 960 struct resource_entry *entry; 961 int ret; 962 963 /* Retrieve GPIO data */ 964 id = acpi_match_device(dev->dev->driver->acpi_match_table, dev->dev); 965 if (id) 966 gpio_mapping = (const struct acpi_gpio_mapping *) id->driver_data; 967 968 ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping); 969 if (ret) 970 return ret; 971 972 /* Retrieve UART ACPI info */ 973 ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev), 974 &resources, bcm_resource, dev); 975 if (ret < 0) 976 return ret; 977 978 resource_list_for_each_entry(entry, &resources) { 979 if (resource_type(entry->res) == IORESOURCE_IRQ) { 980 dev->irq = entry->res->start; 981 break; 982 } 983 } 984 acpi_dev_free_resource_list(&resources); 985 986 dmi_id = dmi_first_match(bcm_active_low_irq_dmi_table); 987 if (dmi_id) { 988 dev_warn(dev->dev, "%s: Overwriting IRQ polarity to active low", 989 dmi_id->ident); 990 dev->irq_active_low = true; 991 } 992 993 return 0; 994 } 995 #else 996 static int bcm_acpi_probe(struct bcm_device *dev) 997 { 998 return -EINVAL; 999 } 1000 #endif /* CONFIG_ACPI */ 1001 1002 static int bcm_of_probe(struct bcm_device *bdev) 1003 { 1004 device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed); 1005 return 0; 1006 } 1007 1008 static int bcm_probe(struct platform_device *pdev) 1009 { 1010 struct bcm_device *dev; 1011 int ret; 1012 1013 dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL); 1014 if (!dev) 1015 return -ENOMEM; 1016 1017 dev->dev = &pdev->dev; 1018 dev->irq = platform_get_irq(pdev, 0); 1019 1020 if (has_acpi_companion(&pdev->dev)) { 1021 ret = bcm_acpi_probe(dev); 1022 if (ret) 1023 return ret; 1024 } 1025 1026 ret = bcm_get_resources(dev); 1027 if (ret) 1028 return ret; 1029 1030 platform_set_drvdata(pdev, dev); 1031 1032 dev_info(&pdev->dev, "%s device registered.\n", dev->name); 1033 1034 /* Place this instance on the device list */ 1035 mutex_lock(&bcm_device_lock); 1036 list_add_tail(&dev->list, &bcm_device_list); 1037 mutex_unlock(&bcm_device_lock); 1038 1039 ret = bcm_gpio_set_power(dev, false); 1040 if (ret) 1041 dev_err(&pdev->dev, "Failed to power down\n"); 1042 1043 return 0; 1044 } 1045 1046 static int bcm_remove(struct platform_device *pdev) 1047 { 1048 struct bcm_device *dev = platform_get_drvdata(pdev); 1049 1050 mutex_lock(&bcm_device_lock); 1051 list_del(&dev->list); 1052 mutex_unlock(&bcm_device_lock); 1053 1054 dev_info(&pdev->dev, "%s device unregistered.\n", dev->name); 1055 1056 return 0; 1057 } 1058 1059 static const struct hci_uart_proto bcm_proto = { 1060 .id = HCI_UART_BCM, 1061 .name = "Broadcom", 1062 .manufacturer = 15, 1063 .init_speed = 115200, 1064 .open = bcm_open, 1065 .close = bcm_close, 1066 .flush = bcm_flush, 1067 .setup = bcm_setup, 1068 .set_baudrate = bcm_set_baudrate, 1069 .recv = bcm_recv, 1070 .enqueue = bcm_enqueue, 1071 .dequeue = bcm_dequeue, 1072 }; 1073 1074 #ifdef CONFIG_ACPI 1075 static const struct acpi_device_id bcm_acpi_match[] = { 1076 { "BCM2E1A", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1077 { "BCM2E39", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1078 { "BCM2E3A", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1079 { "BCM2E3D", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1080 { "BCM2E3F", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1081 { "BCM2E40", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1082 { "BCM2E54", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1083 { "BCM2E55", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1084 { "BCM2E64", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1085 { "BCM2E65", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1086 { "BCM2E67", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1087 { "BCM2E71", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1088 { "BCM2E72", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1089 { "BCM2E7B", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1090 { "BCM2E7C", (kernel_ulong_t)&acpi_bcm_int_last_gpios }, 1091 { "BCM2E7E", (kernel_ulong_t)&acpi_bcm_int_first_gpios }, 1092 { "BCM2E95", (kernel_ulong_t)&acpi_bcm_int_first_gpios }, 1093 { "BCM2E96", (kernel_ulong_t)&acpi_bcm_int_first_gpios }, 1094 { "BCM2EA4", (kernel_ulong_t)&acpi_bcm_int_first_gpios }, 1095 { }, 1096 }; 1097 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match); 1098 #endif 1099 1100 /* suspend and resume callbacks */ 1101 static const struct dev_pm_ops bcm_pm_ops = { 1102 SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume) 1103 SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL) 1104 }; 1105 1106 static struct platform_driver bcm_driver = { 1107 .probe = bcm_probe, 1108 .remove = bcm_remove, 1109 .driver = { 1110 .name = "hci_bcm", 1111 .acpi_match_table = ACPI_PTR(bcm_acpi_match), 1112 .pm = &bcm_pm_ops, 1113 }, 1114 }; 1115 1116 static int bcm_serdev_probe(struct serdev_device *serdev) 1117 { 1118 struct bcm_device *bcmdev; 1119 int err; 1120 1121 bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL); 1122 if (!bcmdev) 1123 return -ENOMEM; 1124 1125 bcmdev->dev = &serdev->dev; 1126 #ifdef CONFIG_PM 1127 bcmdev->hu = &bcmdev->serdev_hu; 1128 #endif 1129 bcmdev->serdev_hu.serdev = serdev; 1130 serdev_device_set_drvdata(serdev, bcmdev); 1131 1132 if (has_acpi_companion(&serdev->dev)) 1133 err = bcm_acpi_probe(bcmdev); 1134 else 1135 err = bcm_of_probe(bcmdev); 1136 if (err) 1137 return err; 1138 1139 err = bcm_get_resources(bcmdev); 1140 if (err) 1141 return err; 1142 1143 err = bcm_gpio_set_power(bcmdev, false); 1144 if (err) 1145 dev_err(&serdev->dev, "Failed to power down\n"); 1146 1147 return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto); 1148 } 1149 1150 static void bcm_serdev_remove(struct serdev_device *serdev) 1151 { 1152 struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev); 1153 1154 hci_uart_unregister_device(&bcmdev->serdev_hu); 1155 } 1156 1157 #ifdef CONFIG_OF 1158 static const struct of_device_id bcm_bluetooth_of_match[] = { 1159 { .compatible = "brcm,bcm43438-bt" }, 1160 { }, 1161 }; 1162 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match); 1163 #endif 1164 1165 static struct serdev_device_driver bcm_serdev_driver = { 1166 .probe = bcm_serdev_probe, 1167 .remove = bcm_serdev_remove, 1168 .driver = { 1169 .name = "hci_uart_bcm", 1170 .of_match_table = of_match_ptr(bcm_bluetooth_of_match), 1171 .acpi_match_table = ACPI_PTR(bcm_acpi_match), 1172 .pm = &bcm_pm_ops, 1173 }, 1174 }; 1175 1176 int __init bcm_init(void) 1177 { 1178 /* For now, we need to keep both platform device 1179 * driver (ACPI generated) and serdev driver (DT). 1180 */ 1181 platform_driver_register(&bcm_driver); 1182 serdev_device_driver_register(&bcm_serdev_driver); 1183 1184 return hci_uart_register_proto(&bcm_proto); 1185 } 1186 1187 int __exit bcm_deinit(void) 1188 { 1189 platform_driver_unregister(&bcm_driver); 1190 serdev_device_driver_unregister(&bcm_serdev_driver); 1191 1192 return hci_uart_unregister_proto(&bcm_proto); 1193 } 1194