1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Generic Bluetooth USB driver
10 #include <linux/module.h>
11 #include <linux/usb.h>
12 #include <linux/usb/quirks.h>
13 #include <linux/firmware.h>
14 #include <linux/iopoll.h>
15 #include <linux/of_device.h>
16 #include <linux/of_irq.h>
17 #include <linux/suspend.h>
18 #include <linux/gpio/consumer.h>
19 #include <asm/unaligned.h>
21 #include <net/bluetooth/bluetooth.h>
22 #include <net/bluetooth/hci_core.h>
30 static bool disable_scofix;
31 static bool force_scofix;
32 static bool enable_autosuspend = IS_ENABLED(CONFIG_BT_HCIBTUSB_AUTOSUSPEND);
34 static bool reset = true;
36 static struct usb_driver btusb_driver;
38 #define BTUSB_IGNORE 0x01
39 #define BTUSB_DIGIANSWER 0x02
40 #define BTUSB_CSR 0x04
41 #define BTUSB_SNIFFER 0x08
42 #define BTUSB_BCM92035 0x10
43 #define BTUSB_BROKEN_ISOC 0x20
44 #define BTUSB_WRONG_SCO_MTU 0x40
45 #define BTUSB_ATH3012 0x80
46 #define BTUSB_INTEL 0x100
47 #define BTUSB_INTEL_BOOT 0x200
48 #define BTUSB_BCM_PATCHRAM 0x400
49 #define BTUSB_MARVELL 0x800
50 #define BTUSB_SWAVE 0x1000
51 #define BTUSB_INTEL_NEW 0x2000
52 #define BTUSB_AMP 0x4000
53 #define BTUSB_QCA_ROME 0x8000
54 #define BTUSB_BCM_APPLE 0x10000
55 #define BTUSB_REALTEK 0x20000
56 #define BTUSB_BCM2045 0x40000
57 #define BTUSB_IFNUM_2 0x80000
58 #define BTUSB_CW6622 0x100000
59 #define BTUSB_MEDIATEK 0x200000
60 #define BTUSB_WIDEBAND_SPEECH 0x400000
61 #define BTUSB_VALID_LE_STATES 0x800000
62 #define BTUSB_QCA_WCN6855 0x1000000
63 #define BTUSB_INTEL_NEWGEN 0x2000000
65 static const struct usb_device_id btusb_table[] = {
66 /* Generic Bluetooth USB device */
67 { USB_DEVICE_INFO(0xe0, 0x01, 0x01) },
69 /* Generic Bluetooth AMP device */
70 { USB_DEVICE_INFO(0xe0, 0x01, 0x04), .driver_info = BTUSB_AMP },
72 /* Generic Bluetooth USB interface */
73 { USB_INTERFACE_INFO(0xe0, 0x01, 0x01) },
75 /* Apple-specific (Broadcom) devices */
76 { USB_VENDOR_AND_INTERFACE_INFO(0x05ac, 0xff, 0x01, 0x01),
77 .driver_info = BTUSB_BCM_APPLE | BTUSB_IFNUM_2 },
79 /* MediaTek MT76x0E */
80 { USB_DEVICE(0x0e8d, 0x763f) },
82 /* Broadcom SoftSailing reporting vendor specific */
83 { USB_DEVICE(0x0a5c, 0x21e1) },
85 /* Apple MacBookPro 7,1 */
86 { USB_DEVICE(0x05ac, 0x8213) },
89 { USB_DEVICE(0x05ac, 0x8215) },
91 /* Apple MacBookPro6,2 */
92 { USB_DEVICE(0x05ac, 0x8218) },
94 /* Apple MacBookAir3,1, MacBookAir3,2 */
95 { USB_DEVICE(0x05ac, 0x821b) },
97 /* Apple MacBookAir4,1 */
98 { USB_DEVICE(0x05ac, 0x821f) },
100 /* Apple MacBookPro8,2 */
101 { USB_DEVICE(0x05ac, 0x821a) },
103 /* Apple MacMini5,1 */
104 { USB_DEVICE(0x05ac, 0x8281) },
106 /* AVM BlueFRITZ! USB v2.0 */
107 { USB_DEVICE(0x057c, 0x3800), .driver_info = BTUSB_SWAVE },
109 /* Bluetooth Ultraport Module from IBM */
110 { USB_DEVICE(0x04bf, 0x030a) },
112 /* ALPS Modules with non-standard id */
113 { USB_DEVICE(0x044e, 0x3001) },
114 { USB_DEVICE(0x044e, 0x3002) },
116 /* Ericsson with non-standard id */
117 { USB_DEVICE(0x0bdb, 0x1002) },
119 /* Canyon CN-BTU1 with HID interfaces */
120 { USB_DEVICE(0x0c10, 0x0000) },
122 /* Broadcom BCM20702A0 */
123 { USB_DEVICE(0x413c, 0x8197) },
125 /* Broadcom BCM20702B0 (Dynex/Insignia) */
126 { USB_DEVICE(0x19ff, 0x0239), .driver_info = BTUSB_BCM_PATCHRAM },
128 /* Broadcom BCM43142A0 (Foxconn/Lenovo) */
129 { USB_VENDOR_AND_INTERFACE_INFO(0x105b, 0xff, 0x01, 0x01),
130 .driver_info = BTUSB_BCM_PATCHRAM },
132 /* Broadcom BCM920703 (HTC Vive) */
133 { USB_VENDOR_AND_INTERFACE_INFO(0x0bb4, 0xff, 0x01, 0x01),
134 .driver_info = BTUSB_BCM_PATCHRAM },
136 /* Foxconn - Hon Hai */
137 { USB_VENDOR_AND_INTERFACE_INFO(0x0489, 0xff, 0x01, 0x01),
138 .driver_info = BTUSB_BCM_PATCHRAM },
140 /* Lite-On Technology - Broadcom based */
141 { USB_VENDOR_AND_INTERFACE_INFO(0x04ca, 0xff, 0x01, 0x01),
142 .driver_info = BTUSB_BCM_PATCHRAM },
144 /* Broadcom devices with vendor specific id */
145 { USB_VENDOR_AND_INTERFACE_INFO(0x0a5c, 0xff, 0x01, 0x01),
146 .driver_info = BTUSB_BCM_PATCHRAM },
148 /* ASUSTek Computer - Broadcom based */
149 { USB_VENDOR_AND_INTERFACE_INFO(0x0b05, 0xff, 0x01, 0x01),
150 .driver_info = BTUSB_BCM_PATCHRAM },
152 /* Belkin F8065bf - Broadcom based */
153 { USB_VENDOR_AND_INTERFACE_INFO(0x050d, 0xff, 0x01, 0x01),
154 .driver_info = BTUSB_BCM_PATCHRAM },
156 /* IMC Networks - Broadcom based */
157 { USB_VENDOR_AND_INTERFACE_INFO(0x13d3, 0xff, 0x01, 0x01),
158 .driver_info = BTUSB_BCM_PATCHRAM },
160 /* Dell Computer - Broadcom based */
161 { USB_VENDOR_AND_INTERFACE_INFO(0x413c, 0xff, 0x01, 0x01),
162 .driver_info = BTUSB_BCM_PATCHRAM },
164 /* Toshiba Corp - Broadcom based */
165 { USB_VENDOR_AND_INTERFACE_INFO(0x0930, 0xff, 0x01, 0x01),
166 .driver_info = BTUSB_BCM_PATCHRAM },
168 /* Intel Bluetooth USB Bootloader (RAM module) */
169 { USB_DEVICE(0x8087, 0x0a5a),
170 .driver_info = BTUSB_INTEL_BOOT | BTUSB_BROKEN_ISOC },
172 { } /* Terminating entry */
175 MODULE_DEVICE_TABLE(usb, btusb_table);
177 static const struct usb_device_id blacklist_table[] = {
178 /* CSR BlueCore devices */
179 { USB_DEVICE(0x0a12, 0x0001), .driver_info = BTUSB_CSR },
181 /* Broadcom BCM2033 without firmware */
182 { USB_DEVICE(0x0a5c, 0x2033), .driver_info = BTUSB_IGNORE },
184 /* Broadcom BCM2045 devices */
185 { USB_DEVICE(0x0a5c, 0x2045), .driver_info = BTUSB_BCM2045 },
187 /* Atheros 3011 with sflash firmware */
188 { USB_DEVICE(0x0489, 0xe027), .driver_info = BTUSB_IGNORE },
189 { USB_DEVICE(0x0489, 0xe03d), .driver_info = BTUSB_IGNORE },
190 { USB_DEVICE(0x04f2, 0xaff1), .driver_info = BTUSB_IGNORE },
191 { USB_DEVICE(0x0930, 0x0215), .driver_info = BTUSB_IGNORE },
192 { USB_DEVICE(0x0cf3, 0x3002), .driver_info = BTUSB_IGNORE },
193 { USB_DEVICE(0x0cf3, 0xe019), .driver_info = BTUSB_IGNORE },
194 { USB_DEVICE(0x13d3, 0x3304), .driver_info = BTUSB_IGNORE },
196 /* Atheros AR9285 Malbec with sflash firmware */
197 { USB_DEVICE(0x03f0, 0x311d), .driver_info = BTUSB_IGNORE },
199 /* Atheros 3012 with sflash firmware */
200 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
201 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
202 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
203 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
204 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
205 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
206 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
207 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
208 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
209 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
210 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
211 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
212 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
213 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
214 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
215 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
216 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
217 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
218 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
219 { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
220 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
221 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
222 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
223 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
224 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
225 { USB_DEVICE(0x0cf3, 0x0036), .driver_info = BTUSB_ATH3012 },
226 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
227 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
228 { USB_DEVICE(0x0cf3, 0x311d), .driver_info = BTUSB_ATH3012 },
229 { USB_DEVICE(0x0cf3, 0x311e), .driver_info = BTUSB_ATH3012 },
230 { USB_DEVICE(0x0cf3, 0x311f), .driver_info = BTUSB_ATH3012 },
231 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
232 { USB_DEVICE(0x0cf3, 0x817a), .driver_info = BTUSB_ATH3012 },
233 { USB_DEVICE(0x0cf3, 0x817b), .driver_info = BTUSB_ATH3012 },
234 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
235 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
236 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
237 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
238 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
239 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
240 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
241 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
242 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
243 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
244 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
245 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
246 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
247 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
248 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
249 { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
251 /* Atheros AR5BBU12 with sflash firmware */
252 { USB_DEVICE(0x0489, 0xe02c), .driver_info = BTUSB_IGNORE },
254 /* Atheros AR5BBU12 with sflash firmware */
255 { USB_DEVICE(0x0489, 0xe036), .driver_info = BTUSB_ATH3012 },
256 { USB_DEVICE(0x0489, 0xe03c), .driver_info = BTUSB_ATH3012 },
258 /* QCA ROME chipset */
259 { USB_DEVICE(0x0cf3, 0x535b), .driver_info = BTUSB_QCA_ROME |
260 BTUSB_WIDEBAND_SPEECH },
261 { USB_DEVICE(0x0cf3, 0xe007), .driver_info = BTUSB_QCA_ROME |
262 BTUSB_WIDEBAND_SPEECH },
263 { USB_DEVICE(0x0cf3, 0xe009), .driver_info = BTUSB_QCA_ROME |
264 BTUSB_WIDEBAND_SPEECH },
265 { USB_DEVICE(0x0cf3, 0xe010), .driver_info = BTUSB_QCA_ROME |
266 BTUSB_WIDEBAND_SPEECH },
267 { USB_DEVICE(0x0cf3, 0xe300), .driver_info = BTUSB_QCA_ROME |
268 BTUSB_WIDEBAND_SPEECH },
269 { USB_DEVICE(0x0cf3, 0xe301), .driver_info = BTUSB_QCA_ROME |
270 BTUSB_WIDEBAND_SPEECH },
271 { USB_DEVICE(0x0cf3, 0xe360), .driver_info = BTUSB_QCA_ROME |
272 BTUSB_WIDEBAND_SPEECH },
273 { USB_DEVICE(0x0489, 0xe092), .driver_info = BTUSB_QCA_ROME |
274 BTUSB_WIDEBAND_SPEECH },
275 { USB_DEVICE(0x0489, 0xe09f), .driver_info = BTUSB_QCA_ROME |
276 BTUSB_WIDEBAND_SPEECH },
277 { USB_DEVICE(0x0489, 0xe0a2), .driver_info = BTUSB_QCA_ROME |
278 BTUSB_WIDEBAND_SPEECH },
279 { USB_DEVICE(0x04ca, 0x3011), .driver_info = BTUSB_QCA_ROME |
280 BTUSB_WIDEBAND_SPEECH },
281 { USB_DEVICE(0x04ca, 0x3015), .driver_info = BTUSB_QCA_ROME |
282 BTUSB_WIDEBAND_SPEECH },
283 { USB_DEVICE(0x04ca, 0x3016), .driver_info = BTUSB_QCA_ROME |
284 BTUSB_WIDEBAND_SPEECH },
285 { USB_DEVICE(0x04ca, 0x301a), .driver_info = BTUSB_QCA_ROME |
286 BTUSB_WIDEBAND_SPEECH },
287 { USB_DEVICE(0x04ca, 0x3021), .driver_info = BTUSB_QCA_ROME |
288 BTUSB_WIDEBAND_SPEECH },
289 { USB_DEVICE(0x13d3, 0x3491), .driver_info = BTUSB_QCA_ROME |
290 BTUSB_WIDEBAND_SPEECH },
291 { USB_DEVICE(0x13d3, 0x3496), .driver_info = BTUSB_QCA_ROME |
292 BTUSB_WIDEBAND_SPEECH },
293 { USB_DEVICE(0x13d3, 0x3501), .driver_info = BTUSB_QCA_ROME |
294 BTUSB_WIDEBAND_SPEECH },
296 /* QCA WCN6855 chipset */
297 { USB_DEVICE(0x0cf3, 0xe600), .driver_info = BTUSB_QCA_WCN6855 |
298 BTUSB_WIDEBAND_SPEECH },
300 /* Broadcom BCM2035 */
301 { USB_DEVICE(0x0a5c, 0x2009), .driver_info = BTUSB_BCM92035 },
302 { USB_DEVICE(0x0a5c, 0x200a), .driver_info = BTUSB_WRONG_SCO_MTU },
303 { USB_DEVICE(0x0a5c, 0x2035), .driver_info = BTUSB_WRONG_SCO_MTU },
305 /* Broadcom BCM2045 */
306 { USB_DEVICE(0x0a5c, 0x2039), .driver_info = BTUSB_WRONG_SCO_MTU },
307 { USB_DEVICE(0x0a5c, 0x2101), .driver_info = BTUSB_WRONG_SCO_MTU },
309 /* IBM/Lenovo ThinkPad with Broadcom chip */
310 { USB_DEVICE(0x0a5c, 0x201e), .driver_info = BTUSB_WRONG_SCO_MTU },
311 { USB_DEVICE(0x0a5c, 0x2110), .driver_info = BTUSB_WRONG_SCO_MTU },
313 /* HP laptop with Broadcom chip */
314 { USB_DEVICE(0x03f0, 0x171d), .driver_info = BTUSB_WRONG_SCO_MTU },
316 /* Dell laptop with Broadcom chip */
317 { USB_DEVICE(0x413c, 0x8126), .driver_info = BTUSB_WRONG_SCO_MTU },
319 /* Dell Wireless 370 and 410 devices */
320 { USB_DEVICE(0x413c, 0x8152), .driver_info = BTUSB_WRONG_SCO_MTU },
321 { USB_DEVICE(0x413c, 0x8156), .driver_info = BTUSB_WRONG_SCO_MTU },
323 /* Belkin F8T012 and F8T013 devices */
324 { USB_DEVICE(0x050d, 0x0012), .driver_info = BTUSB_WRONG_SCO_MTU },
325 { USB_DEVICE(0x050d, 0x0013), .driver_info = BTUSB_WRONG_SCO_MTU },
327 /* Asus WL-BTD202 device */
328 { USB_DEVICE(0x0b05, 0x1715), .driver_info = BTUSB_WRONG_SCO_MTU },
330 /* Kensington Bluetooth USB adapter */
331 { USB_DEVICE(0x047d, 0x105e), .driver_info = BTUSB_WRONG_SCO_MTU },
333 /* RTX Telecom based adapters with buggy SCO support */
334 { USB_DEVICE(0x0400, 0x0807), .driver_info = BTUSB_BROKEN_ISOC },
335 { USB_DEVICE(0x0400, 0x080a), .driver_info = BTUSB_BROKEN_ISOC },
337 /* CONWISE Technology based adapters with buggy SCO support */
338 { USB_DEVICE(0x0e5e, 0x6622),
339 .driver_info = BTUSB_BROKEN_ISOC | BTUSB_CW6622},
341 /* Roper Class 1 Bluetooth Dongle (Silicon Wave based) */
342 { USB_DEVICE(0x1310, 0x0001), .driver_info = BTUSB_SWAVE },
344 /* Digianswer devices */
345 { USB_DEVICE(0x08fd, 0x0001), .driver_info = BTUSB_DIGIANSWER },
346 { USB_DEVICE(0x08fd, 0x0002), .driver_info = BTUSB_IGNORE },
348 /* CSR BlueCore Bluetooth Sniffer */
349 { USB_DEVICE(0x0a12, 0x0002),
350 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
352 /* Frontline ComProbe Bluetooth Sniffer */
353 { USB_DEVICE(0x16d3, 0x0002),
354 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
356 /* Marvell Bluetooth devices */
357 { USB_DEVICE(0x1286, 0x2044), .driver_info = BTUSB_MARVELL },
358 { USB_DEVICE(0x1286, 0x2046), .driver_info = BTUSB_MARVELL },
359 { USB_DEVICE(0x1286, 0x204e), .driver_info = BTUSB_MARVELL },
361 /* Intel Bluetooth devices */
362 { USB_DEVICE(0x8087, 0x0025), .driver_info = BTUSB_INTEL_NEW |
363 BTUSB_WIDEBAND_SPEECH |
364 BTUSB_VALID_LE_STATES },
365 { USB_DEVICE(0x8087, 0x0026), .driver_info = BTUSB_INTEL_NEW |
366 BTUSB_WIDEBAND_SPEECH },
367 { USB_DEVICE(0x8087, 0x0029), .driver_info = BTUSB_INTEL_NEW |
368 BTUSB_WIDEBAND_SPEECH },
369 { USB_DEVICE(0x8087, 0x0032), .driver_info = BTUSB_INTEL_NEWGEN |
370 BTUSB_WIDEBAND_SPEECH},
371 { USB_DEVICE(0x8087, 0x0033), .driver_info = BTUSB_INTEL_NEWGEN |
372 BTUSB_WIDEBAND_SPEECH},
373 { USB_DEVICE(0x8087, 0x07da), .driver_info = BTUSB_CSR },
374 { USB_DEVICE(0x8087, 0x07dc), .driver_info = BTUSB_INTEL },
375 { USB_DEVICE(0x8087, 0x0a2a), .driver_info = BTUSB_INTEL },
376 { USB_DEVICE(0x8087, 0x0a2b), .driver_info = BTUSB_INTEL_NEW |
377 BTUSB_WIDEBAND_SPEECH },
378 { USB_DEVICE(0x8087, 0x0aa7), .driver_info = BTUSB_INTEL |
379 BTUSB_WIDEBAND_SPEECH },
380 { USB_DEVICE(0x8087, 0x0aaa), .driver_info = BTUSB_INTEL_NEW |
381 BTUSB_WIDEBAND_SPEECH |
382 BTUSB_VALID_LE_STATES },
384 /* Other Intel Bluetooth devices */
385 { USB_VENDOR_AND_INTERFACE_INFO(0x8087, 0xe0, 0x01, 0x01),
386 .driver_info = BTUSB_IGNORE },
388 /* Realtek 8822CE Bluetooth devices */
389 { USB_DEVICE(0x0bda, 0xb00c), .driver_info = BTUSB_REALTEK |
390 BTUSB_WIDEBAND_SPEECH },
392 /* Realtek 8852AE Bluetooth devices */
393 { USB_DEVICE(0x0bda, 0xc852), .driver_info = BTUSB_REALTEK |
394 BTUSB_WIDEBAND_SPEECH },
396 /* Realtek Bluetooth devices */
397 { USB_VENDOR_AND_INTERFACE_INFO(0x0bda, 0xe0, 0x01, 0x01),
398 .driver_info = BTUSB_REALTEK },
400 /* MediaTek Bluetooth devices */
401 { USB_VENDOR_AND_INTERFACE_INFO(0x0e8d, 0xe0, 0x01, 0x01),
402 .driver_info = BTUSB_MEDIATEK |
403 BTUSB_WIDEBAND_SPEECH |
404 BTUSB_VALID_LE_STATES },
406 /* Additional MediaTek MT7615E Bluetooth devices */
407 { USB_DEVICE(0x13d3, 0x3560), .driver_info = BTUSB_MEDIATEK},
409 /* Additional Realtek 8723AE Bluetooth devices */
410 { USB_DEVICE(0x0930, 0x021d), .driver_info = BTUSB_REALTEK },
411 { USB_DEVICE(0x13d3, 0x3394), .driver_info = BTUSB_REALTEK },
413 /* Additional Realtek 8723BE Bluetooth devices */
414 { USB_DEVICE(0x0489, 0xe085), .driver_info = BTUSB_REALTEK },
415 { USB_DEVICE(0x0489, 0xe08b), .driver_info = BTUSB_REALTEK },
416 { USB_DEVICE(0x13d3, 0x3410), .driver_info = BTUSB_REALTEK },
417 { USB_DEVICE(0x13d3, 0x3416), .driver_info = BTUSB_REALTEK },
418 { USB_DEVICE(0x13d3, 0x3459), .driver_info = BTUSB_REALTEK },
419 { USB_DEVICE(0x13d3, 0x3494), .driver_info = BTUSB_REALTEK },
421 /* Additional Realtek 8723BU Bluetooth devices */
422 { USB_DEVICE(0x7392, 0xa611), .driver_info = BTUSB_REALTEK },
424 /* Additional Realtek 8723DE Bluetooth devices */
425 { USB_DEVICE(0x0bda, 0xb009), .driver_info = BTUSB_REALTEK },
426 { USB_DEVICE(0x2ff8, 0xb011), .driver_info = BTUSB_REALTEK },
428 /* Additional Realtek 8821AE Bluetooth devices */
429 { USB_DEVICE(0x0b05, 0x17dc), .driver_info = BTUSB_REALTEK },
430 { USB_DEVICE(0x13d3, 0x3414), .driver_info = BTUSB_REALTEK },
431 { USB_DEVICE(0x13d3, 0x3458), .driver_info = BTUSB_REALTEK },
432 { USB_DEVICE(0x13d3, 0x3461), .driver_info = BTUSB_REALTEK },
433 { USB_DEVICE(0x13d3, 0x3462), .driver_info = BTUSB_REALTEK },
435 /* Additional Realtek 8822BE Bluetooth devices */
436 { USB_DEVICE(0x13d3, 0x3526), .driver_info = BTUSB_REALTEK },
437 { USB_DEVICE(0x0b05, 0x185c), .driver_info = BTUSB_REALTEK },
439 /* Additional Realtek 8822CE Bluetooth devices */
440 { USB_DEVICE(0x04ca, 0x4005), .driver_info = BTUSB_REALTEK |
441 BTUSB_WIDEBAND_SPEECH },
442 { USB_DEVICE(0x04c5, 0x161f), .driver_info = BTUSB_REALTEK |
443 BTUSB_WIDEBAND_SPEECH },
444 { USB_DEVICE(0x0b05, 0x18ef), .driver_info = BTUSB_REALTEK |
445 BTUSB_WIDEBAND_SPEECH },
446 { USB_DEVICE(0x13d3, 0x3548), .driver_info = BTUSB_REALTEK |
447 BTUSB_WIDEBAND_SPEECH },
448 { USB_DEVICE(0x13d3, 0x3549), .driver_info = BTUSB_REALTEK |
449 BTUSB_WIDEBAND_SPEECH },
450 { USB_DEVICE(0x13d3, 0x3553), .driver_info = BTUSB_REALTEK |
451 BTUSB_WIDEBAND_SPEECH },
452 { USB_DEVICE(0x13d3, 0x3555), .driver_info = BTUSB_REALTEK |
453 BTUSB_WIDEBAND_SPEECH },
454 { USB_DEVICE(0x2ff8, 0x3051), .driver_info = BTUSB_REALTEK |
455 BTUSB_WIDEBAND_SPEECH },
456 { USB_DEVICE(0x1358, 0xc123), .driver_info = BTUSB_REALTEK |
457 BTUSB_WIDEBAND_SPEECH },
458 { USB_DEVICE(0x0bda, 0xc123), .driver_info = BTUSB_REALTEK |
459 BTUSB_WIDEBAND_SPEECH },
460 { USB_DEVICE(0x0cb5, 0xc547), .driver_info = BTUSB_REALTEK |
461 BTUSB_WIDEBAND_SPEECH },
463 /* Silicon Wave based devices */
464 { USB_DEVICE(0x0c10, 0x0000), .driver_info = BTUSB_SWAVE },
466 { } /* Terminating entry */
469 /* The Bluetooth USB module build into some devices needs to be reset on resume,
470 * this is a problem with the platform (likely shutting off all power) not with
471 * the module itself. So we use a DMI list to match known broken platforms.
473 static const struct dmi_system_id btusb_needs_reset_resume_table[] = {
475 /* Dell OptiPlex 3060 (QCA ROME device 0cf3:e007) */
477 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
478 DMI_MATCH(DMI_PRODUCT_NAME, "OptiPlex 3060"),
482 /* Dell XPS 9360 (QCA ROME device 0cf3:e300) */
484 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
485 DMI_MATCH(DMI_PRODUCT_NAME, "XPS 13 9360"),
489 /* Dell Inspiron 5565 (QCA ROME device 0cf3:e009) */
491 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
492 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 5565"),
498 #define BTUSB_MAX_ISOC_FRAMES 10
500 #define BTUSB_INTR_RUNNING 0
501 #define BTUSB_BULK_RUNNING 1
502 #define BTUSB_ISOC_RUNNING 2
503 #define BTUSB_SUSPENDING 3
504 #define BTUSB_DID_ISO_RESUME 4
505 #define BTUSB_BOOTLOADER 5
506 #define BTUSB_DOWNLOADING 6
507 #define BTUSB_FIRMWARE_LOADED 7
508 #define BTUSB_FIRMWARE_FAILED 8
509 #define BTUSB_BOOTING 9
510 #define BTUSB_DIAG_RUNNING 10
511 #define BTUSB_OOB_WAKE_ENABLED 11
512 #define BTUSB_HW_RESET_ACTIVE 12
513 #define BTUSB_TX_WAIT_VND_EVT 13
514 #define BTUSB_WAKEUP_DISABLE 14
517 struct hci_dev *hdev;
518 struct usb_device *udev;
519 struct usb_interface *intf;
520 struct usb_interface *isoc;
521 struct usb_interface *diag;
526 struct work_struct work;
527 struct work_struct waker;
529 struct usb_anchor deferred;
530 struct usb_anchor tx_anchor;
534 struct usb_anchor intr_anchor;
535 struct usb_anchor bulk_anchor;
536 struct usb_anchor isoc_anchor;
537 struct usb_anchor diag_anchor;
538 struct usb_anchor ctrl_anchor;
541 struct sk_buff *evt_skb;
542 struct sk_buff *acl_skb;
543 struct sk_buff *sco_skb;
545 struct usb_endpoint_descriptor *intr_ep;
546 struct usb_endpoint_descriptor *bulk_tx_ep;
547 struct usb_endpoint_descriptor *bulk_rx_ep;
548 struct usb_endpoint_descriptor *isoc_tx_ep;
549 struct usb_endpoint_descriptor *isoc_rx_ep;
550 struct usb_endpoint_descriptor *diag_tx_ep;
551 struct usb_endpoint_descriptor *diag_rx_ep;
553 struct gpio_desc *reset_gpio;
558 unsigned int sco_num;
559 unsigned int air_mode;
560 bool usb_alt6_packet_flow;
564 int (*recv_event)(struct hci_dev *hdev, struct sk_buff *skb);
565 int (*recv_bulk)(struct btusb_data *data, void *buffer, int count);
567 int (*setup_on_usb)(struct hci_dev *hdev);
569 int oob_wake_irq; /* irq for out-of-band wake-on-bt */
570 unsigned cmd_timeout_cnt;
573 static void btusb_intel_cmd_timeout(struct hci_dev *hdev)
575 struct btusb_data *data = hci_get_drvdata(hdev);
576 struct gpio_desc *reset_gpio = data->reset_gpio;
578 if (++data->cmd_timeout_cnt < 5)
582 bt_dev_err(hdev, "No way to reset. Ignoring and continuing");
587 * Toggle the hard reset line if the platform provides one. The reset
588 * is going to yank the device off the USB and then replug. So doing
589 * once is enough. The cleanup is handled correctly on the way out
590 * (standard USB disconnect), and the new device is detected cleanly
591 * and bound to the driver again like it should be.
593 if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
594 bt_dev_err(hdev, "last reset failed? Not resetting again");
598 bt_dev_err(hdev, "Initiating HW reset via gpio");
599 gpiod_set_value_cansleep(reset_gpio, 1);
601 gpiod_set_value_cansleep(reset_gpio, 0);
604 static void btusb_rtl_cmd_timeout(struct hci_dev *hdev)
606 struct btusb_data *data = hci_get_drvdata(hdev);
607 struct gpio_desc *reset_gpio = data->reset_gpio;
609 if (++data->cmd_timeout_cnt < 5)
613 bt_dev_err(hdev, "No gpio to reset Realtek device, ignoring");
617 /* Toggle the hard reset line. The Realtek device is going to
618 * yank itself off the USB and then replug. The cleanup is handled
619 * correctly on the way out (standard USB disconnect), and the new
620 * device is detected cleanly and bound to the driver again like
623 if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
624 bt_dev_err(hdev, "last reset failed? Not resetting again");
628 bt_dev_err(hdev, "Reset Realtek device via gpio");
629 gpiod_set_value_cansleep(reset_gpio, 1);
631 gpiod_set_value_cansleep(reset_gpio, 0);
634 static void btusb_qca_cmd_timeout(struct hci_dev *hdev)
636 struct btusb_data *data = hci_get_drvdata(hdev);
639 if (++data->cmd_timeout_cnt < 5)
642 bt_dev_err(hdev, "Multiple cmd timeouts seen. Resetting usb device.");
643 /* This is not an unbalanced PM reference since the device will reset */
644 err = usb_autopm_get_interface(data->intf);
646 usb_queue_reset_device(data->intf);
648 bt_dev_err(hdev, "Failed usb_autopm_get_interface with %d", err);
651 static inline void btusb_free_frags(struct btusb_data *data)
655 spin_lock_irqsave(&data->rxlock, flags);
657 kfree_skb(data->evt_skb);
658 data->evt_skb = NULL;
660 kfree_skb(data->acl_skb);
661 data->acl_skb = NULL;
663 kfree_skb(data->sco_skb);
664 data->sco_skb = NULL;
666 spin_unlock_irqrestore(&data->rxlock, flags);
669 static int btusb_recv_intr(struct btusb_data *data, void *buffer, int count)
675 spin_lock_irqsave(&data->rxlock, flags);
682 skb = bt_skb_alloc(HCI_MAX_EVENT_SIZE, GFP_ATOMIC);
688 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
689 hci_skb_expect(skb) = HCI_EVENT_HDR_SIZE;
692 len = min_t(uint, hci_skb_expect(skb), count);
693 skb_put_data(skb, buffer, len);
697 hci_skb_expect(skb) -= len;
699 if (skb->len == HCI_EVENT_HDR_SIZE) {
700 /* Complete event header */
701 hci_skb_expect(skb) = hci_event_hdr(skb)->plen;
703 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
712 if (!hci_skb_expect(skb)) {
714 data->recv_event(data->hdev, skb);
720 spin_unlock_irqrestore(&data->rxlock, flags);
725 static int btusb_recv_bulk(struct btusb_data *data, void *buffer, int count)
731 spin_lock_irqsave(&data->rxlock, flags);
738 skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
744 hci_skb_pkt_type(skb) = HCI_ACLDATA_PKT;
745 hci_skb_expect(skb) = HCI_ACL_HDR_SIZE;
748 len = min_t(uint, hci_skb_expect(skb), count);
749 skb_put_data(skb, buffer, len);
753 hci_skb_expect(skb) -= len;
755 if (skb->len == HCI_ACL_HDR_SIZE) {
756 __le16 dlen = hci_acl_hdr(skb)->dlen;
758 /* Complete ACL header */
759 hci_skb_expect(skb) = __le16_to_cpu(dlen);
761 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
770 if (!hci_skb_expect(skb)) {
772 hci_recv_frame(data->hdev, skb);
778 spin_unlock_irqrestore(&data->rxlock, flags);
783 static int btusb_recv_isoc(struct btusb_data *data, void *buffer, int count)
789 spin_lock_irqsave(&data->rxlock, flags);
796 skb = bt_skb_alloc(HCI_MAX_SCO_SIZE, GFP_ATOMIC);
802 hci_skb_pkt_type(skb) = HCI_SCODATA_PKT;
803 hci_skb_expect(skb) = HCI_SCO_HDR_SIZE;
806 len = min_t(uint, hci_skb_expect(skb), count);
807 skb_put_data(skb, buffer, len);
811 hci_skb_expect(skb) -= len;
813 if (skb->len == HCI_SCO_HDR_SIZE) {
814 /* Complete SCO header */
815 hci_skb_expect(skb) = hci_sco_hdr(skb)->dlen;
817 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
826 if (!hci_skb_expect(skb)) {
828 hci_recv_frame(data->hdev, skb);
834 spin_unlock_irqrestore(&data->rxlock, flags);
839 static void btusb_intr_complete(struct urb *urb)
841 struct hci_dev *hdev = urb->context;
842 struct btusb_data *data = hci_get_drvdata(hdev);
845 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
848 if (!test_bit(HCI_RUNNING, &hdev->flags))
851 if (urb->status == 0) {
852 hdev->stat.byte_rx += urb->actual_length;
854 if (btusb_recv_intr(data, urb->transfer_buffer,
855 urb->actual_length) < 0) {
856 bt_dev_err(hdev, "corrupted event packet");
859 } else if (urb->status == -ENOENT) {
860 /* Avoid suspend failed when usb_kill_urb */
864 if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
867 usb_mark_last_busy(data->udev);
868 usb_anchor_urb(urb, &data->intr_anchor);
870 err = usb_submit_urb(urb, GFP_ATOMIC);
872 /* -EPERM: urb is being killed;
873 * -ENODEV: device got disconnected
875 if (err != -EPERM && err != -ENODEV)
876 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
878 usb_unanchor_urb(urb);
882 static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
884 struct btusb_data *data = hci_get_drvdata(hdev);
890 BT_DBG("%s", hdev->name);
895 urb = usb_alloc_urb(0, mem_flags);
899 size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
901 buf = kmalloc(size, mem_flags);
907 pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
909 usb_fill_int_urb(urb, data->udev, pipe, buf, size,
910 btusb_intr_complete, hdev, data->intr_ep->bInterval);
912 urb->transfer_flags |= URB_FREE_BUFFER;
914 usb_anchor_urb(urb, &data->intr_anchor);
916 err = usb_submit_urb(urb, mem_flags);
918 if (err != -EPERM && err != -ENODEV)
919 bt_dev_err(hdev, "urb %p submission failed (%d)",
921 usb_unanchor_urb(urb);
929 static void btusb_bulk_complete(struct urb *urb)
931 struct hci_dev *hdev = urb->context;
932 struct btusb_data *data = hci_get_drvdata(hdev);
935 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
938 if (!test_bit(HCI_RUNNING, &hdev->flags))
941 if (urb->status == 0) {
942 hdev->stat.byte_rx += urb->actual_length;
944 if (data->recv_bulk(data, urb->transfer_buffer,
945 urb->actual_length) < 0) {
946 bt_dev_err(hdev, "corrupted ACL packet");
949 } else if (urb->status == -ENOENT) {
950 /* Avoid suspend failed when usb_kill_urb */
954 if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
957 usb_anchor_urb(urb, &data->bulk_anchor);
958 usb_mark_last_busy(data->udev);
960 err = usb_submit_urb(urb, GFP_ATOMIC);
962 /* -EPERM: urb is being killed;
963 * -ENODEV: device got disconnected
965 if (err != -EPERM && err != -ENODEV)
966 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
968 usb_unanchor_urb(urb);
972 static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
974 struct btusb_data *data = hci_get_drvdata(hdev);
978 int err, size = HCI_MAX_FRAME_SIZE;
980 BT_DBG("%s", hdev->name);
982 if (!data->bulk_rx_ep)
985 urb = usb_alloc_urb(0, mem_flags);
989 buf = kmalloc(size, mem_flags);
995 pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
997 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
998 btusb_bulk_complete, hdev);
1000 urb->transfer_flags |= URB_FREE_BUFFER;
1002 usb_mark_last_busy(data->udev);
1003 usb_anchor_urb(urb, &data->bulk_anchor);
1005 err = usb_submit_urb(urb, mem_flags);
1007 if (err != -EPERM && err != -ENODEV)
1008 bt_dev_err(hdev, "urb %p submission failed (%d)",
1010 usb_unanchor_urb(urb);
1018 static void btusb_isoc_complete(struct urb *urb)
1020 struct hci_dev *hdev = urb->context;
1021 struct btusb_data *data = hci_get_drvdata(hdev);
1024 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1025 urb->actual_length);
1027 if (!test_bit(HCI_RUNNING, &hdev->flags))
1030 if (urb->status == 0) {
1031 for (i = 0; i < urb->number_of_packets; i++) {
1032 unsigned int offset = urb->iso_frame_desc[i].offset;
1033 unsigned int length = urb->iso_frame_desc[i].actual_length;
1035 if (urb->iso_frame_desc[i].status)
1038 hdev->stat.byte_rx += length;
1040 if (btusb_recv_isoc(data, urb->transfer_buffer + offset,
1042 bt_dev_err(hdev, "corrupted SCO packet");
1043 hdev->stat.err_rx++;
1046 } else if (urb->status == -ENOENT) {
1047 /* Avoid suspend failed when usb_kill_urb */
1051 if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
1054 usb_anchor_urb(urb, &data->isoc_anchor);
1056 err = usb_submit_urb(urb, GFP_ATOMIC);
1058 /* -EPERM: urb is being killed;
1059 * -ENODEV: device got disconnected
1061 if (err != -EPERM && err != -ENODEV)
1062 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
1064 usb_unanchor_urb(urb);
1068 static inline void __fill_isoc_descriptor_msbc(struct urb *urb, int len,
1069 int mtu, struct btusb_data *data)
1072 unsigned int interval;
1074 BT_DBG("len %d mtu %d", len, mtu);
1076 /* For mSBC ALT 6 setting the host will send the packet at continuous
1077 * flow. As per core spec 5, vol 4, part B, table 2.1. For ALT setting
1078 * 6 the HCI PACKET INTERVAL should be 7.5ms for every usb packets.
1079 * To maintain the rate we send 63bytes of usb packets alternatively for
1080 * 7ms and 8ms to maintain the rate as 7.5ms.
1082 if (data->usb_alt6_packet_flow) {
1084 data->usb_alt6_packet_flow = false;
1087 data->usb_alt6_packet_flow = true;
1090 for (i = 0; i < interval; i++) {
1091 urb->iso_frame_desc[i].offset = offset;
1092 urb->iso_frame_desc[i].length = offset;
1095 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
1096 urb->iso_frame_desc[i].offset = offset;
1097 urb->iso_frame_desc[i].length = len;
1101 urb->number_of_packets = i;
1104 static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
1108 BT_DBG("len %d mtu %d", len, mtu);
1110 for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
1111 i++, offset += mtu, len -= mtu) {
1112 urb->iso_frame_desc[i].offset = offset;
1113 urb->iso_frame_desc[i].length = mtu;
1116 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
1117 urb->iso_frame_desc[i].offset = offset;
1118 urb->iso_frame_desc[i].length = len;
1122 urb->number_of_packets = i;
1125 static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
1127 struct btusb_data *data = hci_get_drvdata(hdev);
1133 BT_DBG("%s", hdev->name);
1135 if (!data->isoc_rx_ep)
1138 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
1142 size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
1143 BTUSB_MAX_ISOC_FRAMES;
1145 buf = kmalloc(size, mem_flags);
1151 pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
1153 usb_fill_int_urb(urb, data->udev, pipe, buf, size, btusb_isoc_complete,
1154 hdev, data->isoc_rx_ep->bInterval);
1156 urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
1158 __fill_isoc_descriptor(urb, size,
1159 le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
1161 usb_anchor_urb(urb, &data->isoc_anchor);
1163 err = usb_submit_urb(urb, mem_flags);
1165 if (err != -EPERM && err != -ENODEV)
1166 bt_dev_err(hdev, "urb %p submission failed (%d)",
1168 usb_unanchor_urb(urb);
1176 static void btusb_diag_complete(struct urb *urb)
1178 struct hci_dev *hdev = urb->context;
1179 struct btusb_data *data = hci_get_drvdata(hdev);
1182 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1183 urb->actual_length);
1185 if (urb->status == 0) {
1186 struct sk_buff *skb;
1188 skb = bt_skb_alloc(urb->actual_length, GFP_ATOMIC);
1190 skb_put_data(skb, urb->transfer_buffer,
1191 urb->actual_length);
1192 hci_recv_diag(hdev, skb);
1194 } else if (urb->status == -ENOENT) {
1195 /* Avoid suspend failed when usb_kill_urb */
1199 if (!test_bit(BTUSB_DIAG_RUNNING, &data->flags))
1202 usb_anchor_urb(urb, &data->diag_anchor);
1203 usb_mark_last_busy(data->udev);
1205 err = usb_submit_urb(urb, GFP_ATOMIC);
1207 /* -EPERM: urb is being killed;
1208 * -ENODEV: device got disconnected
1210 if (err != -EPERM && err != -ENODEV)
1211 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
1213 usb_unanchor_urb(urb);
1217 static int btusb_submit_diag_urb(struct hci_dev *hdev, gfp_t mem_flags)
1219 struct btusb_data *data = hci_get_drvdata(hdev);
1223 int err, size = HCI_MAX_FRAME_SIZE;
1225 BT_DBG("%s", hdev->name);
1227 if (!data->diag_rx_ep)
1230 urb = usb_alloc_urb(0, mem_flags);
1234 buf = kmalloc(size, mem_flags);
1240 pipe = usb_rcvbulkpipe(data->udev, data->diag_rx_ep->bEndpointAddress);
1242 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
1243 btusb_diag_complete, hdev);
1245 urb->transfer_flags |= URB_FREE_BUFFER;
1247 usb_mark_last_busy(data->udev);
1248 usb_anchor_urb(urb, &data->diag_anchor);
1250 err = usb_submit_urb(urb, mem_flags);
1252 if (err != -EPERM && err != -ENODEV)
1253 bt_dev_err(hdev, "urb %p submission failed (%d)",
1255 usb_unanchor_urb(urb);
1263 static void btusb_tx_complete(struct urb *urb)
1265 struct sk_buff *skb = urb->context;
1266 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1267 struct btusb_data *data = hci_get_drvdata(hdev);
1268 unsigned long flags;
1270 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1271 urb->actual_length);
1273 if (!test_bit(HCI_RUNNING, &hdev->flags))
1277 hdev->stat.byte_tx += urb->transfer_buffer_length;
1279 hdev->stat.err_tx++;
1282 spin_lock_irqsave(&data->txlock, flags);
1283 data->tx_in_flight--;
1284 spin_unlock_irqrestore(&data->txlock, flags);
1286 kfree(urb->setup_packet);
1291 static void btusb_isoc_tx_complete(struct urb *urb)
1293 struct sk_buff *skb = urb->context;
1294 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1296 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1297 urb->actual_length);
1299 if (!test_bit(HCI_RUNNING, &hdev->flags))
1303 hdev->stat.byte_tx += urb->transfer_buffer_length;
1305 hdev->stat.err_tx++;
1308 kfree(urb->setup_packet);
1313 static int btusb_open(struct hci_dev *hdev)
1315 struct btusb_data *data = hci_get_drvdata(hdev);
1318 BT_DBG("%s", hdev->name);
1320 err = usb_autopm_get_interface(data->intf);
1324 /* Patching USB firmware files prior to starting any URBs of HCI path
1325 * It is more safe to use USB bulk channel for downloading USB patch
1327 if (data->setup_on_usb) {
1328 err = data->setup_on_usb(hdev);
1333 data->intf->needs_remote_wakeup = 1;
1335 /* Disable device remote wakeup when host is suspended
1336 * For Realtek chips, global suspend without
1337 * SET_FEATURE (DEVICE_REMOTE_WAKEUP) can save more power in device.
1339 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1340 device_wakeup_disable(&data->udev->dev);
1342 if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
1345 err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
1349 err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1351 usb_kill_anchored_urbs(&data->intr_anchor);
1355 set_bit(BTUSB_BULK_RUNNING, &data->flags);
1356 btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1359 if (!btusb_submit_diag_urb(hdev, GFP_KERNEL))
1360 set_bit(BTUSB_DIAG_RUNNING, &data->flags);
1364 usb_autopm_put_interface(data->intf);
1368 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1370 usb_autopm_put_interface(data->intf);
1374 static void btusb_stop_traffic(struct btusb_data *data)
1376 usb_kill_anchored_urbs(&data->intr_anchor);
1377 usb_kill_anchored_urbs(&data->bulk_anchor);
1378 usb_kill_anchored_urbs(&data->isoc_anchor);
1379 usb_kill_anchored_urbs(&data->diag_anchor);
1380 usb_kill_anchored_urbs(&data->ctrl_anchor);
1383 static int btusb_close(struct hci_dev *hdev)
1385 struct btusb_data *data = hci_get_drvdata(hdev);
1388 BT_DBG("%s", hdev->name);
1390 cancel_work_sync(&data->work);
1391 cancel_work_sync(&data->waker);
1393 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1394 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
1395 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1396 clear_bit(BTUSB_DIAG_RUNNING, &data->flags);
1398 btusb_stop_traffic(data);
1399 btusb_free_frags(data);
1401 err = usb_autopm_get_interface(data->intf);
1405 data->intf->needs_remote_wakeup = 0;
1407 /* Enable remote wake up for auto-suspend */
1408 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1409 data->intf->needs_remote_wakeup = 1;
1411 usb_autopm_put_interface(data->intf);
1414 usb_scuttle_anchored_urbs(&data->deferred);
1418 static int btusb_flush(struct hci_dev *hdev)
1420 struct btusb_data *data = hci_get_drvdata(hdev);
1422 BT_DBG("%s", hdev->name);
1424 usb_kill_anchored_urbs(&data->tx_anchor);
1425 btusb_free_frags(data);
1430 static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1432 struct btusb_data *data = hci_get_drvdata(hdev);
1433 struct usb_ctrlrequest *dr;
1437 urb = usb_alloc_urb(0, GFP_KERNEL);
1439 return ERR_PTR(-ENOMEM);
1441 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1444 return ERR_PTR(-ENOMEM);
1447 dr->bRequestType = data->cmdreq_type;
1448 dr->bRequest = data->cmdreq;
1451 dr->wLength = __cpu_to_le16(skb->len);
1453 pipe = usb_sndctrlpipe(data->udev, 0x00);
1455 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1456 skb->data, skb->len, btusb_tx_complete, skb);
1458 skb->dev = (void *)hdev;
1463 static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1465 struct btusb_data *data = hci_get_drvdata(hdev);
1469 if (!data->bulk_tx_ep)
1470 return ERR_PTR(-ENODEV);
1472 urb = usb_alloc_urb(0, GFP_KERNEL);
1474 return ERR_PTR(-ENOMEM);
1476 pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1478 usb_fill_bulk_urb(urb, data->udev, pipe,
1479 skb->data, skb->len, btusb_tx_complete, skb);
1481 skb->dev = (void *)hdev;
1486 static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1488 struct btusb_data *data = hci_get_drvdata(hdev);
1492 if (!data->isoc_tx_ep)
1493 return ERR_PTR(-ENODEV);
1495 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1497 return ERR_PTR(-ENOMEM);
1499 pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1501 usb_fill_int_urb(urb, data->udev, pipe,
1502 skb->data, skb->len, btusb_isoc_tx_complete,
1503 skb, data->isoc_tx_ep->bInterval);
1505 urb->transfer_flags = URB_ISO_ASAP;
1507 if (data->isoc_altsetting == 6)
1508 __fill_isoc_descriptor_msbc(urb, skb->len,
1509 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize),
1512 __fill_isoc_descriptor(urb, skb->len,
1513 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1514 skb->dev = (void *)hdev;
1519 static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1521 struct btusb_data *data = hci_get_drvdata(hdev);
1524 usb_anchor_urb(urb, &data->tx_anchor);
1526 err = usb_submit_urb(urb, GFP_KERNEL);
1528 if (err != -EPERM && err != -ENODEV)
1529 bt_dev_err(hdev, "urb %p submission failed (%d)",
1531 kfree(urb->setup_packet);
1532 usb_unanchor_urb(urb);
1534 usb_mark_last_busy(data->udev);
1541 static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1543 struct btusb_data *data = hci_get_drvdata(hdev);
1544 unsigned long flags;
1547 spin_lock_irqsave(&data->txlock, flags);
1548 suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1550 data->tx_in_flight++;
1551 spin_unlock_irqrestore(&data->txlock, flags);
1554 return submit_tx_urb(hdev, urb);
1556 usb_anchor_urb(urb, &data->deferred);
1557 schedule_work(&data->waker);
1563 static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1567 BT_DBG("%s", hdev->name);
1569 switch (hci_skb_pkt_type(skb)) {
1570 case HCI_COMMAND_PKT:
1571 urb = alloc_ctrl_urb(hdev, skb);
1573 return PTR_ERR(urb);
1575 hdev->stat.cmd_tx++;
1576 return submit_or_queue_tx_urb(hdev, urb);
1578 case HCI_ACLDATA_PKT:
1579 urb = alloc_bulk_urb(hdev, skb);
1581 return PTR_ERR(urb);
1583 hdev->stat.acl_tx++;
1584 return submit_or_queue_tx_urb(hdev, urb);
1586 case HCI_SCODATA_PKT:
1587 if (hci_conn_num(hdev, SCO_LINK) < 1)
1590 urb = alloc_isoc_urb(hdev, skb);
1592 return PTR_ERR(urb);
1594 hdev->stat.sco_tx++;
1595 return submit_tx_urb(hdev, urb);
1601 static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1603 struct btusb_data *data = hci_get_drvdata(hdev);
1605 BT_DBG("%s evt %d", hdev->name, evt);
1607 if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1608 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1609 data->air_mode = evt;
1610 schedule_work(&data->work);
1614 static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1616 struct btusb_data *data = hci_get_drvdata(hdev);
1617 struct usb_interface *intf = data->isoc;
1618 struct usb_endpoint_descriptor *ep_desc;
1624 err = usb_set_interface(data->udev, data->isoc_ifnum, altsetting);
1626 bt_dev_err(hdev, "setting interface failed (%d)", -err);
1630 data->isoc_altsetting = altsetting;
1632 data->isoc_tx_ep = NULL;
1633 data->isoc_rx_ep = NULL;
1635 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1636 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1638 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1639 data->isoc_tx_ep = ep_desc;
1643 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1644 data->isoc_rx_ep = ep_desc;
1649 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1650 bt_dev_err(hdev, "invalid SCO descriptors");
1657 static int btusb_switch_alt_setting(struct hci_dev *hdev, int new_alts)
1659 struct btusb_data *data = hci_get_drvdata(hdev);
1662 if (data->isoc_altsetting != new_alts) {
1663 unsigned long flags;
1665 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1666 usb_kill_anchored_urbs(&data->isoc_anchor);
1668 /* When isochronous alternate setting needs to be
1669 * changed, because SCO connection has been added
1670 * or removed, a packet fragment may be left in the
1671 * reassembling state. This could lead to wrongly
1672 * assembled fragments.
1674 * Clear outstanding fragment when selecting a new
1675 * alternate setting.
1677 spin_lock_irqsave(&data->rxlock, flags);
1678 kfree_skb(data->sco_skb);
1679 data->sco_skb = NULL;
1680 spin_unlock_irqrestore(&data->rxlock, flags);
1682 err = __set_isoc_interface(hdev, new_alts);
1687 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1688 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1689 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1691 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1697 static struct usb_host_interface *btusb_find_altsetting(struct btusb_data *data,
1700 struct usb_interface *intf = data->isoc;
1703 BT_DBG("Looking for Alt no :%d", alt);
1708 for (i = 0; i < intf->num_altsetting; i++) {
1709 if (intf->altsetting[i].desc.bAlternateSetting == alt)
1710 return &intf->altsetting[i];
1716 static void btusb_work(struct work_struct *work)
1718 struct btusb_data *data = container_of(work, struct btusb_data, work);
1719 struct hci_dev *hdev = data->hdev;
1723 if (data->sco_num > 0) {
1724 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1725 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1727 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1728 usb_kill_anchored_urbs(&data->isoc_anchor);
1732 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1735 if (data->air_mode == HCI_NOTIFY_ENABLE_SCO_CVSD) {
1736 if (hdev->voice_setting & 0x0020) {
1737 static const int alts[3] = { 2, 4, 5 };
1739 new_alts = alts[data->sco_num - 1];
1741 new_alts = data->sco_num;
1743 } else if (data->air_mode == HCI_NOTIFY_ENABLE_SCO_TRANSP) {
1744 /* Bluetooth USB spec recommends alt 6 (63 bytes), but
1745 * many adapters do not support it. Alt 1 appears to
1746 * work for all adapters that do not have alt 6, and
1747 * which work with WBS at all.
1749 new_alts = btusb_find_altsetting(data, 6) ? 6 : 1;
1752 if (btusb_switch_alt_setting(hdev, new_alts) < 0)
1753 bt_dev_err(hdev, "set USB alt:(%d) failed!", new_alts);
1755 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1756 usb_kill_anchored_urbs(&data->isoc_anchor);
1758 __set_isoc_interface(hdev, 0);
1759 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1760 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1764 static void btusb_waker(struct work_struct *work)
1766 struct btusb_data *data = container_of(work, struct btusb_data, waker);
1769 err = usb_autopm_get_interface(data->intf);
1773 usb_autopm_put_interface(data->intf);
1776 static int btusb_setup_bcm92035(struct hci_dev *hdev)
1778 struct sk_buff *skb;
1781 BT_DBG("%s", hdev->name);
1783 skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1785 bt_dev_err(hdev, "BCM92035 command failed (%ld)", PTR_ERR(skb));
1792 static int btusb_setup_csr(struct hci_dev *hdev)
1794 struct btusb_data *data = hci_get_drvdata(hdev);
1795 u16 bcdDevice = le16_to_cpu(data->udev->descriptor.bcdDevice);
1796 struct hci_rp_read_local_version *rp;
1797 struct sk_buff *skb;
1798 bool is_fake = false;
1801 BT_DBG("%s", hdev->name);
1803 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1806 int err = PTR_ERR(skb);
1807 bt_dev_err(hdev, "CSR: Local version failed (%d)", err);
1811 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1812 bt_dev_err(hdev, "CSR: Local version length mismatch");
1817 rp = (struct hci_rp_read_local_version *)skb->data;
1819 /* Detect a wide host of Chinese controllers that aren't CSR.
1821 * Known fake bcdDevices: 0x0100, 0x0134, 0x1915, 0x2520, 0x7558, 0x8891
1823 * The main thing they have in common is that these are really popular low-cost
1824 * options that support newer Bluetooth versions but rely on heavy VID/PID
1825 * squatting of this poor old Bluetooth 1.1 device. Even sold as such.
1827 * We detect actual CSR devices by checking that the HCI manufacturer code
1828 * is Cambridge Silicon Radio (10) and ensuring that LMP sub-version and
1829 * HCI rev values always match. As they both store the firmware number.
1831 if (le16_to_cpu(rp->manufacturer) != 10 ||
1832 le16_to_cpu(rp->hci_rev) != le16_to_cpu(rp->lmp_subver))
1835 /* Known legit CSR firmware build numbers and their supported BT versions:
1836 * - 1.1 (0x1) -> 0x0073, 0x020d, 0x033c, 0x034e
1837 * - 1.2 (0x2) -> 0x04d9, 0x0529
1838 * - 2.0 (0x3) -> 0x07a6, 0x07ad, 0x0c5c
1839 * - 2.1 (0x4) -> 0x149c, 0x1735, 0x1899 (0x1899 is a BlueCore4-External)
1840 * - 4.0 (0x6) -> 0x1d86, 0x2031, 0x22bb
1842 * e.g. Real CSR dongles with LMP subversion 0x73 are old enough that
1843 * support BT 1.1 only; so it's a dead giveaway when some
1844 * third-party BT 4.0 dongle reuses it.
1846 else if (le16_to_cpu(rp->lmp_subver) <= 0x034e &&
1847 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_1_1)
1850 else if (le16_to_cpu(rp->lmp_subver) <= 0x0529 &&
1851 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_1_2)
1854 else if (le16_to_cpu(rp->lmp_subver) <= 0x0c5c &&
1855 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_2_0)
1858 else if (le16_to_cpu(rp->lmp_subver) <= 0x1899 &&
1859 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_2_1)
1862 else if (le16_to_cpu(rp->lmp_subver) <= 0x22bb &&
1863 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_4_0)
1866 /* Other clones which beat all the above checks */
1867 else if (bcdDevice == 0x0134 &&
1868 le16_to_cpu(rp->lmp_subver) == 0x0c5c &&
1869 le16_to_cpu(rp->hci_ver) == BLUETOOTH_VER_2_0)
1873 bt_dev_warn(hdev, "CSR: Unbranded CSR clone detected; adding workarounds...");
1875 /* Generally these clones have big discrepancies between
1876 * advertised features and what's actually supported.
1877 * Probably will need to be expanded in the future;
1878 * without these the controller will lock up.
1880 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
1881 set_bit(HCI_QUIRK_BROKEN_ERR_DATA_REPORTING, &hdev->quirks);
1883 /* Clear the reset quirk since this is not an actual
1884 * early Bluetooth 1.1 device from CSR.
1886 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1887 clear_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1890 * Special workaround for clones with a Barrot 8041a02 chip,
1891 * these clones are really messed-up:
1892 * 1. Their bulk rx endpoint will never report any data unless
1893 * the device was suspended at least once (yes really).
1894 * 2. They will not wakeup when autosuspended and receiving data
1895 * on their bulk rx endpoint from e.g. a keyboard or mouse
1896 * (IOW remote-wakeup support is broken for the bulk endpoint).
1898 * To fix 1. enable runtime-suspend, force-suspend the
1899 * hci and then wake-it up by disabling runtime-suspend.
1901 * To fix 2. clear the hci's can_wake flag, this way the hci
1902 * will still be autosuspended when it is not open.
1904 if (bcdDevice == 0x8891 &&
1905 le16_to_cpu(rp->lmp_subver) == 0x1012 &&
1906 le16_to_cpu(rp->hci_rev) == 0x0810 &&
1907 le16_to_cpu(rp->hci_ver) == BLUETOOTH_VER_4_0) {
1908 bt_dev_warn(hdev, "CSR: detected a fake CSR dongle using a Barrot 8041a02 chip, this chip is very buggy and may have issues");
1910 pm_runtime_allow(&data->udev->dev);
1912 ret = pm_runtime_suspend(&data->udev->dev);
1916 bt_dev_err(hdev, "Failed to suspend the device for Barrot 8041a02 receive-issue workaround");
1918 pm_runtime_forbid(&data->udev->dev);
1920 device_set_wakeup_capable(&data->udev->dev, false);
1921 /* Re-enable autosuspend if this was requested */
1922 if (enable_autosuspend)
1923 usb_enable_autosuspend(data->udev);
1932 static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1933 struct intel_version *ver)
1935 const struct firmware *fw;
1939 snprintf(fwname, sizeof(fwname),
1940 "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1941 ver->hw_platform, ver->hw_variant, ver->hw_revision,
1942 ver->fw_variant, ver->fw_revision, ver->fw_build_num,
1943 ver->fw_build_ww, ver->fw_build_yy);
1945 ret = request_firmware(&fw, fwname, &hdev->dev);
1947 if (ret == -EINVAL) {
1948 bt_dev_err(hdev, "Intel firmware file request failed (%d)",
1953 bt_dev_err(hdev, "failed to open Intel firmware file: %s (%d)",
1956 /* If the correct firmware patch file is not found, use the
1957 * default firmware patch file instead
1959 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1960 ver->hw_platform, ver->hw_variant);
1961 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1962 bt_dev_err(hdev, "failed to open default fw file: %s",
1968 bt_dev_info(hdev, "Intel Bluetooth firmware file: %s", fwname);
1973 static int btusb_setup_intel_patching(struct hci_dev *hdev,
1974 const struct firmware *fw,
1975 const u8 **fw_ptr, int *disable_patch)
1977 struct sk_buff *skb;
1978 struct hci_command_hdr *cmd;
1979 const u8 *cmd_param;
1980 struct hci_event_hdr *evt = NULL;
1981 const u8 *evt_param = NULL;
1982 int remain = fw->size - (*fw_ptr - fw->data);
1984 /* The first byte indicates the types of the patch command or event.
1985 * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1986 * in the current firmware buffer doesn't start with 0x01 or
1987 * the size of remain buffer is smaller than HCI command header,
1988 * the firmware file is corrupted and it should stop the patching
1991 if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1992 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd read");
1998 cmd = (struct hci_command_hdr *)(*fw_ptr);
1999 *fw_ptr += sizeof(*cmd);
2000 remain -= sizeof(*cmd);
2002 /* Ensure that the remain firmware data is long enough than the length
2003 * of command parameter. If not, the firmware file is corrupted.
2005 if (remain < cmd->plen) {
2006 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd len");
2010 /* If there is a command that loads a patch in the firmware
2011 * file, then enable the patch upon success, otherwise just
2012 * disable the manufacturer mode, for example patch activation
2013 * is not required when the default firmware patch file is used
2014 * because there are no patch data to load.
2016 if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
2019 cmd_param = *fw_ptr;
2020 *fw_ptr += cmd->plen;
2021 remain -= cmd->plen;
2023 /* This reads the expected events when the above command is sent to the
2024 * device. Some vendor commands expects more than one events, for
2025 * example command status event followed by vendor specific event.
2026 * For this case, it only keeps the last expected event. so the command
2027 * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
2028 * last expected event.
2030 while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
2034 evt = (struct hci_event_hdr *)(*fw_ptr);
2035 *fw_ptr += sizeof(*evt);
2036 remain -= sizeof(*evt);
2038 if (remain < evt->plen) {
2039 bt_dev_err(hdev, "Intel fw corrupted: invalid evt len");
2043 evt_param = *fw_ptr;
2044 *fw_ptr += evt->plen;
2045 remain -= evt->plen;
2048 /* Every HCI commands in the firmware file has its correspond event.
2049 * If event is not found or remain is smaller than zero, the firmware
2050 * file is corrupted.
2052 if (!evt || !evt_param || remain < 0) {
2053 bt_dev_err(hdev, "Intel fw corrupted: invalid evt read");
2057 skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
2058 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
2060 bt_dev_err(hdev, "sending Intel patch command (0x%4.4x) failed (%ld)",
2061 cmd->opcode, PTR_ERR(skb));
2062 return PTR_ERR(skb);
2065 /* It ensures that the returned event matches the event data read from
2066 * the firmware file. At fist, it checks the length and then
2067 * the contents of the event.
2069 if (skb->len != evt->plen) {
2070 bt_dev_err(hdev, "mismatch event length (opcode 0x%4.4x)",
2071 le16_to_cpu(cmd->opcode));
2076 if (memcmp(skb->data, evt_param, evt->plen)) {
2077 bt_dev_err(hdev, "mismatch event parameter (opcode 0x%4.4x)",
2078 le16_to_cpu(cmd->opcode));
2087 static int btusb_setup_intel(struct hci_dev *hdev)
2089 struct sk_buff *skb;
2090 const struct firmware *fw;
2092 int disable_patch, err;
2093 struct intel_version ver;
2095 BT_DBG("%s", hdev->name);
2097 /* The controller has a bug with the first HCI command sent to it
2098 * returning number of completed commands as zero. This would stall the
2099 * command processing in the Bluetooth core.
2101 * As a workaround, send HCI Reset command first which will reset the
2102 * number of completed commands and allow normal command processing
2105 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2107 bt_dev_err(hdev, "sending initial HCI reset command failed (%ld)",
2109 return PTR_ERR(skb);
2113 /* Read Intel specific controller version first to allow selection of
2114 * which firmware file to load.
2116 * The returned information are hardware variant and revision plus
2117 * firmware variant, revision and build number.
2119 err = btintel_read_version(hdev, &ver);
2123 bt_dev_info(hdev, "read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
2124 ver.hw_platform, ver.hw_variant, ver.hw_revision,
2125 ver.fw_variant, ver.fw_revision, ver.fw_build_num,
2126 ver.fw_build_ww, ver.fw_build_yy, ver.fw_patch_num);
2128 /* fw_patch_num indicates the version of patch the device currently
2129 * have. If there is no patch data in the device, it is always 0x00.
2130 * So, if it is other than 0x00, no need to patch the device again.
2132 if (ver.fw_patch_num) {
2133 bt_dev_info(hdev, "Intel device is already patched. "
2134 "patch num: %02x", ver.fw_patch_num);
2138 /* Opens the firmware patch file based on the firmware version read
2139 * from the controller. If it fails to open the matching firmware
2140 * patch file, it tries to open the default firmware patch file.
2141 * If no patch file is found, allow the device to operate without
2144 fw = btusb_setup_intel_get_fw(hdev, &ver);
2149 /* Enable the manufacturer mode of the controller.
2150 * Only while this mode is enabled, the driver can download the
2151 * firmware patch data and configuration parameters.
2153 err = btintel_enter_mfg(hdev);
2155 release_firmware(fw);
2161 /* The firmware data file consists of list of Intel specific HCI
2162 * commands and its expected events. The first byte indicates the
2163 * type of the message, either HCI command or HCI event.
2165 * It reads the command and its expected event from the firmware file,
2166 * and send to the controller. Once __hci_cmd_sync_ev() returns,
2167 * the returned event is compared with the event read from the firmware
2168 * file and it will continue until all the messages are downloaded to
2171 * Once the firmware patching is completed successfully,
2172 * the manufacturer mode is disabled with reset and activating the
2175 * If the firmware patching fails, the manufacturer mode is
2176 * disabled with reset and deactivating the patch.
2178 * If the default patch file is used, no reset is done when disabling
2181 while (fw->size > fw_ptr - fw->data) {
2184 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
2187 goto exit_mfg_deactivate;
2190 release_firmware(fw);
2193 goto exit_mfg_disable;
2195 /* Patching completed successfully and disable the manufacturer mode
2196 * with reset and activate the downloaded firmware patches.
2198 err = btintel_exit_mfg(hdev, true, true);
2202 /* Need build number for downloaded fw patches in
2203 * every power-on boot
2205 err = btintel_read_version(hdev, &ver);
2208 bt_dev_info(hdev, "Intel BT fw patch 0x%02x completed & activated",
2214 /* Disable the manufacturer mode without reset */
2215 err = btintel_exit_mfg(hdev, false, false);
2219 bt_dev_info(hdev, "Intel firmware patch completed");
2223 exit_mfg_deactivate:
2224 release_firmware(fw);
2226 /* Patching failed. Disable the manufacturer mode with reset and
2227 * deactivate the downloaded firmware patches.
2229 err = btintel_exit_mfg(hdev, true, false);
2233 bt_dev_info(hdev, "Intel firmware patch completed and deactivated");
2236 /* Set the event mask for Intel specific vendor events. This enables
2237 * a few extra events that are useful during general operation.
2239 btintel_set_event_mask_mfg(hdev, false);
2241 btintel_check_bdaddr(hdev);
2245 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
2247 struct sk_buff *skb;
2248 struct hci_event_hdr *hdr;
2249 struct hci_ev_cmd_complete *evt;
2251 skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_KERNEL);
2255 hdr = skb_put(skb, sizeof(*hdr));
2256 hdr->evt = HCI_EV_CMD_COMPLETE;
2257 hdr->plen = sizeof(*evt) + 1;
2259 evt = skb_put(skb, sizeof(*evt));
2261 evt->opcode = cpu_to_le16(opcode);
2263 skb_put_u8(skb, 0x00);
2265 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
2267 return hci_recv_frame(hdev, skb);
2270 static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
2273 /* When the device is in bootloader mode, then it can send
2274 * events via the bulk endpoint. These events are treated the
2275 * same way as the ones received from the interrupt endpoint.
2277 if (test_bit(BTUSB_BOOTLOADER, &data->flags))
2278 return btusb_recv_intr(data, buffer, count);
2280 return btusb_recv_bulk(data, buffer, count);
2283 static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
2286 const struct intel_bootup *evt = ptr;
2288 if (len != sizeof(*evt))
2291 if (test_and_clear_bit(BTUSB_BOOTING, &data->flags))
2292 wake_up_bit(&data->flags, BTUSB_BOOTING);
2295 static void btusb_intel_secure_send_result(struct btusb_data *data,
2296 const void *ptr, unsigned int len)
2298 const struct intel_secure_send_result *evt = ptr;
2300 if (len != sizeof(*evt))
2304 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
2306 if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
2307 test_bit(BTUSB_FIRMWARE_LOADED, &data->flags))
2308 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
2311 static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
2313 struct btusb_data *data = hci_get_drvdata(hdev);
2315 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2316 struct hci_event_hdr *hdr = (void *)skb->data;
2318 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
2320 const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
2321 unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
2323 switch (skb->data[2]) {
2325 /* When switching to the operational firmware
2326 * the device sends a vendor specific event
2327 * indicating that the bootup completed.
2329 btusb_intel_bootup(data, ptr, len);
2332 /* When the firmware loading completes the
2333 * device sends out a vendor specific event
2334 * indicating the result of the firmware
2337 btusb_intel_secure_send_result(data, ptr, len);
2343 return hci_recv_frame(hdev, skb);
2346 static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
2348 struct btusb_data *data = hci_get_drvdata(hdev);
2351 BT_DBG("%s", hdev->name);
2353 switch (hci_skb_pkt_type(skb)) {
2354 case HCI_COMMAND_PKT:
2355 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2356 struct hci_command_hdr *cmd = (void *)skb->data;
2357 __u16 opcode = le16_to_cpu(cmd->opcode);
2359 /* When in bootloader mode and the command 0xfc09
2360 * is received, it needs to be send down the
2361 * bulk endpoint. So allocate a bulk URB instead.
2363 if (opcode == 0xfc09)
2364 urb = alloc_bulk_urb(hdev, skb);
2366 urb = alloc_ctrl_urb(hdev, skb);
2368 /* When the 0xfc01 command is issued to boot into
2369 * the operational firmware, it will actually not
2370 * send a command complete event. To keep the flow
2371 * control working inject that event here.
2373 if (opcode == 0xfc01)
2374 inject_cmd_complete(hdev, opcode);
2376 urb = alloc_ctrl_urb(hdev, skb);
2379 return PTR_ERR(urb);
2381 hdev->stat.cmd_tx++;
2382 return submit_or_queue_tx_urb(hdev, urb);
2384 case HCI_ACLDATA_PKT:
2385 urb = alloc_bulk_urb(hdev, skb);
2387 return PTR_ERR(urb);
2389 hdev->stat.acl_tx++;
2390 return submit_or_queue_tx_urb(hdev, urb);
2392 case HCI_SCODATA_PKT:
2393 if (hci_conn_num(hdev, SCO_LINK) < 1)
2396 urb = alloc_isoc_urb(hdev, skb);
2398 return PTR_ERR(urb);
2400 hdev->stat.sco_tx++;
2401 return submit_tx_urb(hdev, urb);
2407 static int btusb_setup_intel_new_get_fw_name(struct intel_version *ver,
2408 struct intel_boot_params *params,
2409 char *fw_name, size_t len,
2412 switch (ver->hw_variant) {
2413 case 0x0b: /* SfP */
2414 case 0x0c: /* WsP */
2415 snprintf(fw_name, len, "intel/ibt-%u-%u.%s",
2416 le16_to_cpu(ver->hw_variant),
2417 le16_to_cpu(params->dev_revid),
2420 case 0x11: /* JfP */
2421 case 0x12: /* ThP */
2422 case 0x13: /* HrP */
2423 case 0x14: /* CcP */
2424 snprintf(fw_name, len, "intel/ibt-%u-%u-%u.%s",
2425 le16_to_cpu(ver->hw_variant),
2426 le16_to_cpu(ver->hw_revision),
2427 le16_to_cpu(ver->fw_revision),
2437 static void btusb_setup_intel_newgen_get_fw_name(const struct intel_version_tlv *ver_tlv,
2438 char *fw_name, size_t len,
2441 /* The firmware file name for new generation controllers will be
2442 * ibt-<cnvi_top type+cnvi_top step>-<cnvr_top type+cnvr_top step>
2444 snprintf(fw_name, len, "intel/ibt-%04x-%04x.%s",
2445 INTEL_CNVX_TOP_PACK_SWAB(INTEL_CNVX_TOP_TYPE(ver_tlv->cnvi_top),
2446 INTEL_CNVX_TOP_STEP(ver_tlv->cnvi_top)),
2447 INTEL_CNVX_TOP_PACK_SWAB(INTEL_CNVX_TOP_TYPE(ver_tlv->cnvr_top),
2448 INTEL_CNVX_TOP_STEP(ver_tlv->cnvr_top)),
2452 static int btusb_download_wait(struct hci_dev *hdev, ktime_t calltime, int msec)
2454 struct btusb_data *data = hci_get_drvdata(hdev);
2455 ktime_t delta, rettime;
2456 unsigned long long duration;
2459 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2461 bt_dev_info(hdev, "Waiting for firmware download to complete");
2463 err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2465 msecs_to_jiffies(msec));
2466 if (err == -EINTR) {
2467 bt_dev_err(hdev, "Firmware loading interrupted");
2472 bt_dev_err(hdev, "Firmware loading timeout");
2476 if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2477 bt_dev_err(hdev, "Firmware loading failed");
2481 rettime = ktime_get();
2482 delta = ktime_sub(rettime, calltime);
2483 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
2485 bt_dev_info(hdev, "Firmware loaded in %llu usecs", duration);
2490 static int btusb_intel_download_firmware_newgen(struct hci_dev *hdev,
2491 struct intel_version_tlv *ver,
2494 const struct firmware *fw;
2497 struct btusb_data *data = hci_get_drvdata(hdev);
2500 if (!ver || !boot_param)
2503 /* The firmware variant determines if the device is in bootloader
2504 * mode or is running operational firmware. The value 0x03 identifies
2505 * the bootloader and the value 0x23 identifies the operational
2508 * When the operational firmware is already present, then only
2509 * the check for valid Bluetooth device address is needed. This
2510 * determines if the device will be added as configured or
2511 * unconfigured controller.
2513 * It is not possible to use the Secure Boot Parameters in this
2514 * case since that command is only available in bootloader mode.
2516 if (ver->img_type == 0x03) {
2517 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2518 btintel_check_bdaddr(hdev);
2521 /* If the OTP has no valid Bluetooth device address, then there will
2522 * also be no valid address for the operational firmware.
2524 if (!bacmp(&ver->otp_bd_addr, BDADDR_ANY)) {
2525 bt_dev_info(hdev, "No device address configured");
2526 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2529 btusb_setup_intel_newgen_get_fw_name(ver, fwname, sizeof(fwname), "sfi");
2530 err = request_firmware(&fw, fwname, &hdev->dev);
2532 bt_dev_err(hdev, "Failed to load Intel firmware file %s (%d)",
2537 bt_dev_info(hdev, "Found device firmware: %s", fwname);
2539 if (fw->size < 644) {
2540 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
2546 calltime = ktime_get();
2548 set_bit(BTUSB_DOWNLOADING, &data->flags);
2550 /* Start firmware downloading and get boot parameter */
2551 err = btintel_download_firmware_newgen(hdev, ver, fw, boot_param,
2552 INTEL_HW_VARIANT(ver->cnvi_bt),
2555 if (err == -EALREADY) {
2556 /* Firmware has already been loaded */
2557 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2562 /* When FW download fails, send Intel Reset to retry
2565 btintel_reset_to_bootloader(hdev);
2569 /* Before switching the device into operational mode and with that
2570 * booting the loaded firmware, wait for the bootloader notification
2571 * that all fragments have been successfully received.
2573 * When the event processing receives the notification, then the
2574 * BTUSB_DOWNLOADING flag will be cleared.
2576 * The firmware loading should not take longer than 5 seconds
2577 * and thus just timeout if that happens and fail the setup
2580 err = btusb_download_wait(hdev, calltime, 5000);
2581 if (err == -ETIMEDOUT)
2582 btintel_reset_to_bootloader(hdev);
2585 release_firmware(fw);
2589 static int btusb_intel_download_firmware(struct hci_dev *hdev,
2590 struct intel_version *ver,
2591 struct intel_boot_params *params,
2594 const struct firmware *fw;
2597 struct btusb_data *data = hci_get_drvdata(hdev);
2600 if (!ver || !params)
2603 /* The firmware variant determines if the device is in bootloader
2604 * mode or is running operational firmware. The value 0x06 identifies
2605 * the bootloader and the value 0x23 identifies the operational
2608 * When the operational firmware is already present, then only
2609 * the check for valid Bluetooth device address is needed. This
2610 * determines if the device will be added as configured or
2611 * unconfigured controller.
2613 * It is not possible to use the Secure Boot Parameters in this
2614 * case since that command is only available in bootloader mode.
2616 if (ver->fw_variant == 0x23) {
2617 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2618 btintel_check_bdaddr(hdev);
2620 /* SfP and WsP don't seem to update the firmware version on file
2621 * so version checking is currently possible.
2623 switch (ver->hw_variant) {
2624 case 0x0b: /* SfP */
2625 case 0x0c: /* WsP */
2629 /* Proceed to download to check if the version matches */
2633 /* Read the secure boot parameters to identify the operating
2634 * details of the bootloader.
2636 err = btintel_read_boot_params(hdev, params);
2640 /* It is required that every single firmware fragment is acknowledged
2641 * with a command complete event. If the boot parameters indicate
2642 * that this bootloader does not send them, then abort the setup.
2644 if (params->limited_cce != 0x00) {
2645 bt_dev_err(hdev, "Unsupported Intel firmware loading method (%u)",
2646 params->limited_cce);
2650 /* If the OTP has no valid Bluetooth device address, then there will
2651 * also be no valid address for the operational firmware.
2653 if (!bacmp(¶ms->otp_bdaddr, BDADDR_ANY)) {
2654 bt_dev_info(hdev, "No device address configured");
2655 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2659 /* With this Intel bootloader only the hardware variant and device
2660 * revision information are used to select the right firmware for SfP
2663 * The firmware filename is ibt-<hw_variant>-<dev_revid>.sfi.
2665 * Currently the supported hardware variants are:
2666 * 11 (0x0b) for iBT3.0 (LnP/SfP)
2667 * 12 (0x0c) for iBT3.5 (WsP)
2669 * For ThP/JfP and for future SKU's, the FW name varies based on HW
2670 * variant, HW revision and FW revision, as these are dependent on CNVi
2671 * and RF Combination.
2673 * 17 (0x11) for iBT3.5 (JfP)
2674 * 18 (0x12) for iBT3.5 (ThP)
2676 * The firmware file name for these will be
2677 * ibt-<hw_variant>-<hw_revision>-<fw_revision>.sfi.
2680 err = btusb_setup_intel_new_get_fw_name(ver, params, fwname,
2681 sizeof(fwname), "sfi");
2683 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2687 err = request_firmware(&fw, fwname, &hdev->dev);
2689 bt_dev_err(hdev, "Failed to load Intel firmware file %s (%d)",
2694 bt_dev_info(hdev, "Found device firmware: %s", fwname);
2696 if (fw->size < 644) {
2697 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
2703 calltime = ktime_get();
2705 set_bit(BTUSB_DOWNLOADING, &data->flags);
2707 /* Start firmware downloading and get boot parameter */
2708 err = btintel_download_firmware(hdev, ver, fw, boot_param);
2710 if (err == -EALREADY) {
2711 /* Firmware has already been loaded */
2712 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2717 /* When FW download fails, send Intel Reset to retry
2720 btintel_reset_to_bootloader(hdev);
2724 /* Before switching the device into operational mode and with that
2725 * booting the loaded firmware, wait for the bootloader notification
2726 * that all fragments have been successfully received.
2728 * When the event processing receives the notification, then the
2729 * BTUSB_DOWNLOADING flag will be cleared.
2731 * The firmware loading should not take longer than 5 seconds
2732 * and thus just timeout if that happens and fail the setup
2735 err = btusb_download_wait(hdev, calltime, 5000);
2736 if (err == -ETIMEDOUT)
2737 btintel_reset_to_bootloader(hdev);
2740 release_firmware(fw);
2744 static int btusb_boot_wait(struct hci_dev *hdev, ktime_t calltime, int msec)
2746 struct btusb_data *data = hci_get_drvdata(hdev);
2747 ktime_t delta, rettime;
2748 unsigned long long duration;
2751 bt_dev_info(hdev, "Waiting for device to boot");
2753 err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2755 msecs_to_jiffies(msec));
2756 if (err == -EINTR) {
2757 bt_dev_err(hdev, "Device boot interrupted");
2762 bt_dev_err(hdev, "Device boot timeout");
2766 rettime = ktime_get();
2767 delta = ktime_sub(rettime, calltime);
2768 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2770 bt_dev_info(hdev, "Device booted in %llu usecs", duration);
2775 static int btusb_intel_boot(struct hci_dev *hdev, u32 boot_addr)
2777 struct btusb_data *data = hci_get_drvdata(hdev);
2781 calltime = ktime_get();
2783 set_bit(BTUSB_BOOTING, &data->flags);
2785 err = btintel_send_intel_reset(hdev, boot_addr);
2787 bt_dev_err(hdev, "Intel Soft Reset failed (%d)", err);
2788 btintel_reset_to_bootloader(hdev);
2792 /* The bootloader will not indicate when the device is ready. This
2793 * is done by the operational firmware sending bootup notification.
2795 * Booting into operational firmware should not take longer than
2796 * 1 second. However if that happens, then just fail the setup
2797 * since something went wrong.
2799 err = btusb_boot_wait(hdev, calltime, 1000);
2800 if (err == -ETIMEDOUT)
2801 btintel_reset_to_bootloader(hdev);
2806 static int btusb_setup_intel_new(struct hci_dev *hdev)
2808 struct btusb_data *data = hci_get_drvdata(hdev);
2809 struct intel_version ver;
2810 struct intel_boot_params params;
2814 struct intel_debug_features features;
2816 BT_DBG("%s", hdev->name);
2818 /* Set the default boot parameter to 0x0 and it is updated to
2819 * SKU specific boot parameter after reading Intel_Write_Boot_Params
2820 * command while downloading the firmware.
2822 boot_param = 0x00000000;
2824 /* Read the Intel version information to determine if the device
2825 * is in bootloader mode or if it already has operational firmware
2828 err = btintel_read_version(hdev, &ver);
2830 bt_dev_err(hdev, "Intel Read version failed (%d)", err);
2831 btintel_reset_to_bootloader(hdev);
2835 err = btintel_version_info(hdev, &ver);
2839 err = btusb_intel_download_firmware(hdev, &ver, ¶ms, &boot_param);
2843 /* controller is already having an operational firmware */
2844 if (ver.fw_variant == 0x23)
2847 err = btusb_intel_boot(hdev, boot_param);
2851 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2853 err = btusb_setup_intel_new_get_fw_name(&ver, ¶ms, ddcname,
2854 sizeof(ddcname), "ddc");
2857 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2859 /* Once the device is running in operational mode, it needs to
2860 * apply the device configuration (DDC) parameters.
2862 * The device can work without DDC parameters, so even if it
2863 * fails to load the file, no need to fail the setup.
2865 btintel_load_ddc_config(hdev, ddcname);
2868 /* Read the Intel supported features and if new exception formats
2869 * supported, need to load the additional DDC config to enable.
2871 btintel_read_debug_features(hdev, &features);
2873 /* Set DDC mask for available debug features */
2874 btintel_set_debug_features(hdev, &features);
2876 /* Read the Intel version information after loading the FW */
2877 err = btintel_read_version(hdev, &ver);
2881 btintel_version_info(hdev, &ver);
2884 /* All Intel controllers that support the Microsoft vendor
2885 * extension are using 0xFC1E for VsMsftOpCode.
2887 switch (ver.hw_variant) {
2888 case 0x11: /* JfP */
2889 case 0x12: /* ThP */
2890 case 0x13: /* HrP */
2891 case 0x14: /* CcP */
2892 hci_set_msft_opcode(hdev, 0xFC1E);
2896 /* Set the event mask for Intel specific vendor events. This enables
2897 * a few extra events that are useful during general operation. It
2898 * does not enable any debugging related events.
2900 * The device will function correctly without these events enabled
2901 * and thus no need to fail the setup.
2903 btintel_set_event_mask(hdev, false);
2908 static int btusb_setup_intel_newgen(struct hci_dev *hdev)
2910 struct btusb_data *data = hci_get_drvdata(hdev);
2914 struct intel_debug_features features;
2915 struct intel_version_tlv version;
2917 bt_dev_dbg(hdev, "");
2919 /* Set the default boot parameter to 0x0 and it is updated to
2920 * SKU specific boot parameter after reading Intel_Write_Boot_Params
2921 * command while downloading the firmware.
2923 boot_param = 0x00000000;
2925 /* Read the Intel version information to determine if the device
2926 * is in bootloader mode or if it already has operational firmware
2929 err = btintel_read_version_tlv(hdev, &version);
2931 bt_dev_err(hdev, "Intel Read version failed (%d)", err);
2932 btintel_reset_to_bootloader(hdev);
2936 err = btintel_version_info_tlv(hdev, &version);
2940 err = btusb_intel_download_firmware_newgen(hdev, &version, &boot_param);
2944 /* check if controller is already having an operational firmware */
2945 if (version.img_type == 0x03)
2948 err = btusb_intel_boot(hdev, boot_param);
2952 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2954 btusb_setup_intel_newgen_get_fw_name(&version, ddcname, sizeof(ddcname),
2956 /* Once the device is running in operational mode, it needs to
2957 * apply the device configuration (DDC) parameters.
2959 * The device can work without DDC parameters, so even if it
2960 * fails to load the file, no need to fail the setup.
2962 btintel_load_ddc_config(hdev, ddcname);
2964 /* Read the Intel supported features and if new exception formats
2965 * supported, need to load the additional DDC config to enable.
2967 btintel_read_debug_features(hdev, &features);
2969 /* Set DDC mask for available debug features */
2970 btintel_set_debug_features(hdev, &features);
2972 /* Read the Intel version information after loading the FW */
2973 err = btintel_read_version_tlv(hdev, &version);
2977 btintel_version_info_tlv(hdev, &version);
2980 /* Set the event mask for Intel specific vendor events. This enables
2981 * a few extra events that are useful during general operation. It
2982 * does not enable any debugging related events.
2984 * The device will function correctly without these events enabled
2985 * and thus no need to fail the setup.
2987 btintel_set_event_mask(hdev, false);
2991 static int btusb_shutdown_intel(struct hci_dev *hdev)
2993 struct sk_buff *skb;
2996 /* In the shutdown sequence where Bluetooth is turned off followed
2997 * by WiFi being turned off, turning WiFi back on causes issue with
2998 * the RF calibration.
3000 * To ensure that any RF activity has been stopped, issue HCI Reset
3001 * command to clear all ongoing activity including advertising,
3004 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
3007 bt_dev_err(hdev, "HCI reset during shutdown failed");
3012 /* Some platforms have an issue with BT LED when the interface is
3013 * down or BT radio is turned off, which takes 5 seconds to BT LED
3014 * goes off. This command turns off the BT LED immediately.
3016 skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
3019 bt_dev_err(hdev, "turning off Intel device LED failed");
3027 static int btusb_shutdown_intel_new(struct hci_dev *hdev)
3029 struct sk_buff *skb;
3031 /* Send HCI Reset to the controller to stop any BT activity which
3032 * were triggered. This will help to save power and maintain the
3033 * sync b/w Host and controller
3035 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
3037 bt_dev_err(hdev, "HCI reset during shutdown failed");
3038 return PTR_ERR(skb);
3045 #define FIRMWARE_MT7663 "mediatek/mt7663pr2h.bin"
3046 #define FIRMWARE_MT7668 "mediatek/mt7668pr2h.bin"
3048 #define HCI_WMT_MAX_EVENT_SIZE 64
3049 /* It is for mt79xx download rom patch*/
3050 #define MTK_FW_ROM_PATCH_HEADER_SIZE 32
3051 #define MTK_FW_ROM_PATCH_GD_SIZE 64
3052 #define MTK_FW_ROM_PATCH_SEC_MAP_SIZE 64
3053 #define MTK_SEC_MAP_COMMON_SIZE 12
3054 #define MTK_SEC_MAP_NEED_SEND_SIZE 52
3057 BTMTK_WMT_PATCH_DWNLD = 0x1,
3058 BTMTK_WMT_FUNC_CTRL = 0x6,
3059 BTMTK_WMT_RST = 0x7,
3060 BTMTK_WMT_SEMAPHORE = 0x17,
3065 BTMTK_WMT_PATCH_UNDONE,
3066 BTMTK_WMT_PATCH_PROGRESS,
3067 BTMTK_WMT_PATCH_DONE,
3068 BTMTK_WMT_ON_UNDONE,
3070 BTMTK_WMT_ON_PROGRESS,
3073 struct btmtk_wmt_hdr {
3080 struct btmtk_hci_wmt_cmd {
3081 struct btmtk_wmt_hdr hdr;
3085 struct btmtk_hci_wmt_evt {
3086 struct hci_event_hdr hhdr;
3087 struct btmtk_wmt_hdr whdr;
3090 struct btmtk_hci_wmt_evt_funcc {
3091 struct btmtk_hci_wmt_evt hwhdr;
3095 struct btmtk_tci_sleep {
3098 __le16 host_duration;
3100 u8 time_compensation;
3103 struct btmtk_hci_wmt_params {
3111 struct btmtk_patch_header {
3119 struct btmtk_global_desc {
3126 struct btmtk_section_map {
3131 __le32 u4SecSpec[13];
3138 __le32 dlmodecrctype;
3145 static void btusb_mtk_wmt_recv(struct urb *urb)
3147 struct hci_dev *hdev = urb->context;
3148 struct btusb_data *data = hci_get_drvdata(hdev);
3149 struct hci_event_hdr *hdr;
3150 struct sk_buff *skb;
3153 if (urb->status == 0 && urb->actual_length > 0) {
3154 hdev->stat.byte_rx += urb->actual_length;
3156 /* WMT event shouldn't be fragmented and the size should be
3157 * less than HCI_WMT_MAX_EVENT_SIZE.
3159 skb = bt_skb_alloc(HCI_WMT_MAX_EVENT_SIZE, GFP_ATOMIC);
3161 hdev->stat.err_rx++;
3165 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
3166 skb_put_data(skb, urb->transfer_buffer, urb->actual_length);
3168 hdr = (void *)skb->data;
3169 /* Fix up the vendor event id with 0xff for vendor specific
3170 * instead of 0xe4 so that event send via monitoring socket can
3171 * be parsed properly.
3175 /* When someone waits for the WMT event, the skb is being cloned
3176 * and being processed the events from there then.
3178 if (test_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags)) {
3179 data->evt_skb = skb_clone(skb, GFP_ATOMIC);
3180 if (!data->evt_skb) {
3186 err = hci_recv_frame(hdev, skb);
3188 kfree_skb(data->evt_skb);
3189 data->evt_skb = NULL;
3193 if (test_and_clear_bit(BTUSB_TX_WAIT_VND_EVT,
3195 /* Barrier to sync with other CPUs */
3196 smp_mb__after_atomic();
3197 wake_up_bit(&data->flags,
3198 BTUSB_TX_WAIT_VND_EVT);
3201 } else if (urb->status == -ENOENT) {
3202 /* Avoid suspend failed when usb_kill_urb */
3206 usb_mark_last_busy(data->udev);
3208 /* The URB complete handler is still called with urb->actual_length = 0
3209 * when the event is not available, so we should keep re-submitting
3210 * URB until WMT event returns, Also, It's necessary to wait some time
3211 * between the two consecutive control URBs to relax the target device
3212 * to generate the event. Otherwise, the WMT event cannot return from
3213 * the device successfully.
3217 usb_anchor_urb(urb, &data->ctrl_anchor);
3218 err = usb_submit_urb(urb, GFP_ATOMIC);
3220 /* -EPERM: urb is being killed;
3221 * -ENODEV: device got disconnected
3223 if (err != -EPERM && err != -ENODEV)
3224 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
3226 usb_unanchor_urb(urb);
3230 static int btusb_mtk_submit_wmt_recv_urb(struct hci_dev *hdev)
3232 struct btusb_data *data = hci_get_drvdata(hdev);
3233 struct usb_ctrlrequest *dr;
3239 urb = usb_alloc_urb(0, GFP_KERNEL);
3243 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
3249 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_IN;
3251 dr->wIndex = cpu_to_le16(0);
3252 dr->wValue = cpu_to_le16(48);
3253 dr->wLength = cpu_to_le16(size);
3255 buf = kmalloc(size, GFP_KERNEL);
3262 pipe = usb_rcvctrlpipe(data->udev, 0);
3264 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
3265 buf, size, btusb_mtk_wmt_recv, hdev);
3267 urb->transfer_flags |= URB_FREE_BUFFER;
3269 usb_anchor_urb(urb, &data->ctrl_anchor);
3270 err = usb_submit_urb(urb, GFP_KERNEL);
3272 if (err != -EPERM && err != -ENODEV)
3273 bt_dev_err(hdev, "urb %p submission failed (%d)",
3275 usb_unanchor_urb(urb);
3283 static int btusb_mtk_hci_wmt_sync(struct hci_dev *hdev,
3284 struct btmtk_hci_wmt_params *wmt_params)
3286 struct btusb_data *data = hci_get_drvdata(hdev);
3287 struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
3288 u32 hlen, status = BTMTK_WMT_INVALID;
3289 struct btmtk_hci_wmt_evt *wmt_evt;
3290 struct btmtk_hci_wmt_cmd *wc;
3291 struct btmtk_wmt_hdr *hdr;
3294 /* Submit control IN URB on demand to process the WMT event */
3295 err = btusb_mtk_submit_wmt_recv_urb(hdev);
3299 /* Send the WMT command and wait until the WMT event returns */
3300 hlen = sizeof(*hdr) + wmt_params->dlen;
3304 wc = kzalloc(hlen, GFP_KERNEL);
3310 hdr->op = wmt_params->op;
3311 hdr->dlen = cpu_to_le16(wmt_params->dlen + 1);
3312 hdr->flag = wmt_params->flag;
3313 memcpy(wc->data, wmt_params->data, wmt_params->dlen);
3315 set_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
3317 err = __hci_cmd_send(hdev, 0xfc6f, hlen, wc);
3320 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
3324 /* The vendor specific WMT commands are all answered by a vendor
3325 * specific event and will have the Command Status or Command
3326 * Complete as with usual HCI command flow control.
3328 * After sending the command, wait for BTUSB_TX_WAIT_VND_EVT
3329 * state to be cleared. The driver specific event receive routine
3330 * will clear that state and with that indicate completion of the
3333 err = wait_on_bit_timeout(&data->flags, BTUSB_TX_WAIT_VND_EVT,
3334 TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
3335 if (err == -EINTR) {
3336 bt_dev_err(hdev, "Execution of wmt command interrupted");
3337 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
3342 bt_dev_err(hdev, "Execution of wmt command timed out");
3343 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
3348 /* Parse and handle the return WMT event */
3349 wmt_evt = (struct btmtk_hci_wmt_evt *)data->evt_skb->data;
3350 if (wmt_evt->whdr.op != hdr->op) {
3351 bt_dev_err(hdev, "Wrong op received %d expected %d",
3352 wmt_evt->whdr.op, hdr->op);
3357 switch (wmt_evt->whdr.op) {
3358 case BTMTK_WMT_SEMAPHORE:
3359 if (wmt_evt->whdr.flag == 2)
3360 status = BTMTK_WMT_PATCH_UNDONE;
3362 status = BTMTK_WMT_PATCH_DONE;
3364 case BTMTK_WMT_FUNC_CTRL:
3365 wmt_evt_funcc = (struct btmtk_hci_wmt_evt_funcc *)wmt_evt;
3366 if (be16_to_cpu(wmt_evt_funcc->status) == 0x404)
3367 status = BTMTK_WMT_ON_DONE;
3368 else if (be16_to_cpu(wmt_evt_funcc->status) == 0x420)
3369 status = BTMTK_WMT_ON_PROGRESS;
3371 status = BTMTK_WMT_ON_UNDONE;
3373 case BTMTK_WMT_PATCH_DWNLD:
3374 if (wmt_evt->whdr.flag == 2)
3375 status = BTMTK_WMT_PATCH_DONE;
3376 else if (wmt_evt->whdr.flag == 1)
3377 status = BTMTK_WMT_PATCH_PROGRESS;
3379 status = BTMTK_WMT_PATCH_UNDONE;
3383 if (wmt_params->status)
3384 *wmt_params->status = status;
3387 kfree_skb(data->evt_skb);
3388 data->evt_skb = NULL;
3394 static int btusb_mtk_setup_firmware_79xx(struct hci_dev *hdev, const char *fwname)
3396 struct btmtk_hci_wmt_params wmt_params;
3397 struct btmtk_global_desc *globaldesc = NULL;
3398 struct btmtk_section_map *sectionmap;
3399 const struct firmware *fw;
3401 const u8 *fw_bin_ptr;
3402 int err, dlen, i, status;
3403 u8 flag, first_block, retry;
3404 u32 section_num, dl_size, section_offset;
3407 err = request_firmware(&fw, fwname, &hdev->dev);
3409 bt_dev_err(hdev, "Failed to load firmware file (%d)", err);
3414 fw_bin_ptr = fw_ptr;
3415 globaldesc = (struct btmtk_global_desc *)(fw_ptr + MTK_FW_ROM_PATCH_HEADER_SIZE);
3416 section_num = le32_to_cpu(globaldesc->section_num);
3418 for (i = 0; i < section_num; i++) {
3420 fw_ptr = fw_bin_ptr;
3421 sectionmap = (struct btmtk_section_map *)(fw_ptr + MTK_FW_ROM_PATCH_HEADER_SIZE +
3422 MTK_FW_ROM_PATCH_GD_SIZE + MTK_FW_ROM_PATCH_SEC_MAP_SIZE * i);
3424 section_offset = le32_to_cpu(sectionmap->secoffset);
3425 dl_size = le32_to_cpu(sectionmap->bin_info_spec.dlsize);
3430 cmd[0] = 0; /* 0 means legacy dl mode. */
3432 fw_ptr + MTK_FW_ROM_PATCH_HEADER_SIZE +
3433 MTK_FW_ROM_PATCH_GD_SIZE + MTK_FW_ROM_PATCH_SEC_MAP_SIZE * i +
3434 MTK_SEC_MAP_COMMON_SIZE,
3435 MTK_SEC_MAP_NEED_SEND_SIZE + 1);
3437 wmt_params.op = BTMTK_WMT_PATCH_DWNLD;
3438 wmt_params.status = &status;
3439 wmt_params.flag = 0;
3440 wmt_params.dlen = MTK_SEC_MAP_NEED_SEND_SIZE + 1;
3441 wmt_params.data = &cmd;
3443 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3445 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
3447 goto err_release_fw;
3450 if (status == BTMTK_WMT_PATCH_UNDONE) {
3452 } else if (status == BTMTK_WMT_PATCH_PROGRESS) {
3455 } else if (status == BTMTK_WMT_PATCH_DONE) {
3458 bt_dev_err(hdev, "Failed wmt patch dwnld status (%d)",
3460 goto err_release_fw;
3464 fw_ptr += section_offset;
3465 wmt_params.op = BTMTK_WMT_PATCH_DWNLD;
3466 wmt_params.status = NULL;
3468 while (dl_size > 0) {
3469 dlen = min_t(int, 250, dl_size);
3470 if (first_block == 1) {
3473 } else if (dl_size - dlen <= 0) {
3479 wmt_params.flag = flag;
3480 wmt_params.dlen = dlen;
3481 wmt_params.data = fw_ptr;
3483 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3485 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
3487 goto err_release_fw;
3497 /* Wait a few moments for firmware activation done */
3498 usleep_range(100000, 120000);
3501 release_firmware(fw);
3506 static int btusb_mtk_setup_firmware(struct hci_dev *hdev, const char *fwname)
3508 struct btmtk_hci_wmt_params wmt_params;
3509 const struct firmware *fw;
3515 err = request_firmware(&fw, fwname, &hdev->dev);
3517 bt_dev_err(hdev, "Failed to load firmware file (%d)", err);
3521 /* Power on data RAM the firmware relies on. */
3523 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3524 wmt_params.flag = 3;
3525 wmt_params.dlen = sizeof(param);
3526 wmt_params.data = ¶m;
3527 wmt_params.status = NULL;
3529 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3531 bt_dev_err(hdev, "Failed to power on data RAM (%d)", err);
3532 goto err_release_fw;
3538 /* The size of patch header is 30 bytes, should be skip */
3541 goto err_release_fw;
3548 wmt_params.op = BTMTK_WMT_PATCH_DWNLD;
3549 wmt_params.status = NULL;
3551 while (fw_size > 0) {
3552 dlen = min_t(int, 250, fw_size);
3554 /* Tell device the position in sequence */
3555 if (fw_size - dlen <= 0)
3557 else if (fw_size < fw->size - 30)
3560 wmt_params.flag = flag;
3561 wmt_params.dlen = dlen;
3562 wmt_params.data = fw_ptr;
3564 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3566 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
3568 goto err_release_fw;
3575 wmt_params.op = BTMTK_WMT_RST;
3576 wmt_params.flag = 4;
3577 wmt_params.dlen = 0;
3578 wmt_params.data = NULL;
3579 wmt_params.status = NULL;
3581 /* Activate funciton the firmware providing to */
3582 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3584 bt_dev_err(hdev, "Failed to send wmt rst (%d)", err);
3585 goto err_release_fw;
3588 /* Wait a few moments for firmware activation done */
3589 usleep_range(10000, 12000);
3592 release_firmware(fw);
3597 static int btusb_mtk_func_query(struct hci_dev *hdev)
3599 struct btmtk_hci_wmt_params wmt_params;
3603 /* Query whether the function is enabled */
3604 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3605 wmt_params.flag = 4;
3606 wmt_params.dlen = sizeof(param);
3607 wmt_params.data = ¶m;
3608 wmt_params.status = &status;
3610 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3612 bt_dev_err(hdev, "Failed to query function status (%d)", err);
3619 static int btusb_mtk_reg_read(struct btusb_data *data, u32 reg, u32 *val)
3621 int pipe, err, size = sizeof(u32);
3624 buf = kzalloc(size, GFP_KERNEL);
3628 pipe = usb_rcvctrlpipe(data->udev, 0);
3629 err = usb_control_msg(data->udev, pipe, 0x63,
3630 USB_TYPE_VENDOR | USB_DIR_IN,
3631 reg >> 16, reg & 0xffff,
3632 buf, size, USB_CTRL_SET_TIMEOUT);
3636 *val = get_unaligned_le32(buf);
3644 static int btusb_mtk_id_get(struct btusb_data *data, u32 reg, u32 *id)
3646 return btusb_mtk_reg_read(data, reg, id);
3649 static int btusb_mtk_setup(struct hci_dev *hdev)
3651 struct btusb_data *data = hci_get_drvdata(hdev);
3652 struct btmtk_hci_wmt_params wmt_params;
3653 ktime_t calltime, delta, rettime;
3654 struct btmtk_tci_sleep tci_sleep;
3655 unsigned long long duration;
3656 struct sk_buff *skb;
3660 char fw_bin_name[64];
3664 calltime = ktime_get();
3666 err = btusb_mtk_id_get(data, 0x80000008, &dev_id);
3668 bt_dev_err(hdev, "Failed to get device id (%d)", err);
3673 err = btusb_mtk_id_get(data, 0x70010200, &dev_id);
3675 bt_dev_err(hdev, "Failed to get device id (%d)", err);
3678 err = btusb_mtk_id_get(data, 0x80021004, &fw_version);
3680 bt_dev_err(hdev, "Failed to get fw version (%d)", err);
3687 fwname = FIRMWARE_MT7663;
3690 fwname = FIRMWARE_MT7668;
3693 snprintf(fw_bin_name, sizeof(fw_bin_name),
3694 "mediatek/BT_RAM_CODE_MT%04x_1_%x_hdr.bin",
3695 dev_id & 0xffff, (fw_version & 0xff) + 1);
3696 err = btusb_mtk_setup_firmware_79xx(hdev, fw_bin_name);
3698 /* Enable Bluetooth protocol */
3700 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3701 wmt_params.flag = 0;
3702 wmt_params.dlen = sizeof(param);
3703 wmt_params.data = ¶m;
3704 wmt_params.status = NULL;
3706 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3708 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3713 bt_dev_err(hdev, "Unsupported hardware variant (%08x)",
3718 /* Query whether the firmware is already download */
3719 wmt_params.op = BTMTK_WMT_SEMAPHORE;
3720 wmt_params.flag = 1;
3721 wmt_params.dlen = 0;
3722 wmt_params.data = NULL;
3723 wmt_params.status = &status;
3725 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3727 bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
3731 if (status == BTMTK_WMT_PATCH_DONE) {
3732 bt_dev_info(hdev, "firmware already downloaded");
3733 goto ignore_setup_fw;
3736 /* Setup a firmware which the device definitely requires */
3737 err = btusb_mtk_setup_firmware(hdev, fwname);
3742 err = readx_poll_timeout(btusb_mtk_func_query, hdev, status,
3743 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
3745 /* -ETIMEDOUT happens */
3749 /* The other errors happen in btusb_mtk_func_query */
3753 if (status == BTMTK_WMT_ON_DONE) {
3754 bt_dev_info(hdev, "function already on");
3755 goto ignore_func_on;
3758 /* Enable Bluetooth protocol */
3760 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3761 wmt_params.flag = 0;
3762 wmt_params.dlen = sizeof(param);
3763 wmt_params.data = ¶m;
3764 wmt_params.status = NULL;
3766 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3768 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3773 /* Apply the low power environment setup */
3774 tci_sleep.mode = 0x5;
3775 tci_sleep.duration = cpu_to_le16(0x640);
3776 tci_sleep.host_duration = cpu_to_le16(0x640);
3777 tci_sleep.host_wakeup_pin = 0;
3778 tci_sleep.time_compensation = 0;
3780 skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
3784 bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
3790 rettime = ktime_get();
3791 delta = ktime_sub(rettime, calltime);
3792 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
3794 bt_dev_info(hdev, "Device setup in %llu usecs", duration);
3799 static int btusb_mtk_shutdown(struct hci_dev *hdev)
3801 struct btmtk_hci_wmt_params wmt_params;
3805 /* Disable the device */
3806 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3807 wmt_params.flag = 0;
3808 wmt_params.dlen = sizeof(param);
3809 wmt_params.data = ¶m;
3810 wmt_params.status = NULL;
3812 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3814 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3821 MODULE_FIRMWARE(FIRMWARE_MT7663);
3822 MODULE_FIRMWARE(FIRMWARE_MT7668);
3825 /* Configure an out-of-band gpio as wake-up pin, if specified in device tree */
3826 static int marvell_config_oob_wake(struct hci_dev *hdev)
3828 struct sk_buff *skb;
3829 struct btusb_data *data = hci_get_drvdata(hdev);
3830 struct device *dev = &data->udev->dev;
3831 u16 pin, gap, opcode;
3835 /* Move on if no wakeup pin specified */
3836 if (of_property_read_u16(dev->of_node, "marvell,wakeup-pin", &pin) ||
3837 of_property_read_u16(dev->of_node, "marvell,wakeup-gap-ms", &gap))
3840 /* Vendor specific command to configure a GPIO as wake-up pin */
3841 opcode = hci_opcode_pack(0x3F, 0x59);
3842 cmd[0] = opcode & 0xFF;
3843 cmd[1] = opcode >> 8;
3844 cmd[2] = 2; /* length of parameters that follow */
3846 cmd[4] = gap; /* time in ms, for which wakeup pin should be asserted */
3848 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
3850 bt_dev_err(hdev, "%s: No memory", __func__);
3854 skb_put_data(skb, cmd, sizeof(cmd));
3855 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
3857 ret = btusb_send_frame(hdev, skb);
3859 bt_dev_err(hdev, "%s: configuration failed", __func__);
3868 static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
3869 const bdaddr_t *bdaddr)
3871 struct sk_buff *skb;
3876 buf[1] = sizeof(bdaddr_t);
3877 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
3879 skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3882 bt_dev_err(hdev, "changing Marvell device address failed (%ld)",
3891 static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
3892 const bdaddr_t *bdaddr)
3894 struct sk_buff *skb;
3901 buf[3] = sizeof(bdaddr_t);
3902 memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
3904 skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3907 bt_dev_err(hdev, "Change address command failed (%ld)", ret);
3915 static int btusb_set_bdaddr_wcn6855(struct hci_dev *hdev,
3916 const bdaddr_t *bdaddr)
3918 struct sk_buff *skb;
3922 memcpy(buf, bdaddr, sizeof(bdaddr_t));
3924 skb = __hci_cmd_sync_ev(hdev, 0xfc14, sizeof(buf), buf,
3925 HCI_EV_CMD_COMPLETE, HCI_INIT_TIMEOUT);
3928 bt_dev_err(hdev, "Change address command failed (%ld)", ret);
3936 #define QCA_DFU_PACKET_LEN 4096
3938 #define QCA_GET_TARGET_VERSION 0x09
3939 #define QCA_CHECK_STATUS 0x05
3940 #define QCA_DFU_DOWNLOAD 0x01
3942 #define QCA_SYSCFG_UPDATED 0x40
3943 #define QCA_PATCH_UPDATED 0x80
3944 #define QCA_DFU_TIMEOUT 3000
3945 #define QCA_FLAG_MULTI_NVM 0x80
3947 struct qca_version {
3949 __le32 patch_version;
3956 struct qca_rampatch_version {
3957 __le16 rom_version_high;
3958 __le16 rom_version_low;
3959 __le16 patch_version;
3962 struct qca_device_info {
3964 u8 rampatch_hdr; /* length of header in rampatch */
3965 u8 nvm_hdr; /* length of header in NVM */
3966 u8 ver_offset; /* offset of version structure in rampatch */
3969 static const struct qca_device_info qca_devices_table[] = {
3970 { 0x00000100, 20, 4, 8 }, /* Rome 1.0 */
3971 { 0x00000101, 20, 4, 8 }, /* Rome 1.1 */
3972 { 0x00000200, 28, 4, 16 }, /* Rome 2.0 */
3973 { 0x00000201, 28, 4, 16 }, /* Rome 2.1 */
3974 { 0x00000300, 28, 4, 16 }, /* Rome 3.0 */
3975 { 0x00000302, 28, 4, 16 }, /* Rome 3.2 */
3976 { 0x00130100, 40, 4, 16 }, /* WCN6855 1.0 */
3977 { 0x00130200, 40, 4, 16 }, /* WCN6855 2.0 */
3980 static int btusb_qca_send_vendor_req(struct usb_device *udev, u8 request,
3981 void *data, u16 size)
3986 buf = kmalloc(size, GFP_KERNEL);
3990 /* Found some of USB hosts have IOT issues with ours so that we should
3991 * not wait until HCI layer is ready.
3993 pipe = usb_rcvctrlpipe(udev, 0);
3994 err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
3995 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3997 dev_err(&udev->dev, "Failed to access otp area (%d)", err);
4001 memcpy(data, buf, size);
4009 static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
4010 const struct firmware *firmware,
4013 struct btusb_data *btdata = hci_get_drvdata(hdev);
4014 struct usb_device *udev = btdata->udev;
4015 size_t count, size, sent = 0;
4019 buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
4023 count = firmware->size;
4025 size = min_t(size_t, count, hdr_size);
4026 memcpy(buf, firmware->data, size);
4028 /* USB patches should go down to controller through USB path
4029 * because binary format fits to go down through USB channel.
4030 * USB control path is for patching headers and USB bulk is for
4033 pipe = usb_sndctrlpipe(udev, 0);
4034 err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
4035 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
4037 bt_dev_err(hdev, "Failed to send headers (%d)", err);
4045 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
4047 memcpy(buf, firmware->data + sent, size);
4049 pipe = usb_sndbulkpipe(udev, 0x02);
4050 err = usb_bulk_msg(udev, pipe, buf, size, &len,
4053 bt_dev_err(hdev, "Failed to send body at %zd of %zd (%d)",
4054 sent, firmware->size, err);
4059 bt_dev_err(hdev, "Failed to get bulk buffer");
4073 static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
4074 struct qca_version *ver,
4075 const struct qca_device_info *info)
4077 struct qca_rampatch_version *rver;
4078 const struct firmware *fw;
4079 u32 ver_rom, ver_patch, rver_rom;
4080 u16 rver_rom_low, rver_rom_high, rver_patch;
4084 ver_rom = le32_to_cpu(ver->rom_version);
4085 ver_patch = le32_to_cpu(ver->patch_version);
4087 snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
4089 err = request_firmware(&fw, fwname, &hdev->dev);
4091 bt_dev_err(hdev, "failed to request rampatch file: %s (%d)",
4096 bt_dev_info(hdev, "using rampatch file: %s", fwname);
4098 rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
4099 rver_rom_low = le16_to_cpu(rver->rom_version_low);
4100 rver_patch = le16_to_cpu(rver->patch_version);
4102 if (ver_rom & ~0xffffU) {
4103 rver_rom_high = le16_to_cpu(rver->rom_version_high);
4104 rver_rom = le32_to_cpu(rver_rom_high << 16 | rver_rom_low);
4106 rver_rom = rver_rom_low;
4109 bt_dev_info(hdev, "QCA: patch rome 0x%x build 0x%x, "
4110 "firmware rome 0x%x build 0x%x",
4111 rver_rom, rver_patch, ver_rom, ver_patch);
4113 if (rver_rom != ver_rom || rver_patch <= ver_patch) {
4114 bt_dev_err(hdev, "rampatch file version did not match with firmware");
4119 err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
4122 release_firmware(fw);
4127 static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
4128 struct qca_version *ver,
4129 const struct qca_device_info *info)
4131 const struct firmware *fw;
4135 if (((ver->flag >> 8) & 0xff) == QCA_FLAG_MULTI_NVM) {
4136 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x_%04x.bin",
4137 le32_to_cpu(ver->rom_version),
4138 le16_to_cpu(ver->board_id));
4140 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
4141 le32_to_cpu(ver->rom_version));
4144 err = request_firmware(&fw, fwname, &hdev->dev);
4146 bt_dev_err(hdev, "failed to request NVM file: %s (%d)",
4151 bt_dev_info(hdev, "using NVM file: %s", fwname);
4153 err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
4155 release_firmware(fw);
4160 /* identify the ROM version and check whether patches are needed */
4161 static bool btusb_qca_need_patch(struct usb_device *udev)
4163 struct qca_version ver;
4165 if (btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
4168 /* only low ROM versions need patches */
4169 return !(le32_to_cpu(ver.rom_version) & ~0xffffU);
4172 static int btusb_setup_qca(struct hci_dev *hdev)
4174 struct btusb_data *btdata = hci_get_drvdata(hdev);
4175 struct usb_device *udev = btdata->udev;
4176 const struct qca_device_info *info = NULL;
4177 struct qca_version ver;
4182 err = btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
4187 ver_rom = le32_to_cpu(ver.rom_version);
4189 for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
4190 if (ver_rom == qca_devices_table[i].rom_version)
4191 info = &qca_devices_table[i];
4194 /* If the rom_version is not matched in the qca_devices_table
4195 * and the high ROM version is not zero, we assume this chip no
4196 * need to load the rampatch and nvm.
4198 if (ver_rom & ~0xffffU)
4201 bt_dev_err(hdev, "don't support firmware rome 0x%x", ver_rom);
4205 err = btusb_qca_send_vendor_req(udev, QCA_CHECK_STATUS, &status,
4210 if (!(status & QCA_PATCH_UPDATED)) {
4211 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
4216 err = btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
4221 if (!(status & QCA_SYSCFG_UPDATED)) {
4222 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
4230 static inline int __set_diag_interface(struct hci_dev *hdev)
4232 struct btusb_data *data = hci_get_drvdata(hdev);
4233 struct usb_interface *intf = data->diag;
4239 data->diag_tx_ep = NULL;
4240 data->diag_rx_ep = NULL;
4242 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
4243 struct usb_endpoint_descriptor *ep_desc;
4245 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
4247 if (!data->diag_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
4248 data->diag_tx_ep = ep_desc;
4252 if (!data->diag_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
4253 data->diag_rx_ep = ep_desc;
4258 if (!data->diag_tx_ep || !data->diag_rx_ep) {
4259 bt_dev_err(hdev, "invalid diagnostic descriptors");
4266 static struct urb *alloc_diag_urb(struct hci_dev *hdev, bool enable)
4268 struct btusb_data *data = hci_get_drvdata(hdev);
4269 struct sk_buff *skb;
4273 if (!data->diag_tx_ep)
4274 return ERR_PTR(-ENODEV);
4276 urb = usb_alloc_urb(0, GFP_KERNEL);
4278 return ERR_PTR(-ENOMEM);
4280 skb = bt_skb_alloc(2, GFP_KERNEL);
4283 return ERR_PTR(-ENOMEM);
4286 skb_put_u8(skb, 0xf0);
4287 skb_put_u8(skb, enable);
4289 pipe = usb_sndbulkpipe(data->udev, data->diag_tx_ep->bEndpointAddress);
4291 usb_fill_bulk_urb(urb, data->udev, pipe,
4292 skb->data, skb->len, btusb_tx_complete, skb);
4294 skb->dev = (void *)hdev;
4299 static int btusb_bcm_set_diag(struct hci_dev *hdev, bool enable)
4301 struct btusb_data *data = hci_get_drvdata(hdev);
4307 if (!test_bit(HCI_RUNNING, &hdev->flags))
4310 urb = alloc_diag_urb(hdev, enable);
4312 return PTR_ERR(urb);
4314 return submit_or_queue_tx_urb(hdev, urb);
4318 static irqreturn_t btusb_oob_wake_handler(int irq, void *priv)
4320 struct btusb_data *data = priv;
4322 pm_wakeup_event(&data->udev->dev, 0);
4325 /* Disable only if not already disabled (keep it balanced) */
4326 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
4327 disable_irq_nosync(irq);
4328 disable_irq_wake(irq);
4333 static const struct of_device_id btusb_match_table[] = {
4334 { .compatible = "usb1286,204e" },
4335 { .compatible = "usbcf3,e300" }, /* QCA6174A */
4336 { .compatible = "usb4ca,301a" }, /* QCA6174A (Lite-On) */
4339 MODULE_DEVICE_TABLE(of, btusb_match_table);
4341 /* Use an oob wakeup pin? */
4342 static int btusb_config_oob_wake(struct hci_dev *hdev)
4344 struct btusb_data *data = hci_get_drvdata(hdev);
4345 struct device *dev = &data->udev->dev;
4348 clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
4350 if (!of_match_device(btusb_match_table, dev))
4353 /* Move on if no IRQ specified */
4354 irq = of_irq_get_byname(dev->of_node, "wakeup");
4356 bt_dev_dbg(hdev, "%s: no OOB Wakeup IRQ in DT", __func__);
4360 irq_set_status_flags(irq, IRQ_NOAUTOEN);
4361 ret = devm_request_irq(&hdev->dev, irq, btusb_oob_wake_handler,
4362 0, "OOB Wake-on-BT", data);
4364 bt_dev_err(hdev, "%s: IRQ request failed", __func__);
4368 ret = device_init_wakeup(dev, true);
4370 bt_dev_err(hdev, "%s: failed to init_wakeup", __func__);
4374 data->oob_wake_irq = irq;
4375 bt_dev_info(hdev, "OOB Wake-on-BT configured at IRQ %u", irq);
4380 static void btusb_check_needs_reset_resume(struct usb_interface *intf)
4382 if (dmi_check_system(btusb_needs_reset_resume_table))
4383 interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
4386 static bool btusb_prevent_wake(struct hci_dev *hdev)
4388 struct btusb_data *data = hci_get_drvdata(hdev);
4390 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
4393 return !device_may_wakeup(&data->udev->dev);
4396 static int btusb_shutdown_qca(struct hci_dev *hdev)
4398 struct sk_buff *skb;
4400 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
4402 bt_dev_err(hdev, "HCI reset during shutdown failed");
4403 return PTR_ERR(skb);
4410 static int btusb_probe(struct usb_interface *intf,
4411 const struct usb_device_id *id)
4413 struct usb_endpoint_descriptor *ep_desc;
4414 struct gpio_desc *reset_gpio;
4415 struct btusb_data *data;
4416 struct hci_dev *hdev;
4417 unsigned ifnum_base;
4420 BT_DBG("intf %p id %p", intf, id);
4422 /* interface numbers are hardcoded in the spec */
4423 if (intf->cur_altsetting->desc.bInterfaceNumber != 0) {
4424 if (!(id->driver_info & BTUSB_IFNUM_2))
4426 if (intf->cur_altsetting->desc.bInterfaceNumber != 2)
4430 ifnum_base = intf->cur_altsetting->desc.bInterfaceNumber;
4432 if (!id->driver_info) {
4433 const struct usb_device_id *match;
4435 match = usb_match_id(intf, blacklist_table);
4440 if (id->driver_info == BTUSB_IGNORE)
4443 if (id->driver_info & BTUSB_ATH3012) {
4444 struct usb_device *udev = interface_to_usbdev(intf);
4446 /* Old firmware would otherwise let ath3k driver load
4447 * patch and sysconfig files
4449 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001 &&
4450 !btusb_qca_need_patch(udev))
4454 data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
4458 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
4459 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
4461 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
4462 data->intr_ep = ep_desc;
4466 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
4467 data->bulk_tx_ep = ep_desc;
4471 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
4472 data->bulk_rx_ep = ep_desc;
4477 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
4480 if (id->driver_info & BTUSB_AMP) {
4481 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
4482 data->cmdreq = 0x2b;
4484 data->cmdreq_type = USB_TYPE_CLASS;
4485 data->cmdreq = 0x00;
4488 data->udev = interface_to_usbdev(intf);
4491 INIT_WORK(&data->work, btusb_work);
4492 INIT_WORK(&data->waker, btusb_waker);
4493 init_usb_anchor(&data->deferred);
4494 init_usb_anchor(&data->tx_anchor);
4495 spin_lock_init(&data->txlock);
4497 init_usb_anchor(&data->intr_anchor);
4498 init_usb_anchor(&data->bulk_anchor);
4499 init_usb_anchor(&data->isoc_anchor);
4500 init_usb_anchor(&data->diag_anchor);
4501 init_usb_anchor(&data->ctrl_anchor);
4502 spin_lock_init(&data->rxlock);
4504 if (id->driver_info & BTUSB_INTEL_NEW) {
4505 data->recv_event = btusb_recv_event_intel;
4506 data->recv_bulk = btusb_recv_bulk_intel;
4507 set_bit(BTUSB_BOOTLOADER, &data->flags);
4509 data->recv_event = hci_recv_frame;
4510 data->recv_bulk = btusb_recv_bulk;
4513 hdev = hci_alloc_dev();
4517 hdev->bus = HCI_USB;
4518 hci_set_drvdata(hdev, data);
4520 if (id->driver_info & BTUSB_AMP)
4521 hdev->dev_type = HCI_AMP;
4523 hdev->dev_type = HCI_PRIMARY;
4527 SET_HCIDEV_DEV(hdev, &intf->dev);
4529 reset_gpio = gpiod_get_optional(&data->udev->dev, "reset",
4531 if (IS_ERR(reset_gpio)) {
4532 err = PTR_ERR(reset_gpio);
4534 } else if (reset_gpio) {
4535 data->reset_gpio = reset_gpio;
4538 hdev->open = btusb_open;
4539 hdev->close = btusb_close;
4540 hdev->flush = btusb_flush;
4541 hdev->send = btusb_send_frame;
4542 hdev->notify = btusb_notify;
4543 hdev->prevent_wake = btusb_prevent_wake;
4546 err = btusb_config_oob_wake(hdev);
4550 /* Marvell devices may need a specific chip configuration */
4551 if (id->driver_info & BTUSB_MARVELL && data->oob_wake_irq) {
4552 err = marvell_config_oob_wake(hdev);
4557 if (id->driver_info & BTUSB_CW6622)
4558 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
4560 if (id->driver_info & BTUSB_BCM2045)
4561 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
4563 if (id->driver_info & BTUSB_BCM92035)
4564 hdev->setup = btusb_setup_bcm92035;
4566 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) &&
4567 (id->driver_info & BTUSB_BCM_PATCHRAM)) {
4568 hdev->manufacturer = 15;
4569 hdev->setup = btbcm_setup_patchram;
4570 hdev->set_diag = btusb_bcm_set_diag;
4571 hdev->set_bdaddr = btbcm_set_bdaddr;
4573 /* Broadcom LM_DIAG Interface numbers are hardcoded */
4574 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
4577 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) &&
4578 (id->driver_info & BTUSB_BCM_APPLE)) {
4579 hdev->manufacturer = 15;
4580 hdev->setup = btbcm_setup_apple;
4581 hdev->set_diag = btusb_bcm_set_diag;
4583 /* Broadcom LM_DIAG Interface numbers are hardcoded */
4584 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
4587 if (id->driver_info & BTUSB_INTEL) {
4588 hdev->manufacturer = 2;
4589 hdev->setup = btusb_setup_intel;
4590 hdev->shutdown = btusb_shutdown_intel;
4591 hdev->set_diag = btintel_set_diag_mfg;
4592 hdev->set_bdaddr = btintel_set_bdaddr;
4593 hdev->cmd_timeout = btusb_intel_cmd_timeout;
4594 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4595 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4596 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
4599 if (id->driver_info & BTUSB_INTEL_NEW) {
4600 hdev->manufacturer = 2;
4601 hdev->send = btusb_send_frame_intel;
4602 hdev->setup = btusb_setup_intel_new;
4603 hdev->shutdown = btusb_shutdown_intel_new;
4604 hdev->hw_error = btintel_hw_error;
4605 hdev->set_diag = btintel_set_diag;
4606 hdev->set_bdaddr = btintel_set_bdaddr;
4607 hdev->cmd_timeout = btusb_intel_cmd_timeout;
4608 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4609 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4610 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
4613 if (id->driver_info & BTUSB_INTEL_NEWGEN) {
4614 hdev->manufacturer = 2;
4615 hdev->send = btusb_send_frame_intel;
4616 hdev->setup = btusb_setup_intel_newgen;
4617 hdev->shutdown = btusb_shutdown_intel_new;
4618 hdev->hw_error = btintel_hw_error;
4619 hdev->set_diag = btintel_set_diag;
4620 hdev->set_bdaddr = btintel_set_bdaddr;
4621 hdev->cmd_timeout = btusb_intel_cmd_timeout;
4622 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4623 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4624 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
4626 data->recv_event = btusb_recv_event_intel;
4627 data->recv_bulk = btusb_recv_bulk_intel;
4628 set_bit(BTUSB_BOOTLOADER, &data->flags);
4631 if (id->driver_info & BTUSB_MARVELL)
4632 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
4634 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_MTK) &&
4635 (id->driver_info & BTUSB_MEDIATEK)) {
4636 hdev->setup = btusb_mtk_setup;
4637 hdev->shutdown = btusb_mtk_shutdown;
4638 hdev->manufacturer = 70;
4639 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
4642 if (id->driver_info & BTUSB_SWAVE) {
4643 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
4644 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
4647 if (id->driver_info & BTUSB_INTEL_BOOT) {
4648 hdev->manufacturer = 2;
4649 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
4652 if (id->driver_info & BTUSB_ATH3012) {
4653 data->setup_on_usb = btusb_setup_qca;
4654 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
4655 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4656 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4659 if (id->driver_info & BTUSB_QCA_ROME) {
4660 data->setup_on_usb = btusb_setup_qca;
4661 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
4662 hdev->cmd_timeout = btusb_qca_cmd_timeout;
4663 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4664 btusb_check_needs_reset_resume(intf);
4667 if (id->driver_info & BTUSB_QCA_WCN6855) {
4668 data->setup_on_usb = btusb_setup_qca;
4669 hdev->shutdown = btusb_shutdown_qca;
4670 hdev->set_bdaddr = btusb_set_bdaddr_wcn6855;
4671 hdev->cmd_timeout = btusb_qca_cmd_timeout;
4672 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4675 if (id->driver_info & BTUSB_AMP) {
4676 /* AMP controllers do not support SCO packets */
4679 /* Interface orders are hardcoded in the specification */
4680 data->isoc = usb_ifnum_to_if(data->udev, ifnum_base + 1);
4681 data->isoc_ifnum = ifnum_base + 1;
4684 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_RTL) &&
4685 (id->driver_info & BTUSB_REALTEK)) {
4686 hdev->setup = btrtl_setup_realtek;
4687 hdev->shutdown = btrtl_shutdown_realtek;
4688 hdev->cmd_timeout = btusb_rtl_cmd_timeout;
4690 /* Realtek devices lose their updated firmware over global
4691 * suspend that means host doesn't send SET_FEATURE
4692 * (DEVICE_REMOTE_WAKEUP)
4694 set_bit(BTUSB_WAKEUP_DISABLE, &data->flags);
4698 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4700 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
4701 if (!disable_scofix)
4702 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
4705 if (id->driver_info & BTUSB_BROKEN_ISOC)
4708 if (id->driver_info & BTUSB_WIDEBAND_SPEECH)
4709 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED, &hdev->quirks);
4711 if (id->driver_info & BTUSB_VALID_LE_STATES)
4712 set_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks);
4714 if (id->driver_info & BTUSB_DIGIANSWER) {
4715 data->cmdreq_type = USB_TYPE_VENDOR;
4716 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4719 if (id->driver_info & BTUSB_CSR) {
4720 struct usb_device *udev = data->udev;
4721 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
4723 /* Old firmware would otherwise execute USB reset */
4724 if (bcdDevice < 0x117)
4725 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4727 /* This must be set first in case we disable it for fakes */
4728 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4730 /* Fake CSR devices with broken commands */
4731 if (le16_to_cpu(udev->descriptor.idVendor) == 0x0a12 &&
4732 le16_to_cpu(udev->descriptor.idProduct) == 0x0001)
4733 hdev->setup = btusb_setup_csr;
4736 if (id->driver_info & BTUSB_SNIFFER) {
4737 struct usb_device *udev = data->udev;
4739 /* New sniffer firmware has crippled HCI interface */
4740 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
4741 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
4744 if (id->driver_info & BTUSB_INTEL_BOOT) {
4745 /* A bug in the bootloader causes that interrupt interface is
4746 * only enabled after receiving SetInterface(0, AltSetting=0).
4748 err = usb_set_interface(data->udev, 0, 0);
4750 BT_ERR("failed to set interface 0, alt 0 %d", err);
4756 err = usb_driver_claim_interface(&btusb_driver,
4762 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) && data->diag) {
4763 if (!usb_driver_claim_interface(&btusb_driver,
4765 __set_diag_interface(hdev);
4770 if (enable_autosuspend)
4771 usb_enable_autosuspend(data->udev);
4773 err = hci_register_dev(hdev);
4777 usb_set_intfdata(intf, data);
4782 if (data->reset_gpio)
4783 gpiod_put(data->reset_gpio);
4788 static void btusb_disconnect(struct usb_interface *intf)
4790 struct btusb_data *data = usb_get_intfdata(intf);
4791 struct hci_dev *hdev;
4793 BT_DBG("intf %p", intf);
4799 usb_set_intfdata(data->intf, NULL);
4802 usb_set_intfdata(data->isoc, NULL);
4805 usb_set_intfdata(data->diag, NULL);
4807 hci_unregister_dev(hdev);
4809 if (intf == data->intf) {
4811 usb_driver_release_interface(&btusb_driver, data->isoc);
4813 usb_driver_release_interface(&btusb_driver, data->diag);
4814 } else if (intf == data->isoc) {
4816 usb_driver_release_interface(&btusb_driver, data->diag);
4817 usb_driver_release_interface(&btusb_driver, data->intf);
4818 } else if (intf == data->diag) {
4819 usb_driver_release_interface(&btusb_driver, data->intf);
4821 usb_driver_release_interface(&btusb_driver, data->isoc);
4824 if (data->oob_wake_irq)
4825 device_init_wakeup(&data->udev->dev, false);
4827 if (data->reset_gpio)
4828 gpiod_put(data->reset_gpio);
4834 static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
4836 struct btusb_data *data = usb_get_intfdata(intf);
4838 BT_DBG("intf %p", intf);
4840 if (data->suspend_count++)
4843 spin_lock_irq(&data->txlock);
4844 if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
4845 set_bit(BTUSB_SUSPENDING, &data->flags);
4846 spin_unlock_irq(&data->txlock);
4848 spin_unlock_irq(&data->txlock);
4849 data->suspend_count--;
4853 cancel_work_sync(&data->work);
4855 btusb_stop_traffic(data);
4856 usb_kill_anchored_urbs(&data->tx_anchor);
4858 if (data->oob_wake_irq && device_may_wakeup(&data->udev->dev)) {
4859 set_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
4860 enable_irq_wake(data->oob_wake_irq);
4861 enable_irq(data->oob_wake_irq);
4864 /* For global suspend, Realtek devices lose the loaded fw
4865 * in them. But for autosuspend, firmware should remain.
4866 * Actually, it depends on whether the usb host sends
4867 * set feature (enable wakeup) or not.
4869 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags)) {
4870 if (PMSG_IS_AUTO(message) &&
4871 device_can_wakeup(&data->udev->dev))
4872 data->udev->do_remote_wakeup = 1;
4873 else if (!PMSG_IS_AUTO(message))
4874 data->udev->reset_resume = 1;
4880 static void play_deferred(struct btusb_data *data)
4885 while ((urb = usb_get_from_anchor(&data->deferred))) {
4886 usb_anchor_urb(urb, &data->tx_anchor);
4888 err = usb_submit_urb(urb, GFP_ATOMIC);
4890 if (err != -EPERM && err != -ENODEV)
4891 BT_ERR("%s urb %p submission failed (%d)",
4892 data->hdev->name, urb, -err);
4893 kfree(urb->setup_packet);
4894 usb_unanchor_urb(urb);
4899 data->tx_in_flight++;
4903 /* Cleanup the rest deferred urbs. */
4904 while ((urb = usb_get_from_anchor(&data->deferred))) {
4905 kfree(urb->setup_packet);
4910 static int btusb_resume(struct usb_interface *intf)
4912 struct btusb_data *data = usb_get_intfdata(intf);
4913 struct hci_dev *hdev = data->hdev;
4916 BT_DBG("intf %p", intf);
4918 if (--data->suspend_count)
4921 /* Disable only if not already disabled (keep it balanced) */
4922 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
4923 disable_irq(data->oob_wake_irq);
4924 disable_irq_wake(data->oob_wake_irq);
4927 if (!test_bit(HCI_RUNNING, &hdev->flags))
4930 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
4931 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
4933 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
4938 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
4939 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
4941 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
4945 btusb_submit_bulk_urb(hdev, GFP_NOIO);
4948 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
4949 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
4950 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
4952 btusb_submit_isoc_urb(hdev, GFP_NOIO);
4955 spin_lock_irq(&data->txlock);
4956 play_deferred(data);
4957 clear_bit(BTUSB_SUSPENDING, &data->flags);
4958 spin_unlock_irq(&data->txlock);
4959 schedule_work(&data->work);
4964 usb_scuttle_anchored_urbs(&data->deferred);
4966 spin_lock_irq(&data->txlock);
4967 clear_bit(BTUSB_SUSPENDING, &data->flags);
4968 spin_unlock_irq(&data->txlock);
4974 static struct usb_driver btusb_driver = {
4976 .probe = btusb_probe,
4977 .disconnect = btusb_disconnect,
4979 .suspend = btusb_suspend,
4980 .resume = btusb_resume,
4982 .id_table = btusb_table,
4983 .supports_autosuspend = 1,
4984 .disable_hub_initiated_lpm = 1,
4987 module_usb_driver(btusb_driver);
4989 module_param(disable_scofix, bool, 0644);
4990 MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
4992 module_param(force_scofix, bool, 0644);
4993 MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
4995 module_param(enable_autosuspend, bool, 0644);
4996 MODULE_PARM_DESC(enable_autosuspend, "Enable USB autosuspend by default");
4998 module_param(reset, bool, 0644);
4999 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
5002 MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
5003 MODULE_VERSION(VERSION);
5004 MODULE_LICENSE("GPL");