1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Generic Bluetooth USB driver
6 * Copyright (C) 2005-2008 Marcel Holtmann <marcel@holtmann.org>
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
63 static const struct usb_device_id btusb_table[] = {
64 /* Generic Bluetooth USB device */
65 { USB_DEVICE_INFO(0xe0, 0x01, 0x01) },
67 /* Generic Bluetooth AMP device */
68 { USB_DEVICE_INFO(0xe0, 0x01, 0x04), .driver_info = BTUSB_AMP },
70 /* Generic Bluetooth USB interface */
71 { USB_INTERFACE_INFO(0xe0, 0x01, 0x01) },
73 /* Apple-specific (Broadcom) devices */
74 { USB_VENDOR_AND_INTERFACE_INFO(0x05ac, 0xff, 0x01, 0x01),
75 .driver_info = BTUSB_BCM_APPLE | BTUSB_IFNUM_2 },
77 /* MediaTek MT76x0E */
78 { USB_DEVICE(0x0e8d, 0x763f) },
80 /* Broadcom SoftSailing reporting vendor specific */
81 { USB_DEVICE(0x0a5c, 0x21e1) },
83 /* Apple MacBookPro 7,1 */
84 { USB_DEVICE(0x05ac, 0x8213) },
87 { USB_DEVICE(0x05ac, 0x8215) },
89 /* Apple MacBookPro6,2 */
90 { USB_DEVICE(0x05ac, 0x8218) },
92 /* Apple MacBookAir3,1, MacBookAir3,2 */
93 { USB_DEVICE(0x05ac, 0x821b) },
95 /* Apple MacBookAir4,1 */
96 { USB_DEVICE(0x05ac, 0x821f) },
98 /* Apple MacBookPro8,2 */
99 { USB_DEVICE(0x05ac, 0x821a) },
101 /* Apple MacMini5,1 */
102 { USB_DEVICE(0x05ac, 0x8281) },
104 /* AVM BlueFRITZ! USB v2.0 */
105 { USB_DEVICE(0x057c, 0x3800), .driver_info = BTUSB_SWAVE },
107 /* Bluetooth Ultraport Module from IBM */
108 { USB_DEVICE(0x04bf, 0x030a) },
110 /* ALPS Modules with non-standard id */
111 { USB_DEVICE(0x044e, 0x3001) },
112 { USB_DEVICE(0x044e, 0x3002) },
114 /* Ericsson with non-standard id */
115 { USB_DEVICE(0x0bdb, 0x1002) },
117 /* Canyon CN-BTU1 with HID interfaces */
118 { USB_DEVICE(0x0c10, 0x0000) },
120 /* Broadcom BCM20702A0 */
121 { USB_DEVICE(0x413c, 0x8197) },
123 /* Broadcom BCM20702B0 (Dynex/Insignia) */
124 { USB_DEVICE(0x19ff, 0x0239), .driver_info = BTUSB_BCM_PATCHRAM },
126 /* Broadcom BCM43142A0 (Foxconn/Lenovo) */
127 { USB_VENDOR_AND_INTERFACE_INFO(0x105b, 0xff, 0x01, 0x01),
128 .driver_info = BTUSB_BCM_PATCHRAM },
130 /* Broadcom BCM920703 (HTC Vive) */
131 { USB_VENDOR_AND_INTERFACE_INFO(0x0bb4, 0xff, 0x01, 0x01),
132 .driver_info = BTUSB_BCM_PATCHRAM },
134 /* Foxconn - Hon Hai */
135 { USB_VENDOR_AND_INTERFACE_INFO(0x0489, 0xff, 0x01, 0x01),
136 .driver_info = BTUSB_BCM_PATCHRAM },
138 /* Lite-On Technology - Broadcom based */
139 { USB_VENDOR_AND_INTERFACE_INFO(0x04ca, 0xff, 0x01, 0x01),
140 .driver_info = BTUSB_BCM_PATCHRAM },
142 /* Broadcom devices with vendor specific id */
143 { USB_VENDOR_AND_INTERFACE_INFO(0x0a5c, 0xff, 0x01, 0x01),
144 .driver_info = BTUSB_BCM_PATCHRAM },
146 /* ASUSTek Computer - Broadcom based */
147 { USB_VENDOR_AND_INTERFACE_INFO(0x0b05, 0xff, 0x01, 0x01),
148 .driver_info = BTUSB_BCM_PATCHRAM },
150 /* Belkin F8065bf - Broadcom based */
151 { USB_VENDOR_AND_INTERFACE_INFO(0x050d, 0xff, 0x01, 0x01),
152 .driver_info = BTUSB_BCM_PATCHRAM },
154 /* IMC Networks - Broadcom based */
155 { USB_VENDOR_AND_INTERFACE_INFO(0x13d3, 0xff, 0x01, 0x01),
156 .driver_info = BTUSB_BCM_PATCHRAM },
158 /* Dell Computer - Broadcom based */
159 { USB_VENDOR_AND_INTERFACE_INFO(0x413c, 0xff, 0x01, 0x01),
160 .driver_info = BTUSB_BCM_PATCHRAM },
162 /* Toshiba Corp - Broadcom based */
163 { USB_VENDOR_AND_INTERFACE_INFO(0x0930, 0xff, 0x01, 0x01),
164 .driver_info = BTUSB_BCM_PATCHRAM },
166 /* Intel Bluetooth USB Bootloader (RAM module) */
167 { USB_DEVICE(0x8087, 0x0a5a),
168 .driver_info = BTUSB_INTEL_BOOT | BTUSB_BROKEN_ISOC },
170 { } /* Terminating entry */
173 MODULE_DEVICE_TABLE(usb, btusb_table);
175 static const struct usb_device_id blacklist_table[] = {
176 /* CSR BlueCore devices */
177 { USB_DEVICE(0x0a12, 0x0001), .driver_info = BTUSB_CSR },
179 /* Broadcom BCM2033 without firmware */
180 { USB_DEVICE(0x0a5c, 0x2033), .driver_info = BTUSB_IGNORE },
182 /* Broadcom BCM2045 devices */
183 { USB_DEVICE(0x0a5c, 0x2045), .driver_info = BTUSB_BCM2045 },
185 /* Atheros 3011 with sflash firmware */
186 { USB_DEVICE(0x0489, 0xe027), .driver_info = BTUSB_IGNORE },
187 { USB_DEVICE(0x0489, 0xe03d), .driver_info = BTUSB_IGNORE },
188 { USB_DEVICE(0x04f2, 0xaff1), .driver_info = BTUSB_IGNORE },
189 { USB_DEVICE(0x0930, 0x0215), .driver_info = BTUSB_IGNORE },
190 { USB_DEVICE(0x0cf3, 0x3002), .driver_info = BTUSB_IGNORE },
191 { USB_DEVICE(0x0cf3, 0xe019), .driver_info = BTUSB_IGNORE },
192 { USB_DEVICE(0x13d3, 0x3304), .driver_info = BTUSB_IGNORE },
194 /* Atheros AR9285 Malbec with sflash firmware */
195 { USB_DEVICE(0x03f0, 0x311d), .driver_info = BTUSB_IGNORE },
197 /* Atheros 3012 with sflash firmware */
198 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
199 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
200 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
201 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
202 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
203 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
204 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
205 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
206 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
207 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
208 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
209 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
210 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
211 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
212 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
213 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
214 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
215 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
216 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
217 { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
218 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
219 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
220 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
221 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
222 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
223 { USB_DEVICE(0x0cf3, 0x0036), .driver_info = BTUSB_ATH3012 },
224 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
225 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
226 { USB_DEVICE(0x0cf3, 0x311d), .driver_info = BTUSB_ATH3012 },
227 { USB_DEVICE(0x0cf3, 0x311e), .driver_info = BTUSB_ATH3012 },
228 { USB_DEVICE(0x0cf3, 0x311f), .driver_info = BTUSB_ATH3012 },
229 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
230 { USB_DEVICE(0x0cf3, 0x817a), .driver_info = BTUSB_ATH3012 },
231 { USB_DEVICE(0x0cf3, 0x817b), .driver_info = BTUSB_ATH3012 },
232 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
233 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
234 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
235 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
236 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
237 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
238 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
239 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
240 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
241 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
242 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
243 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
244 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
245 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
246 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
247 { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
249 /* Atheros AR5BBU12 with sflash firmware */
250 { USB_DEVICE(0x0489, 0xe02c), .driver_info = BTUSB_IGNORE },
252 /* Atheros AR5BBU12 with sflash firmware */
253 { USB_DEVICE(0x0489, 0xe036), .driver_info = BTUSB_ATH3012 },
254 { USB_DEVICE(0x0489, 0xe03c), .driver_info = BTUSB_ATH3012 },
256 /* QCA ROME chipset */
257 { USB_DEVICE(0x0cf3, 0x535b), .driver_info = BTUSB_QCA_ROME },
258 { USB_DEVICE(0x0cf3, 0xe007), .driver_info = BTUSB_QCA_ROME },
259 { USB_DEVICE(0x0cf3, 0xe009), .driver_info = BTUSB_QCA_ROME },
260 { USB_DEVICE(0x0cf3, 0xe010), .driver_info = BTUSB_QCA_ROME },
261 { USB_DEVICE(0x0cf3, 0xe300), .driver_info = BTUSB_QCA_ROME },
262 { USB_DEVICE(0x0cf3, 0xe301), .driver_info = BTUSB_QCA_ROME },
263 { USB_DEVICE(0x0cf3, 0xe360), .driver_info = BTUSB_QCA_ROME },
264 { USB_DEVICE(0x0489, 0xe092), .driver_info = BTUSB_QCA_ROME },
265 { USB_DEVICE(0x0489, 0xe09f), .driver_info = BTUSB_QCA_ROME },
266 { USB_DEVICE(0x0489, 0xe0a2), .driver_info = BTUSB_QCA_ROME },
267 { USB_DEVICE(0x04ca, 0x3011), .driver_info = BTUSB_QCA_ROME },
268 { USB_DEVICE(0x04ca, 0x3015), .driver_info = BTUSB_QCA_ROME },
269 { USB_DEVICE(0x04ca, 0x3016), .driver_info = BTUSB_QCA_ROME },
270 { USB_DEVICE(0x04ca, 0x301a), .driver_info = BTUSB_QCA_ROME },
271 { USB_DEVICE(0x04ca, 0x3021), .driver_info = BTUSB_QCA_ROME },
272 { USB_DEVICE(0x13d3, 0x3491), .driver_info = BTUSB_QCA_ROME },
273 { USB_DEVICE(0x13d3, 0x3496), .driver_info = BTUSB_QCA_ROME },
274 { USB_DEVICE(0x13d3, 0x3501), .driver_info = BTUSB_QCA_ROME },
276 /* Broadcom BCM2035 */
277 { USB_DEVICE(0x0a5c, 0x2009), .driver_info = BTUSB_BCM92035 },
278 { USB_DEVICE(0x0a5c, 0x200a), .driver_info = BTUSB_WRONG_SCO_MTU },
279 { USB_DEVICE(0x0a5c, 0x2035), .driver_info = BTUSB_WRONG_SCO_MTU },
281 /* Broadcom BCM2045 */
282 { USB_DEVICE(0x0a5c, 0x2039), .driver_info = BTUSB_WRONG_SCO_MTU },
283 { USB_DEVICE(0x0a5c, 0x2101), .driver_info = BTUSB_WRONG_SCO_MTU },
285 /* IBM/Lenovo ThinkPad with Broadcom chip */
286 { USB_DEVICE(0x0a5c, 0x201e), .driver_info = BTUSB_WRONG_SCO_MTU },
287 { USB_DEVICE(0x0a5c, 0x2110), .driver_info = BTUSB_WRONG_SCO_MTU },
289 /* HP laptop with Broadcom chip */
290 { USB_DEVICE(0x03f0, 0x171d), .driver_info = BTUSB_WRONG_SCO_MTU },
292 /* Dell laptop with Broadcom chip */
293 { USB_DEVICE(0x413c, 0x8126), .driver_info = BTUSB_WRONG_SCO_MTU },
295 /* Dell Wireless 370 and 410 devices */
296 { USB_DEVICE(0x413c, 0x8152), .driver_info = BTUSB_WRONG_SCO_MTU },
297 { USB_DEVICE(0x413c, 0x8156), .driver_info = BTUSB_WRONG_SCO_MTU },
299 /* Belkin F8T012 and F8T013 devices */
300 { USB_DEVICE(0x050d, 0x0012), .driver_info = BTUSB_WRONG_SCO_MTU },
301 { USB_DEVICE(0x050d, 0x0013), .driver_info = BTUSB_WRONG_SCO_MTU },
303 /* Asus WL-BTD202 device */
304 { USB_DEVICE(0x0b05, 0x1715), .driver_info = BTUSB_WRONG_SCO_MTU },
306 /* Kensington Bluetooth USB adapter */
307 { USB_DEVICE(0x047d, 0x105e), .driver_info = BTUSB_WRONG_SCO_MTU },
309 /* RTX Telecom based adapters with buggy SCO support */
310 { USB_DEVICE(0x0400, 0x0807), .driver_info = BTUSB_BROKEN_ISOC },
311 { USB_DEVICE(0x0400, 0x080a), .driver_info = BTUSB_BROKEN_ISOC },
313 /* CONWISE Technology based adapters with buggy SCO support */
314 { USB_DEVICE(0x0e5e, 0x6622),
315 .driver_info = BTUSB_BROKEN_ISOC | BTUSB_CW6622},
317 /* Roper Class 1 Bluetooth Dongle (Silicon Wave based) */
318 { USB_DEVICE(0x1310, 0x0001), .driver_info = BTUSB_SWAVE },
320 /* Digianswer devices */
321 { USB_DEVICE(0x08fd, 0x0001), .driver_info = BTUSB_DIGIANSWER },
322 { USB_DEVICE(0x08fd, 0x0002), .driver_info = BTUSB_IGNORE },
324 /* CSR BlueCore Bluetooth Sniffer */
325 { USB_DEVICE(0x0a12, 0x0002),
326 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
328 /* Frontline ComProbe Bluetooth Sniffer */
329 { USB_DEVICE(0x16d3, 0x0002),
330 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
332 /* Marvell Bluetooth devices */
333 { USB_DEVICE(0x1286, 0x2044), .driver_info = BTUSB_MARVELL },
334 { USB_DEVICE(0x1286, 0x2046), .driver_info = BTUSB_MARVELL },
335 { USB_DEVICE(0x1286, 0x204e), .driver_info = BTUSB_MARVELL },
337 /* Intel Bluetooth devices */
338 { USB_DEVICE(0x8087, 0x0025), .driver_info = BTUSB_INTEL_NEW |
339 BTUSB_WIDEBAND_SPEECH |
340 BTUSB_VALID_LE_STATES },
341 { USB_DEVICE(0x8087, 0x0026), .driver_info = BTUSB_INTEL_NEW |
342 BTUSB_WIDEBAND_SPEECH },
343 { USB_DEVICE(0x8087, 0x0029), .driver_info = BTUSB_INTEL_NEW |
344 BTUSB_WIDEBAND_SPEECH },
345 { USB_DEVICE(0x8087, 0x0032), .driver_info = BTUSB_INTEL_NEW |
346 BTUSB_WIDEBAND_SPEECH},
347 { USB_DEVICE(0x8087, 0x07da), .driver_info = BTUSB_CSR },
348 { USB_DEVICE(0x8087, 0x07dc), .driver_info = BTUSB_INTEL },
349 { USB_DEVICE(0x8087, 0x0a2a), .driver_info = BTUSB_INTEL },
350 { USB_DEVICE(0x8087, 0x0a2b), .driver_info = BTUSB_INTEL_NEW |
351 BTUSB_WIDEBAND_SPEECH },
352 { USB_DEVICE(0x8087, 0x0aa7), .driver_info = BTUSB_INTEL |
353 BTUSB_WIDEBAND_SPEECH },
354 { USB_DEVICE(0x8087, 0x0aaa), .driver_info = BTUSB_INTEL_NEW |
355 BTUSB_WIDEBAND_SPEECH |
356 BTUSB_VALID_LE_STATES },
358 /* Other Intel Bluetooth devices */
359 { USB_VENDOR_AND_INTERFACE_INFO(0x8087, 0xe0, 0x01, 0x01),
360 .driver_info = BTUSB_IGNORE },
362 /* Realtek 8822CE Bluetooth devices */
363 { USB_DEVICE(0x0bda, 0xb00c), .driver_info = BTUSB_REALTEK |
364 BTUSB_WIDEBAND_SPEECH },
366 /* Realtek Bluetooth devices */
367 { USB_VENDOR_AND_INTERFACE_INFO(0x0bda, 0xe0, 0x01, 0x01),
368 .driver_info = BTUSB_REALTEK },
370 /* MediaTek Bluetooth devices */
371 { USB_VENDOR_AND_INTERFACE_INFO(0x0e8d, 0xe0, 0x01, 0x01),
372 .driver_info = BTUSB_MEDIATEK },
374 /* Additional Realtek 8723AE Bluetooth devices */
375 { USB_DEVICE(0x0930, 0x021d), .driver_info = BTUSB_REALTEK },
376 { USB_DEVICE(0x13d3, 0x3394), .driver_info = BTUSB_REALTEK },
378 /* Additional Realtek 8723BE Bluetooth devices */
379 { USB_DEVICE(0x0489, 0xe085), .driver_info = BTUSB_REALTEK },
380 { USB_DEVICE(0x0489, 0xe08b), .driver_info = BTUSB_REALTEK },
381 { USB_DEVICE(0x13d3, 0x3410), .driver_info = BTUSB_REALTEK },
382 { USB_DEVICE(0x13d3, 0x3416), .driver_info = BTUSB_REALTEK },
383 { USB_DEVICE(0x13d3, 0x3459), .driver_info = BTUSB_REALTEK },
384 { USB_DEVICE(0x13d3, 0x3494), .driver_info = BTUSB_REALTEK },
386 /* Additional Realtek 8723BU Bluetooth devices */
387 { USB_DEVICE(0x7392, 0xa611), .driver_info = BTUSB_REALTEK },
389 /* Additional Realtek 8723DE Bluetooth devices */
390 { USB_DEVICE(0x0bda, 0xb009), .driver_info = BTUSB_REALTEK },
391 { USB_DEVICE(0x2ff8, 0xb011), .driver_info = BTUSB_REALTEK },
393 /* Additional Realtek 8821AE Bluetooth devices */
394 { USB_DEVICE(0x0b05, 0x17dc), .driver_info = BTUSB_REALTEK },
395 { USB_DEVICE(0x13d3, 0x3414), .driver_info = BTUSB_REALTEK },
396 { USB_DEVICE(0x13d3, 0x3458), .driver_info = BTUSB_REALTEK },
397 { USB_DEVICE(0x13d3, 0x3461), .driver_info = BTUSB_REALTEK },
398 { USB_DEVICE(0x13d3, 0x3462), .driver_info = BTUSB_REALTEK },
400 /* Additional Realtek 8822BE Bluetooth devices */
401 { USB_DEVICE(0x13d3, 0x3526), .driver_info = BTUSB_REALTEK },
402 { USB_DEVICE(0x0b05, 0x185c), .driver_info = BTUSB_REALTEK },
404 /* Additional Realtek 8822CE Bluetooth devices */
405 { USB_DEVICE(0x04ca, 0x4005), .driver_info = BTUSB_REALTEK },
406 { USB_DEVICE(0x13d3, 0x3548), .driver_info = BTUSB_REALTEK },
408 /* Silicon Wave based devices */
409 { USB_DEVICE(0x0c10, 0x0000), .driver_info = BTUSB_SWAVE },
411 { } /* Terminating entry */
414 /* The Bluetooth USB module build into some devices needs to be reset on resume,
415 * this is a problem with the platform (likely shutting off all power) not with
416 * the module itself. So we use a DMI list to match known broken platforms.
418 static const struct dmi_system_id btusb_needs_reset_resume_table[] = {
420 /* Dell OptiPlex 3060 (QCA ROME device 0cf3:e007) */
422 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
423 DMI_MATCH(DMI_PRODUCT_NAME, "OptiPlex 3060"),
427 /* Dell XPS 9360 (QCA ROME device 0cf3:e300) */
429 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
430 DMI_MATCH(DMI_PRODUCT_NAME, "XPS 13 9360"),
434 /* Dell Inspiron 5565 (QCA ROME device 0cf3:e009) */
436 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
437 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 5565"),
443 #define BTUSB_MAX_ISOC_FRAMES 10
445 #define BTUSB_INTR_RUNNING 0
446 #define BTUSB_BULK_RUNNING 1
447 #define BTUSB_ISOC_RUNNING 2
448 #define BTUSB_SUSPENDING 3
449 #define BTUSB_DID_ISO_RESUME 4
450 #define BTUSB_BOOTLOADER 5
451 #define BTUSB_DOWNLOADING 6
452 #define BTUSB_FIRMWARE_LOADED 7
453 #define BTUSB_FIRMWARE_FAILED 8
454 #define BTUSB_BOOTING 9
455 #define BTUSB_DIAG_RUNNING 10
456 #define BTUSB_OOB_WAKE_ENABLED 11
457 #define BTUSB_HW_RESET_ACTIVE 12
458 #define BTUSB_TX_WAIT_VND_EVT 13
459 #define BTUSB_WAKEUP_DISABLE 14
460 #define BTUSB_USE_ALT1_FOR_WBS 15
463 struct hci_dev *hdev;
464 struct usb_device *udev;
465 struct usb_interface *intf;
466 struct usb_interface *isoc;
467 struct usb_interface *diag;
472 struct work_struct work;
473 struct work_struct waker;
475 struct usb_anchor deferred;
476 struct usb_anchor tx_anchor;
480 struct usb_anchor intr_anchor;
481 struct usb_anchor bulk_anchor;
482 struct usb_anchor isoc_anchor;
483 struct usb_anchor diag_anchor;
484 struct usb_anchor ctrl_anchor;
487 struct sk_buff *evt_skb;
488 struct sk_buff *acl_skb;
489 struct sk_buff *sco_skb;
491 struct usb_endpoint_descriptor *intr_ep;
492 struct usb_endpoint_descriptor *bulk_tx_ep;
493 struct usb_endpoint_descriptor *bulk_rx_ep;
494 struct usb_endpoint_descriptor *isoc_tx_ep;
495 struct usb_endpoint_descriptor *isoc_rx_ep;
496 struct usb_endpoint_descriptor *diag_tx_ep;
497 struct usb_endpoint_descriptor *diag_rx_ep;
499 struct gpio_desc *reset_gpio;
504 unsigned int sco_num;
505 unsigned int air_mode;
506 bool usb_alt6_packet_flow;
510 int (*recv_event)(struct hci_dev *hdev, struct sk_buff *skb);
511 int (*recv_bulk)(struct btusb_data *data, void *buffer, int count);
513 int (*setup_on_usb)(struct hci_dev *hdev);
515 int oob_wake_irq; /* irq for out-of-band wake-on-bt */
516 unsigned cmd_timeout_cnt;
519 static void btusb_intel_cmd_timeout(struct hci_dev *hdev)
521 struct btusb_data *data = hci_get_drvdata(hdev);
522 struct gpio_desc *reset_gpio = data->reset_gpio;
524 if (++data->cmd_timeout_cnt < 5)
528 bt_dev_err(hdev, "No way to reset. Ignoring and continuing");
533 * Toggle the hard reset line if the platform provides one. The reset
534 * is going to yank the device off the USB and then replug. So doing
535 * once is enough. The cleanup is handled correctly on the way out
536 * (standard USB disconnect), and the new device is detected cleanly
537 * and bound to the driver again like it should be.
539 if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
540 bt_dev_err(hdev, "last reset failed? Not resetting again");
544 bt_dev_err(hdev, "Initiating HW reset via gpio");
545 gpiod_set_value_cansleep(reset_gpio, 1);
547 gpiod_set_value_cansleep(reset_gpio, 0);
550 static void btusb_rtl_cmd_timeout(struct hci_dev *hdev)
552 struct btusb_data *data = hci_get_drvdata(hdev);
553 struct gpio_desc *reset_gpio = data->reset_gpio;
555 if (++data->cmd_timeout_cnt < 5)
559 bt_dev_err(hdev, "No gpio to reset Realtek device, ignoring");
563 /* Toggle the hard reset line. The Realtek device is going to
564 * yank itself off the USB and then replug. The cleanup is handled
565 * correctly on the way out (standard USB disconnect), and the new
566 * device is detected cleanly and bound to the driver again like
569 if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
570 bt_dev_err(hdev, "last reset failed? Not resetting again");
574 bt_dev_err(hdev, "Reset Realtek device via gpio");
575 gpiod_set_value_cansleep(reset_gpio, 1);
577 gpiod_set_value_cansleep(reset_gpio, 0);
580 static void btusb_qca_cmd_timeout(struct hci_dev *hdev)
582 struct btusb_data *data = hci_get_drvdata(hdev);
585 if (++data->cmd_timeout_cnt < 5)
588 bt_dev_err(hdev, "Multiple cmd timeouts seen. Resetting usb device.");
589 /* This is not an unbalanced PM reference since the device will reset */
590 err = usb_autopm_get_interface(data->intf);
592 usb_queue_reset_device(data->intf);
594 bt_dev_err(hdev, "Failed usb_autopm_get_interface with %d", err);
597 static inline void btusb_free_frags(struct btusb_data *data)
601 spin_lock_irqsave(&data->rxlock, flags);
603 kfree_skb(data->evt_skb);
604 data->evt_skb = NULL;
606 kfree_skb(data->acl_skb);
607 data->acl_skb = NULL;
609 kfree_skb(data->sco_skb);
610 data->sco_skb = NULL;
612 spin_unlock_irqrestore(&data->rxlock, flags);
615 static int btusb_recv_intr(struct btusb_data *data, void *buffer, int count)
621 spin_lock_irqsave(&data->rxlock, flags);
628 skb = bt_skb_alloc(HCI_MAX_EVENT_SIZE, GFP_ATOMIC);
634 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
635 hci_skb_expect(skb) = HCI_EVENT_HDR_SIZE;
638 len = min_t(uint, hci_skb_expect(skb), count);
639 skb_put_data(skb, buffer, len);
643 hci_skb_expect(skb) -= len;
645 if (skb->len == HCI_EVENT_HDR_SIZE) {
646 /* Complete event header */
647 hci_skb_expect(skb) = hci_event_hdr(skb)->plen;
649 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
658 if (!hci_skb_expect(skb)) {
660 data->recv_event(data->hdev, skb);
666 spin_unlock_irqrestore(&data->rxlock, flags);
671 static int btusb_recv_bulk(struct btusb_data *data, void *buffer, int count)
677 spin_lock_irqsave(&data->rxlock, flags);
684 skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
690 hci_skb_pkt_type(skb) = HCI_ACLDATA_PKT;
691 hci_skb_expect(skb) = HCI_ACL_HDR_SIZE;
694 len = min_t(uint, hci_skb_expect(skb), count);
695 skb_put_data(skb, buffer, len);
699 hci_skb_expect(skb) -= len;
701 if (skb->len == HCI_ACL_HDR_SIZE) {
702 __le16 dlen = hci_acl_hdr(skb)->dlen;
704 /* Complete ACL header */
705 hci_skb_expect(skb) = __le16_to_cpu(dlen);
707 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
716 if (!hci_skb_expect(skb)) {
718 hci_recv_frame(data->hdev, skb);
724 spin_unlock_irqrestore(&data->rxlock, flags);
729 static int btusb_recv_isoc(struct btusb_data *data, void *buffer, int count)
735 spin_lock_irqsave(&data->rxlock, flags);
742 skb = bt_skb_alloc(HCI_MAX_SCO_SIZE, GFP_ATOMIC);
748 hci_skb_pkt_type(skb) = HCI_SCODATA_PKT;
749 hci_skb_expect(skb) = HCI_SCO_HDR_SIZE;
752 len = min_t(uint, hci_skb_expect(skb), count);
753 skb_put_data(skb, buffer, len);
757 hci_skb_expect(skb) -= len;
759 if (skb->len == HCI_SCO_HDR_SIZE) {
760 /* Complete SCO header */
761 hci_skb_expect(skb) = hci_sco_hdr(skb)->dlen;
763 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
772 if (!hci_skb_expect(skb)) {
774 hci_recv_frame(data->hdev, skb);
780 spin_unlock_irqrestore(&data->rxlock, flags);
785 static void btusb_intr_complete(struct urb *urb)
787 struct hci_dev *hdev = urb->context;
788 struct btusb_data *data = hci_get_drvdata(hdev);
791 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
794 if (!test_bit(HCI_RUNNING, &hdev->flags))
797 if (urb->status == 0) {
798 hdev->stat.byte_rx += urb->actual_length;
800 if (btusb_recv_intr(data, urb->transfer_buffer,
801 urb->actual_length) < 0) {
802 bt_dev_err(hdev, "corrupted event packet");
805 } else if (urb->status == -ENOENT) {
806 /* Avoid suspend failed when usb_kill_urb */
810 if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
813 usb_mark_last_busy(data->udev);
814 usb_anchor_urb(urb, &data->intr_anchor);
816 err = usb_submit_urb(urb, GFP_ATOMIC);
818 /* -EPERM: urb is being killed;
819 * -ENODEV: device got disconnected
821 if (err != -EPERM && err != -ENODEV)
822 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
824 usb_unanchor_urb(urb);
828 static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
830 struct btusb_data *data = hci_get_drvdata(hdev);
836 BT_DBG("%s", hdev->name);
841 urb = usb_alloc_urb(0, mem_flags);
845 size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
847 buf = kmalloc(size, mem_flags);
853 pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
855 usb_fill_int_urb(urb, data->udev, pipe, buf, size,
856 btusb_intr_complete, hdev, data->intr_ep->bInterval);
858 urb->transfer_flags |= URB_FREE_BUFFER;
860 usb_anchor_urb(urb, &data->intr_anchor);
862 err = usb_submit_urb(urb, mem_flags);
864 if (err != -EPERM && err != -ENODEV)
865 bt_dev_err(hdev, "urb %p submission failed (%d)",
867 usb_unanchor_urb(urb);
875 static void btusb_bulk_complete(struct urb *urb)
877 struct hci_dev *hdev = urb->context;
878 struct btusb_data *data = hci_get_drvdata(hdev);
881 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
884 if (!test_bit(HCI_RUNNING, &hdev->flags))
887 if (urb->status == 0) {
888 hdev->stat.byte_rx += urb->actual_length;
890 if (data->recv_bulk(data, urb->transfer_buffer,
891 urb->actual_length) < 0) {
892 bt_dev_err(hdev, "corrupted ACL packet");
895 } else if (urb->status == -ENOENT) {
896 /* Avoid suspend failed when usb_kill_urb */
900 if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
903 usb_anchor_urb(urb, &data->bulk_anchor);
904 usb_mark_last_busy(data->udev);
906 err = usb_submit_urb(urb, GFP_ATOMIC);
908 /* -EPERM: urb is being killed;
909 * -ENODEV: device got disconnected
911 if (err != -EPERM && err != -ENODEV)
912 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
914 usb_unanchor_urb(urb);
918 static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
920 struct btusb_data *data = hci_get_drvdata(hdev);
924 int err, size = HCI_MAX_FRAME_SIZE;
926 BT_DBG("%s", hdev->name);
928 if (!data->bulk_rx_ep)
931 urb = usb_alloc_urb(0, mem_flags);
935 buf = kmalloc(size, mem_flags);
941 pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
943 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
944 btusb_bulk_complete, hdev);
946 urb->transfer_flags |= URB_FREE_BUFFER;
948 usb_mark_last_busy(data->udev);
949 usb_anchor_urb(urb, &data->bulk_anchor);
951 err = usb_submit_urb(urb, mem_flags);
953 if (err != -EPERM && err != -ENODEV)
954 bt_dev_err(hdev, "urb %p submission failed (%d)",
956 usb_unanchor_urb(urb);
964 static void btusb_isoc_complete(struct urb *urb)
966 struct hci_dev *hdev = urb->context;
967 struct btusb_data *data = hci_get_drvdata(hdev);
970 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
973 if (!test_bit(HCI_RUNNING, &hdev->flags))
976 if (urb->status == 0) {
977 for (i = 0; i < urb->number_of_packets; i++) {
978 unsigned int offset = urb->iso_frame_desc[i].offset;
979 unsigned int length = urb->iso_frame_desc[i].actual_length;
981 if (urb->iso_frame_desc[i].status)
984 hdev->stat.byte_rx += length;
986 if (btusb_recv_isoc(data, urb->transfer_buffer + offset,
988 bt_dev_err(hdev, "corrupted SCO packet");
992 } else if (urb->status == -ENOENT) {
993 /* Avoid suspend failed when usb_kill_urb */
997 if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
1000 usb_anchor_urb(urb, &data->isoc_anchor);
1002 err = usb_submit_urb(urb, GFP_ATOMIC);
1004 /* -EPERM: urb is being killed;
1005 * -ENODEV: device got disconnected
1007 if (err != -EPERM && err != -ENODEV)
1008 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
1010 usb_unanchor_urb(urb);
1014 static inline void __fill_isoc_descriptor_msbc(struct urb *urb, int len,
1015 int mtu, struct btusb_data *data)
1018 unsigned int interval;
1020 BT_DBG("len %d mtu %d", len, mtu);
1022 /* For mSBC ALT 6 setting the host will send the packet at continuous
1023 * flow. As per core spec 5, vol 4, part B, table 2.1. For ALT setting
1024 * 6 the HCI PACKET INTERVAL should be 7.5ms for every usb packets.
1025 * To maintain the rate we send 63bytes of usb packets alternatively for
1026 * 7ms and 8ms to maintain the rate as 7.5ms.
1028 if (data->usb_alt6_packet_flow) {
1030 data->usb_alt6_packet_flow = false;
1033 data->usb_alt6_packet_flow = true;
1036 for (i = 0; i < interval; i++) {
1037 urb->iso_frame_desc[i].offset = offset;
1038 urb->iso_frame_desc[i].length = offset;
1041 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
1042 urb->iso_frame_desc[i].offset = offset;
1043 urb->iso_frame_desc[i].length = len;
1047 urb->number_of_packets = i;
1050 static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
1054 BT_DBG("len %d mtu %d", len, mtu);
1056 for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
1057 i++, offset += mtu, len -= mtu) {
1058 urb->iso_frame_desc[i].offset = offset;
1059 urb->iso_frame_desc[i].length = mtu;
1062 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
1063 urb->iso_frame_desc[i].offset = offset;
1064 urb->iso_frame_desc[i].length = len;
1068 urb->number_of_packets = i;
1071 static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
1073 struct btusb_data *data = hci_get_drvdata(hdev);
1079 BT_DBG("%s", hdev->name);
1081 if (!data->isoc_rx_ep)
1084 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
1088 size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
1089 BTUSB_MAX_ISOC_FRAMES;
1091 buf = kmalloc(size, mem_flags);
1097 pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
1099 usb_fill_int_urb(urb, data->udev, pipe, buf, size, btusb_isoc_complete,
1100 hdev, data->isoc_rx_ep->bInterval);
1102 urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
1104 __fill_isoc_descriptor(urb, size,
1105 le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
1107 usb_anchor_urb(urb, &data->isoc_anchor);
1109 err = usb_submit_urb(urb, mem_flags);
1111 if (err != -EPERM && err != -ENODEV)
1112 bt_dev_err(hdev, "urb %p submission failed (%d)",
1114 usb_unanchor_urb(urb);
1122 static void btusb_diag_complete(struct urb *urb)
1124 struct hci_dev *hdev = urb->context;
1125 struct btusb_data *data = hci_get_drvdata(hdev);
1128 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1129 urb->actual_length);
1131 if (urb->status == 0) {
1132 struct sk_buff *skb;
1134 skb = bt_skb_alloc(urb->actual_length, GFP_ATOMIC);
1136 skb_put_data(skb, urb->transfer_buffer,
1137 urb->actual_length);
1138 hci_recv_diag(hdev, skb);
1140 } else if (urb->status == -ENOENT) {
1141 /* Avoid suspend failed when usb_kill_urb */
1145 if (!test_bit(BTUSB_DIAG_RUNNING, &data->flags))
1148 usb_anchor_urb(urb, &data->diag_anchor);
1149 usb_mark_last_busy(data->udev);
1151 err = usb_submit_urb(urb, GFP_ATOMIC);
1153 /* -EPERM: urb is being killed;
1154 * -ENODEV: device got disconnected
1156 if (err != -EPERM && err != -ENODEV)
1157 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
1159 usb_unanchor_urb(urb);
1163 static int btusb_submit_diag_urb(struct hci_dev *hdev, gfp_t mem_flags)
1165 struct btusb_data *data = hci_get_drvdata(hdev);
1169 int err, size = HCI_MAX_FRAME_SIZE;
1171 BT_DBG("%s", hdev->name);
1173 if (!data->diag_rx_ep)
1176 urb = usb_alloc_urb(0, mem_flags);
1180 buf = kmalloc(size, mem_flags);
1186 pipe = usb_rcvbulkpipe(data->udev, data->diag_rx_ep->bEndpointAddress);
1188 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
1189 btusb_diag_complete, hdev);
1191 urb->transfer_flags |= URB_FREE_BUFFER;
1193 usb_mark_last_busy(data->udev);
1194 usb_anchor_urb(urb, &data->diag_anchor);
1196 err = usb_submit_urb(urb, mem_flags);
1198 if (err != -EPERM && err != -ENODEV)
1199 bt_dev_err(hdev, "urb %p submission failed (%d)",
1201 usb_unanchor_urb(urb);
1209 static void btusb_tx_complete(struct urb *urb)
1211 struct sk_buff *skb = urb->context;
1212 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1213 struct btusb_data *data = hci_get_drvdata(hdev);
1214 unsigned long flags;
1216 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1217 urb->actual_length);
1219 if (!test_bit(HCI_RUNNING, &hdev->flags))
1223 hdev->stat.byte_tx += urb->transfer_buffer_length;
1225 hdev->stat.err_tx++;
1228 spin_lock_irqsave(&data->txlock, flags);
1229 data->tx_in_flight--;
1230 spin_unlock_irqrestore(&data->txlock, flags);
1232 kfree(urb->setup_packet);
1237 static void btusb_isoc_tx_complete(struct urb *urb)
1239 struct sk_buff *skb = urb->context;
1240 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1242 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1243 urb->actual_length);
1245 if (!test_bit(HCI_RUNNING, &hdev->flags))
1249 hdev->stat.byte_tx += urb->transfer_buffer_length;
1251 hdev->stat.err_tx++;
1254 kfree(urb->setup_packet);
1259 static int btusb_open(struct hci_dev *hdev)
1261 struct btusb_data *data = hci_get_drvdata(hdev);
1264 BT_DBG("%s", hdev->name);
1266 err = usb_autopm_get_interface(data->intf);
1270 /* Patching USB firmware files prior to starting any URBs of HCI path
1271 * It is more safe to use USB bulk channel for downloading USB patch
1273 if (data->setup_on_usb) {
1274 err = data->setup_on_usb(hdev);
1279 data->intf->needs_remote_wakeup = 1;
1281 /* Disable device remote wakeup when host is suspended
1282 * For Realtek chips, global suspend without
1283 * SET_FEATURE (DEVICE_REMOTE_WAKEUP) can save more power in device.
1285 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1286 device_wakeup_disable(&data->udev->dev);
1288 if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
1291 err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
1295 err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1297 usb_kill_anchored_urbs(&data->intr_anchor);
1301 set_bit(BTUSB_BULK_RUNNING, &data->flags);
1302 btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1305 if (!btusb_submit_diag_urb(hdev, GFP_KERNEL))
1306 set_bit(BTUSB_DIAG_RUNNING, &data->flags);
1310 usb_autopm_put_interface(data->intf);
1314 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1316 usb_autopm_put_interface(data->intf);
1320 static void btusb_stop_traffic(struct btusb_data *data)
1322 usb_kill_anchored_urbs(&data->intr_anchor);
1323 usb_kill_anchored_urbs(&data->bulk_anchor);
1324 usb_kill_anchored_urbs(&data->isoc_anchor);
1325 usb_kill_anchored_urbs(&data->diag_anchor);
1326 usb_kill_anchored_urbs(&data->ctrl_anchor);
1329 static int btusb_close(struct hci_dev *hdev)
1331 struct btusb_data *data = hci_get_drvdata(hdev);
1334 BT_DBG("%s", hdev->name);
1336 cancel_work_sync(&data->work);
1337 cancel_work_sync(&data->waker);
1339 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1340 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
1341 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1342 clear_bit(BTUSB_DIAG_RUNNING, &data->flags);
1344 btusb_stop_traffic(data);
1345 btusb_free_frags(data);
1347 err = usb_autopm_get_interface(data->intf);
1351 data->intf->needs_remote_wakeup = 0;
1353 /* Enable remote wake up for auto-suspend */
1354 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1355 data->intf->needs_remote_wakeup = 1;
1357 usb_autopm_put_interface(data->intf);
1360 usb_scuttle_anchored_urbs(&data->deferred);
1364 static int btusb_flush(struct hci_dev *hdev)
1366 struct btusb_data *data = hci_get_drvdata(hdev);
1368 BT_DBG("%s", hdev->name);
1370 usb_kill_anchored_urbs(&data->tx_anchor);
1371 btusb_free_frags(data);
1376 static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1378 struct btusb_data *data = hci_get_drvdata(hdev);
1379 struct usb_ctrlrequest *dr;
1383 urb = usb_alloc_urb(0, GFP_KERNEL);
1385 return ERR_PTR(-ENOMEM);
1387 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1390 return ERR_PTR(-ENOMEM);
1393 dr->bRequestType = data->cmdreq_type;
1394 dr->bRequest = data->cmdreq;
1397 dr->wLength = __cpu_to_le16(skb->len);
1399 pipe = usb_sndctrlpipe(data->udev, 0x00);
1401 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1402 skb->data, skb->len, btusb_tx_complete, skb);
1404 skb->dev = (void *)hdev;
1409 static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1411 struct btusb_data *data = hci_get_drvdata(hdev);
1415 if (!data->bulk_tx_ep)
1416 return ERR_PTR(-ENODEV);
1418 urb = usb_alloc_urb(0, GFP_KERNEL);
1420 return ERR_PTR(-ENOMEM);
1422 pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1424 usb_fill_bulk_urb(urb, data->udev, pipe,
1425 skb->data, skb->len, btusb_tx_complete, skb);
1427 skb->dev = (void *)hdev;
1432 static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1434 struct btusb_data *data = hci_get_drvdata(hdev);
1438 if (!data->isoc_tx_ep)
1439 return ERR_PTR(-ENODEV);
1441 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1443 return ERR_PTR(-ENOMEM);
1445 pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1447 usb_fill_int_urb(urb, data->udev, pipe,
1448 skb->data, skb->len, btusb_isoc_tx_complete,
1449 skb, data->isoc_tx_ep->bInterval);
1451 urb->transfer_flags = URB_ISO_ASAP;
1453 if (data->isoc_altsetting == 6)
1454 __fill_isoc_descriptor_msbc(urb, skb->len,
1455 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize),
1458 __fill_isoc_descriptor(urb, skb->len,
1459 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1460 skb->dev = (void *)hdev;
1465 static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1467 struct btusb_data *data = hci_get_drvdata(hdev);
1470 usb_anchor_urb(urb, &data->tx_anchor);
1472 err = usb_submit_urb(urb, GFP_KERNEL);
1474 if (err != -EPERM && err != -ENODEV)
1475 bt_dev_err(hdev, "urb %p submission failed (%d)",
1477 kfree(urb->setup_packet);
1478 usb_unanchor_urb(urb);
1480 usb_mark_last_busy(data->udev);
1487 static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1489 struct btusb_data *data = hci_get_drvdata(hdev);
1490 unsigned long flags;
1493 spin_lock_irqsave(&data->txlock, flags);
1494 suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1496 data->tx_in_flight++;
1497 spin_unlock_irqrestore(&data->txlock, flags);
1500 return submit_tx_urb(hdev, urb);
1502 usb_anchor_urb(urb, &data->deferred);
1503 schedule_work(&data->waker);
1509 static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1513 BT_DBG("%s", hdev->name);
1515 switch (hci_skb_pkt_type(skb)) {
1516 case HCI_COMMAND_PKT:
1517 urb = alloc_ctrl_urb(hdev, skb);
1519 return PTR_ERR(urb);
1521 hdev->stat.cmd_tx++;
1522 return submit_or_queue_tx_urb(hdev, urb);
1524 case HCI_ACLDATA_PKT:
1525 urb = alloc_bulk_urb(hdev, skb);
1527 return PTR_ERR(urb);
1529 hdev->stat.acl_tx++;
1530 return submit_or_queue_tx_urb(hdev, urb);
1532 case HCI_SCODATA_PKT:
1533 if (hci_conn_num(hdev, SCO_LINK) < 1)
1536 urb = alloc_isoc_urb(hdev, skb);
1538 return PTR_ERR(urb);
1540 hdev->stat.sco_tx++;
1541 return submit_tx_urb(hdev, urb);
1547 static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1549 struct btusb_data *data = hci_get_drvdata(hdev);
1551 BT_DBG("%s evt %d", hdev->name, evt);
1553 if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1554 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1555 data->air_mode = evt;
1556 schedule_work(&data->work);
1560 static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1562 struct btusb_data *data = hci_get_drvdata(hdev);
1563 struct usb_interface *intf = data->isoc;
1564 struct usb_endpoint_descriptor *ep_desc;
1570 err = usb_set_interface(data->udev, data->isoc_ifnum, altsetting);
1572 bt_dev_err(hdev, "setting interface failed (%d)", -err);
1576 data->isoc_altsetting = altsetting;
1578 data->isoc_tx_ep = NULL;
1579 data->isoc_rx_ep = NULL;
1581 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1582 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1584 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1585 data->isoc_tx_ep = ep_desc;
1589 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1590 data->isoc_rx_ep = ep_desc;
1595 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1596 bt_dev_err(hdev, "invalid SCO descriptors");
1603 static int btusb_switch_alt_setting(struct hci_dev *hdev, int new_alts)
1605 struct btusb_data *data = hci_get_drvdata(hdev);
1608 if (data->isoc_altsetting != new_alts) {
1609 unsigned long flags;
1611 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1612 usb_kill_anchored_urbs(&data->isoc_anchor);
1614 /* When isochronous alternate setting needs to be
1615 * changed, because SCO connection has been added
1616 * or removed, a packet fragment may be left in the
1617 * reassembling state. This could lead to wrongly
1618 * assembled fragments.
1620 * Clear outstanding fragment when selecting a new
1621 * alternate setting.
1623 spin_lock_irqsave(&data->rxlock, flags);
1624 kfree_skb(data->sco_skb);
1625 data->sco_skb = NULL;
1626 spin_unlock_irqrestore(&data->rxlock, flags);
1628 err = __set_isoc_interface(hdev, new_alts);
1633 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1634 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1635 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1637 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1643 static struct usb_host_interface *btusb_find_altsetting(struct btusb_data *data,
1646 struct usb_interface *intf = data->isoc;
1649 BT_DBG("Looking for Alt no :%d", alt);
1654 for (i = 0; i < intf->num_altsetting; i++) {
1655 if (intf->altsetting[i].desc.bAlternateSetting == alt)
1656 return &intf->altsetting[i];
1662 static void btusb_work(struct work_struct *work)
1664 struct btusb_data *data = container_of(work, struct btusb_data, work);
1665 struct hci_dev *hdev = data->hdev;
1669 if (data->sco_num > 0) {
1670 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1671 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1673 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1674 usb_kill_anchored_urbs(&data->isoc_anchor);
1678 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1681 if (data->air_mode == HCI_NOTIFY_ENABLE_SCO_CVSD) {
1682 if (hdev->voice_setting & 0x0020) {
1683 static const int alts[3] = { 2, 4, 5 };
1685 new_alts = alts[data->sco_num - 1];
1687 new_alts = data->sco_num;
1689 } else if (data->air_mode == HCI_NOTIFY_ENABLE_SCO_TRANSP) {
1690 /* Check if Alt 6 is supported for Transparent audio */
1691 if (btusb_find_altsetting(data, 6)) {
1692 data->usb_alt6_packet_flow = true;
1694 } else if (test_bit(BTUSB_USE_ALT1_FOR_WBS, &data->flags)) {
1697 bt_dev_err(hdev, "Device does not support ALT setting 6");
1701 if (btusb_switch_alt_setting(hdev, new_alts) < 0)
1702 bt_dev_err(hdev, "set USB alt:(%d) failed!", new_alts);
1704 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1705 usb_kill_anchored_urbs(&data->isoc_anchor);
1707 __set_isoc_interface(hdev, 0);
1708 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1709 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1713 static void btusb_waker(struct work_struct *work)
1715 struct btusb_data *data = container_of(work, struct btusb_data, waker);
1718 err = usb_autopm_get_interface(data->intf);
1722 usb_autopm_put_interface(data->intf);
1725 static int btusb_setup_bcm92035(struct hci_dev *hdev)
1727 struct sk_buff *skb;
1730 BT_DBG("%s", hdev->name);
1732 skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1734 bt_dev_err(hdev, "BCM92035 command failed (%ld)", PTR_ERR(skb));
1741 static int btusb_setup_csr(struct hci_dev *hdev)
1743 struct hci_rp_read_local_version *rp;
1744 struct sk_buff *skb;
1745 bool is_fake = false;
1747 BT_DBG("%s", hdev->name);
1749 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1752 int err = PTR_ERR(skb);
1753 bt_dev_err(hdev, "CSR: Local version failed (%d)", err);
1757 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1758 bt_dev_err(hdev, "CSR: Local version length mismatch");
1763 rp = (struct hci_rp_read_local_version *)skb->data;
1765 /* Detect a wide host of Chinese controllers that aren't CSR.
1767 * Known fake bcdDevices: 0x0100, 0x0134, 0x1915, 0x2520, 0x7558, 0x8891
1769 * The main thing they have in common is that these are really popular low-cost
1770 * options that support newer Bluetooth versions but rely on heavy VID/PID
1771 * squatting of this poor old Bluetooth 1.1 device. Even sold as such.
1773 * We detect actual CSR devices by checking that the HCI manufacturer code
1774 * is Cambridge Silicon Radio (10) and ensuring that LMP sub-version and
1775 * HCI rev values always match. As they both store the firmware number.
1777 if (le16_to_cpu(rp->manufacturer) != 10 ||
1778 le16_to_cpu(rp->hci_rev) != le16_to_cpu(rp->lmp_subver))
1781 /* Known legit CSR firmware build numbers and their supported BT versions:
1782 * - 1.1 (0x1) -> 0x0073, 0x020d, 0x033c, 0x034e
1783 * - 1.2 (0x2) -> 0x04d9, 0x0529
1784 * - 2.0 (0x3) -> 0x07a6, 0x07ad, 0x0c5c
1785 * - 2.1 (0x4) -> 0x149c, 0x1735, 0x1899 (0x1899 is a BlueCore4-External)
1786 * - 4.0 (0x6) -> 0x1d86, 0x2031, 0x22bb
1788 * e.g. Real CSR dongles with LMP subversion 0x73 are old enough that
1789 * support BT 1.1 only; so it's a dead giveaway when some
1790 * third-party BT 4.0 dongle reuses it.
1792 else if (le16_to_cpu(rp->lmp_subver) <= 0x034e &&
1793 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_1_1)
1796 else if (le16_to_cpu(rp->lmp_subver) <= 0x0529 &&
1797 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_1_2)
1800 else if (le16_to_cpu(rp->lmp_subver) <= 0x0c5c &&
1801 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_2_0)
1804 else if (le16_to_cpu(rp->lmp_subver) <= 0x1899 &&
1805 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_2_1)
1808 else if (le16_to_cpu(rp->lmp_subver) <= 0x22bb &&
1809 le16_to_cpu(rp->hci_ver) > BLUETOOTH_VER_4_0)
1813 bt_dev_warn(hdev, "CSR: Unbranded CSR clone detected; adding workarounds...");
1815 /* Generally these clones have big discrepancies between
1816 * advertised features and what's actually supported.
1817 * Probably will need to be expanded in the future;
1818 * without these the controller will lock up.
1820 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
1821 set_bit(HCI_QUIRK_BROKEN_ERR_DATA_REPORTING, &hdev->quirks);
1823 /* Clear the reset quirk since this is not an actual
1824 * early Bluetooth 1.1 device from CSR.
1826 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1827 clear_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
1835 static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1836 struct intel_version *ver)
1838 const struct firmware *fw;
1842 snprintf(fwname, sizeof(fwname),
1843 "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1844 ver->hw_platform, ver->hw_variant, ver->hw_revision,
1845 ver->fw_variant, ver->fw_revision, ver->fw_build_num,
1846 ver->fw_build_ww, ver->fw_build_yy);
1848 ret = request_firmware(&fw, fwname, &hdev->dev);
1850 if (ret == -EINVAL) {
1851 bt_dev_err(hdev, "Intel firmware file request failed (%d)",
1856 bt_dev_err(hdev, "failed to open Intel firmware file: %s (%d)",
1859 /* If the correct firmware patch file is not found, use the
1860 * default firmware patch file instead
1862 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1863 ver->hw_platform, ver->hw_variant);
1864 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1865 bt_dev_err(hdev, "failed to open default fw file: %s",
1871 bt_dev_info(hdev, "Intel Bluetooth firmware file: %s", fwname);
1876 static int btusb_setup_intel_patching(struct hci_dev *hdev,
1877 const struct firmware *fw,
1878 const u8 **fw_ptr, int *disable_patch)
1880 struct sk_buff *skb;
1881 struct hci_command_hdr *cmd;
1882 const u8 *cmd_param;
1883 struct hci_event_hdr *evt = NULL;
1884 const u8 *evt_param = NULL;
1885 int remain = fw->size - (*fw_ptr - fw->data);
1887 /* The first byte indicates the types of the patch command or event.
1888 * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1889 * in the current firmware buffer doesn't start with 0x01 or
1890 * the size of remain buffer is smaller than HCI command header,
1891 * the firmware file is corrupted and it should stop the patching
1894 if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1895 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd read");
1901 cmd = (struct hci_command_hdr *)(*fw_ptr);
1902 *fw_ptr += sizeof(*cmd);
1903 remain -= sizeof(*cmd);
1905 /* Ensure that the remain firmware data is long enough than the length
1906 * of command parameter. If not, the firmware file is corrupted.
1908 if (remain < cmd->plen) {
1909 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd len");
1913 /* If there is a command that loads a patch in the firmware
1914 * file, then enable the patch upon success, otherwise just
1915 * disable the manufacturer mode, for example patch activation
1916 * is not required when the default firmware patch file is used
1917 * because there are no patch data to load.
1919 if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
1922 cmd_param = *fw_ptr;
1923 *fw_ptr += cmd->plen;
1924 remain -= cmd->plen;
1926 /* This reads the expected events when the above command is sent to the
1927 * device. Some vendor commands expects more than one events, for
1928 * example command status event followed by vendor specific event.
1929 * For this case, it only keeps the last expected event. so the command
1930 * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
1931 * last expected event.
1933 while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
1937 evt = (struct hci_event_hdr *)(*fw_ptr);
1938 *fw_ptr += sizeof(*evt);
1939 remain -= sizeof(*evt);
1941 if (remain < evt->plen) {
1942 bt_dev_err(hdev, "Intel fw corrupted: invalid evt len");
1946 evt_param = *fw_ptr;
1947 *fw_ptr += evt->plen;
1948 remain -= evt->plen;
1951 /* Every HCI commands in the firmware file has its correspond event.
1952 * If event is not found or remain is smaller than zero, the firmware
1953 * file is corrupted.
1955 if (!evt || !evt_param || remain < 0) {
1956 bt_dev_err(hdev, "Intel fw corrupted: invalid evt read");
1960 skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
1961 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
1963 bt_dev_err(hdev, "sending Intel patch command (0x%4.4x) failed (%ld)",
1964 cmd->opcode, PTR_ERR(skb));
1965 return PTR_ERR(skb);
1968 /* It ensures that the returned event matches the event data read from
1969 * the firmware file. At fist, it checks the length and then
1970 * the contents of the event.
1972 if (skb->len != evt->plen) {
1973 bt_dev_err(hdev, "mismatch event length (opcode 0x%4.4x)",
1974 le16_to_cpu(cmd->opcode));
1979 if (memcmp(skb->data, evt_param, evt->plen)) {
1980 bt_dev_err(hdev, "mismatch event parameter (opcode 0x%4.4x)",
1981 le16_to_cpu(cmd->opcode));
1990 static int btusb_setup_intel(struct hci_dev *hdev)
1992 struct sk_buff *skb;
1993 const struct firmware *fw;
1995 int disable_patch, err;
1996 struct intel_version ver;
1998 BT_DBG("%s", hdev->name);
2000 /* The controller has a bug with the first HCI command sent to it
2001 * returning number of completed commands as zero. This would stall the
2002 * command processing in the Bluetooth core.
2004 * As a workaround, send HCI Reset command first which will reset the
2005 * number of completed commands and allow normal command processing
2008 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2010 bt_dev_err(hdev, "sending initial HCI reset command failed (%ld)",
2012 return PTR_ERR(skb);
2016 /* Read Intel specific controller version first to allow selection of
2017 * which firmware file to load.
2019 * The returned information are hardware variant and revision plus
2020 * firmware variant, revision and build number.
2022 err = btintel_read_version(hdev, &ver);
2026 bt_dev_info(hdev, "read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
2027 ver.hw_platform, ver.hw_variant, ver.hw_revision,
2028 ver.fw_variant, ver.fw_revision, ver.fw_build_num,
2029 ver.fw_build_ww, ver.fw_build_yy, ver.fw_patch_num);
2031 /* fw_patch_num indicates the version of patch the device currently
2032 * have. If there is no patch data in the device, it is always 0x00.
2033 * So, if it is other than 0x00, no need to patch the device again.
2035 if (ver.fw_patch_num) {
2036 bt_dev_info(hdev, "Intel device is already patched. "
2037 "patch num: %02x", ver.fw_patch_num);
2041 /* Opens the firmware patch file based on the firmware version read
2042 * from the controller. If it fails to open the matching firmware
2043 * patch file, it tries to open the default firmware patch file.
2044 * If no patch file is found, allow the device to operate without
2047 fw = btusb_setup_intel_get_fw(hdev, &ver);
2052 /* Enable the manufacturer mode of the controller.
2053 * Only while this mode is enabled, the driver can download the
2054 * firmware patch data and configuration parameters.
2056 err = btintel_enter_mfg(hdev);
2058 release_firmware(fw);
2064 /* The firmware data file consists of list of Intel specific HCI
2065 * commands and its expected events. The first byte indicates the
2066 * type of the message, either HCI command or HCI event.
2068 * It reads the command and its expected event from the firmware file,
2069 * and send to the controller. Once __hci_cmd_sync_ev() returns,
2070 * the returned event is compared with the event read from the firmware
2071 * file and it will continue until all the messages are downloaded to
2074 * Once the firmware patching is completed successfully,
2075 * the manufacturer mode is disabled with reset and activating the
2078 * If the firmware patching fails, the manufacturer mode is
2079 * disabled with reset and deactivating the patch.
2081 * If the default patch file is used, no reset is done when disabling
2084 while (fw->size > fw_ptr - fw->data) {
2087 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
2090 goto exit_mfg_deactivate;
2093 release_firmware(fw);
2096 goto exit_mfg_disable;
2098 /* Patching completed successfully and disable the manufacturer mode
2099 * with reset and activate the downloaded firmware patches.
2101 err = btintel_exit_mfg(hdev, true, true);
2105 /* Need build number for downloaded fw patches in
2106 * every power-on boot
2108 err = btintel_read_version(hdev, &ver);
2111 bt_dev_info(hdev, "Intel BT fw patch 0x%02x completed & activated",
2117 /* Disable the manufacturer mode without reset */
2118 err = btintel_exit_mfg(hdev, false, false);
2122 bt_dev_info(hdev, "Intel firmware patch completed");
2126 exit_mfg_deactivate:
2127 release_firmware(fw);
2129 /* Patching failed. Disable the manufacturer mode with reset and
2130 * deactivate the downloaded firmware patches.
2132 err = btintel_exit_mfg(hdev, true, false);
2136 bt_dev_info(hdev, "Intel firmware patch completed and deactivated");
2139 /* Set the event mask for Intel specific vendor events. This enables
2140 * a few extra events that are useful during general operation.
2142 btintel_set_event_mask_mfg(hdev, false);
2144 btintel_check_bdaddr(hdev);
2148 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
2150 struct sk_buff *skb;
2151 struct hci_event_hdr *hdr;
2152 struct hci_ev_cmd_complete *evt;
2154 skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_KERNEL);
2158 hdr = skb_put(skb, sizeof(*hdr));
2159 hdr->evt = HCI_EV_CMD_COMPLETE;
2160 hdr->plen = sizeof(*evt) + 1;
2162 evt = skb_put(skb, sizeof(*evt));
2164 evt->opcode = cpu_to_le16(opcode);
2166 skb_put_u8(skb, 0x00);
2168 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
2170 return hci_recv_frame(hdev, skb);
2173 static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
2176 /* When the device is in bootloader mode, then it can send
2177 * events via the bulk endpoint. These events are treated the
2178 * same way as the ones received from the interrupt endpoint.
2180 if (test_bit(BTUSB_BOOTLOADER, &data->flags))
2181 return btusb_recv_intr(data, buffer, count);
2183 return btusb_recv_bulk(data, buffer, count);
2186 static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
2189 const struct intel_bootup *evt = ptr;
2191 if (len != sizeof(*evt))
2194 if (test_and_clear_bit(BTUSB_BOOTING, &data->flags))
2195 wake_up_bit(&data->flags, BTUSB_BOOTING);
2198 static void btusb_intel_secure_send_result(struct btusb_data *data,
2199 const void *ptr, unsigned int len)
2201 const struct intel_secure_send_result *evt = ptr;
2203 if (len != sizeof(*evt))
2207 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
2209 if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
2210 test_bit(BTUSB_FIRMWARE_LOADED, &data->flags))
2211 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
2214 static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
2216 struct btusb_data *data = hci_get_drvdata(hdev);
2218 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2219 struct hci_event_hdr *hdr = (void *)skb->data;
2221 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
2223 const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
2224 unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
2226 switch (skb->data[2]) {
2228 /* When switching to the operational firmware
2229 * the device sends a vendor specific event
2230 * indicating that the bootup completed.
2232 btusb_intel_bootup(data, ptr, len);
2235 /* When the firmware loading completes the
2236 * device sends out a vendor specific event
2237 * indicating the result of the firmware
2240 btusb_intel_secure_send_result(data, ptr, len);
2246 return hci_recv_frame(hdev, skb);
2249 static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
2251 struct btusb_data *data = hci_get_drvdata(hdev);
2254 BT_DBG("%s", hdev->name);
2256 switch (hci_skb_pkt_type(skb)) {
2257 case HCI_COMMAND_PKT:
2258 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2259 struct hci_command_hdr *cmd = (void *)skb->data;
2260 __u16 opcode = le16_to_cpu(cmd->opcode);
2262 /* When in bootloader mode and the command 0xfc09
2263 * is received, it needs to be send down the
2264 * bulk endpoint. So allocate a bulk URB instead.
2266 if (opcode == 0xfc09)
2267 urb = alloc_bulk_urb(hdev, skb);
2269 urb = alloc_ctrl_urb(hdev, skb);
2271 /* When the 0xfc01 command is issued to boot into
2272 * the operational firmware, it will actually not
2273 * send a command complete event. To keep the flow
2274 * control working inject that event here.
2276 if (opcode == 0xfc01)
2277 inject_cmd_complete(hdev, opcode);
2279 urb = alloc_ctrl_urb(hdev, skb);
2282 return PTR_ERR(urb);
2284 hdev->stat.cmd_tx++;
2285 return submit_or_queue_tx_urb(hdev, urb);
2287 case HCI_ACLDATA_PKT:
2288 urb = alloc_bulk_urb(hdev, skb);
2290 return PTR_ERR(urb);
2292 hdev->stat.acl_tx++;
2293 return submit_or_queue_tx_urb(hdev, urb);
2295 case HCI_SCODATA_PKT:
2296 if (hci_conn_num(hdev, SCO_LINK) < 1)
2299 urb = alloc_isoc_urb(hdev, skb);
2301 return PTR_ERR(urb);
2303 hdev->stat.sco_tx++;
2304 return submit_tx_urb(hdev, urb);
2310 static bool btusb_setup_intel_new_get_fw_name(struct intel_version *ver,
2311 struct intel_boot_params *params,
2312 char *fw_name, size_t len,
2315 switch (ver->hw_variant) {
2316 case 0x0b: /* SfP */
2317 case 0x0c: /* WsP */
2318 snprintf(fw_name, len, "intel/ibt-%u-%u.%s",
2319 le16_to_cpu(ver->hw_variant),
2320 le16_to_cpu(params->dev_revid),
2323 case 0x11: /* JfP */
2324 case 0x12: /* ThP */
2325 case 0x13: /* HrP */
2326 case 0x14: /* CcP */
2327 snprintf(fw_name, len, "intel/ibt-%u-%u-%u.%s",
2328 le16_to_cpu(ver->hw_variant),
2329 le16_to_cpu(ver->hw_revision),
2330 le16_to_cpu(ver->fw_revision),
2339 static int btusb_intel_download_firmware(struct hci_dev *hdev,
2340 struct intel_version *ver,
2341 struct intel_boot_params *params)
2343 const struct firmware *fw;
2347 struct btusb_data *data = hci_get_drvdata(hdev);
2349 if (!ver || !params)
2352 /* The hardware platform number has a fixed value of 0x37 and
2353 * for now only accept this single value.
2355 if (ver->hw_platform != 0x37) {
2356 bt_dev_err(hdev, "Unsupported Intel hardware platform (%u)",
2361 /* Check for supported iBT hardware variants of this firmware
2364 * This check has been put in place to ensure correct forward
2365 * compatibility options when newer hardware variants come along.
2367 switch (ver->hw_variant) {
2368 case 0x0b: /* SfP */
2369 case 0x0c: /* WsP */
2370 case 0x11: /* JfP */
2371 case 0x12: /* ThP */
2372 case 0x13: /* HrP */
2373 case 0x14: /* CcP */
2376 bt_dev_err(hdev, "Unsupported Intel hardware variant (%u)",
2381 btintel_version_info(hdev, ver);
2383 /* The firmware variant determines if the device is in bootloader
2384 * mode or is running operational firmware. The value 0x06 identifies
2385 * the bootloader and the value 0x23 identifies the operational
2388 * When the operational firmware is already present, then only
2389 * the check for valid Bluetooth device address is needed. This
2390 * determines if the device will be added as configured or
2391 * unconfigured controller.
2393 * It is not possible to use the Secure Boot Parameters in this
2394 * case since that command is only available in bootloader mode.
2396 if (ver->fw_variant == 0x23) {
2397 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2398 btintel_check_bdaddr(hdev);
2402 /* If the device is not in bootloader mode, then the only possible
2403 * choice is to return an error and abort the device initialization.
2405 if (ver->fw_variant != 0x06) {
2406 bt_dev_err(hdev, "Unsupported Intel firmware variant (%u)",
2411 /* Read the secure boot parameters to identify the operating
2412 * details of the bootloader.
2414 err = btintel_read_boot_params(hdev, params);
2418 /* It is required that every single firmware fragment is acknowledged
2419 * with a command complete event. If the boot parameters indicate
2420 * that this bootloader does not send them, then abort the setup.
2422 if (params->limited_cce != 0x00) {
2423 bt_dev_err(hdev, "Unsupported Intel firmware loading method (%u)",
2424 params->limited_cce);
2428 /* If the OTP has no valid Bluetooth device address, then there will
2429 * also be no valid address for the operational firmware.
2431 if (!bacmp(¶ms->otp_bdaddr, BDADDR_ANY)) {
2432 bt_dev_info(hdev, "No device address configured");
2433 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2436 /* With this Intel bootloader only the hardware variant and device
2437 * revision information are used to select the right firmware for SfP
2440 * The firmware filename is ibt-<hw_variant>-<dev_revid>.sfi.
2442 * Currently the supported hardware variants are:
2443 * 11 (0x0b) for iBT3.0 (LnP/SfP)
2444 * 12 (0x0c) for iBT3.5 (WsP)
2446 * For ThP/JfP and for future SKU's, the FW name varies based on HW
2447 * variant, HW revision and FW revision, as these are dependent on CNVi
2448 * and RF Combination.
2450 * 17 (0x11) for iBT3.5 (JfP)
2451 * 18 (0x12) for iBT3.5 (ThP)
2453 * The firmware file name for these will be
2454 * ibt-<hw_variant>-<hw_revision>-<fw_revision>.sfi.
2457 err = btusb_setup_intel_new_get_fw_name(ver, params, fwname,
2458 sizeof(fwname), "sfi");
2460 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2464 err = request_firmware(&fw, fwname, &hdev->dev);
2466 bt_dev_err(hdev, "Failed to load Intel firmware file (%d)", err);
2470 bt_dev_info(hdev, "Found device firmware: %s", fwname);
2472 if (fw->size < 644) {
2473 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
2479 set_bit(BTUSB_DOWNLOADING, &data->flags);
2481 /* Start firmware downloading and get boot parameter */
2482 err = btintel_download_firmware(hdev, fw, &boot_param);
2484 /* When FW download fails, send Intel Reset to retry
2487 btintel_reset_to_bootloader(hdev);
2490 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2492 bt_dev_info(hdev, "Waiting for firmware download to complete");
2494 /* Before switching the device into operational mode and with that
2495 * booting the loaded firmware, wait for the bootloader notification
2496 * that all fragments have been successfully received.
2498 * When the event processing receives the notification, then the
2499 * BTUSB_DOWNLOADING flag will be cleared.
2501 * The firmware loading should not take longer than 5 seconds
2502 * and thus just timeout if that happens and fail the setup
2505 err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2507 msecs_to_jiffies(5000));
2508 if (err == -EINTR) {
2509 bt_dev_err(hdev, "Firmware loading interrupted");
2514 bt_dev_err(hdev, "Firmware loading timeout");
2516 btintel_reset_to_bootloader(hdev);
2520 if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2521 bt_dev_err(hdev, "Firmware loading failed");
2527 release_firmware(fw);
2531 static int btusb_setup_intel_new(struct hci_dev *hdev)
2533 struct btusb_data *data = hci_get_drvdata(hdev);
2534 struct intel_version ver;
2535 struct intel_boot_params params;
2538 ktime_t calltime, delta, rettime;
2539 unsigned long long duration;
2541 struct intel_debug_features features;
2543 BT_DBG("%s", hdev->name);
2545 /* Set the default boot parameter to 0x0 and it is updated to
2546 * SKU specific boot parameter after reading Intel_Write_Boot_Params
2547 * command while downloading the firmware.
2549 boot_param = 0x00000000;
2551 calltime = ktime_get();
2553 /* Read the Intel version information to determine if the device
2554 * is in bootloader mode or if it already has operational firmware
2557 err = btintel_read_version(hdev, &ver);
2559 bt_dev_err(hdev, "Intel Read version failed (%d)", err);
2560 btintel_reset_to_bootloader(hdev);
2564 err = btusb_intel_download_firmware(hdev, &ver, ¶ms);
2568 /* controller is already having an operational firmware */
2569 if (ver.fw_variant == 0x23)
2572 rettime = ktime_get();
2573 delta = ktime_sub(rettime, calltime);
2574 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2576 bt_dev_info(hdev, "Firmware loaded in %llu usecs", duration);
2578 calltime = ktime_get();
2580 set_bit(BTUSB_BOOTING, &data->flags);
2582 err = btintel_send_intel_reset(hdev, boot_param);
2584 bt_dev_err(hdev, "Intel Soft Reset failed (%d)", err);
2585 btintel_reset_to_bootloader(hdev);
2589 /* The bootloader will not indicate when the device is ready. This
2590 * is done by the operational firmware sending bootup notification.
2592 * Booting into operational firmware should not take longer than
2593 * 1 second. However if that happens, then just fail the setup
2594 * since something went wrong.
2596 bt_dev_info(hdev, "Waiting for device to boot");
2598 err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2600 msecs_to_jiffies(1000));
2602 if (err == -EINTR) {
2603 bt_dev_err(hdev, "Device boot interrupted");
2608 bt_dev_err(hdev, "Device boot timeout");
2609 btintel_reset_to_bootloader(hdev);
2613 rettime = ktime_get();
2614 delta = ktime_sub(rettime, calltime);
2615 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2617 bt_dev_info(hdev, "Device booted in %llu usecs", duration);
2619 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2621 err = btusb_setup_intel_new_get_fw_name(&ver, ¶ms, ddcname,
2622 sizeof(ddcname), "ddc");
2625 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2627 /* Once the device is running in operational mode, it needs to
2628 * apply the device configuration (DDC) parameters.
2630 * The device can work without DDC parameters, so even if it
2631 * fails to load the file, no need to fail the setup.
2633 btintel_load_ddc_config(hdev, ddcname);
2636 /* Read the Intel supported features and if new exception formats
2637 * supported, need to load the additional DDC config to enable.
2639 btintel_read_debug_features(hdev, &features);
2641 /* Set DDC mask for available debug features */
2642 btintel_set_debug_features(hdev, &features);
2644 /* Read the Intel version information after loading the FW */
2645 err = btintel_read_version(hdev, &ver);
2649 btintel_version_info(hdev, &ver);
2652 /* All Intel controllers that support the Microsoft vendor
2653 * extension are using 0xFC1E for VsMsftOpCode.
2655 switch (ver.hw_variant) {
2656 case 0x12: /* ThP */
2657 hci_set_msft_opcode(hdev, 0xFC1E);
2661 /* Set the event mask for Intel specific vendor events. This enables
2662 * a few extra events that are useful during general operation. It
2663 * does not enable any debugging related events.
2665 * The device will function correctly without these events enabled
2666 * and thus no need to fail the setup.
2668 btintel_set_event_mask(hdev, false);
2673 static int btusb_shutdown_intel(struct hci_dev *hdev)
2675 struct sk_buff *skb;
2678 /* In the shutdown sequence where Bluetooth is turned off followed
2679 * by WiFi being turned off, turning WiFi back on causes issue with
2680 * the RF calibration.
2682 * To ensure that any RF activity has been stopped, issue HCI Reset
2683 * command to clear all ongoing activity including advertising,
2686 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2689 bt_dev_err(hdev, "HCI reset during shutdown failed");
2694 /* Some platforms have an issue with BT LED when the interface is
2695 * down or BT radio is turned off, which takes 5 seconds to BT LED
2696 * goes off. This command turns off the BT LED immediately.
2698 skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
2701 bt_dev_err(hdev, "turning off Intel device LED failed");
2709 static int btusb_shutdown_intel_new(struct hci_dev *hdev)
2711 struct sk_buff *skb;
2713 /* Send HCI Reset to the controller to stop any BT activity which
2714 * were triggered. This will help to save power and maintain the
2715 * sync b/w Host and controller
2717 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2719 bt_dev_err(hdev, "HCI reset during shutdown failed");
2720 return PTR_ERR(skb);
2727 #define FIRMWARE_MT7663 "mediatek/mt7663pr2h.bin"
2728 #define FIRMWARE_MT7668 "mediatek/mt7668pr2h.bin"
2730 #define HCI_WMT_MAX_EVENT_SIZE 64
2733 BTMTK_WMT_PATCH_DWNLD = 0x1,
2734 BTMTK_WMT_FUNC_CTRL = 0x6,
2735 BTMTK_WMT_RST = 0x7,
2736 BTMTK_WMT_SEMAPHORE = 0x17,
2741 BTMTK_WMT_PATCH_UNDONE,
2742 BTMTK_WMT_PATCH_DONE,
2743 BTMTK_WMT_ON_UNDONE,
2745 BTMTK_WMT_ON_PROGRESS,
2748 struct btmtk_wmt_hdr {
2755 struct btmtk_hci_wmt_cmd {
2756 struct btmtk_wmt_hdr hdr;
2760 struct btmtk_hci_wmt_evt {
2761 struct hci_event_hdr hhdr;
2762 struct btmtk_wmt_hdr whdr;
2765 struct btmtk_hci_wmt_evt_funcc {
2766 struct btmtk_hci_wmt_evt hwhdr;
2770 struct btmtk_tci_sleep {
2773 __le16 host_duration;
2775 u8 time_compensation;
2778 struct btmtk_hci_wmt_params {
2786 static void btusb_mtk_wmt_recv(struct urb *urb)
2788 struct hci_dev *hdev = urb->context;
2789 struct btusb_data *data = hci_get_drvdata(hdev);
2790 struct hci_event_hdr *hdr;
2791 struct sk_buff *skb;
2794 if (urb->status == 0 && urb->actual_length > 0) {
2795 hdev->stat.byte_rx += urb->actual_length;
2797 /* WMT event shouldn't be fragmented and the size should be
2798 * less than HCI_WMT_MAX_EVENT_SIZE.
2800 skb = bt_skb_alloc(HCI_WMT_MAX_EVENT_SIZE, GFP_ATOMIC);
2802 hdev->stat.err_rx++;
2806 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
2807 skb_put_data(skb, urb->transfer_buffer, urb->actual_length);
2809 hdr = (void *)skb->data;
2810 /* Fix up the vendor event id with 0xff for vendor specific
2811 * instead of 0xe4 so that event send via monitoring socket can
2812 * be parsed properly.
2816 /* When someone waits for the WMT event, the skb is being cloned
2817 * and being processed the events from there then.
2819 if (test_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags)) {
2820 data->evt_skb = skb_clone(skb, GFP_ATOMIC);
2825 err = hci_recv_frame(hdev, skb);
2829 if (test_and_clear_bit(BTUSB_TX_WAIT_VND_EVT,
2831 /* Barrier to sync with other CPUs */
2832 smp_mb__after_atomic();
2833 wake_up_bit(&data->flags,
2834 BTUSB_TX_WAIT_VND_EVT);
2839 kfree_skb(data->evt_skb);
2840 data->evt_skb = NULL;
2842 } else if (urb->status == -ENOENT) {
2843 /* Avoid suspend failed when usb_kill_urb */
2847 usb_mark_last_busy(data->udev);
2849 /* The URB complete handler is still called with urb->actual_length = 0
2850 * when the event is not available, so we should keep re-submitting
2851 * URB until WMT event returns, Also, It's necessary to wait some time
2852 * between the two consecutive control URBs to relax the target device
2853 * to generate the event. Otherwise, the WMT event cannot return from
2854 * the device successfully.
2858 usb_anchor_urb(urb, &data->ctrl_anchor);
2859 err = usb_submit_urb(urb, GFP_ATOMIC);
2861 /* -EPERM: urb is being killed;
2862 * -ENODEV: device got disconnected
2864 if (err != -EPERM && err != -ENODEV)
2865 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
2867 usb_unanchor_urb(urb);
2871 static int btusb_mtk_submit_wmt_recv_urb(struct hci_dev *hdev)
2873 struct btusb_data *data = hci_get_drvdata(hdev);
2874 struct usb_ctrlrequest *dr;
2880 urb = usb_alloc_urb(0, GFP_KERNEL);
2884 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
2890 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_IN;
2892 dr->wIndex = cpu_to_le16(0);
2893 dr->wValue = cpu_to_le16(48);
2894 dr->wLength = cpu_to_le16(size);
2896 buf = kmalloc(size, GFP_KERNEL);
2902 pipe = usb_rcvctrlpipe(data->udev, 0);
2904 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
2905 buf, size, btusb_mtk_wmt_recv, hdev);
2907 urb->transfer_flags |= URB_FREE_BUFFER;
2909 usb_anchor_urb(urb, &data->ctrl_anchor);
2910 err = usb_submit_urb(urb, GFP_KERNEL);
2912 if (err != -EPERM && err != -ENODEV)
2913 bt_dev_err(hdev, "urb %p submission failed (%d)",
2915 usb_unanchor_urb(urb);
2923 static int btusb_mtk_hci_wmt_sync(struct hci_dev *hdev,
2924 struct btmtk_hci_wmt_params *wmt_params)
2926 struct btusb_data *data = hci_get_drvdata(hdev);
2927 struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
2928 u32 hlen, status = BTMTK_WMT_INVALID;
2929 struct btmtk_hci_wmt_evt *wmt_evt;
2930 struct btmtk_hci_wmt_cmd wc;
2931 struct btmtk_wmt_hdr *hdr;
2934 /* Submit control IN URB on demand to process the WMT event */
2935 err = btusb_mtk_submit_wmt_recv_urb(hdev);
2939 /* Send the WMT command and wait until the WMT event returns */
2940 hlen = sizeof(*hdr) + wmt_params->dlen;
2944 hdr = (struct btmtk_wmt_hdr *)&wc;
2946 hdr->op = wmt_params->op;
2947 hdr->dlen = cpu_to_le16(wmt_params->dlen + 1);
2948 hdr->flag = wmt_params->flag;
2949 memcpy(wc.data, wmt_params->data, wmt_params->dlen);
2951 set_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2953 err = __hci_cmd_send(hdev, 0xfc6f, hlen, &wc);
2956 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2960 /* The vendor specific WMT commands are all answered by a vendor
2961 * specific event and will have the Command Status or Command
2962 * Complete as with usual HCI command flow control.
2964 * After sending the command, wait for BTUSB_TX_WAIT_VND_EVT
2965 * state to be cleared. The driver specific event receive routine
2966 * will clear that state and with that indicate completion of the
2969 err = wait_on_bit_timeout(&data->flags, BTUSB_TX_WAIT_VND_EVT,
2970 TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
2971 if (err == -EINTR) {
2972 bt_dev_err(hdev, "Execution of wmt command interrupted");
2973 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2978 bt_dev_err(hdev, "Execution of wmt command timed out");
2979 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2983 /* Parse and handle the return WMT event */
2984 wmt_evt = (struct btmtk_hci_wmt_evt *)data->evt_skb->data;
2985 if (wmt_evt->whdr.op != hdr->op) {
2986 bt_dev_err(hdev, "Wrong op received %d expected %d",
2987 wmt_evt->whdr.op, hdr->op);
2992 switch (wmt_evt->whdr.op) {
2993 case BTMTK_WMT_SEMAPHORE:
2994 if (wmt_evt->whdr.flag == 2)
2995 status = BTMTK_WMT_PATCH_UNDONE;
2997 status = BTMTK_WMT_PATCH_DONE;
2999 case BTMTK_WMT_FUNC_CTRL:
3000 wmt_evt_funcc = (struct btmtk_hci_wmt_evt_funcc *)wmt_evt;
3001 if (be16_to_cpu(wmt_evt_funcc->status) == 0x404)
3002 status = BTMTK_WMT_ON_DONE;
3003 else if (be16_to_cpu(wmt_evt_funcc->status) == 0x420)
3004 status = BTMTK_WMT_ON_PROGRESS;
3006 status = BTMTK_WMT_ON_UNDONE;
3010 if (wmt_params->status)
3011 *wmt_params->status = status;
3014 kfree_skb(data->evt_skb);
3015 data->evt_skb = NULL;
3020 static int btusb_mtk_setup_firmware(struct hci_dev *hdev, const char *fwname)
3022 struct btmtk_hci_wmt_params wmt_params;
3023 const struct firmware *fw;
3029 err = request_firmware(&fw, fwname, &hdev->dev);
3031 bt_dev_err(hdev, "Failed to load firmware file (%d)", err);
3035 /* Power on data RAM the firmware relies on. */
3037 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3038 wmt_params.flag = 3;
3039 wmt_params.dlen = sizeof(param);
3040 wmt_params.data = ¶m;
3041 wmt_params.status = NULL;
3043 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3045 bt_dev_err(hdev, "Failed to power on data RAM (%d)", err);
3052 /* The size of patch header is 30 bytes, should be skip */
3055 goto err_release_fw;
3062 wmt_params.op = BTMTK_WMT_PATCH_DWNLD;
3063 wmt_params.status = NULL;
3065 while (fw_size > 0) {
3066 dlen = min_t(int, 250, fw_size);
3068 /* Tell deivice the position in sequence */
3069 if (fw_size - dlen <= 0)
3071 else if (fw_size < fw->size - 30)
3074 wmt_params.flag = flag;
3075 wmt_params.dlen = dlen;
3076 wmt_params.data = fw_ptr;
3078 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3080 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
3082 goto err_release_fw;
3089 wmt_params.op = BTMTK_WMT_RST;
3090 wmt_params.flag = 4;
3091 wmt_params.dlen = 0;
3092 wmt_params.data = NULL;
3093 wmt_params.status = NULL;
3095 /* Activate funciton the firmware providing to */
3096 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3098 bt_dev_err(hdev, "Failed to send wmt rst (%d)", err);
3099 goto err_release_fw;
3102 /* Wait a few moments for firmware activation done */
3103 usleep_range(10000, 12000);
3106 release_firmware(fw);
3111 static int btusb_mtk_func_query(struct hci_dev *hdev)
3113 struct btmtk_hci_wmt_params wmt_params;
3117 /* Query whether the function is enabled */
3118 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3119 wmt_params.flag = 4;
3120 wmt_params.dlen = sizeof(param);
3121 wmt_params.data = ¶m;
3122 wmt_params.status = &status;
3124 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3126 bt_dev_err(hdev, "Failed to query function status (%d)", err);
3133 static int btusb_mtk_reg_read(struct btusb_data *data, u32 reg, u32 *val)
3135 int pipe, err, size = sizeof(u32);
3138 buf = kzalloc(size, GFP_KERNEL);
3142 pipe = usb_rcvctrlpipe(data->udev, 0);
3143 err = usb_control_msg(data->udev, pipe, 0x63,
3144 USB_TYPE_VENDOR | USB_DIR_IN,
3145 reg >> 16, reg & 0xffff,
3146 buf, size, USB_CTRL_SET_TIMEOUT);
3150 *val = get_unaligned_le32(buf);
3158 static int btusb_mtk_id_get(struct btusb_data *data, u32 *id)
3160 return btusb_mtk_reg_read(data, 0x80000008, id);
3163 static int btusb_mtk_setup(struct hci_dev *hdev)
3165 struct btusb_data *data = hci_get_drvdata(hdev);
3166 struct btmtk_hci_wmt_params wmt_params;
3167 ktime_t calltime, delta, rettime;
3168 struct btmtk_tci_sleep tci_sleep;
3169 unsigned long long duration;
3170 struct sk_buff *skb;
3176 calltime = ktime_get();
3178 err = btusb_mtk_id_get(data, &dev_id);
3180 bt_dev_err(hdev, "Failed to get device id (%d)", err);
3186 fwname = FIRMWARE_MT7663;
3189 fwname = FIRMWARE_MT7668;
3192 bt_dev_err(hdev, "Unsupported support hardware variant (%08x)",
3197 /* Query whether the firmware is already download */
3198 wmt_params.op = BTMTK_WMT_SEMAPHORE;
3199 wmt_params.flag = 1;
3200 wmt_params.dlen = 0;
3201 wmt_params.data = NULL;
3202 wmt_params.status = &status;
3204 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3206 bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
3210 if (status == BTMTK_WMT_PATCH_DONE) {
3211 bt_dev_info(hdev, "firmware already downloaded");
3212 goto ignore_setup_fw;
3215 /* Setup a firmware which the device definitely requires */
3216 err = btusb_mtk_setup_firmware(hdev, fwname);
3221 err = readx_poll_timeout(btusb_mtk_func_query, hdev, status,
3222 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
3224 /* -ETIMEDOUT happens */
3228 /* The other errors happen in btusb_mtk_func_query */
3232 if (status == BTMTK_WMT_ON_DONE) {
3233 bt_dev_info(hdev, "function already on");
3234 goto ignore_func_on;
3237 /* Enable Bluetooth protocol */
3239 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3240 wmt_params.flag = 0;
3241 wmt_params.dlen = sizeof(param);
3242 wmt_params.data = ¶m;
3243 wmt_params.status = NULL;
3245 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3247 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3252 /* Apply the low power environment setup */
3253 tci_sleep.mode = 0x5;
3254 tci_sleep.duration = cpu_to_le16(0x640);
3255 tci_sleep.host_duration = cpu_to_le16(0x640);
3256 tci_sleep.host_wakeup_pin = 0;
3257 tci_sleep.time_compensation = 0;
3259 skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
3263 bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
3268 rettime = ktime_get();
3269 delta = ktime_sub(rettime, calltime);
3270 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
3272 bt_dev_info(hdev, "Device setup in %llu usecs", duration);
3277 static int btusb_mtk_shutdown(struct hci_dev *hdev)
3279 struct btmtk_hci_wmt_params wmt_params;
3283 /* Disable the device */
3284 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3285 wmt_params.flag = 0;
3286 wmt_params.dlen = sizeof(param);
3287 wmt_params.data = ¶m;
3288 wmt_params.status = NULL;
3290 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3292 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3299 MODULE_FIRMWARE(FIRMWARE_MT7663);
3300 MODULE_FIRMWARE(FIRMWARE_MT7668);
3303 /* Configure an out-of-band gpio as wake-up pin, if specified in device tree */
3304 static int marvell_config_oob_wake(struct hci_dev *hdev)
3306 struct sk_buff *skb;
3307 struct btusb_data *data = hci_get_drvdata(hdev);
3308 struct device *dev = &data->udev->dev;
3309 u16 pin, gap, opcode;
3313 /* Move on if no wakeup pin specified */
3314 if (of_property_read_u16(dev->of_node, "marvell,wakeup-pin", &pin) ||
3315 of_property_read_u16(dev->of_node, "marvell,wakeup-gap-ms", &gap))
3318 /* Vendor specific command to configure a GPIO as wake-up pin */
3319 opcode = hci_opcode_pack(0x3F, 0x59);
3320 cmd[0] = opcode & 0xFF;
3321 cmd[1] = opcode >> 8;
3322 cmd[2] = 2; /* length of parameters that follow */
3324 cmd[4] = gap; /* time in ms, for which wakeup pin should be asserted */
3326 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
3328 bt_dev_err(hdev, "%s: No memory\n", __func__);
3332 skb_put_data(skb, cmd, sizeof(cmd));
3333 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
3335 ret = btusb_send_frame(hdev, skb);
3337 bt_dev_err(hdev, "%s: configuration failed\n", __func__);
3346 static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
3347 const bdaddr_t *bdaddr)
3349 struct sk_buff *skb;
3354 buf[1] = sizeof(bdaddr_t);
3355 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
3357 skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3360 bt_dev_err(hdev, "changing Marvell device address failed (%ld)",
3369 static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
3370 const bdaddr_t *bdaddr)
3372 struct sk_buff *skb;
3379 buf[3] = sizeof(bdaddr_t);
3380 memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
3382 skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3385 bt_dev_err(hdev, "Change address command failed (%ld)", ret);
3393 #define QCA_DFU_PACKET_LEN 4096
3395 #define QCA_GET_TARGET_VERSION 0x09
3396 #define QCA_CHECK_STATUS 0x05
3397 #define QCA_DFU_DOWNLOAD 0x01
3399 #define QCA_SYSCFG_UPDATED 0x40
3400 #define QCA_PATCH_UPDATED 0x80
3401 #define QCA_DFU_TIMEOUT 3000
3403 struct qca_version {
3405 __le32 patch_version;
3411 struct qca_rampatch_version {
3413 __le16 patch_version;
3416 struct qca_device_info {
3418 u8 rampatch_hdr; /* length of header in rampatch */
3419 u8 nvm_hdr; /* length of header in NVM */
3420 u8 ver_offset; /* offset of version structure in rampatch */
3423 static const struct qca_device_info qca_devices_table[] = {
3424 { 0x00000100, 20, 4, 10 }, /* Rome 1.0 */
3425 { 0x00000101, 20, 4, 10 }, /* Rome 1.1 */
3426 { 0x00000200, 28, 4, 18 }, /* Rome 2.0 */
3427 { 0x00000201, 28, 4, 18 }, /* Rome 2.1 */
3428 { 0x00000300, 28, 4, 18 }, /* Rome 3.0 */
3429 { 0x00000302, 28, 4, 18 }, /* Rome 3.2 */
3432 static int btusb_qca_send_vendor_req(struct usb_device *udev, u8 request,
3433 void *data, u16 size)
3438 buf = kmalloc(size, GFP_KERNEL);
3442 /* Found some of USB hosts have IOT issues with ours so that we should
3443 * not wait until HCI layer is ready.
3445 pipe = usb_rcvctrlpipe(udev, 0);
3446 err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
3447 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3449 dev_err(&udev->dev, "Failed to access otp area (%d)", err);
3453 memcpy(data, buf, size);
3461 static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
3462 const struct firmware *firmware,
3465 struct btusb_data *btdata = hci_get_drvdata(hdev);
3466 struct usb_device *udev = btdata->udev;
3467 size_t count, size, sent = 0;
3471 buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
3475 count = firmware->size;
3477 size = min_t(size_t, count, hdr_size);
3478 memcpy(buf, firmware->data, size);
3480 /* USB patches should go down to controller through USB path
3481 * because binary format fits to go down through USB channel.
3482 * USB control path is for patching headers and USB bulk is for
3485 pipe = usb_sndctrlpipe(udev, 0);
3486 err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
3487 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3489 bt_dev_err(hdev, "Failed to send headers (%d)", err);
3497 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
3499 memcpy(buf, firmware->data + sent, size);
3501 pipe = usb_sndbulkpipe(udev, 0x02);
3502 err = usb_bulk_msg(udev, pipe, buf, size, &len,
3505 bt_dev_err(hdev, "Failed to send body at %zd of %zd (%d)",
3506 sent, firmware->size, err);
3511 bt_dev_err(hdev, "Failed to get bulk buffer");
3525 static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
3526 struct qca_version *ver,
3527 const struct qca_device_info *info)
3529 struct qca_rampatch_version *rver;
3530 const struct firmware *fw;
3531 u32 ver_rom, ver_patch;
3532 u16 rver_rom, rver_patch;
3536 ver_rom = le32_to_cpu(ver->rom_version);
3537 ver_patch = le32_to_cpu(ver->patch_version);
3539 snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
3541 err = request_firmware(&fw, fwname, &hdev->dev);
3543 bt_dev_err(hdev, "failed to request rampatch file: %s (%d)",
3548 bt_dev_info(hdev, "using rampatch file: %s", fwname);
3550 rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
3551 rver_rom = le16_to_cpu(rver->rom_version);
3552 rver_patch = le16_to_cpu(rver->patch_version);
3554 bt_dev_info(hdev, "QCA: patch rome 0x%x build 0x%x, "
3555 "firmware rome 0x%x build 0x%x",
3556 rver_rom, rver_patch, ver_rom, ver_patch);
3558 if (rver_rom != ver_rom || rver_patch <= ver_patch) {
3559 bt_dev_err(hdev, "rampatch file version did not match with firmware");
3564 err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
3567 release_firmware(fw);
3572 static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
3573 struct qca_version *ver,
3574 const struct qca_device_info *info)
3576 const struct firmware *fw;
3580 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
3581 le32_to_cpu(ver->rom_version));
3583 err = request_firmware(&fw, fwname, &hdev->dev);
3585 bt_dev_err(hdev, "failed to request NVM file: %s (%d)",
3590 bt_dev_info(hdev, "using NVM file: %s", fwname);
3592 err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
3594 release_firmware(fw);
3599 /* identify the ROM version and check whether patches are needed */
3600 static bool btusb_qca_need_patch(struct usb_device *udev)
3602 struct qca_version ver;
3604 if (btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
3607 /* only low ROM versions need patches */
3608 return !(le32_to_cpu(ver.rom_version) & ~0xffffU);
3611 static int btusb_setup_qca(struct hci_dev *hdev)
3613 struct btusb_data *btdata = hci_get_drvdata(hdev);
3614 struct usb_device *udev = btdata->udev;
3615 const struct qca_device_info *info = NULL;
3616 struct qca_version ver;
3621 err = btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
3626 ver_rom = le32_to_cpu(ver.rom_version);
3627 /* Don't care about high ROM versions */
3628 if (ver_rom & ~0xffffU)
3631 for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
3632 if (ver_rom == qca_devices_table[i].rom_version)
3633 info = &qca_devices_table[i];
3636 bt_dev_err(hdev, "don't support firmware rome 0x%x", ver_rom);
3640 err = btusb_qca_send_vendor_req(udev, QCA_CHECK_STATUS, &status,
3645 if (!(status & QCA_PATCH_UPDATED)) {
3646 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
3651 if (!(status & QCA_SYSCFG_UPDATED)) {
3652 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
3660 static inline int __set_diag_interface(struct hci_dev *hdev)
3662 struct btusb_data *data = hci_get_drvdata(hdev);
3663 struct usb_interface *intf = data->diag;
3669 data->diag_tx_ep = NULL;
3670 data->diag_rx_ep = NULL;
3672 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3673 struct usb_endpoint_descriptor *ep_desc;
3675 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3677 if (!data->diag_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3678 data->diag_tx_ep = ep_desc;
3682 if (!data->diag_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3683 data->diag_rx_ep = ep_desc;
3688 if (!data->diag_tx_ep || !data->diag_rx_ep) {
3689 bt_dev_err(hdev, "invalid diagnostic descriptors");
3696 static struct urb *alloc_diag_urb(struct hci_dev *hdev, bool enable)
3698 struct btusb_data *data = hci_get_drvdata(hdev);
3699 struct sk_buff *skb;
3703 if (!data->diag_tx_ep)
3704 return ERR_PTR(-ENODEV);
3706 urb = usb_alloc_urb(0, GFP_KERNEL);
3708 return ERR_PTR(-ENOMEM);
3710 skb = bt_skb_alloc(2, GFP_KERNEL);
3713 return ERR_PTR(-ENOMEM);
3716 skb_put_u8(skb, 0xf0);
3717 skb_put_u8(skb, enable);
3719 pipe = usb_sndbulkpipe(data->udev, data->diag_tx_ep->bEndpointAddress);
3721 usb_fill_bulk_urb(urb, data->udev, pipe,
3722 skb->data, skb->len, btusb_tx_complete, skb);
3724 skb->dev = (void *)hdev;
3729 static int btusb_bcm_set_diag(struct hci_dev *hdev, bool enable)
3731 struct btusb_data *data = hci_get_drvdata(hdev);
3737 if (!test_bit(HCI_RUNNING, &hdev->flags))
3740 urb = alloc_diag_urb(hdev, enable);
3742 return PTR_ERR(urb);
3744 return submit_or_queue_tx_urb(hdev, urb);
3748 static irqreturn_t btusb_oob_wake_handler(int irq, void *priv)
3750 struct btusb_data *data = priv;
3752 pm_wakeup_event(&data->udev->dev, 0);
3755 /* Disable only if not already disabled (keep it balanced) */
3756 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
3757 disable_irq_nosync(irq);
3758 disable_irq_wake(irq);
3763 static const struct of_device_id btusb_match_table[] = {
3764 { .compatible = "usb1286,204e" },
3765 { .compatible = "usbcf3,e300" }, /* QCA6174A */
3766 { .compatible = "usb4ca,301a" }, /* QCA6174A (Lite-On) */
3769 MODULE_DEVICE_TABLE(of, btusb_match_table);
3771 /* Use an oob wakeup pin? */
3772 static int btusb_config_oob_wake(struct hci_dev *hdev)
3774 struct btusb_data *data = hci_get_drvdata(hdev);
3775 struct device *dev = &data->udev->dev;
3778 clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
3780 if (!of_match_device(btusb_match_table, dev))
3783 /* Move on if no IRQ specified */
3784 irq = of_irq_get_byname(dev->of_node, "wakeup");
3786 bt_dev_dbg(hdev, "%s: no OOB Wakeup IRQ in DT", __func__);
3790 irq_set_status_flags(irq, IRQ_NOAUTOEN);
3791 ret = devm_request_irq(&hdev->dev, irq, btusb_oob_wake_handler,
3792 0, "OOB Wake-on-BT", data);
3794 bt_dev_err(hdev, "%s: IRQ request failed", __func__);
3798 ret = device_init_wakeup(dev, true);
3800 bt_dev_err(hdev, "%s: failed to init_wakeup", __func__);
3804 data->oob_wake_irq = irq;
3805 bt_dev_info(hdev, "OOB Wake-on-BT configured at IRQ %u", irq);
3810 static void btusb_check_needs_reset_resume(struct usb_interface *intf)
3812 if (dmi_check_system(btusb_needs_reset_resume_table))
3813 interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
3816 static bool btusb_prevent_wake(struct hci_dev *hdev)
3818 struct btusb_data *data = hci_get_drvdata(hdev);
3820 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
3823 return !device_may_wakeup(&data->udev->dev);
3826 static int btusb_probe(struct usb_interface *intf,
3827 const struct usb_device_id *id)
3829 struct usb_endpoint_descriptor *ep_desc;
3830 struct gpio_desc *reset_gpio;
3831 struct btusb_data *data;
3832 struct hci_dev *hdev;
3833 unsigned ifnum_base;
3836 BT_DBG("intf %p id %p", intf, id);
3838 /* interface numbers are hardcoded in the spec */
3839 if (intf->cur_altsetting->desc.bInterfaceNumber != 0) {
3840 if (!(id->driver_info & BTUSB_IFNUM_2))
3842 if (intf->cur_altsetting->desc.bInterfaceNumber != 2)
3846 ifnum_base = intf->cur_altsetting->desc.bInterfaceNumber;
3848 if (!id->driver_info) {
3849 const struct usb_device_id *match;
3851 match = usb_match_id(intf, blacklist_table);
3856 if (id->driver_info == BTUSB_IGNORE)
3859 if (id->driver_info & BTUSB_ATH3012) {
3860 struct usb_device *udev = interface_to_usbdev(intf);
3862 /* Old firmware would otherwise let ath3k driver load
3863 * patch and sysconfig files
3865 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001 &&
3866 !btusb_qca_need_patch(udev))
3870 data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
3874 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3875 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3877 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
3878 data->intr_ep = ep_desc;
3882 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3883 data->bulk_tx_ep = ep_desc;
3887 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3888 data->bulk_rx_ep = ep_desc;
3893 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
3896 if (id->driver_info & BTUSB_AMP) {
3897 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
3898 data->cmdreq = 0x2b;
3900 data->cmdreq_type = USB_TYPE_CLASS;
3901 data->cmdreq = 0x00;
3904 data->udev = interface_to_usbdev(intf);
3907 INIT_WORK(&data->work, btusb_work);
3908 INIT_WORK(&data->waker, btusb_waker);
3909 init_usb_anchor(&data->deferred);
3910 init_usb_anchor(&data->tx_anchor);
3911 spin_lock_init(&data->txlock);
3913 init_usb_anchor(&data->intr_anchor);
3914 init_usb_anchor(&data->bulk_anchor);
3915 init_usb_anchor(&data->isoc_anchor);
3916 init_usb_anchor(&data->diag_anchor);
3917 init_usb_anchor(&data->ctrl_anchor);
3918 spin_lock_init(&data->rxlock);
3920 if (id->driver_info & BTUSB_INTEL_NEW) {
3921 data->recv_event = btusb_recv_event_intel;
3922 data->recv_bulk = btusb_recv_bulk_intel;
3923 set_bit(BTUSB_BOOTLOADER, &data->flags);
3925 data->recv_event = hci_recv_frame;
3926 data->recv_bulk = btusb_recv_bulk;
3929 hdev = hci_alloc_dev();
3933 hdev->bus = HCI_USB;
3934 hci_set_drvdata(hdev, data);
3936 if (id->driver_info & BTUSB_AMP)
3937 hdev->dev_type = HCI_AMP;
3939 hdev->dev_type = HCI_PRIMARY;
3943 SET_HCIDEV_DEV(hdev, &intf->dev);
3945 reset_gpio = gpiod_get_optional(&data->udev->dev, "reset",
3947 if (IS_ERR(reset_gpio)) {
3948 err = PTR_ERR(reset_gpio);
3950 } else if (reset_gpio) {
3951 data->reset_gpio = reset_gpio;
3954 hdev->open = btusb_open;
3955 hdev->close = btusb_close;
3956 hdev->flush = btusb_flush;
3957 hdev->send = btusb_send_frame;
3958 hdev->notify = btusb_notify;
3959 hdev->prevent_wake = btusb_prevent_wake;
3962 err = btusb_config_oob_wake(hdev);
3966 /* Marvell devices may need a specific chip configuration */
3967 if (id->driver_info & BTUSB_MARVELL && data->oob_wake_irq) {
3968 err = marvell_config_oob_wake(hdev);
3973 if (id->driver_info & BTUSB_CW6622)
3974 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3976 if (id->driver_info & BTUSB_BCM2045)
3977 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3979 if (id->driver_info & BTUSB_BCM92035)
3980 hdev->setup = btusb_setup_bcm92035;
3982 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) &&
3983 (id->driver_info & BTUSB_BCM_PATCHRAM)) {
3984 hdev->manufacturer = 15;
3985 hdev->setup = btbcm_setup_patchram;
3986 hdev->set_diag = btusb_bcm_set_diag;
3987 hdev->set_bdaddr = btbcm_set_bdaddr;
3989 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3990 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3993 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) &&
3994 (id->driver_info & BTUSB_BCM_APPLE)) {
3995 hdev->manufacturer = 15;
3996 hdev->setup = btbcm_setup_apple;
3997 hdev->set_diag = btusb_bcm_set_diag;
3999 /* Broadcom LM_DIAG Interface numbers are hardcoded */
4000 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
4003 if (id->driver_info & BTUSB_INTEL) {
4004 hdev->manufacturer = 2;
4005 hdev->setup = btusb_setup_intel;
4006 hdev->shutdown = btusb_shutdown_intel;
4007 hdev->set_diag = btintel_set_diag_mfg;
4008 hdev->set_bdaddr = btintel_set_bdaddr;
4009 hdev->cmd_timeout = btusb_intel_cmd_timeout;
4010 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4011 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4012 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
4015 if (id->driver_info & BTUSB_INTEL_NEW) {
4016 hdev->manufacturer = 2;
4017 hdev->send = btusb_send_frame_intel;
4018 hdev->setup = btusb_setup_intel_new;
4019 hdev->shutdown = btusb_shutdown_intel_new;
4020 hdev->hw_error = btintel_hw_error;
4021 hdev->set_diag = btintel_set_diag;
4022 hdev->set_bdaddr = btintel_set_bdaddr;
4023 hdev->cmd_timeout = btusb_intel_cmd_timeout;
4024 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4025 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4026 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
4029 if (id->driver_info & BTUSB_MARVELL)
4030 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
4032 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_MTK) &&
4033 (id->driver_info & BTUSB_MEDIATEK)) {
4034 hdev->setup = btusb_mtk_setup;
4035 hdev->shutdown = btusb_mtk_shutdown;
4036 hdev->manufacturer = 70;
4037 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
4040 if (id->driver_info & BTUSB_SWAVE) {
4041 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
4042 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
4045 if (id->driver_info & BTUSB_INTEL_BOOT) {
4046 hdev->manufacturer = 2;
4047 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
4050 if (id->driver_info & BTUSB_ATH3012) {
4051 data->setup_on_usb = btusb_setup_qca;
4052 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
4053 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4054 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
4057 if (id->driver_info & BTUSB_QCA_ROME) {
4058 data->setup_on_usb = btusb_setup_qca;
4059 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
4060 hdev->cmd_timeout = btusb_qca_cmd_timeout;
4061 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4062 btusb_check_needs_reset_resume(intf);
4065 if (id->driver_info & BTUSB_AMP) {
4066 /* AMP controllers do not support SCO packets */
4069 /* Interface orders are hardcoded in the specification */
4070 data->isoc = usb_ifnum_to_if(data->udev, ifnum_base + 1);
4071 data->isoc_ifnum = ifnum_base + 1;
4074 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_RTL) &&
4075 (id->driver_info & BTUSB_REALTEK)) {
4076 hdev->setup = btrtl_setup_realtek;
4077 hdev->shutdown = btrtl_shutdown_realtek;
4078 hdev->cmd_timeout = btusb_rtl_cmd_timeout;
4080 /* Realtek devices lose their updated firmware over global
4081 * suspend that means host doesn't send SET_FEATURE
4082 * (DEVICE_REMOTE_WAKEUP)
4084 set_bit(BTUSB_WAKEUP_DISABLE, &data->flags);
4085 if (btusb_find_altsetting(data, 1))
4086 set_bit(BTUSB_USE_ALT1_FOR_WBS, &data->flags);
4088 bt_dev_err(hdev, "Device does not support ALT setting 1");
4092 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4094 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
4095 if (!disable_scofix)
4096 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
4099 if (id->driver_info & BTUSB_BROKEN_ISOC)
4102 if (id->driver_info & BTUSB_WIDEBAND_SPEECH)
4103 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED, &hdev->quirks);
4105 if (id->driver_info & BTUSB_VALID_LE_STATES)
4106 set_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks);
4108 if (id->driver_info & BTUSB_DIGIANSWER) {
4109 data->cmdreq_type = USB_TYPE_VENDOR;
4110 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4113 if (id->driver_info & BTUSB_CSR) {
4114 struct usb_device *udev = data->udev;
4115 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
4117 /* Old firmware would otherwise execute USB reset */
4118 if (bcdDevice < 0x117)
4119 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4121 /* This must be set first in case we disable it for fakes */
4122 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4124 /* Fake CSR devices with broken commands */
4125 if (le16_to_cpu(udev->descriptor.idVendor) == 0x0a12 &&
4126 le16_to_cpu(udev->descriptor.idProduct) == 0x0001)
4127 hdev->setup = btusb_setup_csr;
4130 if (id->driver_info & BTUSB_SNIFFER) {
4131 struct usb_device *udev = data->udev;
4133 /* New sniffer firmware has crippled HCI interface */
4134 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
4135 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
4138 if (id->driver_info & BTUSB_INTEL_BOOT) {
4139 /* A bug in the bootloader causes that interrupt interface is
4140 * only enabled after receiving SetInterface(0, AltSetting=0).
4142 err = usb_set_interface(data->udev, 0, 0);
4144 BT_ERR("failed to set interface 0, alt 0 %d", err);
4150 err = usb_driver_claim_interface(&btusb_driver,
4156 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) && data->diag) {
4157 if (!usb_driver_claim_interface(&btusb_driver,
4159 __set_diag_interface(hdev);
4164 if (enable_autosuspend)
4165 usb_enable_autosuspend(data->udev);
4167 err = hci_register_dev(hdev);
4171 usb_set_intfdata(intf, data);
4176 if (data->reset_gpio)
4177 gpiod_put(data->reset_gpio);
4182 static void btusb_disconnect(struct usb_interface *intf)
4184 struct btusb_data *data = usb_get_intfdata(intf);
4185 struct hci_dev *hdev;
4187 BT_DBG("intf %p", intf);
4193 usb_set_intfdata(data->intf, NULL);
4196 usb_set_intfdata(data->isoc, NULL);
4199 usb_set_intfdata(data->diag, NULL);
4201 hci_unregister_dev(hdev);
4203 if (intf == data->intf) {
4205 usb_driver_release_interface(&btusb_driver, data->isoc);
4207 usb_driver_release_interface(&btusb_driver, data->diag);
4208 } else if (intf == data->isoc) {
4210 usb_driver_release_interface(&btusb_driver, data->diag);
4211 usb_driver_release_interface(&btusb_driver, data->intf);
4212 } else if (intf == data->diag) {
4213 usb_driver_release_interface(&btusb_driver, data->intf);
4215 usb_driver_release_interface(&btusb_driver, data->isoc);
4218 if (data->oob_wake_irq)
4219 device_init_wakeup(&data->udev->dev, false);
4221 if (data->reset_gpio)
4222 gpiod_put(data->reset_gpio);
4228 static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
4230 struct btusb_data *data = usb_get_intfdata(intf);
4232 BT_DBG("intf %p", intf);
4234 if (data->suspend_count++)
4237 spin_lock_irq(&data->txlock);
4238 if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
4239 set_bit(BTUSB_SUSPENDING, &data->flags);
4240 spin_unlock_irq(&data->txlock);
4242 spin_unlock_irq(&data->txlock);
4243 data->suspend_count--;
4247 cancel_work_sync(&data->work);
4249 btusb_stop_traffic(data);
4250 usb_kill_anchored_urbs(&data->tx_anchor);
4252 if (data->oob_wake_irq && device_may_wakeup(&data->udev->dev)) {
4253 set_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
4254 enable_irq_wake(data->oob_wake_irq);
4255 enable_irq(data->oob_wake_irq);
4258 /* For global suspend, Realtek devices lose the loaded fw
4259 * in them. But for autosuspend, firmware should remain.
4260 * Actually, it depends on whether the usb host sends
4261 * set feature (enable wakeup) or not.
4263 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags)) {
4264 if (PMSG_IS_AUTO(message) &&
4265 device_can_wakeup(&data->udev->dev))
4266 data->udev->do_remote_wakeup = 1;
4267 else if (!PMSG_IS_AUTO(message))
4268 data->udev->reset_resume = 1;
4274 static void play_deferred(struct btusb_data *data)
4279 while ((urb = usb_get_from_anchor(&data->deferred))) {
4280 usb_anchor_urb(urb, &data->tx_anchor);
4282 err = usb_submit_urb(urb, GFP_ATOMIC);
4284 if (err != -EPERM && err != -ENODEV)
4285 BT_ERR("%s urb %p submission failed (%d)",
4286 data->hdev->name, urb, -err);
4287 kfree(urb->setup_packet);
4288 usb_unanchor_urb(urb);
4293 data->tx_in_flight++;
4297 /* Cleanup the rest deferred urbs. */
4298 while ((urb = usb_get_from_anchor(&data->deferred))) {
4299 kfree(urb->setup_packet);
4304 static int btusb_resume(struct usb_interface *intf)
4306 struct btusb_data *data = usb_get_intfdata(intf);
4307 struct hci_dev *hdev = data->hdev;
4310 BT_DBG("intf %p", intf);
4312 if (--data->suspend_count)
4315 /* Disable only if not already disabled (keep it balanced) */
4316 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
4317 disable_irq(data->oob_wake_irq);
4318 disable_irq_wake(data->oob_wake_irq);
4321 if (!test_bit(HCI_RUNNING, &hdev->flags))
4324 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
4325 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
4327 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
4332 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
4333 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
4335 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
4339 btusb_submit_bulk_urb(hdev, GFP_NOIO);
4342 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
4343 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
4344 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
4346 btusb_submit_isoc_urb(hdev, GFP_NOIO);
4349 spin_lock_irq(&data->txlock);
4350 play_deferred(data);
4351 clear_bit(BTUSB_SUSPENDING, &data->flags);
4352 spin_unlock_irq(&data->txlock);
4353 schedule_work(&data->work);
4358 usb_scuttle_anchored_urbs(&data->deferred);
4360 spin_lock_irq(&data->txlock);
4361 clear_bit(BTUSB_SUSPENDING, &data->flags);
4362 spin_unlock_irq(&data->txlock);
4368 static struct usb_driver btusb_driver = {
4370 .probe = btusb_probe,
4371 .disconnect = btusb_disconnect,
4373 .suspend = btusb_suspend,
4374 .resume = btusb_resume,
4376 .id_table = btusb_table,
4377 .supports_autosuspend = 1,
4378 .disable_hub_initiated_lpm = 1,
4381 module_usb_driver(btusb_driver);
4383 module_param(disable_scofix, bool, 0644);
4384 MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
4386 module_param(force_scofix, bool, 0644);
4387 MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
4389 module_param(enable_autosuspend, bool, 0644);
4390 MODULE_PARM_DESC(enable_autosuspend, "Enable USB autosuspend by default");
4392 module_param(reset, bool, 0644);
4393 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
4395 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
4396 MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
4397 MODULE_VERSION(VERSION);
4398 MODULE_LICENSE("GPL");