drivers/bluetooth/btusb.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *
   4  *  Generic Bluetooth USB driver
   5  *
   6  *  Copyright (C) 2005-2008  Marcel Holtmann <marcel@holtmann.org>
   7  */
   8
   9 #include <linux/dmi.h>
  10 #include <linux/module.h>
  11 #include <linux/usb.h>
  12 #include <linux/usb/quirks.h>
  13 #include <linux/firmware.h>
  14 #include <linux/of_device.h>
  15 #include <linux/of_irq.h>
  16 #include <linux/suspend.h>
  17 #include <linux/gpio/consumer.h>
  18 #include <asm/unaligned.h>
  19
  20 #include <net/bluetooth/bluetooth.h>
  21 #include <net/bluetooth/hci_core.h>
  22
  23 #include "btintel.h"
  24 #include "btbcm.h"
  25 #include "btrtl.h"
  26
  27 #define VERSION "0.8"
  28
  29 static bool disable_scofix;
  30 static bool force_scofix;
  31 static bool enable_autosuspend = IS_ENABLED(CONFIG_BT_HCIBTUSB_AUTOSUSPEND);
  32
  33 static bool reset = true;
  34
  35 static struct usb_driver btusb_driver;
  36
  37 #define BTUSB_IGNORE            0x01
  38 #define BTUSB_DIGIANSWER        0x02
  39 #define BTUSB_CSR               0x04
  40 #define BTUSB_SNIFFER           0x08
  41 #define BTUSB_BCM92035          0x10
  42 #define BTUSB_BROKEN_ISOC       0x20
  43 #define BTUSB_WRONG_SCO_MTU     0x40
  44 #define BTUSB_ATH3012           0x80
  45 #define BTUSB_INTEL             0x100
  46 #define BTUSB_INTEL_BOOT        0x200
  47 #define BTUSB_BCM_PATCHRAM      0x400
  48 #define BTUSB_MARVELL           0x800
  49 #define BTUSB_SWAVE             0x1000
  50 #define BTUSB_INTEL_NEW         0x2000
  51 #define BTUSB_AMP               0x4000
  52 #define BTUSB_QCA_ROME          0x8000
  53 #define BTUSB_BCM_APPLE         0x10000
  54 #define BTUSB_REALTEK           0x20000
  55 #define BTUSB_BCM2045           0x40000
  56 #define BTUSB_IFNUM_2           0x80000
  57 #define BTUSB_CW6622            0x100000
  58
  59 static const struct usb_device_id btusb_table[] = {
  60         /* Generic Bluetooth USB device */
  61         { USB_DEVICE_INFO(0xe0, 0x01, 0x01) },
  62
  63         /* Generic Bluetooth AMP device */
  64         { USB_DEVICE_INFO(0xe0, 0x01, 0x04), .driver_info = BTUSB_AMP },
  65
  66         /* Generic Bluetooth USB interface */
  67         { USB_INTERFACE_INFO(0xe0, 0x01, 0x01) },
  68
  69         /* Apple-specific (Broadcom) devices */
  70         { USB_VENDOR_AND_INTERFACE_INFO(0x05ac, 0xff, 0x01, 0x01),
  71           .driver_info = BTUSB_BCM_APPLE | BTUSB_IFNUM_2 },
  72
  73         /* MediaTek MT76x0E */
  74         { USB_DEVICE(0x0e8d, 0x763f) },
  75
  76         /* Broadcom SoftSailing reporting vendor specific */
  77         { USB_DEVICE(0x0a5c, 0x21e1) },
  78
  79         /* Apple MacBookPro 7,1 */
  80         { USB_DEVICE(0x05ac, 0x8213) },
  81
  82         /* Apple iMac11,1 */
  83         { USB_DEVICE(0x05ac, 0x8215) },
  84
  85         /* Apple MacBookPro6,2 */
  86         { USB_DEVICE(0x05ac, 0x8218) },
  87
  88         /* Apple MacBookAir3,1, MacBookAir3,2 */
  89         { USB_DEVICE(0x05ac, 0x821b) },
  90
  91         /* Apple MacBookAir4,1 */
  92         { USB_DEVICE(0x05ac, 0x821f) },
  93
  94         /* Apple MacBookPro8,2 */
  95         { USB_DEVICE(0x05ac, 0x821a) },
  96
  97         /* Apple MacMini5,1 */
  98         { USB_DEVICE(0x05ac, 0x8281) },
  99
 100         /* AVM BlueFRITZ! USB v2.0 */
 101         { USB_DEVICE(0x057c, 0x3800), .driver_info = BTUSB_SWAVE },
 102
 103         /* Bluetooth Ultraport Module from IBM */
 104         { USB_DEVICE(0x04bf, 0x030a) },
 105
 106         /* ALPS Modules with non-standard id */
 107         { USB_DEVICE(0x044e, 0x3001) },
 108         { USB_DEVICE(0x044e, 0x3002) },
 109
 110         /* Ericsson with non-standard id */
 111         { USB_DEVICE(0x0bdb, 0x1002) },
 112
 113         /* Canyon CN-BTU1 with HID interfaces */
 114         { USB_DEVICE(0x0c10, 0x0000) },
 115
 116         /* Broadcom BCM20702A0 */
 117         { USB_DEVICE(0x413c, 0x8197) },
 118
 119         /* Broadcom BCM20702B0 (Dynex/Insignia) */
 120         { USB_DEVICE(0x19ff, 0x0239), .driver_info = BTUSB_BCM_PATCHRAM },
 121
 122         /* Broadcom BCM43142A0 (Foxconn/Lenovo) */
 123         { USB_VENDOR_AND_INTERFACE_INFO(0x105b, 0xff, 0x01, 0x01),
 124           .driver_info = BTUSB_BCM_PATCHRAM },
 125
 126         /* Broadcom BCM920703 (HTC Vive) */
 127         { USB_VENDOR_AND_INTERFACE_INFO(0x0bb4, 0xff, 0x01, 0x01),
 128           .driver_info = BTUSB_BCM_PATCHRAM },
 129
 130         /* Foxconn - Hon Hai */
 131         { USB_VENDOR_AND_INTERFACE_INFO(0x0489, 0xff, 0x01, 0x01),
 132           .driver_info = BTUSB_BCM_PATCHRAM },
 133
 134         /* Lite-On Technology - Broadcom based */
 135         { USB_VENDOR_AND_INTERFACE_INFO(0x04ca, 0xff, 0x01, 0x01),
 136           .driver_info = BTUSB_BCM_PATCHRAM },
 137
 138         /* Broadcom devices with vendor specific id */
 139         { USB_VENDOR_AND_INTERFACE_INFO(0x0a5c, 0xff, 0x01, 0x01),
 140           .driver_info = BTUSB_BCM_PATCHRAM },
 141
 142         /* ASUSTek Computer - Broadcom based */
 143         { USB_VENDOR_AND_INTERFACE_INFO(0x0b05, 0xff, 0x01, 0x01),
 144           .driver_info = BTUSB_BCM_PATCHRAM },
 145
 146         /* Belkin F8065bf - Broadcom based */
 147         { USB_VENDOR_AND_INTERFACE_INFO(0x050d, 0xff, 0x01, 0x01),
 148           .driver_info = BTUSB_BCM_PATCHRAM },
 149
 150         /* IMC Networks - Broadcom based */
 151         { USB_VENDOR_AND_INTERFACE_INFO(0x13d3, 0xff, 0x01, 0x01),
 152           .driver_info = BTUSB_BCM_PATCHRAM },
 153
 154         /* Dell Computer - Broadcom based  */
 155         { USB_VENDOR_AND_INTERFACE_INFO(0x413c, 0xff, 0x01, 0x01),
 156           .driver_info = BTUSB_BCM_PATCHRAM },
 157
 158         /* Toshiba Corp - Broadcom based */
 159         { USB_VENDOR_AND_INTERFACE_INFO(0x0930, 0xff, 0x01, 0x01),
 160           .driver_info = BTUSB_BCM_PATCHRAM },
 161
 162         /* Intel Bluetooth USB Bootloader (RAM module) */
 163         { USB_DEVICE(0x8087, 0x0a5a),
 164           .driver_info = BTUSB_INTEL_BOOT | BTUSB_BROKEN_ISOC },
 165
 166         { }     /* Terminating entry */
 167 };
 168
 169 MODULE_DEVICE_TABLE(usb, btusb_table);
 170
 171 static const struct usb_device_id blacklist_table[] = {
 172         /* CSR BlueCore devices */
 173         { USB_DEVICE(0x0a12, 0x0001), .driver_info = BTUSB_CSR },
 174
 175         /* Broadcom BCM2033 without firmware */
 176         { USB_DEVICE(0x0a5c, 0x2033), .driver_info = BTUSB_IGNORE },
 177
 178         /* Broadcom BCM2045 devices */
 179         { USB_DEVICE(0x0a5c, 0x2045), .driver_info = BTUSB_BCM2045 },
 180
 181         /* Atheros 3011 with sflash firmware */
 182         { USB_DEVICE(0x0489, 0xe027), .driver_info = BTUSB_IGNORE },
 183         { USB_DEVICE(0x0489, 0xe03d), .driver_info = BTUSB_IGNORE },
 184         { USB_DEVICE(0x04f2, 0xaff1), .driver_info = BTUSB_IGNORE },
 185         { USB_DEVICE(0x0930, 0x0215), .driver_info = BTUSB_IGNORE },
 186         { USB_DEVICE(0x0cf3, 0x3002), .driver_info = BTUSB_IGNORE },
 187         { USB_DEVICE(0x0cf3, 0xe019), .driver_info = BTUSB_IGNORE },
 188         { USB_DEVICE(0x13d3, 0x3304), .driver_info = BTUSB_IGNORE },
 189
 190         /* Atheros AR9285 Malbec with sflash firmware */
 191         { USB_DEVICE(0x03f0, 0x311d), .driver_info = BTUSB_IGNORE },
 192
 193         /* Atheros 3012 with sflash firmware */
 194         { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
 195         { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
 196         { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
 197         { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
 198         { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
 199         { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
 200         { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
 201         { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
 202         { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
 203         { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
 204         { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
 205         { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
 206         { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
 207         { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
 208         { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
 209         { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
 210         { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
 211         { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
 212         { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
 213         { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
 214         { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
 215         { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
 216         { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
 217         { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
 218         { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
 219         { USB_DEVICE(0x0cf3, 0x0036), .driver_info = BTUSB_ATH3012 },
 220         { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
 221         { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
 222         { USB_DEVICE(0x0cf3, 0x311d), .driver_info = BTUSB_ATH3012 },
 223         { USB_DEVICE(0x0cf3, 0x311e), .driver_info = BTUSB_ATH3012 },
 224         { USB_DEVICE(0x0cf3, 0x311f), .driver_info = BTUSB_ATH3012 },
 225         { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
 226         { USB_DEVICE(0x0cf3, 0x817a), .driver_info = BTUSB_ATH3012 },
 227         { USB_DEVICE(0x0cf3, 0x817b), .driver_info = BTUSB_ATH3012 },
 228         { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
 229         { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
 230         { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
 231         { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
 232         { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
 233         { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
 234         { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
 235         { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
 236         { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
 237         { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
 238         { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
 239         { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
 240         { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
 241         { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
 242         { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
 243         { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
 244
 245         /* Atheros AR5BBU12 with sflash firmware */
 246         { USB_DEVICE(0x0489, 0xe02c), .driver_info = BTUSB_IGNORE },
 247
 248         /* Atheros AR5BBU12 with sflash firmware */
 249         { USB_DEVICE(0x0489, 0xe036), .driver_info = BTUSB_ATH3012 },
 250         { USB_DEVICE(0x0489, 0xe03c), .driver_info = BTUSB_ATH3012 },
 251
 252         /* QCA ROME chipset */
 253         { USB_DEVICE(0x0cf3, 0x535b), .driver_info = BTUSB_QCA_ROME },
 254         { USB_DEVICE(0x0cf3, 0xe007), .driver_info = BTUSB_QCA_ROME },
 255         { USB_DEVICE(0x0cf3, 0xe009), .driver_info = BTUSB_QCA_ROME },
 256         { USB_DEVICE(0x0cf3, 0xe010), .driver_info = BTUSB_QCA_ROME },
 257         { USB_DEVICE(0x0cf3, 0xe300), .driver_info = BTUSB_QCA_ROME },
 258         { USB_DEVICE(0x0cf3, 0xe301), .driver_info = BTUSB_QCA_ROME },
 259         { USB_DEVICE(0x0cf3, 0xe360), .driver_info = BTUSB_QCA_ROME },
 260         { USB_DEVICE(0x0489, 0xe092), .driver_info = BTUSB_QCA_ROME },
 261         { USB_DEVICE(0x0489, 0xe09f), .driver_info = BTUSB_QCA_ROME },
 262         { USB_DEVICE(0x0489, 0xe0a2), .driver_info = BTUSB_QCA_ROME },
 263         { USB_DEVICE(0x04ca, 0x3011), .driver_info = BTUSB_QCA_ROME },
 264         { USB_DEVICE(0x04ca, 0x3015), .driver_info = BTUSB_QCA_ROME },
 265         { USB_DEVICE(0x04ca, 0x3016), .driver_info = BTUSB_QCA_ROME },
 266         { USB_DEVICE(0x04ca, 0x301a), .driver_info = BTUSB_QCA_ROME },
 267         { USB_DEVICE(0x13d3, 0x3491), .driver_info = BTUSB_QCA_ROME },
 268         { USB_DEVICE(0x13d3, 0x3496), .driver_info = BTUSB_QCA_ROME },
 269         { USB_DEVICE(0x13d3, 0x3501), .driver_info = BTUSB_QCA_ROME },
 270
 271         /* Broadcom BCM2035 */
 272         { USB_DEVICE(0x0a5c, 0x2009), .driver_info = BTUSB_BCM92035 },
 273         { USB_DEVICE(0x0a5c, 0x200a), .driver_info = BTUSB_WRONG_SCO_MTU },
 274         { USB_DEVICE(0x0a5c, 0x2035), .driver_info = BTUSB_WRONG_SCO_MTU },
 275
 276         /* Broadcom BCM2045 */
 277         { USB_DEVICE(0x0a5c, 0x2039), .driver_info = BTUSB_WRONG_SCO_MTU },
 278         { USB_DEVICE(0x0a5c, 0x2101), .driver_info = BTUSB_WRONG_SCO_MTU },
 279
 280         /* IBM/Lenovo ThinkPad with Broadcom chip */
 281         { USB_DEVICE(0x0a5c, 0x201e), .driver_info = BTUSB_WRONG_SCO_MTU },
 282         { USB_DEVICE(0x0a5c, 0x2110), .driver_info = BTUSB_WRONG_SCO_MTU },
 283
 284         /* HP laptop with Broadcom chip */
 285         { USB_DEVICE(0x03f0, 0x171d), .driver_info = BTUSB_WRONG_SCO_MTU },
 286
 287         /* Dell laptop with Broadcom chip */
 288         { USB_DEVICE(0x413c, 0x8126), .driver_info = BTUSB_WRONG_SCO_MTU },
 289
 290         /* Dell Wireless 370 and 410 devices */
 291         { USB_DEVICE(0x413c, 0x8152), .driver_info = BTUSB_WRONG_SCO_MTU },
 292         { USB_DEVICE(0x413c, 0x8156), .driver_info = BTUSB_WRONG_SCO_MTU },
 293
 294         /* Belkin F8T012 and F8T013 devices */
 295         { USB_DEVICE(0x050d, 0x0012), .driver_info = BTUSB_WRONG_SCO_MTU },
 296         { USB_DEVICE(0x050d, 0x0013), .driver_info = BTUSB_WRONG_SCO_MTU },
 297
 298         /* Asus WL-BTD202 device */
 299         { USB_DEVICE(0x0b05, 0x1715), .driver_info = BTUSB_WRONG_SCO_MTU },
 300
 301         /* Kensington Bluetooth USB adapter */
 302         { USB_DEVICE(0x047d, 0x105e), .driver_info = BTUSB_WRONG_SCO_MTU },
 303
 304         /* RTX Telecom based adapters with buggy SCO support */
 305         { USB_DEVICE(0x0400, 0x0807), .driver_info = BTUSB_BROKEN_ISOC },
 306         { USB_DEVICE(0x0400, 0x080a), .driver_info = BTUSB_BROKEN_ISOC },
 307
 308         /* CONWISE Technology based adapters with buggy SCO support */
 309         { USB_DEVICE(0x0e5e, 0x6622),
 310           .driver_info = BTUSB_BROKEN_ISOC | BTUSB_CW6622},
 311
 312         /* Roper Class 1 Bluetooth Dongle (Silicon Wave based) */
 313         { USB_DEVICE(0x1310, 0x0001), .driver_info = BTUSB_SWAVE },
 314
 315         /* Digianswer devices */
 316         { USB_DEVICE(0x08fd, 0x0001), .driver_info = BTUSB_DIGIANSWER },
 317         { USB_DEVICE(0x08fd, 0x0002), .driver_info = BTUSB_IGNORE },
 318
 319         /* CSR BlueCore Bluetooth Sniffer */
 320         { USB_DEVICE(0x0a12, 0x0002),
 321           .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
 322
 323         /* Frontline ComProbe Bluetooth Sniffer */
 324         { USB_DEVICE(0x16d3, 0x0002),
 325           .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
 326
 327         /* Marvell Bluetooth devices */
 328         { USB_DEVICE(0x1286, 0x2044), .driver_info = BTUSB_MARVELL },
 329         { USB_DEVICE(0x1286, 0x2046), .driver_info = BTUSB_MARVELL },
 330         { USB_DEVICE(0x1286, 0x204e), .driver_info = BTUSB_MARVELL },
 331
 332         /* Intel Bluetooth devices */
 333         { USB_DEVICE(0x8087, 0x0025), .driver_info = BTUSB_INTEL_NEW },
 334         { USB_DEVICE(0x8087, 0x0026), .driver_info = BTUSB_INTEL_NEW },
 335         { USB_DEVICE(0x8087, 0x0029), .driver_info = BTUSB_INTEL_NEW },
 336         { USB_DEVICE(0x8087, 0x07da), .driver_info = BTUSB_CSR },
 337         { USB_DEVICE(0x8087, 0x07dc), .driver_info = BTUSB_INTEL },
 338         { USB_DEVICE(0x8087, 0x0a2a), .driver_info = BTUSB_INTEL },
 339         { USB_DEVICE(0x8087, 0x0a2b), .driver_info = BTUSB_INTEL_NEW },
 340         { USB_DEVICE(0x8087, 0x0aa7), .driver_info = BTUSB_INTEL },
 341         { USB_DEVICE(0x8087, 0x0aaa), .driver_info = BTUSB_INTEL_NEW },
 342
 343         /* Other Intel Bluetooth devices */
 344         { USB_VENDOR_AND_INTERFACE_INFO(0x8087, 0xe0, 0x01, 0x01),
 345           .driver_info = BTUSB_IGNORE },
 346
 347         /* Realtek Bluetooth devices */
 348         { USB_VENDOR_AND_INTERFACE_INFO(0x0bda, 0xe0, 0x01, 0x01),
 349           .driver_info = BTUSB_REALTEK },
 350
 351         /* Additional Realtek 8723AE Bluetooth devices */
 352         { USB_DEVICE(0x0930, 0x021d), .driver_info = BTUSB_REALTEK },
 353         { USB_DEVICE(0x13d3, 0x3394), .driver_info = BTUSB_REALTEK },
 354
 355         /* Additional Realtek 8723BE Bluetooth devices */
 356         { USB_DEVICE(0x0489, 0xe085), .driver_info = BTUSB_REALTEK },
 357         { USB_DEVICE(0x0489, 0xe08b), .driver_info = BTUSB_REALTEK },
 358         { USB_DEVICE(0x13d3, 0x3410), .driver_info = BTUSB_REALTEK },
 359         { USB_DEVICE(0x13d3, 0x3416), .driver_info = BTUSB_REALTEK },
 360         { USB_DEVICE(0x13d3, 0x3459), .driver_info = BTUSB_REALTEK },
 361         { USB_DEVICE(0x13d3, 0x3494), .driver_info = BTUSB_REALTEK },
 362
 363         /* Additional Realtek 8723BU Bluetooth devices */
 364         { USB_DEVICE(0x7392, 0xa611), .driver_info = BTUSB_REALTEK },
 365
 366         /* Additional Realtek 8723DE Bluetooth devices */
 367         { USB_DEVICE(0x0bda, 0xb009), .driver_info = BTUSB_REALTEK },
 368         { USB_DEVICE(0x2ff8, 0xb011), .driver_info = BTUSB_REALTEK },
 369
 370         /* Additional Realtek 8821AE Bluetooth devices */
 371         { USB_DEVICE(0x0b05, 0x17dc), .driver_info = BTUSB_REALTEK },
 372         { USB_DEVICE(0x13d3, 0x3414), .driver_info = BTUSB_REALTEK },
 373         { USB_DEVICE(0x13d3, 0x3458), .driver_info = BTUSB_REALTEK },
 374         { USB_DEVICE(0x13d3, 0x3461), .driver_info = BTUSB_REALTEK },
 375         { USB_DEVICE(0x13d3, 0x3462), .driver_info = BTUSB_REALTEK },
 376
 377         /* Additional Realtek 8822BE Bluetooth devices */
 378         { USB_DEVICE(0x13d3, 0x3526), .driver_info = BTUSB_REALTEK },
 379         { USB_DEVICE(0x0b05, 0x185c), .driver_info = BTUSB_REALTEK },
 380
 381         /* Silicon Wave based devices */
 382         { USB_DEVICE(0x0c10, 0x0000), .driver_info = BTUSB_SWAVE },
 383
 384         { }     /* Terminating entry */
 385 };
 386
 387 /* The Bluetooth USB module build into some devices needs to be reset on resume,
 388  * this is a problem with the platform (likely shutting off all power) not with
 389  * the module itself. So we use a DMI list to match known broken platforms.
 390  */
 391 static const struct dmi_system_id btusb_needs_reset_resume_table[] = {
 392         {
 393                 /* Dell OptiPlex 3060 (QCA ROME device 0cf3:e007) */
 394                 .matches = {
 395                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 396                         DMI_MATCH(DMI_PRODUCT_NAME, "OptiPlex 3060"),
 397                 },
 398         },
 399         {
 400                 /* Dell XPS 9360 (QCA ROME device 0cf3:e300) */
 401                 .matches = {
 402                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 403                         DMI_MATCH(DMI_PRODUCT_NAME, "XPS 13 9360"),
 404                 },
 405         },
 406         {
 407                 /* Dell Inspiron 5565 (QCA ROME device 0cf3:e009) */
 408                 .matches = {
 409                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 410                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 5565"),
 411                 },
 412         },
 413         {}
 414 };
 415
 416 #define BTUSB_MAX_ISOC_FRAMES   10
 417
 418 #define BTUSB_INTR_RUNNING      0
 419 #define BTUSB_BULK_RUNNING      1
 420 #define BTUSB_ISOC_RUNNING      2
 421 #define BTUSB_SUSPENDING        3
 422 #define BTUSB_DID_ISO_RESUME    4
 423 #define BTUSB_BOOTLOADER        5
 424 #define BTUSB_DOWNLOADING       6
 425 #define BTUSB_FIRMWARE_LOADED   7
 426 #define BTUSB_FIRMWARE_FAILED   8
 427 #define BTUSB_BOOTING           9
 428 #define BTUSB_DIAG_RUNNING      10
 429 #define BTUSB_OOB_WAKE_ENABLED  11
 430 #define BTUSB_HW_RESET_ACTIVE   12
 431
 432 struct btusb_data {
 433         struct hci_dev       *hdev;
 434         struct usb_device    *udev;
 435         struct usb_interface *intf;
 436         struct usb_interface *isoc;
 437         struct usb_interface *diag;
 438         unsigned isoc_ifnum;
 439
 440         unsigned long flags;
 441
 442         struct work_struct work;
 443         struct work_struct waker;
 444
 445         struct usb_anchor deferred;
 446         struct usb_anchor tx_anchor;
 447         int tx_in_flight;
 448         spinlock_t txlock;
 449
 450         struct usb_anchor intr_anchor;
 451         struct usb_anchor bulk_anchor;
 452         struct usb_anchor isoc_anchor;
 453         struct usb_anchor diag_anchor;
 454         spinlock_t rxlock;
 455
 456         struct sk_buff *evt_skb;
 457         struct sk_buff *acl_skb;
 458         struct sk_buff *sco_skb;
 459
 460         struct usb_endpoint_descriptor *intr_ep;
 461         struct usb_endpoint_descriptor *bulk_tx_ep;
 462         struct usb_endpoint_descriptor *bulk_rx_ep;
 463         struct usb_endpoint_descriptor *isoc_tx_ep;
 464         struct usb_endpoint_descriptor *isoc_rx_ep;
 465         struct usb_endpoint_descriptor *diag_tx_ep;
 466         struct usb_endpoint_descriptor *diag_rx_ep;
 467
 468         struct gpio_desc *reset_gpio;
 469
 470         __u8 cmdreq_type;
 471         __u8 cmdreq;
 472
 473         unsigned int sco_num;
 474         int isoc_altsetting;
 475         int suspend_count;
 476
 477         int (*recv_event)(struct hci_dev *hdev, struct sk_buff *skb);
 478         int (*recv_bulk)(struct btusb_data *data, void *buffer, int count);
 479
 480         int (*setup_on_usb)(struct hci_dev *hdev);
 481
 482         int oob_wake_irq;   /* irq for out-of-band wake-on-bt */
 483         unsigned cmd_timeout_cnt;
 484 };
 485
 486
 487 static void btusb_intel_cmd_timeout(struct hci_dev *hdev)
 488 {
 489         struct btusb_data *data = hci_get_drvdata(hdev);
 490         struct gpio_desc *reset_gpio = data->reset_gpio;
 491
 492         if (++data->cmd_timeout_cnt < 5)
 493                 return;
 494
 495         if (!reset_gpio) {
 496                 bt_dev_err(hdev, "No way to reset. Ignoring and continuing");
 497                 return;
 498         }
 499
 500         /*
 501          * Toggle the hard reset line if the platform provides one. The reset
 502          * is going to yank the device off the USB and then replug. So doing
 503          * once is enough. The cleanup is handled correctly on the way out
 504          * (standard USB disconnect), and the new device is detected cleanly
 505          * and bound to the driver again like it should be.
 506          */
 507         if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
 508                 bt_dev_err(hdev, "last reset failed? Not resetting again");
 509                 return;
 510         }
 511
 512         bt_dev_err(hdev, "Initiating HW reset via gpio");
 513         gpiod_set_value_cansleep(reset_gpio, 1);
 514         msleep(100);
 515         gpiod_set_value_cansleep(reset_gpio, 0);
 516 }
 517
 518 static inline void btusb_free_frags(struct btusb_data *data)
 519 {
 520         unsigned long flags;
 521
 522         spin_lock_irqsave(&data->rxlock, flags);
 523
 524         kfree_skb(data->evt_skb);
 525         data->evt_skb = NULL;
 526
 527         kfree_skb(data->acl_skb);
 528         data->acl_skb = NULL;
 529
 530         kfree_skb(data->sco_skb);
 531         data->sco_skb = NULL;
 532
 533         spin_unlock_irqrestore(&data->rxlock, flags);
 534 }
 535
 536 static int btusb_recv_intr(struct btusb_data *data, void *buffer, int count)
 537 {
 538         struct sk_buff *skb;
 539         unsigned long flags;
 540         int err = 0;
 541
 542         spin_lock_irqsave(&data->rxlock, flags);
 543         skb = data->evt_skb;
 544
 545         while (count) {
 546                 int len;
 547
 548                 if (!skb) {
 549                         skb = bt_skb_alloc(HCI_MAX_EVENT_SIZE, GFP_ATOMIC);
 550                         if (!skb) {
 551                                 err = -ENOMEM;
 552                                 break;
 553                         }
 554
 555                         hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
 556                         hci_skb_expect(skb) = HCI_EVENT_HDR_SIZE;
 557                 }
 558
 559                 len = min_t(uint, hci_skb_expect(skb), count);
 560                 skb_put_data(skb, buffer, len);
 561
 562                 count -= len;
 563                 buffer += len;
 564                 hci_skb_expect(skb) -= len;
 565
 566                 if (skb->len == HCI_EVENT_HDR_SIZE) {
 567                         /* Complete event header */
 568                         hci_skb_expect(skb) = hci_event_hdr(skb)->plen;
 569
 570                         if (skb_tailroom(skb) < hci_skb_expect(skb)) {
 571                                 kfree_skb(skb);
 572                                 skb = NULL;
 573
 574                                 err = -EILSEQ;
 575                                 break;
 576                         }
 577                 }
 578
 579                 if (!hci_skb_expect(skb)) {
 580                         /* Complete frame */
 581                         data->recv_event(data->hdev, skb);
 582                         skb = NULL;
 583                 }
 584         }
 585
 586         data->evt_skb = skb;
 587         spin_unlock_irqrestore(&data->rxlock, flags);
 588
 589         return err;
 590 }
 591
 592 static int btusb_recv_bulk(struct btusb_data *data, void *buffer, int count)
 593 {
 594         struct sk_buff *skb;
 595         unsigned long flags;
 596         int err = 0;
 597
 598         spin_lock_irqsave(&data->rxlock, flags);
 599         skb = data->acl_skb;
 600
 601         while (count) {
 602                 int len;
 603
 604                 if (!skb) {
 605                         skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
 606                         if (!skb) {
 607                                 err = -ENOMEM;
 608                                 break;
 609                         }
 610
 611                         hci_skb_pkt_type(skb) = HCI_ACLDATA_PKT;
 612                         hci_skb_expect(skb) = HCI_ACL_HDR_SIZE;
 613                 }
 614
 615                 len = min_t(uint, hci_skb_expect(skb), count);
 616                 skb_put_data(skb, buffer, len);
 617
 618                 count -= len;
 619                 buffer += len;
 620                 hci_skb_expect(skb) -= len;
 621
 622                 if (skb->len == HCI_ACL_HDR_SIZE) {
 623                         __le16 dlen = hci_acl_hdr(skb)->dlen;
 624
 625                         /* Complete ACL header */
 626                         hci_skb_expect(skb) = __le16_to_cpu(dlen);
 627
 628                         if (skb_tailroom(skb) < hci_skb_expect(skb)) {
 629                                 kfree_skb(skb);
 630                                 skb = NULL;
 631
 632                                 err = -EILSEQ;
 633                                 break;
 634                         }
 635                 }
 636
 637                 if (!hci_skb_expect(skb)) {
 638                         /* Complete frame */
 639                         hci_recv_frame(data->hdev, skb);
 640                         skb = NULL;
 641                 }
 642         }
 643
 644         data->acl_skb = skb;
 645         spin_unlock_irqrestore(&data->rxlock, flags);
 646
 647         return err;
 648 }
 649
 650 static int btusb_recv_isoc(struct btusb_data *data, void *buffer, int count)
 651 {
 652         struct sk_buff *skb;
 653         unsigned long flags;
 654         int err = 0;
 655
 656         spin_lock_irqsave(&data->rxlock, flags);
 657         skb = data->sco_skb;
 658
 659         while (count) {
 660                 int len;
 661
 662                 if (!skb) {
 663                         skb = bt_skb_alloc(HCI_MAX_SCO_SIZE, GFP_ATOMIC);
 664                         if (!skb) {
 665                                 err = -ENOMEM;
 666                                 break;
 667                         }
 668
 669                         hci_skb_pkt_type(skb) = HCI_SCODATA_PKT;
 670                         hci_skb_expect(skb) = HCI_SCO_HDR_SIZE;
 671                 }
 672
 673                 len = min_t(uint, hci_skb_expect(skb), count);
 674                 skb_put_data(skb, buffer, len);
 675
 676                 count -= len;
 677                 buffer += len;
 678                 hci_skb_expect(skb) -= len;
 679
 680                 if (skb->len == HCI_SCO_HDR_SIZE) {
 681                         /* Complete SCO header */
 682                         hci_skb_expect(skb) = hci_sco_hdr(skb)->dlen;
 683
 684                         if (skb_tailroom(skb) < hci_skb_expect(skb)) {
 685                                 kfree_skb(skb);
 686                                 skb = NULL;
 687
 688                                 err = -EILSEQ;
 689                                 break;
 690                         }
 691                 }
 692
 693                 if (!hci_skb_expect(skb)) {
 694                         /* Complete frame */
 695                         hci_recv_frame(data->hdev, skb);
 696                         skb = NULL;
 697                 }
 698         }
 699
 700         data->sco_skb = skb;
 701         spin_unlock_irqrestore(&data->rxlock, flags);
 702
 703         return err;
 704 }
 705
 706 static void btusb_intr_complete(struct urb *urb)
 707 {
 708         struct hci_dev *hdev = urb->context;
 709         struct btusb_data *data = hci_get_drvdata(hdev);
 710         int err;
 711
 712         BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
 713                urb->actual_length);
 714
 715         if (!test_bit(HCI_RUNNING, &hdev->flags))
 716                 return;
 717
 718         if (urb->status == 0) {
 719                 hdev->stat.byte_rx += urb->actual_length;
 720
 721                 if (btusb_recv_intr(data, urb->transfer_buffer,
 722                                     urb->actual_length) < 0) {
 723                         bt_dev_err(hdev, "corrupted event packet");
 724                         hdev->stat.err_rx++;
 725                 }
 726         } else if (urb->status == -ENOENT) {
 727                 /* Avoid suspend failed when usb_kill_urb */
 728                 return;
 729         }
 730
 731         if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
 732                 return;
 733
 734         usb_mark_last_busy(data->udev);
 735         usb_anchor_urb(urb, &data->intr_anchor);
 736
 737         err = usb_submit_urb(urb, GFP_ATOMIC);
 738         if (err < 0) {
 739                 /* -EPERM: urb is being killed;
 740                  * -ENODEV: device got disconnected
 741                  */
 742                 if (err != -EPERM && err != -ENODEV)
 743                         bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
 744                                    urb, -err);
 745                 usb_unanchor_urb(urb);
 746         }
 747 }
 748
 749 static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
 750 {
 751         struct btusb_data *data = hci_get_drvdata(hdev);
 752         struct urb *urb;
 753         unsigned char *buf;
 754         unsigned int pipe;
 755         int err, size;
 756
 757         BT_DBG("%s", hdev->name);
 758
 759         if (!data->intr_ep)
 760                 return -ENODEV;
 761
 762         urb = usb_alloc_urb(0, mem_flags);
 763         if (!urb)
 764                 return -ENOMEM;
 765
 766         size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
 767
 768         buf = kmalloc(size, mem_flags);
 769         if (!buf) {
 770                 usb_free_urb(urb);
 771                 return -ENOMEM;
 772         }
 773
 774         pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
 775
 776         usb_fill_int_urb(urb, data->udev, pipe, buf, size,
 777                          btusb_intr_complete, hdev, data->intr_ep->bInterval);
 778
 779         urb->transfer_flags |= URB_FREE_BUFFER;
 780
 781         usb_anchor_urb(urb, &data->intr_anchor);
 782
 783         err = usb_submit_urb(urb, mem_flags);
 784         if (err < 0) {
 785                 if (err != -EPERM && err != -ENODEV)
 786                         bt_dev_err(hdev, "urb %p submission failed (%d)",
 787                                    urb, -err);
 788                 usb_unanchor_urb(urb);
 789         }
 790
 791         usb_free_urb(urb);
 792
 793         return err;
 794 }
 795
 796 static void btusb_bulk_complete(struct urb *urb)
 797 {
 798         struct hci_dev *hdev = urb->context;
 799         struct btusb_data *data = hci_get_drvdata(hdev);
 800         int err;
 801
 802         BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
 803                urb->actual_length);
 804
 805         if (!test_bit(HCI_RUNNING, &hdev->flags))
 806                 return;
 807
 808         if (urb->status == 0) {
 809                 hdev->stat.byte_rx += urb->actual_length;
 810
 811                 if (data->recv_bulk(data, urb->transfer_buffer,
 812                                     urb->actual_length) < 0) {
 813                         bt_dev_err(hdev, "corrupted ACL packet");
 814                         hdev->stat.err_rx++;
 815                 }
 816         } else if (urb->status == -ENOENT) {
 817                 /* Avoid suspend failed when usb_kill_urb */
 818                 return;
 819         }
 820
 821         if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
 822                 return;
 823
 824         usb_anchor_urb(urb, &data->bulk_anchor);
 825         usb_mark_last_busy(data->udev);
 826
 827         err = usb_submit_urb(urb, GFP_ATOMIC);
 828         if (err < 0) {
 829                 /* -EPERM: urb is being killed;
 830                  * -ENODEV: device got disconnected
 831                  */
 832                 if (err != -EPERM && err != -ENODEV)
 833                         bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
 834                                    urb, -err);
 835                 usb_unanchor_urb(urb);
 836         }
 837 }
 838
 839 static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
 840 {
 841         struct btusb_data *data = hci_get_drvdata(hdev);
 842         struct urb *urb;
 843         unsigned char *buf;
 844         unsigned int pipe;
 845         int err, size = HCI_MAX_FRAME_SIZE;
 846
 847         BT_DBG("%s", hdev->name);
 848
 849         if (!data->bulk_rx_ep)
 850                 return -ENODEV;
 851
 852         urb = usb_alloc_urb(0, mem_flags);
 853         if (!urb)
 854                 return -ENOMEM;
 855
 856         buf = kmalloc(size, mem_flags);
 857         if (!buf) {
 858                 usb_free_urb(urb);
 859                 return -ENOMEM;
 860         }
 861
 862         pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
 863
 864         usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
 865                           btusb_bulk_complete, hdev);
 866
 867         urb->transfer_flags |= URB_FREE_BUFFER;
 868
 869         usb_mark_last_busy(data->udev);
 870         usb_anchor_urb(urb, &data->bulk_anchor);
 871
 872         err = usb_submit_urb(urb, mem_flags);
 873         if (err < 0) {
 874                 if (err != -EPERM && err != -ENODEV)
 875                         bt_dev_err(hdev, "urb %p submission failed (%d)",
 876                                    urb, -err);
 877                 usb_unanchor_urb(urb);
 878         }
 879
 880         usb_free_urb(urb);
 881
 882         return err;
 883 }
 884
 885 static void btusb_isoc_complete(struct urb *urb)
 886 {
 887         struct hci_dev *hdev = urb->context;
 888         struct btusb_data *data = hci_get_drvdata(hdev);
 889         int i, err;
 890
 891         BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
 892                urb->actual_length);
 893
 894         if (!test_bit(HCI_RUNNING, &hdev->flags))
 895                 return;
 896
 897         if (urb->status == 0) {
 898                 for (i = 0; i < urb->number_of_packets; i++) {
 899                         unsigned int offset = urb->iso_frame_desc[i].offset;
 900                         unsigned int length = urb->iso_frame_desc[i].actual_length;
 901
 902                         if (urb->iso_frame_desc[i].status)
 903                                 continue;
 904
 905                         hdev->stat.byte_rx += length;
 906
 907                         if (btusb_recv_isoc(data, urb->transfer_buffer + offset,
 908                                             length) < 0) {
 909                                 bt_dev_err(hdev, "corrupted SCO packet");
 910                                 hdev->stat.err_rx++;
 911                         }
 912                 }
 913         } else if (urb->status == -ENOENT) {
 914                 /* Avoid suspend failed when usb_kill_urb */
 915                 return;
 916         }
 917
 918         if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
 919                 return;
 920
 921         usb_anchor_urb(urb, &data->isoc_anchor);
 922
 923         err = usb_submit_urb(urb, GFP_ATOMIC);
 924         if (err < 0) {
 925                 /* -EPERM: urb is being killed;
 926                  * -ENODEV: device got disconnected
 927                  */
 928                 if (err != -EPERM && err != -ENODEV)
 929                         bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
 930                                    urb, -err);
 931                 usb_unanchor_urb(urb);
 932         }
 933 }
 934
 935 static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
 936 {
 937         int i, offset = 0;
 938
 939         BT_DBG("len %d mtu %d", len, mtu);
 940
 941         for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
 942                                         i++, offset += mtu, len -= mtu) {
 943                 urb->iso_frame_desc[i].offset = offset;
 944                 urb->iso_frame_desc[i].length = mtu;
 945         }
 946
 947         if (len && i < BTUSB_MAX_ISOC_FRAMES) {
 948                 urb->iso_frame_desc[i].offset = offset;
 949                 urb->iso_frame_desc[i].length = len;
 950                 i++;
 951         }
 952
 953         urb->number_of_packets = i;
 954 }
 955
 956 static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
 957 {
 958         struct btusb_data *data = hci_get_drvdata(hdev);
 959         struct urb *urb;
 960         unsigned char *buf;
 961         unsigned int pipe;
 962         int err, size;
 963
 964         BT_DBG("%s", hdev->name);
 965
 966         if (!data->isoc_rx_ep)
 967                 return -ENODEV;
 968
 969         urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
 970         if (!urb)
 971                 return -ENOMEM;
 972
 973         size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
 974                                                 BTUSB_MAX_ISOC_FRAMES;
 975
 976         buf = kmalloc(size, mem_flags);
 977         if (!buf) {
 978                 usb_free_urb(urb);
 979                 return -ENOMEM;
 980         }
 981
 982         pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
 983
 984         usb_fill_int_urb(urb, data->udev, pipe, buf, size, btusb_isoc_complete,
 985                          hdev, data->isoc_rx_ep->bInterval);
 986
 987         urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
 988
 989         __fill_isoc_descriptor(urb, size,
 990                                le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
 991
 992         usb_anchor_urb(urb, &data->isoc_anchor);
 993
 994         err = usb_submit_urb(urb, mem_flags);
 995         if (err < 0) {
 996                 if (err != -EPERM && err != -ENODEV)
 997                         bt_dev_err(hdev, "urb %p submission failed (%d)",
 998                                    urb, -err);
 999                 usb_unanchor_urb(urb);
1000         }
1001
1002         usb_free_urb(urb);
1003
1004         return err;
1005 }
1006
1007 static void btusb_diag_complete(struct urb *urb)
1008 {
1009         struct hci_dev *hdev = urb->context;
1010         struct btusb_data *data = hci_get_drvdata(hdev);
1011         int err;
1012
1013         BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1014                urb->actual_length);
1015
1016         if (urb->status == 0) {
1017                 struct sk_buff *skb;
1018
1019                 skb = bt_skb_alloc(urb->actual_length, GFP_ATOMIC);
1020                 if (skb) {
1021                         skb_put_data(skb, urb->transfer_buffer,
1022                                      urb->actual_length);
1023                         hci_recv_diag(hdev, skb);
1024                 }
1025         } else if (urb->status == -ENOENT) {
1026                 /* Avoid suspend failed when usb_kill_urb */
1027                 return;
1028         }
1029
1030         if (!test_bit(BTUSB_DIAG_RUNNING, &data->flags))
1031                 return;
1032
1033         usb_anchor_urb(urb, &data->diag_anchor);
1034         usb_mark_last_busy(data->udev);
1035
1036         err = usb_submit_urb(urb, GFP_ATOMIC);
1037         if (err < 0) {
1038                 /* -EPERM: urb is being killed;
1039                  * -ENODEV: device got disconnected
1040                  */
1041                 if (err != -EPERM && err != -ENODEV)
1042                         bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
1043                                    urb, -err);
1044                 usb_unanchor_urb(urb);
1045         }
1046 }
1047
1048 static int btusb_submit_diag_urb(struct hci_dev *hdev, gfp_t mem_flags)
1049 {
1050         struct btusb_data *data = hci_get_drvdata(hdev);
1051         struct urb *urb;
1052         unsigned char *buf;
1053         unsigned int pipe;
1054         int err, size = HCI_MAX_FRAME_SIZE;
1055
1056         BT_DBG("%s", hdev->name);
1057
1058         if (!data->diag_rx_ep)
1059                 return -ENODEV;
1060
1061         urb = usb_alloc_urb(0, mem_flags);
1062         if (!urb)
1063                 return -ENOMEM;
1064
1065         buf = kmalloc(size, mem_flags);
1066         if (!buf) {
1067                 usb_free_urb(urb);
1068                 return -ENOMEM;
1069         }
1070
1071         pipe = usb_rcvbulkpipe(data->udev, data->diag_rx_ep->bEndpointAddress);
1072
1073         usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
1074                           btusb_diag_complete, hdev);
1075
1076         urb->transfer_flags |= URB_FREE_BUFFER;
1077
1078         usb_mark_last_busy(data->udev);
1079         usb_anchor_urb(urb, &data->diag_anchor);
1080
1081         err = usb_submit_urb(urb, mem_flags);
1082         if (err < 0) {
1083                 if (err != -EPERM && err != -ENODEV)
1084                         bt_dev_err(hdev, "urb %p submission failed (%d)",
1085                                    urb, -err);
1086                 usb_unanchor_urb(urb);
1087         }
1088
1089         usb_free_urb(urb);
1090
1091         return err;
1092 }
1093
1094 static void btusb_tx_complete(struct urb *urb)
1095 {
1096         struct sk_buff *skb = urb->context;
1097         struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1098         struct btusb_data *data = hci_get_drvdata(hdev);
1099         unsigned long flags;
1100
1101         BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1102                urb->actual_length);
1103
1104         if (!test_bit(HCI_RUNNING, &hdev->flags))
1105                 goto done;
1106
1107         if (!urb->status)
1108                 hdev->stat.byte_tx += urb->transfer_buffer_length;
1109         else
1110                 hdev->stat.err_tx++;
1111
1112 done:
1113         spin_lock_irqsave(&data->txlock, flags);
1114         data->tx_in_flight--;
1115         spin_unlock_irqrestore(&data->txlock, flags);
1116
1117         kfree(urb->setup_packet);
1118
1119         kfree_skb(skb);
1120 }
1121
1122 static void btusb_isoc_tx_complete(struct urb *urb)
1123 {
1124         struct sk_buff *skb = urb->context;
1125         struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1126
1127         BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1128                urb->actual_length);
1129
1130         if (!test_bit(HCI_RUNNING, &hdev->flags))
1131                 goto done;
1132
1133         if (!urb->status)
1134                 hdev->stat.byte_tx += urb->transfer_buffer_length;
1135         else
1136                 hdev->stat.err_tx++;
1137
1138 done:
1139         kfree(urb->setup_packet);
1140
1141         kfree_skb(skb);
1142 }
1143
1144 static int btusb_open(struct hci_dev *hdev)
1145 {
1146         struct btusb_data *data = hci_get_drvdata(hdev);
1147         int err;
1148
1149         BT_DBG("%s", hdev->name);
1150
1151         err = usb_autopm_get_interface(data->intf);
1152         if (err < 0)
1153                 return err;
1154
1155         /* Patching USB firmware files prior to starting any URBs of HCI path
1156          * It is more safe to use USB bulk channel for downloading USB patch
1157          */
1158         if (data->setup_on_usb) {
1159                 err = data->setup_on_usb(hdev);
1160                 if (err < 0)
1161                         return err;
1162         }
1163
1164         data->intf->needs_remote_wakeup = 1;
1165         /* device specific wakeup source enabled and required for USB
1166          * remote wakeup while host is suspended
1167          */
1168         device_wakeup_enable(&data->udev->dev);
1169
1170         if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
1171                 goto done;
1172
1173         err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
1174         if (err < 0)
1175                 goto failed;
1176
1177         err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1178         if (err < 0) {
1179                 usb_kill_anchored_urbs(&data->intr_anchor);
1180                 goto failed;
1181         }
1182
1183         set_bit(BTUSB_BULK_RUNNING, &data->flags);
1184         btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1185
1186         if (data->diag) {
1187                 if (!btusb_submit_diag_urb(hdev, GFP_KERNEL))
1188                         set_bit(BTUSB_DIAG_RUNNING, &data->flags);
1189         }
1190
1191 done:
1192         usb_autopm_put_interface(data->intf);
1193         return 0;
1194
1195 failed:
1196         clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1197         usb_autopm_put_interface(data->intf);
1198         return err;
1199 }
1200
1201 static void btusb_stop_traffic(struct btusb_data *data)
1202 {
1203         usb_kill_anchored_urbs(&data->intr_anchor);
1204         usb_kill_anchored_urbs(&data->bulk_anchor);
1205         usb_kill_anchored_urbs(&data->isoc_anchor);
1206         usb_kill_anchored_urbs(&data->diag_anchor);
1207 }
1208
1209 static int btusb_close(struct hci_dev *hdev)
1210 {
1211         struct btusb_data *data = hci_get_drvdata(hdev);
1212         int err;
1213
1214         BT_DBG("%s", hdev->name);
1215
1216         cancel_work_sync(&data->work);
1217         cancel_work_sync(&data->waker);
1218
1219         clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1220         clear_bit(BTUSB_BULK_RUNNING, &data->flags);
1221         clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1222         clear_bit(BTUSB_DIAG_RUNNING, &data->flags);
1223
1224         btusb_stop_traffic(data);
1225         btusb_free_frags(data);
1226
1227         err = usb_autopm_get_interface(data->intf);
1228         if (err < 0)
1229                 goto failed;
1230
1231         data->intf->needs_remote_wakeup = 0;
1232         device_wakeup_disable(&data->udev->dev);
1233         usb_autopm_put_interface(data->intf);
1234
1235 failed:
1236         usb_scuttle_anchored_urbs(&data->deferred);
1237         return 0;
1238 }
1239
1240 static int btusb_flush(struct hci_dev *hdev)
1241 {
1242         struct btusb_data *data = hci_get_drvdata(hdev);
1243
1244         BT_DBG("%s", hdev->name);
1245
1246         usb_kill_anchored_urbs(&data->tx_anchor);
1247         btusb_free_frags(data);
1248
1249         return 0;
1250 }
1251
1252 static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1253 {
1254         struct btusb_data *data = hci_get_drvdata(hdev);
1255         struct usb_ctrlrequest *dr;
1256         struct urb *urb;
1257         unsigned int pipe;
1258
1259         urb = usb_alloc_urb(0, GFP_KERNEL);
1260         if (!urb)
1261                 return ERR_PTR(-ENOMEM);
1262
1263         dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1264         if (!dr) {
1265                 usb_free_urb(urb);
1266                 return ERR_PTR(-ENOMEM);
1267         }
1268
1269         dr->bRequestType = data->cmdreq_type;
1270         dr->bRequest     = data->cmdreq;
1271         dr->wIndex       = 0;
1272         dr->wValue       = 0;
1273         dr->wLength      = __cpu_to_le16(skb->len);
1274
1275         pipe = usb_sndctrlpipe(data->udev, 0x00);
1276
1277         usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1278                              skb->data, skb->len, btusb_tx_complete, skb);
1279
1280         skb->dev = (void *)hdev;
1281
1282         return urb;
1283 }
1284
1285 static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1286 {
1287         struct btusb_data *data = hci_get_drvdata(hdev);
1288         struct urb *urb;
1289         unsigned int pipe;
1290
1291         if (!data->bulk_tx_ep)
1292                 return ERR_PTR(-ENODEV);
1293
1294         urb = usb_alloc_urb(0, GFP_KERNEL);
1295         if (!urb)
1296                 return ERR_PTR(-ENOMEM);
1297
1298         pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1299
1300         usb_fill_bulk_urb(urb, data->udev, pipe,
1301                           skb->data, skb->len, btusb_tx_complete, skb);
1302
1303         skb->dev = (void *)hdev;
1304
1305         return urb;
1306 }
1307
1308 static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1309 {
1310         struct btusb_data *data = hci_get_drvdata(hdev);
1311         struct urb *urb;
1312         unsigned int pipe;
1313
1314         if (!data->isoc_tx_ep)
1315                 return ERR_PTR(-ENODEV);
1316
1317         urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1318         if (!urb)
1319                 return ERR_PTR(-ENOMEM);
1320
1321         pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1322
1323         usb_fill_int_urb(urb, data->udev, pipe,
1324                          skb->data, skb->len, btusb_isoc_tx_complete,
1325                          skb, data->isoc_tx_ep->bInterval);
1326
1327         urb->transfer_flags  = URB_ISO_ASAP;
1328
1329         __fill_isoc_descriptor(urb, skb->len,
1330                                le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1331
1332         skb->dev = (void *)hdev;
1333
1334         return urb;
1335 }
1336
1337 static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1338 {
1339         struct btusb_data *data = hci_get_drvdata(hdev);
1340         int err;
1341
1342         usb_anchor_urb(urb, &data->tx_anchor);
1343
1344         err = usb_submit_urb(urb, GFP_KERNEL);
1345         if (err < 0) {
1346                 if (err != -EPERM && err != -ENODEV)
1347                         bt_dev_err(hdev, "urb %p submission failed (%d)",
1348                                    urb, -err);
1349                 kfree(urb->setup_packet);
1350                 usb_unanchor_urb(urb);
1351         } else {
1352                 usb_mark_last_busy(data->udev);
1353         }
1354
1355         usb_free_urb(urb);
1356         return err;
1357 }
1358
1359 static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1360 {
1361         struct btusb_data *data = hci_get_drvdata(hdev);
1362         unsigned long flags;
1363         bool suspending;
1364
1365         spin_lock_irqsave(&data->txlock, flags);
1366         suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1367         if (!suspending)
1368                 data->tx_in_flight++;
1369         spin_unlock_irqrestore(&data->txlock, flags);
1370
1371         if (!suspending)
1372                 return submit_tx_urb(hdev, urb);
1373
1374         usb_anchor_urb(urb, &data->deferred);
1375         schedule_work(&data->waker);
1376
1377         usb_free_urb(urb);
1378         return 0;
1379 }
1380
1381 static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1382 {
1383         struct urb *urb;
1384
1385         BT_DBG("%s", hdev->name);
1386
1387         switch (hci_skb_pkt_type(skb)) {
1388         case HCI_COMMAND_PKT:
1389                 urb = alloc_ctrl_urb(hdev, skb);
1390                 if (IS_ERR(urb))
1391                         return PTR_ERR(urb);
1392
1393                 hdev->stat.cmd_tx++;
1394                 return submit_or_queue_tx_urb(hdev, urb);
1395
1396         case HCI_ACLDATA_PKT:
1397                 urb = alloc_bulk_urb(hdev, skb);
1398                 if (IS_ERR(urb))
1399                         return PTR_ERR(urb);
1400
1401                 hdev->stat.acl_tx++;
1402                 return submit_or_queue_tx_urb(hdev, urb);
1403
1404         case HCI_SCODATA_PKT:
1405                 if (hci_conn_num(hdev, SCO_LINK) < 1)
1406                         return -ENODEV;
1407
1408                 urb = alloc_isoc_urb(hdev, skb);
1409                 if (IS_ERR(urb))
1410                         return PTR_ERR(urb);
1411
1412                 hdev->stat.sco_tx++;
1413                 return submit_tx_urb(hdev, urb);
1414         }
1415
1416         return -EILSEQ;
1417 }
1418
1419 static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1420 {
1421         struct btusb_data *data = hci_get_drvdata(hdev);
1422
1423         BT_DBG("%s evt %d", hdev->name, evt);
1424
1425         if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1426                 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1427                 schedule_work(&data->work);
1428         }
1429 }
1430
1431 static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1432 {
1433         struct btusb_data *data = hci_get_drvdata(hdev);
1434         struct usb_interface *intf = data->isoc;
1435         struct usb_endpoint_descriptor *ep_desc;
1436         int i, err;
1437
1438         if (!data->isoc)
1439                 return -ENODEV;
1440
1441         err = usb_set_interface(data->udev, data->isoc_ifnum, altsetting);
1442         if (err < 0) {
1443                 bt_dev_err(hdev, "setting interface failed (%d)", -err);
1444                 return err;
1445         }
1446
1447         data->isoc_altsetting = altsetting;
1448
1449         data->isoc_tx_ep = NULL;
1450         data->isoc_rx_ep = NULL;
1451
1452         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1453                 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1454
1455                 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1456                         data->isoc_tx_ep = ep_desc;
1457                         continue;
1458                 }
1459
1460                 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1461                         data->isoc_rx_ep = ep_desc;
1462                         continue;
1463                 }
1464         }
1465
1466         if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1467                 bt_dev_err(hdev, "invalid SCO descriptors");
1468                 return -ENODEV;
1469         }
1470
1471         return 0;
1472 }
1473
1474 static void btusb_work(struct work_struct *work)
1475 {
1476         struct btusb_data *data = container_of(work, struct btusb_data, work);
1477         struct hci_dev *hdev = data->hdev;
1478         int new_alts;
1479         int err;
1480
1481         if (data->sco_num > 0) {
1482                 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1483                         err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1484                         if (err < 0) {
1485                                 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1486                                 usb_kill_anchored_urbs(&data->isoc_anchor);
1487                                 return;
1488                         }
1489
1490                         set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1491                 }
1492
1493                 if (hdev->voice_setting & 0x0020) {
1494                         static const int alts[3] = { 2, 4, 5 };
1495
1496                         new_alts = alts[data->sco_num - 1];
1497                 } else {
1498                         new_alts = data->sco_num;
1499                 }
1500
1501                 if (data->isoc_altsetting != new_alts) {
1502                         unsigned long flags;
1503
1504                         clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1505                         usb_kill_anchored_urbs(&data->isoc_anchor);
1506
1507                         /* When isochronous alternate setting needs to be
1508                          * changed, because SCO connection has been added
1509                          * or removed, a packet fragment may be left in the
1510                          * reassembling state. This could lead to wrongly
1511                          * assembled fragments.
1512                          *
1513                          * Clear outstanding fragment when selecting a new
1514                          * alternate setting.
1515                          */
1516                         spin_lock_irqsave(&data->rxlock, flags);
1517                         kfree_skb(data->sco_skb);
1518                         data->sco_skb = NULL;
1519                         spin_unlock_irqrestore(&data->rxlock, flags);
1520
1521                         if (__set_isoc_interface(hdev, new_alts) < 0)
1522                                 return;
1523                 }
1524
1525                 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1526                         if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1527                                 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1528                         else
1529                                 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1530                 }
1531         } else {
1532                 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1533                 usb_kill_anchored_urbs(&data->isoc_anchor);
1534
1535                 __set_isoc_interface(hdev, 0);
1536                 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1537                         usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1538         }
1539 }
1540
1541 static void btusb_waker(struct work_struct *work)
1542 {
1543         struct btusb_data *data = container_of(work, struct btusb_data, waker);
1544         int err;
1545
1546         err = usb_autopm_get_interface(data->intf);
1547         if (err < 0)
1548                 return;
1549
1550         usb_autopm_put_interface(data->intf);
1551 }
1552
1553 static int btusb_setup_bcm92035(struct hci_dev *hdev)
1554 {
1555         struct sk_buff *skb;
1556         u8 val = 0x00;
1557
1558         BT_DBG("%s", hdev->name);
1559
1560         skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1561         if (IS_ERR(skb))
1562                 bt_dev_err(hdev, "BCM92035 command failed (%ld)", PTR_ERR(skb));
1563         else
1564                 kfree_skb(skb);
1565
1566         return 0;
1567 }
1568
1569 static int btusb_setup_csr(struct hci_dev *hdev)
1570 {
1571         struct hci_rp_read_local_version *rp;
1572         struct sk_buff *skb;
1573
1574         BT_DBG("%s", hdev->name);
1575
1576         skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1577                              HCI_INIT_TIMEOUT);
1578         if (IS_ERR(skb)) {
1579                 int err = PTR_ERR(skb);
1580                 bt_dev_err(hdev, "CSR: Local version failed (%d)", err);
1581                 return err;
1582         }
1583
1584         if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1585                 bt_dev_err(hdev, "CSR: Local version length mismatch");
1586                 kfree_skb(skb);
1587                 return -EIO;
1588         }
1589
1590         rp = (struct hci_rp_read_local_version *)skb->data;
1591
1592         /* Detect controllers which aren't real CSR ones. */
1593         if (le16_to_cpu(rp->manufacturer) != 10 ||
1594             le16_to_cpu(rp->lmp_subver) == 0x0c5c) {
1595                 /* Clear the reset quirk since this is not an actual
1596                  * early Bluetooth 1.1 device from CSR.
1597                  */
1598                 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1599
1600                 /* These fake CSR controllers have all a broken
1601                  * stored link key handling and so just disable it.
1602                  */
1603                 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
1604         }
1605
1606         kfree_skb(skb);
1607
1608         return 0;
1609 }
1610
1611 static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1612                                                        struct intel_version *ver)
1613 {
1614         const struct firmware *fw;
1615         char fwname[64];
1616         int ret;
1617
1618         snprintf(fwname, sizeof(fwname),
1619                  "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1620                  ver->hw_platform, ver->hw_variant, ver->hw_revision,
1621                  ver->fw_variant,  ver->fw_revision, ver->fw_build_num,
1622                  ver->fw_build_ww, ver->fw_build_yy);
1623
1624         ret = request_firmware(&fw, fwname, &hdev->dev);
1625         if (ret < 0) {
1626                 if (ret == -EINVAL) {
1627                         bt_dev_err(hdev, "Intel firmware file request failed (%d)",
1628                                    ret);
1629                         return NULL;
1630                 }
1631
1632                 bt_dev_err(hdev, "failed to open Intel firmware file: %s (%d)",
1633                            fwname, ret);
1634
1635                 /* If the correct firmware patch file is not found, use the
1636                  * default firmware patch file instead
1637                  */
1638                 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1639                          ver->hw_platform, ver->hw_variant);
1640                 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1641                         bt_dev_err(hdev, "failed to open default fw file: %s",
1642                                    fwname);
1643                         return NULL;
1644                 }
1645         }
1646
1647         bt_dev_info(hdev, "Intel Bluetooth firmware file: %s", fwname);
1648
1649         return fw;
1650 }
1651
1652 static int btusb_setup_intel_patching(struct hci_dev *hdev,
1653                                       const struct firmware *fw,
1654                                       const u8 **fw_ptr, int *disable_patch)
1655 {
1656         struct sk_buff *skb;
1657         struct hci_command_hdr *cmd;
1658         const u8 *cmd_param;
1659         struct hci_event_hdr *evt = NULL;
1660         const u8 *evt_param = NULL;
1661         int remain = fw->size - (*fw_ptr - fw->data);
1662
1663         /* The first byte indicates the types of the patch command or event.
1664          * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1665          * in the current firmware buffer doesn't start with 0x01 or
1666          * the size of remain buffer is smaller than HCI command header,
1667          * the firmware file is corrupted and it should stop the patching
1668          * process.
1669          */
1670         if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1671                 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd read");
1672                 return -EINVAL;
1673         }
1674         (*fw_ptr)++;
1675         remain--;
1676
1677         cmd = (struct hci_command_hdr *)(*fw_ptr);
1678         *fw_ptr += sizeof(*cmd);
1679         remain -= sizeof(*cmd);
1680
1681         /* Ensure that the remain firmware data is long enough than the length
1682          * of command parameter. If not, the firmware file is corrupted.
1683          */
1684         if (remain < cmd->plen) {
1685                 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd len");
1686                 return -EFAULT;
1687         }
1688
1689         /* If there is a command that loads a patch in the firmware
1690          * file, then enable the patch upon success, otherwise just
1691          * disable the manufacturer mode, for example patch activation
1692          * is not required when the default firmware patch file is used
1693          * because there are no patch data to load.
1694          */
1695         if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
1696                 *disable_patch = 0;
1697
1698         cmd_param = *fw_ptr;
1699         *fw_ptr += cmd->plen;
1700         remain -= cmd->plen;
1701
1702         /* This reads the expected events when the above command is sent to the
1703          * device. Some vendor commands expects more than one events, for
1704          * example command status event followed by vendor specific event.
1705          * For this case, it only keeps the last expected event. so the command
1706          * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
1707          * last expected event.
1708          */
1709         while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
1710                 (*fw_ptr)++;
1711                 remain--;
1712
1713                 evt = (struct hci_event_hdr *)(*fw_ptr);
1714                 *fw_ptr += sizeof(*evt);
1715                 remain -= sizeof(*evt);
1716
1717                 if (remain < evt->plen) {
1718                         bt_dev_err(hdev, "Intel fw corrupted: invalid evt len");
1719                         return -EFAULT;
1720                 }
1721
1722                 evt_param = *fw_ptr;
1723                 *fw_ptr += evt->plen;
1724                 remain -= evt->plen;
1725         }
1726
1727         /* Every HCI commands in the firmware file has its correspond event.
1728          * If event is not found or remain is smaller than zero, the firmware
1729          * file is corrupted.
1730          */
1731         if (!evt || !evt_param || remain < 0) {
1732                 bt_dev_err(hdev, "Intel fw corrupted: invalid evt read");
1733                 return -EFAULT;
1734         }
1735
1736         skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
1737                                 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
1738         if (IS_ERR(skb)) {
1739                 bt_dev_err(hdev, "sending Intel patch command (0x%4.4x) failed (%ld)",
1740                            cmd->opcode, PTR_ERR(skb));
1741                 return PTR_ERR(skb);
1742         }
1743
1744         /* It ensures that the returned event matches the event data read from
1745          * the firmware file. At fist, it checks the length and then
1746          * the contents of the event.
1747          */
1748         if (skb->len != evt->plen) {
1749                 bt_dev_err(hdev, "mismatch event length (opcode 0x%4.4x)",
1750                            le16_to_cpu(cmd->opcode));
1751                 kfree_skb(skb);
1752                 return -EFAULT;
1753         }
1754
1755         if (memcmp(skb->data, evt_param, evt->plen)) {
1756                 bt_dev_err(hdev, "mismatch event parameter (opcode 0x%4.4x)",
1757                            le16_to_cpu(cmd->opcode));
1758                 kfree_skb(skb);
1759                 return -EFAULT;
1760         }
1761         kfree_skb(skb);
1762
1763         return 0;
1764 }
1765
1766 static int btusb_setup_intel(struct hci_dev *hdev)
1767 {
1768         struct sk_buff *skb;
1769         const struct firmware *fw;
1770         const u8 *fw_ptr;
1771         int disable_patch, err;
1772         struct intel_version ver;
1773
1774         BT_DBG("%s", hdev->name);
1775
1776         /* The controller has a bug with the first HCI command sent to it
1777          * returning number of completed commands as zero. This would stall the
1778          * command processing in the Bluetooth core.
1779          *
1780          * As a workaround, send HCI Reset command first which will reset the
1781          * number of completed commands and allow normal command processing
1782          * from now on.
1783          */
1784         skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
1785         if (IS_ERR(skb)) {
1786                 bt_dev_err(hdev, "sending initial HCI reset command failed (%ld)",
1787                            PTR_ERR(skb));
1788                 return PTR_ERR(skb);
1789         }
1790         kfree_skb(skb);
1791
1792         /* Read Intel specific controller version first to allow selection of
1793          * which firmware file to load.
1794          *
1795          * The returned information are hardware variant and revision plus
1796          * firmware variant, revision and build number.
1797          */
1798         err = btintel_read_version(hdev, &ver);
1799         if (err)
1800                 return err;
1801
1802         bt_dev_info(hdev, "read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
1803                     ver.hw_platform, ver.hw_variant, ver.hw_revision,
1804                     ver.fw_variant,  ver.fw_revision, ver.fw_build_num,
1805                     ver.fw_build_ww, ver.fw_build_yy, ver.fw_patch_num);
1806
1807         /* fw_patch_num indicates the version of patch the device currently
1808          * have. If there is no patch data in the device, it is always 0x00.
1809          * So, if it is other than 0x00, no need to patch the device again.
1810          */
1811         if (ver.fw_patch_num) {
1812                 bt_dev_info(hdev, "Intel device is already patched. "
1813                             "patch num: %02x", ver.fw_patch_num);
1814                 goto complete;
1815         }
1816
1817         /* Opens the firmware patch file based on the firmware version read
1818          * from the controller. If it fails to open the matching firmware
1819          * patch file, it tries to open the default firmware patch file.
1820          * If no patch file is found, allow the device to operate without
1821          * a patch.
1822          */
1823         fw = btusb_setup_intel_get_fw(hdev, &ver);
1824         if (!fw)
1825                 goto complete;
1826         fw_ptr = fw->data;
1827
1828         /* Enable the manufacturer mode of the controller.
1829          * Only while this mode is enabled, the driver can download the
1830          * firmware patch data and configuration parameters.
1831          */
1832         err = btintel_enter_mfg(hdev);
1833         if (err) {
1834                 release_firmware(fw);
1835                 return err;
1836         }
1837
1838         disable_patch = 1;
1839
1840         /* The firmware data file consists of list of Intel specific HCI
1841          * commands and its expected events. The first byte indicates the
1842          * type of the message, either HCI command or HCI event.
1843          *
1844          * It reads the command and its expected event from the firmware file,
1845          * and send to the controller. Once __hci_cmd_sync_ev() returns,
1846          * the returned event is compared with the event read from the firmware
1847          * file and it will continue until all the messages are downloaded to
1848          * the controller.
1849          *
1850          * Once the firmware patching is completed successfully,
1851          * the manufacturer mode is disabled with reset and activating the
1852          * downloaded patch.
1853          *
1854          * If the firmware patching fails, the manufacturer mode is
1855          * disabled with reset and deactivating the patch.
1856          *
1857          * If the default patch file is used, no reset is done when disabling
1858          * the manufacturer.
1859          */
1860         while (fw->size > fw_ptr - fw->data) {
1861                 int ret;
1862
1863                 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
1864                                                  &disable_patch);
1865                 if (ret < 0)
1866                         goto exit_mfg_deactivate;
1867         }
1868
1869         release_firmware(fw);
1870
1871         if (disable_patch)
1872                 goto exit_mfg_disable;
1873
1874         /* Patching completed successfully and disable the manufacturer mode
1875          * with reset and activate the downloaded firmware patches.
1876          */
1877         err = btintel_exit_mfg(hdev, true, true);
1878         if (err)
1879                 return err;
1880
1881         bt_dev_info(hdev, "Intel firmware patch completed and activated");
1882
1883         goto complete;
1884
1885 exit_mfg_disable:
1886         /* Disable the manufacturer mode without reset */
1887         err = btintel_exit_mfg(hdev, false, false);
1888         if (err)
1889                 return err;
1890
1891         bt_dev_info(hdev, "Intel firmware patch completed");
1892
1893         goto complete;
1894
1895 exit_mfg_deactivate:
1896         release_firmware(fw);
1897
1898         /* Patching failed. Disable the manufacturer mode with reset and
1899          * deactivate the downloaded firmware patches.
1900          */
1901         err = btintel_exit_mfg(hdev, true, false);
1902         if (err)
1903                 return err;
1904
1905         bt_dev_info(hdev, "Intel firmware patch completed and deactivated");
1906
1907 complete:
1908         /* Set the event mask for Intel specific vendor events. This enables
1909          * a few extra events that are useful during general operation.
1910          */
1911         btintel_set_event_mask_mfg(hdev, false);
1912
1913         btintel_check_bdaddr(hdev);
1914         return 0;
1915 }
1916
1917 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
1918 {
1919         struct sk_buff *skb;
1920         struct hci_event_hdr *hdr;
1921         struct hci_ev_cmd_complete *evt;
1922
1923         skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_KERNEL);
1924         if (!skb)
1925                 return -ENOMEM;
1926
1927         hdr = skb_put(skb, sizeof(*hdr));
1928         hdr->evt = HCI_EV_CMD_COMPLETE;
1929         hdr->plen = sizeof(*evt) + 1;
1930
1931         evt = skb_put(skb, sizeof(*evt));
1932         evt->ncmd = 0x01;
1933         evt->opcode = cpu_to_le16(opcode);
1934
1935         skb_put_u8(skb, 0x00);
1936
1937         hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
1938
1939         return hci_recv_frame(hdev, skb);
1940 }
1941
1942 static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
1943                                  int count)
1944 {
1945         /* When the device is in bootloader mode, then it can send
1946          * events via the bulk endpoint. These events are treated the
1947          * same way as the ones received from the interrupt endpoint.
1948          */
1949         if (test_bit(BTUSB_BOOTLOADER, &data->flags))
1950                 return btusb_recv_intr(data, buffer, count);
1951
1952         return btusb_recv_bulk(data, buffer, count);
1953 }
1954
1955 static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
1956                                unsigned int len)
1957 {
1958         const struct intel_bootup *evt = ptr;
1959
1960         if (len != sizeof(*evt))
1961                 return;
1962
1963         if (test_and_clear_bit(BTUSB_BOOTING, &data->flags))
1964                 wake_up_bit(&data->flags, BTUSB_BOOTING);
1965 }
1966
1967 static void btusb_intel_secure_send_result(struct btusb_data *data,
1968                                            const void *ptr, unsigned int len)
1969 {
1970         const struct intel_secure_send_result *evt = ptr;
1971
1972         if (len != sizeof(*evt))
1973                 return;
1974
1975         if (evt->result)
1976                 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
1977
1978         if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
1979             test_bit(BTUSB_FIRMWARE_LOADED, &data->flags))
1980                 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
1981 }
1982
1983 static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
1984 {
1985         struct btusb_data *data = hci_get_drvdata(hdev);
1986
1987         if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
1988                 struct hci_event_hdr *hdr = (void *)skb->data;
1989
1990                 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
1991                     hdr->plen > 0) {
1992                         const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
1993                         unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
1994
1995                         switch (skb->data[2]) {
1996                         case 0x02:
1997                                 /* When switching to the operational firmware
1998                                  * the device sends a vendor specific event
1999                                  * indicating that the bootup completed.
2000                                  */
2001                                 btusb_intel_bootup(data, ptr, len);
2002                                 break;
2003                         case 0x06:
2004                                 /* When the firmware loading completes the
2005                                  * device sends out a vendor specific event
2006                                  * indicating the result of the firmware
2007                                  * loading.
2008                                  */
2009                                 btusb_intel_secure_send_result(data, ptr, len);
2010                                 break;
2011                         }
2012                 }
2013         }
2014
2015         return hci_recv_frame(hdev, skb);
2016 }
2017
2018 static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
2019 {
2020         struct btusb_data *data = hci_get_drvdata(hdev);
2021         struct urb *urb;
2022
2023         BT_DBG("%s", hdev->name);
2024
2025         switch (hci_skb_pkt_type(skb)) {
2026         case HCI_COMMAND_PKT:
2027                 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2028                         struct hci_command_hdr *cmd = (void *)skb->data;
2029                         __u16 opcode = le16_to_cpu(cmd->opcode);
2030
2031                         /* When in bootloader mode and the command 0xfc09
2032                          * is received, it needs to be send down the
2033                          * bulk endpoint. So allocate a bulk URB instead.
2034                          */
2035                         if (opcode == 0xfc09)
2036                                 urb = alloc_bulk_urb(hdev, skb);
2037                         else
2038                                 urb = alloc_ctrl_urb(hdev, skb);
2039
2040                         /* When the 0xfc01 command is issued to boot into
2041                          * the operational firmware, it will actually not
2042                          * send a command complete event. To keep the flow
2043                          * control working inject that event here.
2044                          */
2045                         if (opcode == 0xfc01)
2046                                 inject_cmd_complete(hdev, opcode);
2047                 } else {
2048                         urb = alloc_ctrl_urb(hdev, skb);
2049                 }
2050                 if (IS_ERR(urb))
2051                         return PTR_ERR(urb);
2052
2053                 hdev->stat.cmd_tx++;
2054                 return submit_or_queue_tx_urb(hdev, urb);
2055
2056         case HCI_ACLDATA_PKT:
2057                 urb = alloc_bulk_urb(hdev, skb);
2058                 if (IS_ERR(urb))
2059                         return PTR_ERR(urb);
2060
2061                 hdev->stat.acl_tx++;
2062                 return submit_or_queue_tx_urb(hdev, urb);
2063
2064         case HCI_SCODATA_PKT:
2065                 if (hci_conn_num(hdev, SCO_LINK) < 1)
2066                         return -ENODEV;
2067
2068                 urb = alloc_isoc_urb(hdev, skb);
2069                 if (IS_ERR(urb))
2070                         return PTR_ERR(urb);
2071
2072                 hdev->stat.sco_tx++;
2073                 return submit_tx_urb(hdev, urb);
2074         }
2075
2076         return -EILSEQ;
2077 }
2078
2079 static bool btusb_setup_intel_new_get_fw_name(struct intel_version *ver,
2080                                              struct intel_boot_params *params,
2081                                              char *fw_name, size_t len,
2082                                              const char *suffix)
2083 {
2084         switch (ver->hw_variant) {
2085         case 0x0b:      /* SfP */
2086         case 0x0c:      /* WsP */
2087                 snprintf(fw_name, len, "intel/ibt-%u-%u.%s",
2088                         le16_to_cpu(ver->hw_variant),
2089                         le16_to_cpu(params->dev_revid),
2090                         suffix);
2091                 break;
2092         case 0x11:      /* JfP */
2093         case 0x12:      /* ThP */
2094         case 0x13:      /* HrP */
2095         case 0x14:      /* CcP */
2096                 snprintf(fw_name, len, "intel/ibt-%u-%u-%u.%s",
2097                         le16_to_cpu(ver->hw_variant),
2098                         le16_to_cpu(ver->hw_revision),
2099                         le16_to_cpu(ver->fw_revision),
2100                         suffix);
2101                 break;
2102         default:
2103                 return false;
2104         }
2105         return true;
2106 }
2107
2108 static int btusb_setup_intel_new(struct hci_dev *hdev)
2109 {
2110         struct btusb_data *data = hci_get_drvdata(hdev);
2111         struct intel_version ver;
2112         struct intel_boot_params params;
2113         const struct firmware *fw;
2114         u32 boot_param;
2115         char fwname[64];
2116         ktime_t calltime, delta, rettime;
2117         unsigned long long duration;
2118         int err;
2119
2120         BT_DBG("%s", hdev->name);
2121
2122         /* Set the default boot parameter to 0x0 and it is updated to
2123          * SKU specific boot parameter after reading Intel_Write_Boot_Params
2124          * command while downloading the firmware.
2125          */
2126         boot_param = 0x00000000;
2127
2128         calltime = ktime_get();
2129
2130         /* Read the Intel version information to determine if the device
2131          * is in bootloader mode or if it already has operational firmware
2132          * loaded.
2133          */
2134         err = btintel_read_version(hdev, &ver);
2135         if (err)
2136                 return err;
2137
2138         /* The hardware platform number has a fixed value of 0x37 and
2139          * for now only accept this single value.
2140          */
2141         if (ver.hw_platform != 0x37) {
2142                 bt_dev_err(hdev, "Unsupported Intel hardware platform (%u)",
2143                            ver.hw_platform);
2144                 return -EINVAL;
2145         }
2146
2147         /* Check for supported iBT hardware variants of this firmware
2148          * loading method.
2149          *
2150          * This check has been put in place to ensure correct forward
2151          * compatibility options when newer hardware variants come along.
2152          */
2153         switch (ver.hw_variant) {
2154         case 0x0b:      /* SfP */
2155         case 0x0c:      /* WsP */
2156         case 0x11:      /* JfP */
2157         case 0x12:      /* ThP */
2158         case 0x13:      /* HrP */
2159         case 0x14:      /* CcP */
2160                 break;
2161         default:
2162                 bt_dev_err(hdev, "Unsupported Intel hardware variant (%u)",
2163                            ver.hw_variant);
2164                 return -EINVAL;
2165         }
2166
2167         btintel_version_info(hdev, &ver);
2168
2169         /* The firmware variant determines if the device is in bootloader
2170          * mode or is running operational firmware. The value 0x06 identifies
2171          * the bootloader and the value 0x23 identifies the operational
2172          * firmware.
2173          *
2174          * When the operational firmware is already present, then only
2175          * the check for valid Bluetooth device address is needed. This
2176          * determines if the device will be added as configured or
2177          * unconfigured controller.
2178          *
2179          * It is not possible to use the Secure Boot Parameters in this
2180          * case since that command is only available in bootloader mode.
2181          */
2182         if (ver.fw_variant == 0x23) {
2183                 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2184                 btintel_check_bdaddr(hdev);
2185                 return 0;
2186         }
2187
2188         /* If the device is not in bootloader mode, then the only possible
2189          * choice is to return an error and abort the device initialization.
2190          */
2191         if (ver.fw_variant != 0x06) {
2192                 bt_dev_err(hdev, "Unsupported Intel firmware variant (%u)",
2193                            ver.fw_variant);
2194                 return -ENODEV;
2195         }
2196
2197         /* Read the secure boot parameters to identify the operating
2198          * details of the bootloader.
2199          */
2200         err = btintel_read_boot_params(hdev, &params);
2201         if (err)
2202                 return err;
2203
2204         /* It is required that every single firmware fragment is acknowledged
2205          * with a command complete event. If the boot parameters indicate
2206          * that this bootloader does not send them, then abort the setup.
2207          */
2208         if (params.limited_cce != 0x00) {
2209                 bt_dev_err(hdev, "Unsupported Intel firmware loading method (%u)",
2210                            params.limited_cce);
2211                 return -EINVAL;
2212         }
2213
2214         /* If the OTP has no valid Bluetooth device address, then there will
2215          * also be no valid address for the operational firmware.
2216          */
2217         if (!bacmp(&params.otp_bdaddr, BDADDR_ANY)) {
2218                 bt_dev_info(hdev, "No device address configured");
2219                 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2220         }
2221
2222         /* With this Intel bootloader only the hardware variant and device
2223          * revision information are used to select the right firmware for SfP
2224          * and WsP.
2225          *
2226          * The firmware filename is ibt-<hw_variant>-<dev_revid>.sfi.
2227          *
2228          * Currently the supported hardware variants are:
2229          *   11 (0x0b) for iBT3.0 (LnP/SfP)
2230          *   12 (0x0c) for iBT3.5 (WsP)
2231          *
2232          * For ThP/JfP and for future SKU's, the FW name varies based on HW
2233          * variant, HW revision and FW revision, as these are dependent on CNVi
2234          * and RF Combination.
2235          *
2236          *   17 (0x11) for iBT3.5 (JfP)
2237          *   18 (0x12) for iBT3.5 (ThP)
2238          *
2239          * The firmware file name for these will be
2240          * ibt-<hw_variant>-<hw_revision>-<fw_revision>.sfi.
2241          *
2242          */
2243         err = btusb_setup_intel_new_get_fw_name(&ver, &params, fwname,
2244                                                 sizeof(fwname), "sfi");
2245         if (!err) {
2246                 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2247                 return -EINVAL;
2248         }
2249
2250         err = request_firmware(&fw, fwname, &hdev->dev);
2251         if (err < 0) {
2252                 bt_dev_err(hdev, "Failed to load Intel firmware file (%d)", err);
2253                 return err;
2254         }
2255
2256         bt_dev_info(hdev, "Found device firmware: %s", fwname);
2257
2258         /* Save the DDC file name for later use to apply once the firmware
2259          * downloading is done.
2260          */
2261         err = btusb_setup_intel_new_get_fw_name(&ver, &params, fwname,
2262                                                 sizeof(fwname), "ddc");
2263         if (!err) {
2264                 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2265                 return -EINVAL;
2266         }
2267
2268         if (fw->size < 644) {
2269                 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
2270                            fw->size);
2271                 err = -EBADF;
2272                 goto done;
2273         }
2274
2275         set_bit(BTUSB_DOWNLOADING, &data->flags);
2276
2277         /* Start firmware downloading and get boot parameter */
2278         err = btintel_download_firmware(hdev, fw, &boot_param);
2279         if (err < 0)
2280                 goto done;
2281
2282         set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2283
2284         bt_dev_info(hdev, "Waiting for firmware download to complete");
2285
2286         /* Before switching the device into operational mode and with that
2287          * booting the loaded firmware, wait for the bootloader notification
2288          * that all fragments have been successfully received.
2289          *
2290          * When the event processing receives the notification, then the
2291          * BTUSB_DOWNLOADING flag will be cleared.
2292          *
2293          * The firmware loading should not take longer than 5 seconds
2294          * and thus just timeout if that happens and fail the setup
2295          * of this device.
2296          */
2297         err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2298                                   TASK_INTERRUPTIBLE,
2299                                   msecs_to_jiffies(5000));
2300         if (err == -EINTR) {
2301                 bt_dev_err(hdev, "Firmware loading interrupted");
2302                 goto done;
2303         }
2304
2305         if (err) {
2306                 bt_dev_err(hdev, "Firmware loading timeout");
2307                 err = -ETIMEDOUT;
2308                 goto done;
2309         }
2310
2311         if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2312                 bt_dev_err(hdev, "Firmware loading failed");
2313                 err = -ENOEXEC;
2314                 goto done;
2315         }
2316
2317         rettime = ktime_get();
2318         delta = ktime_sub(rettime, calltime);
2319         duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2320
2321         bt_dev_info(hdev, "Firmware loaded in %llu usecs", duration);
2322
2323 done:
2324         release_firmware(fw);
2325
2326         if (err < 0)
2327                 return err;
2328
2329         calltime = ktime_get();
2330
2331         set_bit(BTUSB_BOOTING, &data->flags);
2332
2333         err = btintel_send_intel_reset(hdev, boot_param);
2334         if (err)
2335                 return err;
2336
2337         /* The bootloader will not indicate when the device is ready. This
2338          * is done by the operational firmware sending bootup notification.
2339          *
2340          * Booting into operational firmware should not take longer than
2341          * 1 second. However if that happens, then just fail the setup
2342          * since something went wrong.
2343          */
2344         bt_dev_info(hdev, "Waiting for device to boot");
2345
2346         err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2347                                   TASK_INTERRUPTIBLE,
2348                                   msecs_to_jiffies(1000));
2349
2350         if (err == -EINTR) {
2351                 bt_dev_err(hdev, "Device boot interrupted");
2352                 return -EINTR;
2353         }
2354
2355         if (err) {
2356                 bt_dev_err(hdev, "Device boot timeout");
2357                 return -ETIMEDOUT;
2358         }
2359
2360         rettime = ktime_get();
2361         delta = ktime_sub(rettime, calltime);
2362         duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2363
2364         bt_dev_info(hdev, "Device booted in %llu usecs", duration);
2365
2366         clear_bit(BTUSB_BOOTLOADER, &data->flags);
2367
2368         /* Once the device is running in operational mode, it needs to apply
2369          * the device configuration (DDC) parameters.
2370          *
2371          * The device can work without DDC parameters, so even if it fails
2372          * to load the file, no need to fail the setup.
2373          */
2374         btintel_load_ddc_config(hdev, fwname);
2375
2376         /* Set the event mask for Intel specific vendor events. This enables
2377          * a few extra events that are useful during general operation. It
2378          * does not enable any debugging related events.
2379          *
2380          * The device will function correctly without these events enabled
2381          * and thus no need to fail the setup.
2382          */
2383         btintel_set_event_mask(hdev, false);
2384
2385         return 0;
2386 }
2387
2388 static int btusb_shutdown_intel(struct hci_dev *hdev)
2389 {
2390         struct sk_buff *skb;
2391         long ret;
2392
2393         /* In the shutdown sequence where Bluetooth is turned off followed
2394          * by WiFi being turned off, turning WiFi back on causes issue with
2395          * the RF calibration.
2396          *
2397          * To ensure that any RF activity has been stopped, issue HCI Reset
2398          * command to clear all ongoing activity including advertising,
2399          * scanning etc.
2400          */
2401         skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2402         if (IS_ERR(skb)) {
2403                 ret = PTR_ERR(skb);
2404                 bt_dev_err(hdev, "HCI reset during shutdown failed");
2405                 return ret;
2406         }
2407         kfree_skb(skb);
2408
2409         /* Some platforms have an issue with BT LED when the interface is
2410          * down or BT radio is turned off, which takes 5 seconds to BT LED
2411          * goes off. This command turns off the BT LED immediately.
2412          */
2413         skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
2414         if (IS_ERR(skb)) {
2415                 ret = PTR_ERR(skb);
2416                 bt_dev_err(hdev, "turning off Intel device LED failed");
2417                 return ret;
2418         }
2419         kfree_skb(skb);
2420
2421         return 0;
2422 }
2423
2424 static int btusb_shutdown_intel_new(struct hci_dev *hdev)
2425 {
2426         struct sk_buff *skb;
2427
2428         /* Send HCI Reset to the controller to stop any BT activity which
2429          * were triggered. This will help to save power and maintain the
2430          * sync b/w Host and controller
2431          */
2432         skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2433         if (IS_ERR(skb)) {
2434                 bt_dev_err(hdev, "HCI reset during shutdown failed");
2435                 return PTR_ERR(skb);
2436         }
2437         kfree_skb(skb);
2438
2439         return 0;
2440 }
2441
2442 #ifdef CONFIG_PM
2443 /* Configure an out-of-band gpio as wake-up pin, if specified in device tree */
2444 static int marvell_config_oob_wake(struct hci_dev *hdev)
2445 {
2446         struct sk_buff *skb;
2447         struct btusb_data *data = hci_get_drvdata(hdev);
2448         struct device *dev = &data->udev->dev;
2449         u16 pin, gap, opcode;
2450         int ret;
2451         u8 cmd[5];
2452
2453         /* Move on if no wakeup pin specified */
2454         if (of_property_read_u16(dev->of_node, "marvell,wakeup-pin", &pin) ||
2455             of_property_read_u16(dev->of_node, "marvell,wakeup-gap-ms", &gap))
2456                 return 0;
2457
2458         /* Vendor specific command to configure a GPIO as wake-up pin */
2459         opcode = hci_opcode_pack(0x3F, 0x59);
2460         cmd[0] = opcode & 0xFF;
2461         cmd[1] = opcode >> 8;
2462         cmd[2] = 2; /* length of parameters that follow */
2463         cmd[3] = pin;
2464         cmd[4] = gap; /* time in ms, for which wakeup pin should be asserted */
2465
2466         skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
2467         if (!skb) {
2468                 bt_dev_err(hdev, "%s: No memory\n", __func__);
2469                 return -ENOMEM;
2470         }
2471
2472         skb_put_data(skb, cmd, sizeof(cmd));
2473         hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
2474
2475         ret = btusb_send_frame(hdev, skb);
2476         if (ret) {
2477                 bt_dev_err(hdev, "%s: configuration failed\n", __func__);
2478                 kfree_skb(skb);
2479                 return ret;
2480         }
2481
2482         return 0;
2483 }
2484 #endif
2485
2486 static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
2487                                     const bdaddr_t *bdaddr)
2488 {
2489         struct sk_buff *skb;
2490         u8 buf[8];
2491         long ret;
2492
2493         buf[0] = 0xfe;
2494         buf[1] = sizeof(bdaddr_t);
2495         memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
2496
2497         skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
2498         if (IS_ERR(skb)) {
2499                 ret = PTR_ERR(skb);
2500                 bt_dev_err(hdev, "changing Marvell device address failed (%ld)",
2501                            ret);
2502                 return ret;
2503         }
2504         kfree_skb(skb);
2505
2506         return 0;
2507 }
2508
2509 static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
2510                                     const bdaddr_t *bdaddr)
2511 {
2512         struct sk_buff *skb;
2513         u8 buf[10];
2514         long ret;
2515
2516         buf[0] = 0x01;
2517         buf[1] = 0x01;
2518         buf[2] = 0x00;
2519         buf[3] = sizeof(bdaddr_t);
2520         memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
2521
2522         skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
2523         if (IS_ERR(skb)) {
2524                 ret = PTR_ERR(skb);
2525                 bt_dev_err(hdev, "Change address command failed (%ld)", ret);
2526                 return ret;
2527         }
2528         kfree_skb(skb);
2529
2530         return 0;
2531 }
2532
2533 #define QCA_DFU_PACKET_LEN      4096
2534
2535 #define QCA_GET_TARGET_VERSION  0x09
2536 #define QCA_CHECK_STATUS        0x05
2537 #define QCA_DFU_DOWNLOAD        0x01
2538
2539 #define QCA_SYSCFG_UPDATED      0x40
2540 #define QCA_PATCH_UPDATED       0x80
2541 #define QCA_DFU_TIMEOUT         3000
2542
2543 struct qca_version {
2544         __le32  rom_version;
2545         __le32  patch_version;
2546         __le32  ram_version;
2547         __le32  ref_clock;
2548         __u8    reserved[4];
2549 } __packed;
2550
2551 struct qca_rampatch_version {
2552         __le16  rom_version;
2553         __le16  patch_version;
2554 } __packed;
2555
2556 struct qca_device_info {
2557         u32     rom_version;
2558         u8      rampatch_hdr;   /* length of header in rampatch */
2559         u8      nvm_hdr;        /* length of header in NVM */
2560         u8      ver_offset;     /* offset of version structure in rampatch */
2561 };
2562
2563 static const struct qca_device_info qca_devices_table[] = {
2564         { 0x00000100, 20, 4, 10 }, /* Rome 1.0 */
2565         { 0x00000101, 20, 4, 10 }, /* Rome 1.1 */
2566         { 0x00000200, 28, 4, 18 }, /* Rome 2.0 */
2567         { 0x00000201, 28, 4, 18 }, /* Rome 2.1 */
2568         { 0x00000300, 28, 4, 18 }, /* Rome 3.0 */
2569         { 0x00000302, 28, 4, 18 }, /* Rome 3.2 */
2570 };
2571
2572 static int btusb_qca_send_vendor_req(struct usb_device *udev, u8 request,
2573                                      void *data, u16 size)
2574 {
2575         int pipe, err;
2576         u8 *buf;
2577
2578         buf = kmalloc(size, GFP_KERNEL);
2579         if (!buf)
2580                 return -ENOMEM;
2581
2582         /* Found some of USB hosts have IOT issues with ours so that we should
2583          * not wait until HCI layer is ready.
2584          */
2585         pipe = usb_rcvctrlpipe(udev, 0);
2586         err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
2587                               0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
2588         if (err < 0) {
2589                 dev_err(&udev->dev, "Failed to access otp area (%d)", err);
2590                 goto done;
2591         }
2592
2593         memcpy(data, buf, size);
2594
2595 done:
2596         kfree(buf);
2597
2598         return err;
2599 }
2600
2601 static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
2602                                        const struct firmware *firmware,
2603                                        size_t hdr_size)
2604 {
2605         struct btusb_data *btdata = hci_get_drvdata(hdev);
2606         struct usb_device *udev = btdata->udev;
2607         size_t count, size, sent = 0;
2608         int pipe, len, err;
2609         u8 *buf;
2610
2611         buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
2612         if (!buf)
2613                 return -ENOMEM;
2614
2615         count = firmware->size;
2616
2617         size = min_t(size_t, count, hdr_size);
2618         memcpy(buf, firmware->data, size);
2619
2620         /* USB patches should go down to controller through USB path
2621          * because binary format fits to go down through USB channel.
2622          * USB control path is for patching headers and USB bulk is for
2623          * patch body.
2624          */
2625         pipe = usb_sndctrlpipe(udev, 0);
2626         err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
2627                               0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
2628         if (err < 0) {
2629                 bt_dev_err(hdev, "Failed to send headers (%d)", err);
2630                 goto done;
2631         }
2632
2633         sent += size;
2634         count -= size;
2635
2636         while (count) {
2637                 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
2638
2639                 memcpy(buf, firmware->data + sent, size);
2640
2641                 pipe = usb_sndbulkpipe(udev, 0x02);
2642                 err = usb_bulk_msg(udev, pipe, buf, size, &len,
2643                                    QCA_DFU_TIMEOUT);
2644                 if (err < 0) {
2645                         bt_dev_err(hdev, "Failed to send body at %zd of %zd (%d)",
2646                                    sent, firmware->size, err);
2647                         break;
2648                 }
2649
2650                 if (size != len) {
2651                         bt_dev_err(hdev, "Failed to get bulk buffer");
2652                         err = -EILSEQ;
2653                         break;
2654                 }
2655
2656                 sent  += size;
2657                 count -= size;
2658         }
2659
2660 done:
2661         kfree(buf);
2662         return err;
2663 }
2664
2665 static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
2666                                          struct qca_version *ver,
2667                                          const struct qca_device_info *info)
2668 {
2669         struct qca_rampatch_version *rver;
2670         const struct firmware *fw;
2671         u32 ver_rom, ver_patch;
2672         u16 rver_rom, rver_patch;
2673         char fwname[64];
2674         int err;
2675
2676         ver_rom = le32_to_cpu(ver->rom_version);
2677         ver_patch = le32_to_cpu(ver->patch_version);
2678
2679         snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
2680
2681         err = request_firmware(&fw, fwname, &hdev->dev);
2682         if (err) {
2683                 bt_dev_err(hdev, "failed to request rampatch file: %s (%d)",
2684                            fwname, err);
2685                 return err;
2686         }
2687
2688         bt_dev_info(hdev, "using rampatch file: %s", fwname);
2689
2690         rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
2691         rver_rom = le16_to_cpu(rver->rom_version);
2692         rver_patch = le16_to_cpu(rver->patch_version);
2693
2694         bt_dev_info(hdev, "QCA: patch rome 0x%x build 0x%x, "
2695                     "firmware rome 0x%x build 0x%x",
2696                     rver_rom, rver_patch, ver_rom, ver_patch);
2697
2698         if (rver_rom != ver_rom || rver_patch <= ver_patch) {
2699                 bt_dev_err(hdev, "rampatch file version did not match with firmware");
2700                 err = -EINVAL;
2701                 goto done;
2702         }
2703
2704         err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
2705
2706 done:
2707         release_firmware(fw);
2708
2709         return err;
2710 }
2711
2712 static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
2713                                     struct qca_version *ver,
2714                                     const struct qca_device_info *info)
2715 {
2716         const struct firmware *fw;
2717         char fwname[64];
2718         int err;
2719
2720         snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
2721                  le32_to_cpu(ver->rom_version));
2722
2723         err = request_firmware(&fw, fwname, &hdev->dev);
2724         if (err) {
2725                 bt_dev_err(hdev, "failed to request NVM file: %s (%d)",
2726                            fwname, err);
2727                 return err;
2728         }
2729
2730         bt_dev_info(hdev, "using NVM file: %s", fwname);
2731
2732         err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
2733
2734         release_firmware(fw);
2735
2736         return err;
2737 }
2738
2739 /* identify the ROM version and check whether patches are needed */
2740 static bool btusb_qca_need_patch(struct usb_device *udev)
2741 {
2742         struct qca_version ver;
2743
2744         if (btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
2745                                       sizeof(ver)) < 0)
2746                 return false;
2747         /* only low ROM versions need patches */
2748         return !(le32_to_cpu(ver.rom_version) & ~0xffffU);
2749 }
2750
2751 static int btusb_setup_qca(struct hci_dev *hdev)
2752 {
2753         struct btusb_data *btdata = hci_get_drvdata(hdev);
2754         struct usb_device *udev = btdata->udev;
2755         const struct qca_device_info *info = NULL;
2756         struct qca_version ver;
2757         u32 ver_rom;
2758         u8 status;
2759         int i, err;
2760
2761         err = btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
2762                                         sizeof(ver));
2763         if (err < 0)
2764                 return err;
2765
2766         ver_rom = le32_to_cpu(ver.rom_version);
2767         /* Don't care about high ROM versions */
2768         if (ver_rom & ~0xffffU)
2769                 return 0;
2770
2771         for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
2772                 if (ver_rom == qca_devices_table[i].rom_version)
2773                         info = &qca_devices_table[i];
2774         }
2775         if (!info) {
2776                 bt_dev_err(hdev, "don't support firmware rome 0x%x", ver_rom);
2777                 return -ENODEV;
2778         }
2779
2780         err = btusb_qca_send_vendor_req(udev, QCA_CHECK_STATUS, &status,
2781                                         sizeof(status));
2782         if (err < 0)
2783                 return err;
2784
2785         if (!(status & QCA_PATCH_UPDATED)) {
2786                 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
2787                 if (err < 0)
2788                         return err;
2789         }
2790
2791         if (!(status & QCA_SYSCFG_UPDATED)) {
2792                 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
2793                 if (err < 0)
2794                         return err;
2795         }
2796
2797         return 0;
2798 }
2799
2800 #ifdef CONFIG_BT_HCIBTUSB_BCM
2801 static inline int __set_diag_interface(struct hci_dev *hdev)
2802 {
2803         struct btusb_data *data = hci_get_drvdata(hdev);
2804         struct usb_interface *intf = data->diag;
2805         int i;
2806
2807         if (!data->diag)
2808                 return -ENODEV;
2809
2810         data->diag_tx_ep = NULL;
2811         data->diag_rx_ep = NULL;
2812
2813         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
2814                 struct usb_endpoint_descriptor *ep_desc;
2815
2816                 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
2817
2818                 if (!data->diag_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
2819                         data->diag_tx_ep = ep_desc;
2820                         continue;
2821                 }
2822
2823                 if (!data->diag_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
2824                         data->diag_rx_ep = ep_desc;
2825                         continue;
2826                 }
2827         }
2828
2829         if (!data->diag_tx_ep || !data->diag_rx_ep) {
2830                 bt_dev_err(hdev, "invalid diagnostic descriptors");
2831                 return -ENODEV;
2832         }
2833
2834         return 0;
2835 }
2836
2837 static struct urb *alloc_diag_urb(struct hci_dev *hdev, bool enable)
2838 {
2839         struct btusb_data *data = hci_get_drvdata(hdev);
2840         struct sk_buff *skb;
2841         struct urb *urb;
2842         unsigned int pipe;
2843
2844         if (!data->diag_tx_ep)
2845                 return ERR_PTR(-ENODEV);
2846
2847         urb = usb_alloc_urb(0, GFP_KERNEL);
2848         if (!urb)
2849                 return ERR_PTR(-ENOMEM);
2850
2851         skb = bt_skb_alloc(2, GFP_KERNEL);
2852         if (!skb) {
2853                 usb_free_urb(urb);
2854                 return ERR_PTR(-ENOMEM);
2855         }
2856
2857         skb_put_u8(skb, 0xf0);
2858         skb_put_u8(skb, enable);
2859
2860         pipe = usb_sndbulkpipe(data->udev, data->diag_tx_ep->bEndpointAddress);
2861
2862         usb_fill_bulk_urb(urb, data->udev, pipe,
2863                           skb->data, skb->len, btusb_tx_complete, skb);
2864
2865         skb->dev = (void *)hdev;
2866
2867         return urb;
2868 }
2869
2870 static int btusb_bcm_set_diag(struct hci_dev *hdev, bool enable)
2871 {
2872         struct btusb_data *data = hci_get_drvdata(hdev);
2873         struct urb *urb;
2874
2875         if (!data->diag)
2876                 return -ENODEV;
2877
2878         if (!test_bit(HCI_RUNNING, &hdev->flags))
2879                 return -ENETDOWN;
2880
2881         urb = alloc_diag_urb(hdev, enable);
2882         if (IS_ERR(urb))
2883                 return PTR_ERR(urb);
2884
2885         return submit_or_queue_tx_urb(hdev, urb);
2886 }
2887 #endif
2888
2889 #ifdef CONFIG_PM
2890 static irqreturn_t btusb_oob_wake_handler(int irq, void *priv)
2891 {
2892         struct btusb_data *data = priv;
2893
2894         pm_wakeup_event(&data->udev->dev, 0);
2895         pm_system_wakeup();
2896
2897         /* Disable only if not already disabled (keep it balanced) */
2898         if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
2899                 disable_irq_nosync(irq);
2900                 disable_irq_wake(irq);
2901         }
2902         return IRQ_HANDLED;
2903 }
2904
2905 static const struct of_device_id btusb_match_table[] = {
2906         { .compatible = "usb1286,204e" },
2907         { .compatible = "usbcf3,e300" }, /* QCA6174A */
2908         { .compatible = "usb4ca,301a" }, /* QCA6174A (Lite-On) */
2909         { }
2910 };
2911 MODULE_DEVICE_TABLE(of, btusb_match_table);
2912
2913 /* Use an oob wakeup pin? */
2914 static int btusb_config_oob_wake(struct hci_dev *hdev)
2915 {
2916         struct btusb_data *data = hci_get_drvdata(hdev);
2917         struct device *dev = &data->udev->dev;
2918         int irq, ret;
2919
2920         clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
2921
2922         if (!of_match_device(btusb_match_table, dev))
2923                 return 0;
2924
2925         /* Move on if no IRQ specified */
2926         irq = of_irq_get_byname(dev->of_node, "wakeup");
2927         if (irq <= 0) {
2928                 bt_dev_dbg(hdev, "%s: no OOB Wakeup IRQ in DT", __func__);
2929                 return 0;
2930         }
2931
2932         irq_set_status_flags(irq, IRQ_NOAUTOEN);
2933         ret = devm_request_irq(&hdev->dev, irq, btusb_oob_wake_handler,
2934                                0, "OOB Wake-on-BT", data);
2935         if (ret) {
2936                 bt_dev_err(hdev, "%s: IRQ request failed", __func__);
2937                 return ret;
2938         }
2939
2940         ret = device_init_wakeup(dev, true);
2941         if (ret) {
2942                 bt_dev_err(hdev, "%s: failed to init_wakeup", __func__);
2943                 return ret;
2944         }
2945
2946         data->oob_wake_irq = irq;
2947         bt_dev_info(hdev, "OOB Wake-on-BT configured at IRQ %u", irq);
2948         return 0;
2949 }
2950 #endif
2951
2952 static void btusb_check_needs_reset_resume(struct usb_interface *intf)
2953 {
2954         if (dmi_check_system(btusb_needs_reset_resume_table))
2955                 interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
2956 }
2957
2958 static int btusb_probe(struct usb_interface *intf,
2959                        const struct usb_device_id *id)
2960 {
2961         struct usb_endpoint_descriptor *ep_desc;
2962         struct gpio_desc *reset_gpio;
2963         struct btusb_data *data;
2964         struct hci_dev *hdev;
2965         unsigned ifnum_base;
2966         int i, err;
2967
2968         BT_DBG("intf %p id %p", intf, id);
2969
2970         /* interface numbers are hardcoded in the spec */
2971         if (intf->cur_altsetting->desc.bInterfaceNumber != 0) {
2972                 if (!(id->driver_info & BTUSB_IFNUM_2))
2973                         return -ENODEV;
2974                 if (intf->cur_altsetting->desc.bInterfaceNumber != 2)
2975                         return -ENODEV;
2976         }
2977
2978         ifnum_base = intf->cur_altsetting->desc.bInterfaceNumber;
2979
2980         if (!id->driver_info) {
2981                 const struct usb_device_id *match;
2982
2983                 match = usb_match_id(intf, blacklist_table);
2984                 if (match)
2985                         id = match;
2986         }
2987
2988         if (id->driver_info == BTUSB_IGNORE)
2989                 return -ENODEV;
2990
2991         if (id->driver_info & BTUSB_ATH3012) {
2992                 struct usb_device *udev = interface_to_usbdev(intf);
2993
2994                 /* Old firmware would otherwise let ath3k driver load
2995                  * patch and sysconfig files
2996                  */
2997                 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001 &&
2998                     !btusb_qca_need_patch(udev))
2999                         return -ENODEV;
3000         }
3001
3002         data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
3003         if (!data)
3004                 return -ENOMEM;
3005
3006         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3007                 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3008
3009                 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
3010                         data->intr_ep = ep_desc;
3011                         continue;
3012                 }
3013
3014                 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3015                         data->bulk_tx_ep = ep_desc;
3016                         continue;
3017                 }
3018
3019                 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3020                         data->bulk_rx_ep = ep_desc;
3021                         continue;
3022                 }
3023         }
3024
3025         if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
3026                 return -ENODEV;
3027
3028         if (id->driver_info & BTUSB_AMP) {
3029                 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
3030                 data->cmdreq = 0x2b;
3031         } else {
3032                 data->cmdreq_type = USB_TYPE_CLASS;
3033                 data->cmdreq = 0x00;
3034         }
3035
3036         data->udev = interface_to_usbdev(intf);
3037         data->intf = intf;
3038
3039         INIT_WORK(&data->work, btusb_work);
3040         INIT_WORK(&data->waker, btusb_waker);
3041         init_usb_anchor(&data->deferred);
3042         init_usb_anchor(&data->tx_anchor);
3043         spin_lock_init(&data->txlock);
3044
3045         init_usb_anchor(&data->intr_anchor);
3046         init_usb_anchor(&data->bulk_anchor);
3047         init_usb_anchor(&data->isoc_anchor);
3048         init_usb_anchor(&data->diag_anchor);
3049         spin_lock_init(&data->rxlock);
3050
3051         if (id->driver_info & BTUSB_INTEL_NEW) {
3052                 data->recv_event = btusb_recv_event_intel;
3053                 data->recv_bulk = btusb_recv_bulk_intel;
3054                 set_bit(BTUSB_BOOTLOADER, &data->flags);
3055         } else {
3056                 data->recv_event = hci_recv_frame;
3057                 data->recv_bulk = btusb_recv_bulk;
3058         }
3059
3060         hdev = hci_alloc_dev();
3061         if (!hdev)
3062                 return -ENOMEM;
3063
3064         hdev->bus = HCI_USB;
3065         hci_set_drvdata(hdev, data);
3066
3067         if (id->driver_info & BTUSB_AMP)
3068                 hdev->dev_type = HCI_AMP;
3069         else
3070                 hdev->dev_type = HCI_PRIMARY;
3071
3072         data->hdev = hdev;
3073
3074         SET_HCIDEV_DEV(hdev, &intf->dev);
3075
3076         reset_gpio = gpiod_get_optional(&data->udev->dev, "reset",
3077                                         GPIOD_OUT_LOW);
3078         if (IS_ERR(reset_gpio)) {
3079                 err = PTR_ERR(reset_gpio);
3080                 goto out_free_dev;
3081         } else if (reset_gpio) {
3082                 data->reset_gpio = reset_gpio;
3083         }
3084
3085         hdev->open   = btusb_open;
3086         hdev->close  = btusb_close;
3087         hdev->flush  = btusb_flush;
3088         hdev->send   = btusb_send_frame;
3089         hdev->notify = btusb_notify;
3090
3091 #ifdef CONFIG_PM
3092         err = btusb_config_oob_wake(hdev);
3093         if (err)
3094                 goto out_free_dev;
3095
3096         /* Marvell devices may need a specific chip configuration */
3097         if (id->driver_info & BTUSB_MARVELL && data->oob_wake_irq) {
3098                 err = marvell_config_oob_wake(hdev);
3099                 if (err)
3100                         goto out_free_dev;
3101         }
3102 #endif
3103         if (id->driver_info & BTUSB_CW6622)
3104                 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3105
3106         if (id->driver_info & BTUSB_BCM2045)
3107                 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3108
3109         if (id->driver_info & BTUSB_BCM92035)
3110                 hdev->setup = btusb_setup_bcm92035;
3111
3112 #ifdef CONFIG_BT_HCIBTUSB_BCM
3113         if (id->driver_info & BTUSB_BCM_PATCHRAM) {
3114                 hdev->manufacturer = 15;
3115                 hdev->setup = btbcm_setup_patchram;
3116                 hdev->set_diag = btusb_bcm_set_diag;
3117                 hdev->set_bdaddr = btbcm_set_bdaddr;
3118
3119                 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3120                 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3121         }
3122
3123         if (id->driver_info & BTUSB_BCM_APPLE) {
3124                 hdev->manufacturer = 15;
3125                 hdev->setup = btbcm_setup_apple;
3126                 hdev->set_diag = btusb_bcm_set_diag;
3127
3128                 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3129                 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3130         }
3131 #endif
3132
3133         if (id->driver_info & BTUSB_INTEL) {
3134                 hdev->manufacturer = 2;
3135                 hdev->setup = btusb_setup_intel;
3136                 hdev->shutdown = btusb_shutdown_intel;
3137                 hdev->set_diag = btintel_set_diag_mfg;
3138                 hdev->set_bdaddr = btintel_set_bdaddr;
3139                 hdev->cmd_timeout = btusb_intel_cmd_timeout;
3140                 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3141                 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3142                 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
3143         }
3144
3145         if (id->driver_info & BTUSB_INTEL_NEW) {
3146                 hdev->manufacturer = 2;
3147                 hdev->send = btusb_send_frame_intel;
3148                 hdev->setup = btusb_setup_intel_new;
3149                 hdev->shutdown = btusb_shutdown_intel_new;
3150                 hdev->hw_error = btintel_hw_error;
3151                 hdev->set_diag = btintel_set_diag;
3152                 hdev->set_bdaddr = btintel_set_bdaddr;
3153                 hdev->cmd_timeout = btusb_intel_cmd_timeout;
3154                 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3155                 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3156                 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
3157         }
3158
3159         if (id->driver_info & BTUSB_MARVELL)
3160                 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
3161
3162         if (id->driver_info & BTUSB_SWAVE) {
3163                 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
3164                 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
3165         }
3166
3167         if (id->driver_info & BTUSB_INTEL_BOOT) {
3168                 hdev->manufacturer = 2;
3169                 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
3170         }
3171
3172         if (id->driver_info & BTUSB_ATH3012) {
3173                 data->setup_on_usb = btusb_setup_qca;
3174                 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
3175                 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3176                 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3177         }
3178
3179         if (id->driver_info & BTUSB_QCA_ROME) {
3180                 data->setup_on_usb = btusb_setup_qca;
3181                 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
3182                 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3183                 btusb_check_needs_reset_resume(intf);
3184         }
3185
3186 #ifdef CONFIG_BT_HCIBTUSB_RTL
3187         if (id->driver_info & BTUSB_REALTEK) {
3188                 hdev->setup = btrtl_setup_realtek;
3189                 hdev->shutdown = btrtl_shutdown_realtek;
3190
3191                 /* Realtek devices lose their updated firmware over suspend,
3192                  * but the USB hub doesn't notice any status change.
3193                  * Explicitly request a device reset on resume.
3194                  */
3195                 interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
3196         }
3197 #endif
3198
3199         if (id->driver_info & BTUSB_AMP) {
3200                 /* AMP controllers do not support SCO packets */
3201                 data->isoc = NULL;
3202         } else {
3203                 /* Interface orders are hardcoded in the specification */
3204                 data->isoc = usb_ifnum_to_if(data->udev, ifnum_base + 1);
3205                 data->isoc_ifnum = ifnum_base + 1;
3206         }
3207
3208         if (!reset)
3209                 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3210
3211         if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
3212                 if (!disable_scofix)
3213                         set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
3214         }
3215
3216         if (id->driver_info & BTUSB_BROKEN_ISOC)
3217                 data->isoc = NULL;
3218
3219         if (id->driver_info & BTUSB_DIGIANSWER) {
3220                 data->cmdreq_type = USB_TYPE_VENDOR;
3221                 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3222         }
3223
3224         if (id->driver_info & BTUSB_CSR) {
3225                 struct usb_device *udev = data->udev;
3226                 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
3227
3228                 /* Old firmware would otherwise execute USB reset */
3229                 if (bcdDevice < 0x117)
3230                         set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3231
3232                 /* Fake CSR devices with broken commands */
3233                 if (bcdDevice <= 0x100 || bcdDevice == 0x134)
3234                         hdev->setup = btusb_setup_csr;
3235
3236                 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3237         }
3238
3239         if (id->driver_info & BTUSB_SNIFFER) {
3240                 struct usb_device *udev = data->udev;
3241
3242                 /* New sniffer firmware has crippled HCI interface */
3243                 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
3244                         set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
3245         }
3246
3247         if (id->driver_info & BTUSB_INTEL_BOOT) {
3248                 /* A bug in the bootloader causes that interrupt interface is
3249                  * only enabled after receiving SetInterface(0, AltSetting=0).
3250                  */
3251                 err = usb_set_interface(data->udev, 0, 0);
3252                 if (err < 0) {
3253                         BT_ERR("failed to set interface 0, alt 0 %d", err);
3254                         goto out_free_dev;
3255                 }
3256         }
3257
3258         if (data->isoc) {
3259                 err = usb_driver_claim_interface(&btusb_driver,
3260                                                  data->isoc, data);
3261                 if (err < 0)
3262                         goto out_free_dev;
3263         }
3264
3265 #ifdef CONFIG_BT_HCIBTUSB_BCM
3266         if (data->diag) {
3267                 if (!usb_driver_claim_interface(&btusb_driver,
3268                                                 data->diag, data))
3269                         __set_diag_interface(hdev);
3270                 else
3271                         data->diag = NULL;
3272         }
3273 #endif
3274
3275         if (enable_autosuspend)
3276                 usb_enable_autosuspend(data->udev);
3277
3278         err = hci_register_dev(hdev);
3279         if (err < 0)
3280                 goto out_free_dev;
3281
3282         usb_set_intfdata(intf, data);
3283
3284         return 0;
3285
3286 out_free_dev:
3287         if (data->reset_gpio)
3288                 gpiod_put(data->reset_gpio);
3289         hci_free_dev(hdev);
3290         return err;
3291 }
3292
3293 static void btusb_disconnect(struct usb_interface *intf)
3294 {
3295         struct btusb_data *data = usb_get_intfdata(intf);
3296         struct hci_dev *hdev;
3297
3298         BT_DBG("intf %p", intf);
3299
3300         if (!data)
3301                 return;
3302
3303         hdev = data->hdev;
3304         usb_set_intfdata(data->intf, NULL);
3305
3306         if (data->isoc)
3307                 usb_set_intfdata(data->isoc, NULL);
3308
3309         if (data->diag)
3310                 usb_set_intfdata(data->diag, NULL);
3311
3312         hci_unregister_dev(hdev);
3313
3314         if (intf == data->intf) {
3315                 if (data->isoc)
3316                         usb_driver_release_interface(&btusb_driver, data->isoc);
3317                 if (data->diag)
3318                         usb_driver_release_interface(&btusb_driver, data->diag);
3319         } else if (intf == data->isoc) {
3320                 if (data->diag)
3321                         usb_driver_release_interface(&btusb_driver, data->diag);
3322                 usb_driver_release_interface(&btusb_driver, data->intf);
3323         } else if (intf == data->diag) {
3324                 usb_driver_release_interface(&btusb_driver, data->intf);
3325                 if (data->isoc)
3326                         usb_driver_release_interface(&btusb_driver, data->isoc);
3327         }
3328
3329         if (data->oob_wake_irq)
3330                 device_init_wakeup(&data->udev->dev, false);
3331
3332         if (data->reset_gpio)
3333                 gpiod_put(data->reset_gpio);
3334
3335         hci_free_dev(hdev);
3336 }
3337
3338 #ifdef CONFIG_PM
3339 static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
3340 {
3341         struct btusb_data *data = usb_get_intfdata(intf);
3342
3343         BT_DBG("intf %p", intf);
3344
3345         if (data->suspend_count++)
3346                 return 0;
3347
3348         spin_lock_irq(&data->txlock);
3349         if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
3350                 set_bit(BTUSB_SUSPENDING, &data->flags);
3351                 spin_unlock_irq(&data->txlock);
3352         } else {
3353                 spin_unlock_irq(&data->txlock);
3354                 data->suspend_count--;
3355                 return -EBUSY;
3356         }
3357
3358         cancel_work_sync(&data->work);
3359
3360         btusb_stop_traffic(data);
3361         usb_kill_anchored_urbs(&data->tx_anchor);
3362
3363         if (data->oob_wake_irq && device_may_wakeup(&data->udev->dev)) {
3364                 set_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
3365                 enable_irq_wake(data->oob_wake_irq);
3366                 enable_irq(data->oob_wake_irq);
3367         }
3368
3369         return 0;
3370 }
3371
3372 static void play_deferred(struct btusb_data *data)
3373 {
3374         struct urb *urb;
3375         int err;
3376
3377         while ((urb = usb_get_from_anchor(&data->deferred))) {
3378                 usb_anchor_urb(urb, &data->tx_anchor);
3379
3380                 err = usb_submit_urb(urb, GFP_ATOMIC);
3381                 if (err < 0) {
3382                         if (err != -EPERM && err != -ENODEV)
3383                                 BT_ERR("%s urb %p submission failed (%d)",
3384                                        data->hdev->name, urb, -err);
3385                         kfree(urb->setup_packet);
3386                         usb_unanchor_urb(urb);
3387                         usb_free_urb(urb);
3388                         break;
3389                 }
3390
3391                 data->tx_in_flight++;
3392                 usb_free_urb(urb);
3393         }
3394
3395         /* Cleanup the rest deferred urbs. */
3396         while ((urb = usb_get_from_anchor(&data->deferred))) {
3397                 kfree(urb->setup_packet);
3398                 usb_free_urb(urb);
3399         }
3400 }
3401
3402 static int btusb_resume(struct usb_interface *intf)
3403 {
3404         struct btusb_data *data = usb_get_intfdata(intf);
3405         struct hci_dev *hdev = data->hdev;
3406         int err = 0;
3407
3408         BT_DBG("intf %p", intf);
3409
3410         if (--data->suspend_count)
3411                 return 0;
3412
3413         /* Disable only if not already disabled (keep it balanced) */
3414         if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
3415                 disable_irq(data->oob_wake_irq);
3416                 disable_irq_wake(data->oob_wake_irq);
3417         }
3418
3419         if (!test_bit(HCI_RUNNING, &hdev->flags))
3420                 goto done;
3421
3422         if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
3423                 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
3424                 if (err < 0) {
3425                         clear_bit(BTUSB_INTR_RUNNING, &data->flags);
3426                         goto failed;
3427                 }
3428         }
3429
3430         if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
3431                 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
3432                 if (err < 0) {
3433                         clear_bit(BTUSB_BULK_RUNNING, &data->flags);
3434                         goto failed;
3435                 }
3436
3437                 btusb_submit_bulk_urb(hdev, GFP_NOIO);
3438         }
3439
3440         if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
3441                 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
3442                         clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
3443                 else
3444                         btusb_submit_isoc_urb(hdev, GFP_NOIO);
3445         }
3446
3447         spin_lock_irq(&data->txlock);
3448         play_deferred(data);
3449         clear_bit(BTUSB_SUSPENDING, &data->flags);
3450         spin_unlock_irq(&data->txlock);
3451         schedule_work(&data->work);
3452
3453         return 0;
3454
3455 failed:
3456         usb_scuttle_anchored_urbs(&data->deferred);
3457 done:
3458         spin_lock_irq(&data->txlock);
3459         clear_bit(BTUSB_SUSPENDING, &data->flags);
3460         spin_unlock_irq(&data->txlock);
3461
3462         return err;
3463 }
3464 #endif
3465
3466 static struct usb_driver btusb_driver = {
3467         .name           = "btusb",
3468         .probe          = btusb_probe,
3469         .disconnect     = btusb_disconnect,
3470 #ifdef CONFIG_PM
3471         .suspend        = btusb_suspend,
3472         .resume         = btusb_resume,
3473 #endif
3474         .id_table       = btusb_table,
3475         .supports_autosuspend = 1,
3476         .disable_hub_initiated_lpm = 1,
3477 };
3478
3479 module_usb_driver(btusb_driver);
3480
3481 module_param(disable_scofix, bool, 0644);
3482 MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
3483
3484 module_param(force_scofix, bool, 0644);
3485 MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
3486
3487 module_param(enable_autosuspend, bool, 0644);
3488 MODULE_PARM_DESC(enable_autosuspend, "Enable USB autosuspend by default");
3489
3490 module_param(reset, bool, 0644);
3491 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
3492
3493 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
3494 MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
3495 MODULE_VERSION(VERSION);
3496 MODULE_LICENSE("GPL");