drivers/bluetooth/hci_intel.c

   1 /*
   2  *
   3  *  Bluetooth HCI UART driver for Intel 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/wait.h>
  30 #include <linux/tty.h>
  31 #include <linux/platform_device.h>
  32 #include <linux/gpio/consumer.h>
  33 #include <linux/acpi.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/pm_runtime.h>
  36
  37 #include <net/bluetooth/bluetooth.h>
  38 #include <net/bluetooth/hci_core.h>
  39
  40 #include "hci_uart.h"
  41 #include "btintel.h"
  42
  43 #define STATE_BOOTLOADER        0
  44 #define STATE_DOWNLOADING       1
  45 #define STATE_FIRMWARE_LOADED   2
  46 #define STATE_FIRMWARE_FAILED   3
  47 #define STATE_BOOTING           4
  48 #define STATE_LPM_ENABLED       5
  49 #define STATE_TX_ACTIVE         6
  50 #define STATE_SUSPENDED         7
  51 #define STATE_LPM_TRANSACTION   8
  52
  53 #define HCI_LPM_WAKE_PKT 0xf0
  54 #define HCI_LPM_PKT 0xf1
  55 #define HCI_LPM_MAX_SIZE 10
  56 #define HCI_LPM_HDR_SIZE HCI_EVENT_HDR_SIZE
  57
  58 #define LPM_OP_TX_NOTIFY 0x00
  59 #define LPM_OP_SUSPEND_ACK 0x02
  60 #define LPM_OP_RESUME_ACK 0x03
  61
  62 #define LPM_SUSPEND_DELAY_MS 1000
  63
  64 struct hci_lpm_pkt {
  65         __u8 opcode;
  66         __u8 dlen;
  67         __u8 data[0];
  68 } __packed;
  69
  70 struct intel_device {
  71         struct list_head list;
  72         struct platform_device *pdev;
  73         struct gpio_desc *reset;
  74         struct hci_uart *hu;
  75         struct mutex hu_lock;
  76         int irq;
  77 };
  78
  79 static LIST_HEAD(intel_device_list);
  80 static DEFINE_MUTEX(intel_device_list_lock);
  81
  82 struct intel_data {
  83         struct sk_buff *rx_skb;
  84         struct sk_buff_head txq;
  85         struct work_struct busy_work;
  86         struct hci_uart *hu;
  87         unsigned long flags;
  88 };
  89
  90 static u8 intel_convert_speed(unsigned int speed)
  91 {
  92         switch (speed) {
  93         case 9600:
  94                 return 0x00;
  95         case 19200:
  96                 return 0x01;
  97         case 38400:
  98                 return 0x02;
  99         case 57600:
 100                 return 0x03;
 101         case 115200:
 102                 return 0x04;
 103         case 230400:
 104                 return 0x05;
 105         case 460800:
 106                 return 0x06;
 107         case 921600:
 108                 return 0x07;
 109         case 1843200:
 110                 return 0x08;
 111         case 3250000:
 112                 return 0x09;
 113         case 2000000:
 114                 return 0x0a;
 115         case 3000000:
 116                 return 0x0b;
 117         default:
 118                 return 0xff;
 119         }
 120 }
 121
 122 static int intel_wait_booting(struct hci_uart *hu)
 123 {
 124         struct intel_data *intel = hu->priv;
 125         int err;
 126
 127         err = wait_on_bit_timeout(&intel->flags, STATE_BOOTING,
 128                                   TASK_INTERRUPTIBLE,
 129                                   msecs_to_jiffies(1000));
 130
 131         if (err == 1) {
 132                 bt_dev_err(hu->hdev, "Device boot interrupted");
 133                 return -EINTR;
 134         }
 135
 136         if (err) {
 137                 bt_dev_err(hu->hdev, "Device boot timeout");
 138                 return -ETIMEDOUT;
 139         }
 140
 141         return err;
 142 }
 143
 144 #ifdef CONFIG_PM
 145 static int intel_wait_lpm_transaction(struct hci_uart *hu)
 146 {
 147         struct intel_data *intel = hu->priv;
 148         int err;
 149
 150         err = wait_on_bit_timeout(&intel->flags, STATE_LPM_TRANSACTION,
 151                                   TASK_INTERRUPTIBLE,
 152                                   msecs_to_jiffies(1000));
 153
 154         if (err == 1) {
 155                 bt_dev_err(hu->hdev, "LPM transaction interrupted");
 156                 return -EINTR;
 157         }
 158
 159         if (err) {
 160                 bt_dev_err(hu->hdev, "LPM transaction timeout");
 161                 return -ETIMEDOUT;
 162         }
 163
 164         return err;
 165 }
 166
 167 static int intel_lpm_suspend(struct hci_uart *hu)
 168 {
 169         static const u8 suspend[] = { 0x01, 0x01, 0x01 };
 170         struct intel_data *intel = hu->priv;
 171         struct sk_buff *skb;
 172
 173         if (!test_bit(STATE_LPM_ENABLED, &intel->flags) ||
 174             test_bit(STATE_SUSPENDED, &intel->flags))
 175                 return 0;
 176
 177         if (test_bit(STATE_TX_ACTIVE, &intel->flags))
 178                 return -EAGAIN;
 179
 180         bt_dev_dbg(hu->hdev, "Suspending");
 181
 182         skb = bt_skb_alloc(sizeof(suspend), GFP_KERNEL);
 183         if (!skb) {
 184                 bt_dev_err(hu->hdev, "Failed to alloc memory for LPM packet");
 185                 return -ENOMEM;
 186         }
 187
 188         memcpy(skb_put(skb, sizeof(suspend)), suspend, sizeof(suspend));
 189         bt_cb(skb)->pkt_type = HCI_LPM_PKT;
 190
 191         set_bit(STATE_LPM_TRANSACTION, &intel->flags);
 192
 193         /* LPM flow is a priority, enqueue packet at list head */
 194         skb_queue_head(&intel->txq, skb);
 195         hci_uart_tx_wakeup(hu);
 196
 197         intel_wait_lpm_transaction(hu);
 198         /* Even in case of failure, continue and test the suspended flag */
 199
 200         clear_bit(STATE_LPM_TRANSACTION, &intel->flags);
 201
 202         if (!test_bit(STATE_SUSPENDED, &intel->flags)) {
 203                 bt_dev_err(hu->hdev, "Device suspend error");
 204                 return -EINVAL;
 205         }
 206
 207         bt_dev_dbg(hu->hdev, "Suspended");
 208
 209         hci_uart_set_flow_control(hu, true);
 210
 211         return 0;
 212 }
 213
 214 static int intel_lpm_resume(struct hci_uart *hu)
 215 {
 216         struct intel_data *intel = hu->priv;
 217         struct sk_buff *skb;
 218
 219         if (!test_bit(STATE_LPM_ENABLED, &intel->flags) ||
 220             !test_bit(STATE_SUSPENDED, &intel->flags))
 221                 return 0;
 222
 223         bt_dev_dbg(hu->hdev, "Resuming");
 224
 225         hci_uart_set_flow_control(hu, false);
 226
 227         skb = bt_skb_alloc(0, GFP_KERNEL);
 228         if (!skb) {
 229                 bt_dev_err(hu->hdev, "Failed to alloc memory for LPM packet");
 230                 return -ENOMEM;
 231         }
 232
 233         bt_cb(skb)->pkt_type = HCI_LPM_WAKE_PKT;
 234
 235         set_bit(STATE_LPM_TRANSACTION, &intel->flags);
 236
 237         /* LPM flow is a priority, enqueue packet at list head */
 238         skb_queue_head(&intel->txq, skb);
 239         hci_uart_tx_wakeup(hu);
 240
 241         intel_wait_lpm_transaction(hu);
 242         /* Even in case of failure, continue and test the suspended flag */
 243
 244         clear_bit(STATE_LPM_TRANSACTION, &intel->flags);
 245
 246         if (test_bit(STATE_SUSPENDED, &intel->flags)) {
 247                 bt_dev_err(hu->hdev, "Device resume error");
 248                 return -EINVAL;
 249         }
 250
 251         bt_dev_dbg(hu->hdev, "Resumed");
 252
 253         return 0;
 254 }
 255 #endif /* CONFIG_PM */
 256
 257 static int intel_lpm_host_wake(struct hci_uart *hu)
 258 {
 259         static const u8 lpm_resume_ack[] = { LPM_OP_RESUME_ACK, 0x00 };
 260         struct intel_data *intel = hu->priv;
 261         struct sk_buff *skb;
 262
 263         hci_uart_set_flow_control(hu, false);
 264
 265         clear_bit(STATE_SUSPENDED, &intel->flags);
 266
 267         skb = bt_skb_alloc(sizeof(lpm_resume_ack), GFP_KERNEL);
 268         if (!skb) {
 269                 bt_dev_err(hu->hdev, "Failed to alloc memory for LPM packet");
 270                 return -ENOMEM;
 271         }
 272
 273         memcpy(skb_put(skb, sizeof(lpm_resume_ack)), lpm_resume_ack,
 274                sizeof(lpm_resume_ack));
 275         bt_cb(skb)->pkt_type = HCI_LPM_PKT;
 276
 277         /* LPM flow is a priority, enqueue packet at list head */
 278         skb_queue_head(&intel->txq, skb);
 279         hci_uart_tx_wakeup(hu);
 280
 281         bt_dev_dbg(hu->hdev, "Resumed by controller");
 282
 283         return 0;
 284 }
 285
 286 static irqreturn_t intel_irq(int irq, void *dev_id)
 287 {
 288         struct intel_device *idev = dev_id;
 289
 290         dev_info(&idev->pdev->dev, "hci_intel irq\n");
 291
 292         mutex_lock(&idev->hu_lock);
 293         if (idev->hu)
 294                 intel_lpm_host_wake(idev->hu);
 295         mutex_unlock(&idev->hu_lock);
 296
 297         /* Host/Controller are now LPM resumed, trigger a new delayed suspend */
 298         pm_runtime_get(&idev->pdev->dev);
 299         pm_runtime_mark_last_busy(&idev->pdev->dev);
 300         pm_runtime_put_autosuspend(&idev->pdev->dev);
 301
 302         return IRQ_HANDLED;
 303 }
 304
 305 static int intel_set_power(struct hci_uart *hu, bool powered)
 306 {
 307         struct list_head *p;
 308         int err = -ENODEV;
 309
 310         if (!hu->tty->dev)
 311                 return err;
 312
 313         mutex_lock(&intel_device_list_lock);
 314
 315         list_for_each(p, &intel_device_list) {
 316                 struct intel_device *idev = list_entry(p, struct intel_device,
 317                                                        list);
 318
 319                 /* tty device and pdev device should share the same parent
 320                  * which is the UART port.
 321                  */
 322                 if (hu->tty->dev->parent != idev->pdev->dev.parent)
 323                         continue;
 324
 325                 if (!idev->reset) {
 326                         err = -ENOTSUPP;
 327                         break;
 328                 }
 329
 330                 BT_INFO("hu %p, Switching compatible pm device (%s) to %u",
 331                         hu, dev_name(&idev->pdev->dev), powered);
 332
 333                 gpiod_set_value(idev->reset, powered);
 334
 335                 /* Provide to idev a hu reference which is used to run LPM
 336                  * transactions (lpm suspend/resume) from PM callbacks.
 337                  * hu needs to be protected against concurrent removing during
 338                  * these PM ops.
 339                  */
 340                 mutex_lock(&idev->hu_lock);
 341                 idev->hu = powered ? hu : NULL;
 342                 mutex_unlock(&idev->hu_lock);
 343
 344                 if (idev->irq < 0)
 345                         break;
 346
 347                 if (powered && device_can_wakeup(&idev->pdev->dev)) {
 348                         err = devm_request_threaded_irq(&idev->pdev->dev,
 349                                                         idev->irq, NULL,
 350                                                         intel_irq,
 351                                                         IRQF_ONESHOT,
 352                                                         "bt-host-wake", idev);
 353                         if (err) {
 354                                 BT_ERR("hu %p, unable to allocate irq-%d",
 355                                        hu, idev->irq);
 356                                 break;
 357                         }
 358
 359                         device_wakeup_enable(&idev->pdev->dev);
 360
 361                         pm_runtime_set_active(&idev->pdev->dev);
 362                         pm_runtime_use_autosuspend(&idev->pdev->dev);
 363                         pm_runtime_set_autosuspend_delay(&idev->pdev->dev,
 364                                                          LPM_SUSPEND_DELAY_MS);
 365                         pm_runtime_enable(&idev->pdev->dev);
 366                 } else if (!powered && device_may_wakeup(&idev->pdev->dev)) {
 367                         devm_free_irq(&idev->pdev->dev, idev->irq, idev);
 368                         device_wakeup_disable(&idev->pdev->dev);
 369
 370                         pm_runtime_disable(&idev->pdev->dev);
 371                 }
 372         }
 373
 374         mutex_unlock(&intel_device_list_lock);
 375
 376         return err;
 377 }
 378
 379 static void intel_busy_work(struct work_struct *work)
 380 {
 381         struct list_head *p;
 382         struct intel_data *intel = container_of(work, struct intel_data,
 383                                                 busy_work);
 384
 385         if (!intel->hu->tty->dev)
 386                 return;
 387
 388         /* Link is busy, delay the suspend */
 389         mutex_lock(&intel_device_list_lock);
 390         list_for_each(p, &intel_device_list) {
 391                 struct intel_device *idev = list_entry(p, struct intel_device,
 392                                                        list);
 393
 394                 if (intel->hu->tty->dev->parent == idev->pdev->dev.parent) {
 395                         pm_runtime_get(&idev->pdev->dev);
 396                         pm_runtime_mark_last_busy(&idev->pdev->dev);
 397                         pm_runtime_put_autosuspend(&idev->pdev->dev);
 398                         break;
 399                 }
 400         }
 401         mutex_unlock(&intel_device_list_lock);
 402 }
 403
 404 static int intel_open(struct hci_uart *hu)
 405 {
 406         struct intel_data *intel;
 407
 408         BT_DBG("hu %p", hu);
 409
 410         if (!hci_uart_has_flow_control(hu))
 411                 return -EOPNOTSUPP;
 412
 413         intel = kzalloc(sizeof(*intel), GFP_KERNEL);
 414         if (!intel)
 415                 return -ENOMEM;
 416
 417         skb_queue_head_init(&intel->txq);
 418         INIT_WORK(&intel->busy_work, intel_busy_work);
 419
 420         intel->hu = hu;
 421
 422         hu->priv = intel;
 423
 424         if (!intel_set_power(hu, true))
 425                 set_bit(STATE_BOOTING, &intel->flags);
 426
 427         return 0;
 428 }
 429
 430 static int intel_close(struct hci_uart *hu)
 431 {
 432         struct intel_data *intel = hu->priv;
 433
 434         BT_DBG("hu %p", hu);
 435
 436         cancel_work_sync(&intel->busy_work);
 437
 438         intel_set_power(hu, false);
 439
 440         skb_queue_purge(&intel->txq);
 441         kfree_skb(intel->rx_skb);
 442         kfree(intel);
 443
 444         hu->priv = NULL;
 445         return 0;
 446 }
 447
 448 static int intel_flush(struct hci_uart *hu)
 449 {
 450         struct intel_data *intel = hu->priv;
 451
 452         BT_DBG("hu %p", hu);
 453
 454         skb_queue_purge(&intel->txq);
 455
 456         return 0;
 457 }
 458
 459 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
 460 {
 461         struct sk_buff *skb;
 462         struct hci_event_hdr *hdr;
 463         struct hci_ev_cmd_complete *evt;
 464
 465         skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_ATOMIC);
 466         if (!skb)
 467                 return -ENOMEM;
 468
 469         hdr = (struct hci_event_hdr *)skb_put(skb, sizeof(*hdr));
 470         hdr->evt = HCI_EV_CMD_COMPLETE;
 471         hdr->plen = sizeof(*evt) + 1;
 472
 473         evt = (struct hci_ev_cmd_complete *)skb_put(skb, sizeof(*evt));
 474         evt->ncmd = 0x01;
 475         evt->opcode = cpu_to_le16(opcode);
 476
 477         *skb_put(skb, 1) = 0x00;
 478
 479         bt_cb(skb)->pkt_type = HCI_EVENT_PKT;
 480
 481         return hci_recv_frame(hdev, skb);
 482 }
 483
 484 static int intel_set_baudrate(struct hci_uart *hu, unsigned int speed)
 485 {
 486         struct intel_data *intel = hu->priv;
 487         struct hci_dev *hdev = hu->hdev;
 488         u8 speed_cmd[] = { 0x06, 0xfc, 0x01, 0x00 };
 489         struct sk_buff *skb;
 490         int err;
 491
 492         /* This can be the first command sent to the chip, check
 493          * that the controller is ready.
 494          */
 495         err = intel_wait_booting(hu);
 496
 497         clear_bit(STATE_BOOTING, &intel->flags);
 498
 499         /* In case of timeout, try to continue anyway */
 500         if (err && err != ETIMEDOUT)
 501                 return err;
 502
 503         bt_dev_info(hdev, "Change controller speed to %d", speed);
 504
 505         speed_cmd[3] = intel_convert_speed(speed);
 506         if (speed_cmd[3] == 0xff) {
 507                 bt_dev_err(hdev, "Unsupported speed");
 508                 return -EINVAL;
 509         }
 510
 511         /* Device will not accept speed change if Intel version has not been
 512          * previously requested.
 513          */
 514         skb = __hci_cmd_sync(hdev, 0xfc05, 0, NULL, HCI_INIT_TIMEOUT);
 515         if (IS_ERR(skb)) {
 516                 bt_dev_err(hdev, "Reading Intel version information failed (%ld)",
 517                            PTR_ERR(skb));
 518                 return PTR_ERR(skb);
 519         }
 520         kfree_skb(skb);
 521
 522         skb = bt_skb_alloc(sizeof(speed_cmd), GFP_KERNEL);
 523         if (!skb) {
 524                 bt_dev_err(hdev, "Failed to alloc memory for baudrate packet");
 525                 return -ENOMEM;
 526         }
 527
 528         memcpy(skb_put(skb, sizeof(speed_cmd)), speed_cmd, sizeof(speed_cmd));
 529         bt_cb(skb)->pkt_type = HCI_COMMAND_PKT;
 530
 531         hci_uart_set_flow_control(hu, true);
 532
 533         skb_queue_tail(&intel->txq, skb);
 534         hci_uart_tx_wakeup(hu);
 535
 536         /* wait 100ms to change baudrate on controller side */
 537         msleep(100);
 538
 539         hci_uart_set_baudrate(hu, speed);
 540         hci_uart_set_flow_control(hu, false);
 541
 542         return 0;
 543 }
 544
 545 static int intel_setup(struct hci_uart *hu)
 546 {
 547         static const u8 reset_param[] = { 0x00, 0x01, 0x00, 0x01,
 548                                           0x00, 0x08, 0x04, 0x00 };
 549         static const u8 lpm_param[] = { 0x03, 0x07, 0x01, 0x0b };
 550         struct intel_data *intel = hu->priv;
 551         struct intel_device *idev = NULL;
 552         struct hci_dev *hdev = hu->hdev;
 553         struct sk_buff *skb;
 554         struct intel_version *ver;
 555         struct intel_boot_params *params;
 556         struct list_head *p;
 557         const struct firmware *fw;
 558         const u8 *fw_ptr;
 559         char fwname[64];
 560         u32 frag_len;
 561         ktime_t calltime, delta, rettime;
 562         unsigned long long duration;
 563         unsigned int init_speed, oper_speed;
 564         int speed_change = 0;
 565         int err;
 566
 567         bt_dev_dbg(hdev, "start intel_setup");
 568
 569         hu->hdev->set_diag = btintel_set_diag;
 570         hu->hdev->set_bdaddr = btintel_set_bdaddr;
 571
 572         calltime = ktime_get();
 573
 574         if (hu->init_speed)
 575                 init_speed = hu->init_speed;
 576         else
 577                 init_speed = hu->proto->init_speed;
 578
 579         if (hu->oper_speed)
 580                 oper_speed = hu->oper_speed;
 581         else
 582                 oper_speed = hu->proto->oper_speed;
 583
 584         if (oper_speed && init_speed && oper_speed != init_speed)
 585                 speed_change = 1;
 586
 587         /* Check that the controller is ready */
 588         err = intel_wait_booting(hu);
 589
 590         clear_bit(STATE_BOOTING, &intel->flags);
 591
 592         /* In case of timeout, try to continue anyway */
 593         if (err && err != ETIMEDOUT)
 594                 return err;
 595
 596         set_bit(STATE_BOOTLOADER, &intel->flags);
 597
 598         /* Read the Intel version information to determine if the device
 599          * is in bootloader mode or if it already has operational firmware
 600          * loaded.
 601          */
 602         skb = __hci_cmd_sync(hdev, 0xfc05, 0, NULL, HCI_INIT_TIMEOUT);
 603         if (IS_ERR(skb)) {
 604                 bt_dev_err(hdev, "Reading Intel version information failed (%ld)",
 605                            PTR_ERR(skb));
 606                 return PTR_ERR(skb);
 607         }
 608
 609         if (skb->len != sizeof(*ver)) {
 610                 bt_dev_err(hdev, "Intel version event size mismatch");
 611                 kfree_skb(skb);
 612                 return -EILSEQ;
 613         }
 614
 615         ver = (struct intel_version *)skb->data;
 616         if (ver->status) {
 617                 bt_dev_err(hdev, "Intel version command failure (%02x)",
 618                            ver->status);
 619                 err = -bt_to_errno(ver->status);
 620                 kfree_skb(skb);
 621                 return err;
 622         }
 623
 624         /* The hardware platform number has a fixed value of 0x37 and
 625          * for now only accept this single value.
 626          */
 627         if (ver->hw_platform != 0x37) {
 628                 bt_dev_err(hdev, "Unsupported Intel hardware platform (%u)",
 629                            ver->hw_platform);
 630                 kfree_skb(skb);
 631                 return -EINVAL;
 632         }
 633
 634         /* At the moment only the hardware variant iBT 3.0 (LnP/SfP) is
 635          * supported by this firmware loading method. This check has been
 636          * put in place to ensure correct forward compatibility options
 637          * when newer hardware variants come along.
 638          */
 639         if (ver->hw_variant != 0x0b) {
 640                 bt_dev_err(hdev, "Unsupported Intel hardware variant (%u)",
 641                            ver->hw_variant);
 642                 kfree_skb(skb);
 643                 return -EINVAL;
 644         }
 645
 646         btintel_version_info(hdev, ver);
 647
 648         /* The firmware variant determines if the device is in bootloader
 649          * mode or is running operational firmware. The value 0x06 identifies
 650          * the bootloader and the value 0x23 identifies the operational
 651          * firmware.
 652          *
 653          * When the operational firmware is already present, then only
 654          * the check for valid Bluetooth device address is needed. This
 655          * determines if the device will be added as configured or
 656          * unconfigured controller.
 657          *
 658          * It is not possible to use the Secure Boot Parameters in this
 659          * case since that command is only available in bootloader mode.
 660          */
 661         if (ver->fw_variant == 0x23) {
 662                 kfree_skb(skb);
 663                 clear_bit(STATE_BOOTLOADER, &intel->flags);
 664                 btintel_check_bdaddr(hdev);
 665                 return 0;
 666         }
 667
 668         /* If the device is not in bootloader mode, then the only possible
 669          * choice is to return an error and abort the device initialization.
 670          */
 671         if (ver->fw_variant != 0x06) {
 672                 bt_dev_err(hdev, "Unsupported Intel firmware variant (%u)",
 673                            ver->fw_variant);
 674                 kfree_skb(skb);
 675                 return -ENODEV;
 676         }
 677
 678         kfree_skb(skb);
 679
 680         /* Read the secure boot parameters to identify the operating
 681          * details of the bootloader.
 682          */
 683         skb = __hci_cmd_sync(hdev, 0xfc0d, 0, NULL, HCI_INIT_TIMEOUT);
 684         if (IS_ERR(skb)) {
 685                 bt_dev_err(hdev, "Reading Intel boot parameters failed (%ld)",
 686                            PTR_ERR(skb));
 687                 return PTR_ERR(skb);
 688         }
 689
 690         if (skb->len != sizeof(*params)) {
 691                 bt_dev_err(hdev, "Intel boot parameters size mismatch");
 692                 kfree_skb(skb);
 693                 return -EILSEQ;
 694         }
 695
 696         params = (struct intel_boot_params *)skb->data;
 697         if (params->status) {
 698                 bt_dev_err(hdev, "Intel boot parameters command failure (%02x)",
 699                            params->status);
 700                 err = -bt_to_errno(params->status);
 701                 kfree_skb(skb);
 702                 return err;
 703         }
 704
 705         bt_dev_info(hdev, "Device revision is %u",
 706                     le16_to_cpu(params->dev_revid));
 707
 708         bt_dev_info(hdev, "Secure boot is %s",
 709                     params->secure_boot ? "enabled" : "disabled");
 710
 711         bt_dev_info(hdev, "Minimum firmware build %u week %u %u",
 712                 params->min_fw_build_nn, params->min_fw_build_cw,
 713                 2000 + params->min_fw_build_yy);
 714
 715         /* It is required that every single firmware fragment is acknowledged
 716          * with a command complete event. If the boot parameters indicate
 717          * that this bootloader does not send them, then abort the setup.
 718          */
 719         if (params->limited_cce != 0x00) {
 720                 bt_dev_err(hdev, "Unsupported Intel firmware loading method (%u)",
 721                            params->limited_cce);
 722                 kfree_skb(skb);
 723                 return -EINVAL;
 724         }
 725
 726         /* If the OTP has no valid Bluetooth device address, then there will
 727          * also be no valid address for the operational firmware.
 728          */
 729         if (!bacmp(&params->otp_bdaddr, BDADDR_ANY)) {
 730                 bt_dev_info(hdev, "No device address configured");
 731                 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
 732         }
 733
 734         /* With this Intel bootloader only the hardware variant and device
 735          * revision information are used to select the right firmware.
 736          *
 737          * Currently this bootloader support is limited to hardware variant
 738          * iBT 3.0 (LnP/SfP) which is identified by the value 11 (0x0b).
 739          */
 740         snprintf(fwname, sizeof(fwname), "/*(DEBLOBBED)*/",
 741                  le16_to_cpu(params->dev_revid));
 742
 743         err = reject_firmware(&fw, fwname, &hdev->dev);
 744         if (err < 0) {
 745                 bt_dev_err(hdev, "Failed to load Intel firmware file (%d)",
 746                            err);
 747                 kfree_skb(skb);
 748                 return err;
 749         }
 750
 751         bt_dev_info(hdev, "Found device firmware: %s", fwname);
 752
 753         /* Save the DDC file name for later */
 754         snprintf(fwname, sizeof(fwname), "intel/ibt-11-%u.ddc",
 755                  le16_to_cpu(params->dev_revid));
 756
 757         kfree_skb(skb);
 758
 759         if (fw->size < 644) {
 760                 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
 761                            fw->size);
 762                 err = -EBADF;
 763                 goto done;
 764         }
 765
 766         set_bit(STATE_DOWNLOADING, &intel->flags);
 767
 768         /* Start the firmware download transaction with the Init fragment
 769          * represented by the 128 bytes of CSS header.
 770          */
 771         err = btintel_secure_send(hdev, 0x00, 128, fw->data);
 772         if (err < 0) {
 773                 bt_dev_err(hdev, "Failed to send firmware header (%d)", err);
 774                 goto done;
 775         }
 776
 777         /* Send the 256 bytes of public key information from the firmware
 778          * as the PKey fragment.
 779          */
 780         err = btintel_secure_send(hdev, 0x03, 256, fw->data + 128);
 781         if (err < 0) {
 782                 bt_dev_err(hdev, "Failed to send firmware public key (%d)",
 783                            err);
 784                 goto done;
 785         }
 786
 787         /* Send the 256 bytes of signature information from the firmware
 788          * as the Sign fragment.
 789          */
 790         err = btintel_secure_send(hdev, 0x02, 256, fw->data + 388);
 791         if (err < 0) {
 792                 bt_dev_err(hdev, "Failed to send firmware signature (%d)",
 793                            err);
 794                 goto done;
 795         }
 796
 797         fw_ptr = fw->data + 644;
 798         frag_len = 0;
 799
 800         while (fw_ptr - fw->data < fw->size) {
 801                 struct hci_command_hdr *cmd = (void *)(fw_ptr + frag_len);
 802
 803                 frag_len += sizeof(*cmd) + cmd->plen;
 804
 805                 bt_dev_dbg(hdev, "Patching %td/%zu", (fw_ptr - fw->data),
 806                            fw->size);
 807
 808                 /* The parameter length of the secure send command requires
 809                  * a 4 byte alignment. It happens so that the firmware file
 810                  * contains proper Intel_NOP commands to align the fragments
 811                  * as needed.
 812                  *
 813                  * Send set of commands with 4 byte alignment from the
 814                  * firmware data buffer as a single Data fragement.
 815                  */
 816                 if (frag_len % 4)
 817                         continue;
 818
 819                 /* Send each command from the firmware data buffer as
 820                  * a single Data fragment.
 821                  */
 822                 err = btintel_secure_send(hdev, 0x01, frag_len, fw_ptr);
 823                 if (err < 0) {
 824                         bt_dev_err(hdev, "Failed to send firmware data (%d)",
 825                                    err);
 826                         goto done;
 827                 }
 828
 829                 fw_ptr += frag_len;
 830                 frag_len = 0;
 831         }
 832
 833         set_bit(STATE_FIRMWARE_LOADED, &intel->flags);
 834
 835         bt_dev_info(hdev, "Waiting for firmware download to complete");
 836
 837         /* Before switching the device into operational mode and with that
 838          * booting the loaded firmware, wait for the bootloader notification
 839          * that all fragments have been successfully received.
 840          *
 841          * When the event processing receives the notification, then the
 842          * STATE_DOWNLOADING flag will be cleared.
 843          *
 844          * The firmware loading should not take longer than 5 seconds
 845          * and thus just timeout if that happens and fail the setup
 846          * of this device.
 847          */
 848         err = wait_on_bit_timeout(&intel->flags, STATE_DOWNLOADING,
 849                                   TASK_INTERRUPTIBLE,
 850                                   msecs_to_jiffies(5000));
 851         if (err == 1) {
 852                 bt_dev_err(hdev, "Firmware loading interrupted");
 853                 err = -EINTR;
 854                 goto done;
 855         }
 856
 857         if (err) {
 858                 bt_dev_err(hdev, "Firmware loading timeout");
 859                 err = -ETIMEDOUT;
 860                 goto done;
 861         }
 862
 863         if (test_bit(STATE_FIRMWARE_FAILED, &intel->flags)) {
 864                 bt_dev_err(hdev, "Firmware loading failed");
 865                 err = -ENOEXEC;
 866                 goto done;
 867         }
 868
 869         rettime = ktime_get();
 870         delta = ktime_sub(rettime, calltime);
 871         duration = (unsigned long long) ktime_to_ns(delta) >> 10;
 872
 873         bt_dev_info(hdev, "Firmware loaded in %llu usecs", duration);
 874
 875 done:
 876         release_firmware(fw);
 877
 878         if (err < 0)
 879                 return err;
 880
 881         /* We need to restore the default speed before Intel reset */
 882         if (speed_change) {
 883                 err = intel_set_baudrate(hu, init_speed);
 884                 if (err)
 885                         return err;
 886         }
 887
 888         calltime = ktime_get();
 889
 890         set_bit(STATE_BOOTING, &intel->flags);
 891
 892         skb = __hci_cmd_sync(hdev, 0xfc01, sizeof(reset_param), reset_param,
 893                              HCI_INIT_TIMEOUT);
 894         if (IS_ERR(skb))
 895                 return PTR_ERR(skb);
 896
 897         kfree_skb(skb);
 898
 899         /* The bootloader will not indicate when the device is ready. This
 900          * is done by the operational firmware sending bootup notification.
 901          *
 902          * Booting into operational firmware should not take longer than
 903          * 1 second. However if that happens, then just fail the setup
 904          * since something went wrong.
 905          */
 906         bt_dev_info(hdev, "Waiting for device to boot");
 907
 908         err = intel_wait_booting(hu);
 909         if (err)
 910                 return err;
 911
 912         clear_bit(STATE_BOOTING, &intel->flags);
 913
 914         rettime = ktime_get();
 915         delta = ktime_sub(rettime, calltime);
 916         duration = (unsigned long long) ktime_to_ns(delta) >> 10;
 917
 918         bt_dev_info(hdev, "Device booted in %llu usecs", duration);
 919
 920         /* Enable LPM if matching pdev with wakeup enabled */
 921         mutex_lock(&intel_device_list_lock);
 922         list_for_each(p, &intel_device_list) {
 923                 struct intel_device *dev = list_entry(p, struct intel_device,
 924                                                       list);
 925                 if (!hu->tty->dev)
 926                         break;
 927                 if (hu->tty->dev->parent == dev->pdev->dev.parent) {
 928                         if (device_may_wakeup(&dev->pdev->dev))
 929                                 idev = dev;
 930                         break;
 931                 }
 932         }
 933         mutex_unlock(&intel_device_list_lock);
 934
 935         if (!idev)
 936                 goto no_lpm;
 937
 938         bt_dev_info(hdev, "Enabling LPM");
 939
 940         skb = __hci_cmd_sync(hdev, 0xfc8b, sizeof(lpm_param), lpm_param,
 941                              HCI_CMD_TIMEOUT);
 942         if (IS_ERR(skb)) {
 943                 bt_dev_err(hdev, "Failed to enable LPM");
 944                 goto no_lpm;
 945         }
 946         kfree_skb(skb);
 947
 948         set_bit(STATE_LPM_ENABLED, &intel->flags);
 949
 950 no_lpm:
 951         /* Ignore errors, device can work without DDC parameters */
 952         btintel_load_ddc_config(hdev, fwname);
 953
 954         skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_CMD_TIMEOUT);
 955         if (IS_ERR(skb))
 956                 return PTR_ERR(skb);
 957         kfree_skb(skb);
 958
 959         if (speed_change) {
 960                 err = intel_set_baudrate(hu, oper_speed);
 961                 if (err)
 962                         return err;
 963         }
 964
 965         bt_dev_info(hdev, "Setup complete");
 966
 967         clear_bit(STATE_BOOTLOADER, &intel->flags);
 968
 969         return 0;
 970 }
 971
 972 static int intel_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
 973 {
 974         struct hci_uart *hu = hci_get_drvdata(hdev);
 975         struct intel_data *intel = hu->priv;
 976         struct hci_event_hdr *hdr;
 977
 978         if (!test_bit(STATE_BOOTLOADER, &intel->flags) &&
 979             !test_bit(STATE_BOOTING, &intel->flags))
 980                 goto recv;
 981
 982         hdr = (void *)skb->data;
 983
 984         /* When the firmware loading completes the device sends
 985          * out a vendor specific event indicating the result of
 986          * the firmware loading.
 987          */
 988         if (skb->len == 7 && hdr->evt == 0xff && hdr->plen == 0x05 &&
 989             skb->data[2] == 0x06) {
 990                 if (skb->data[3] != 0x00)
 991                         set_bit(STATE_FIRMWARE_FAILED, &intel->flags);
 992
 993                 if (test_and_clear_bit(STATE_DOWNLOADING, &intel->flags) &&
 994                     test_bit(STATE_FIRMWARE_LOADED, &intel->flags)) {
 995                         smp_mb__after_atomic();
 996                         wake_up_bit(&intel->flags, STATE_DOWNLOADING);
 997                 }
 998
 999         /* When switching to the operational firmware the device
1000          * sends a vendor specific event indicating that the bootup
1001          * completed.
1002          */
1003         } else if (skb->len == 9 && hdr->evt == 0xff && hdr->plen == 0x07 &&
1004                    skb->data[2] == 0x02) {
1005                 if (test_and_clear_bit(STATE_BOOTING, &intel->flags)) {
1006                         smp_mb__after_atomic();
1007                         wake_up_bit(&intel->flags, STATE_BOOTING);
1008                 }
1009         }
1010 recv:
1011         return hci_recv_frame(hdev, skb);
1012 }
1013
1014 static void intel_recv_lpm_notify(struct hci_dev *hdev, int value)
1015 {
1016         struct hci_uart *hu = hci_get_drvdata(hdev);
1017         struct intel_data *intel = hu->priv;
1018
1019         bt_dev_dbg(hdev, "TX idle notification (%d)", value);
1020
1021         if (value) {
1022                 set_bit(STATE_TX_ACTIVE, &intel->flags);
1023                 schedule_work(&intel->busy_work);
1024         } else {
1025                 clear_bit(STATE_TX_ACTIVE, &intel->flags);
1026         }
1027 }
1028
1029 static int intel_recv_lpm(struct hci_dev *hdev, struct sk_buff *skb)
1030 {
1031         struct hci_lpm_pkt *lpm = (void *)skb->data;
1032         struct hci_uart *hu = hci_get_drvdata(hdev);
1033         struct intel_data *intel = hu->priv;
1034
1035         switch (lpm->opcode) {
1036         case LPM_OP_TX_NOTIFY:
1037                 if (lpm->dlen < 1) {
1038                         bt_dev_err(hu->hdev, "Invalid LPM notification packet");
1039                         break;
1040                 }
1041                 intel_recv_lpm_notify(hdev, lpm->data[0]);
1042                 break;
1043         case LPM_OP_SUSPEND_ACK:
1044                 set_bit(STATE_SUSPENDED, &intel->flags);
1045                 if (test_and_clear_bit(STATE_LPM_TRANSACTION, &intel->flags)) {
1046                         smp_mb__after_atomic();
1047                         wake_up_bit(&intel->flags, STATE_LPM_TRANSACTION);
1048                 }
1049                 break;
1050         case LPM_OP_RESUME_ACK:
1051                 clear_bit(STATE_SUSPENDED, &intel->flags);
1052                 if (test_and_clear_bit(STATE_LPM_TRANSACTION, &intel->flags)) {
1053                         smp_mb__after_atomic();
1054                         wake_up_bit(&intel->flags, STATE_LPM_TRANSACTION);
1055                 }
1056                 break;
1057         default:
1058                 bt_dev_err(hdev, "Unknown LPM opcode (%02x)", lpm->opcode);
1059                 break;
1060         }
1061
1062         kfree_skb(skb);
1063
1064         return 0;
1065 }
1066
1067 #define INTEL_RECV_LPM \
1068         .type = HCI_LPM_PKT, \
1069         .hlen = HCI_LPM_HDR_SIZE, \
1070         .loff = 1, \
1071         .lsize = 1, \
1072         .maxlen = HCI_LPM_MAX_SIZE
1073
1074 static const struct h4_recv_pkt intel_recv_pkts[] = {
1075         { H4_RECV_ACL,    .recv = hci_recv_frame   },
1076         { H4_RECV_SCO,    .recv = hci_recv_frame   },
1077         { H4_RECV_EVENT,  .recv = intel_recv_event },
1078         { INTEL_RECV_LPM, .recv = intel_recv_lpm   },
1079 };
1080
1081 static int intel_recv(struct hci_uart *hu, const void *data, int count)
1082 {
1083         struct intel_data *intel = hu->priv;
1084
1085         if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
1086                 return -EUNATCH;
1087
1088         intel->rx_skb = h4_recv_buf(hu->hdev, intel->rx_skb, data, count,
1089                                     intel_recv_pkts,
1090                                     ARRAY_SIZE(intel_recv_pkts));
1091         if (IS_ERR(intel->rx_skb)) {
1092                 int err = PTR_ERR(intel->rx_skb);
1093                 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
1094                 intel->rx_skb = NULL;
1095                 return err;
1096         }
1097
1098         return count;
1099 }
1100
1101 static int intel_enqueue(struct hci_uart *hu, struct sk_buff *skb)
1102 {
1103         struct intel_data *intel = hu->priv;
1104         struct list_head *p;
1105
1106         BT_DBG("hu %p skb %p", hu, skb);
1107
1108         if (!hu->tty->dev)
1109                 goto out_enqueue;
1110
1111         /* Be sure our controller is resumed and potential LPM transaction
1112          * completed before enqueuing any packet.
1113          */
1114         mutex_lock(&intel_device_list_lock);
1115         list_for_each(p, &intel_device_list) {
1116                 struct intel_device *idev = list_entry(p, struct intel_device,
1117                                                        list);
1118
1119                 if (hu->tty->dev->parent == idev->pdev->dev.parent) {
1120                         pm_runtime_get_sync(&idev->pdev->dev);
1121                         pm_runtime_mark_last_busy(&idev->pdev->dev);
1122                         pm_runtime_put_autosuspend(&idev->pdev->dev);
1123                         break;
1124                 }
1125         }
1126         mutex_unlock(&intel_device_list_lock);
1127 out_enqueue:
1128         skb_queue_tail(&intel->txq, skb);
1129
1130         return 0;
1131 }
1132
1133 static struct sk_buff *intel_dequeue(struct hci_uart *hu)
1134 {
1135         struct intel_data *intel = hu->priv;
1136         struct sk_buff *skb;
1137
1138         skb = skb_dequeue(&intel->txq);
1139         if (!skb)
1140                 return skb;
1141
1142         if (test_bit(STATE_BOOTLOADER, &intel->flags) &&
1143             (bt_cb(skb)->pkt_type == HCI_COMMAND_PKT)) {
1144                 struct hci_command_hdr *cmd = (void *)skb->data;
1145                 __u16 opcode = le16_to_cpu(cmd->opcode);
1146
1147                 /* When the 0xfc01 command is issued to boot into
1148                  * the operational firmware, it will actually not
1149                  * send a command complete event. To keep the flow
1150                  * control working inject that event here.
1151                  */
1152                 if (opcode == 0xfc01)
1153                         inject_cmd_complete(hu->hdev, opcode);
1154         }
1155
1156         /* Prepend skb with frame type */
1157         memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
1158
1159         return skb;
1160 }
1161
1162 static const struct hci_uart_proto intel_proto = {
1163         .id             = HCI_UART_INTEL,
1164         .name           = "Intel",
1165         .manufacturer   = 2,
1166         .init_speed     = 115200,
1167         .oper_speed     = 3000000,
1168         .open           = intel_open,
1169         .close          = intel_close,
1170         .flush          = intel_flush,
1171         .setup          = intel_setup,
1172         .set_baudrate   = intel_set_baudrate,
1173         .recv           = intel_recv,
1174         .enqueue        = intel_enqueue,
1175         .dequeue        = intel_dequeue,
1176 };
1177
1178 #ifdef CONFIG_ACPI
1179 static const struct acpi_device_id intel_acpi_match[] = {
1180         { "INT33E1", 0 },
1181         { },
1182 };
1183 MODULE_DEVICE_TABLE(acpi, intel_acpi_match);
1184 #endif
1185
1186 #ifdef CONFIG_PM
1187 static int intel_suspend_device(struct device *dev)
1188 {
1189         struct intel_device *idev = dev_get_drvdata(dev);
1190
1191         mutex_lock(&idev->hu_lock);
1192         if (idev->hu)
1193                 intel_lpm_suspend(idev->hu);
1194         mutex_unlock(&idev->hu_lock);
1195
1196         return 0;
1197 }
1198
1199 static int intel_resume_device(struct device *dev)
1200 {
1201         struct intel_device *idev = dev_get_drvdata(dev);
1202
1203         mutex_lock(&idev->hu_lock);
1204         if (idev->hu)
1205                 intel_lpm_resume(idev->hu);
1206         mutex_unlock(&idev->hu_lock);
1207
1208         return 0;
1209 }
1210 #endif
1211
1212 #ifdef CONFIG_PM_SLEEP
1213 static int intel_suspend(struct device *dev)
1214 {
1215         struct intel_device *idev = dev_get_drvdata(dev);
1216
1217         if (device_may_wakeup(dev))
1218                 enable_irq_wake(idev->irq);
1219
1220         return intel_suspend_device(dev);
1221 }
1222
1223 static int intel_resume(struct device *dev)
1224 {
1225         struct intel_device *idev = dev_get_drvdata(dev);
1226
1227         if (device_may_wakeup(dev))
1228                 disable_irq_wake(idev->irq);
1229
1230         return intel_resume_device(dev);
1231 }
1232 #endif
1233
1234 static const struct dev_pm_ops intel_pm_ops = {
1235         SET_SYSTEM_SLEEP_PM_OPS(intel_suspend, intel_resume)
1236         SET_RUNTIME_PM_OPS(intel_suspend_device, intel_resume_device, NULL)
1237 };
1238
1239 static int intel_probe(struct platform_device *pdev)
1240 {
1241         struct intel_device *idev;
1242
1243         idev = devm_kzalloc(&pdev->dev, sizeof(*idev), GFP_KERNEL);
1244         if (!idev)
1245                 return -ENOMEM;
1246
1247         mutex_init(&idev->hu_lock);
1248
1249         idev->pdev = pdev;
1250
1251         idev->reset = devm_gpiod_get(&pdev->dev, "reset", GPIOD_OUT_LOW);
1252         if (IS_ERR(idev->reset)) {
1253                 dev_err(&pdev->dev, "Unable to retrieve gpio\n");
1254                 return PTR_ERR(idev->reset);
1255         }
1256
1257         idev->irq = platform_get_irq(pdev, 0);
1258         if (idev->irq < 0) {
1259                 struct gpio_desc *host_wake;
1260
1261                 dev_err(&pdev->dev, "No IRQ, falling back to gpio-irq\n");
1262
1263                 host_wake = devm_gpiod_get(&pdev->dev, "host-wake", GPIOD_IN);
1264                 if (IS_ERR(host_wake)) {
1265                         dev_err(&pdev->dev, "Unable to retrieve IRQ\n");
1266                         goto no_irq;
1267                 }
1268
1269                 idev->irq = gpiod_to_irq(host_wake);
1270                 if (idev->irq < 0) {
1271                         dev_err(&pdev->dev, "No corresponding irq for gpio\n");
1272                         goto no_irq;
1273                 }
1274         }
1275
1276         /* Only enable wake-up/irq when controller is powered */
1277         device_set_wakeup_capable(&pdev->dev, true);
1278         device_wakeup_disable(&pdev->dev);
1279
1280 no_irq:
1281         platform_set_drvdata(pdev, idev);
1282
1283         /* Place this instance on the device list */
1284         mutex_lock(&intel_device_list_lock);
1285         list_add_tail(&idev->list, &intel_device_list);
1286         mutex_unlock(&intel_device_list_lock);
1287
1288         dev_info(&pdev->dev, "registered, gpio(%d)/irq(%d).\n",
1289                  desc_to_gpio(idev->reset), idev->irq);
1290
1291         return 0;
1292 }
1293
1294 static int intel_remove(struct platform_device *pdev)
1295 {
1296         struct intel_device *idev = platform_get_drvdata(pdev);
1297
1298         device_wakeup_disable(&pdev->dev);
1299
1300         mutex_lock(&intel_device_list_lock);
1301         list_del(&idev->list);
1302         mutex_unlock(&intel_device_list_lock);
1303
1304         dev_info(&pdev->dev, "unregistered.\n");
1305
1306         return 0;
1307 }
1308
1309 static struct platform_driver intel_driver = {
1310         .probe = intel_probe,
1311         .remove = intel_remove,
1312         .driver = {
1313                 .name = "hci_intel",
1314                 .acpi_match_table = ACPI_PTR(intel_acpi_match),
1315                 .pm = &intel_pm_ops,
1316         },
1317 };
1318
1319 int __init intel_init(void)
1320 {
1321         platform_driver_register(&intel_driver);
1322
1323         return hci_uart_register_proto(&intel_proto);
1324 }
1325
1326 int __exit intel_deinit(void)
1327 {
1328         platform_driver_unregister(&intel_driver);
1329
1330         return hci_uart_unregister_proto(&intel_proto);
1331 }