leds: wm831x-status: fix use-after-free on unbind
[linux/fpc-iii.git] / drivers / bluetooth / btusb.c
blob5f022e9cf667e0248f9a17d1aba9aa7111880c82
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
4 * Generic Bluetooth USB driver
6 * Copyright (C) 2005-2008 Marcel Holtmann <marcel@holtmann.org>
7 */
9 #include <linux/dmi.h>
10 #include <linux/module.h>
11 #include <linux/usb.h>
12 #include <linux/usb/quirks.h>
13 #include <linux/firmware.h>
14 #include <linux/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>
24 #include "btintel.h"
25 #include "btbcm.h"
26 #include "btrtl.h"
28 #define VERSION "0.8"
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) },
86 /* Apple iMac11,1 */
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 Bluetooth devices */
363 { USB_VENDOR_AND_INTERFACE_INFO(0x0bda, 0xe0, 0x01, 0x01),
364 .driver_info = BTUSB_REALTEK },
366 /* MediaTek Bluetooth devices */
367 { USB_VENDOR_AND_INTERFACE_INFO(0x0e8d, 0xe0, 0x01, 0x01),
368 .driver_info = BTUSB_MEDIATEK },
370 /* Additional Realtek 8723AE Bluetooth devices */
371 { USB_DEVICE(0x0930, 0x021d), .driver_info = BTUSB_REALTEK },
372 { USB_DEVICE(0x13d3, 0x3394), .driver_info = BTUSB_REALTEK },
374 /* Additional Realtek 8723BE Bluetooth devices */
375 { USB_DEVICE(0x0489, 0xe085), .driver_info = BTUSB_REALTEK },
376 { USB_DEVICE(0x0489, 0xe08b), .driver_info = BTUSB_REALTEK },
377 { USB_DEVICE(0x13d3, 0x3410), .driver_info = BTUSB_REALTEK },
378 { USB_DEVICE(0x13d3, 0x3416), .driver_info = BTUSB_REALTEK },
379 { USB_DEVICE(0x13d3, 0x3459), .driver_info = BTUSB_REALTEK },
380 { USB_DEVICE(0x13d3, 0x3494), .driver_info = BTUSB_REALTEK },
382 /* Additional Realtek 8723BU Bluetooth devices */
383 { USB_DEVICE(0x7392, 0xa611), .driver_info = BTUSB_REALTEK },
385 /* Additional Realtek 8723DE Bluetooth devices */
386 { USB_DEVICE(0x0bda, 0xb009), .driver_info = BTUSB_REALTEK },
387 { USB_DEVICE(0x2ff8, 0xb011), .driver_info = BTUSB_REALTEK },
389 /* Additional Realtek 8821AE Bluetooth devices */
390 { USB_DEVICE(0x0b05, 0x17dc), .driver_info = BTUSB_REALTEK },
391 { USB_DEVICE(0x13d3, 0x3414), .driver_info = BTUSB_REALTEK },
392 { USB_DEVICE(0x13d3, 0x3458), .driver_info = BTUSB_REALTEK },
393 { USB_DEVICE(0x13d3, 0x3461), .driver_info = BTUSB_REALTEK },
394 { USB_DEVICE(0x13d3, 0x3462), .driver_info = BTUSB_REALTEK },
396 /* Additional Realtek 8822BE Bluetooth devices */
397 { USB_DEVICE(0x13d3, 0x3526), .driver_info = BTUSB_REALTEK },
398 { USB_DEVICE(0x0b05, 0x185c), .driver_info = BTUSB_REALTEK },
400 /* Additional Realtek 8822CE Bluetooth devices */
401 { USB_DEVICE(0x04ca, 0x4005), .driver_info = BTUSB_REALTEK },
402 { USB_DEVICE(0x13d3, 0x3548), .driver_info = BTUSB_REALTEK },
404 /* Silicon Wave based devices */
405 { USB_DEVICE(0x0c10, 0x0000), .driver_info = BTUSB_SWAVE },
407 { } /* Terminating entry */
410 /* The Bluetooth USB module build into some devices needs to be reset on resume,
411 * this is a problem with the platform (likely shutting off all power) not with
412 * the module itself. So we use a DMI list to match known broken platforms.
414 static const struct dmi_system_id btusb_needs_reset_resume_table[] = {
416 /* Dell OptiPlex 3060 (QCA ROME device 0cf3:e007) */
417 .matches = {
418 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
419 DMI_MATCH(DMI_PRODUCT_NAME, "OptiPlex 3060"),
423 /* Dell XPS 9360 (QCA ROME device 0cf3:e300) */
424 .matches = {
425 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
426 DMI_MATCH(DMI_PRODUCT_NAME, "XPS 13 9360"),
430 /* Dell Inspiron 5565 (QCA ROME device 0cf3:e009) */
431 .matches = {
432 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
433 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 5565"),
439 #define BTUSB_MAX_ISOC_FRAMES 10
441 #define BTUSB_INTR_RUNNING 0
442 #define BTUSB_BULK_RUNNING 1
443 #define BTUSB_ISOC_RUNNING 2
444 #define BTUSB_SUSPENDING 3
445 #define BTUSB_DID_ISO_RESUME 4
446 #define BTUSB_BOOTLOADER 5
447 #define BTUSB_DOWNLOADING 6
448 #define BTUSB_FIRMWARE_LOADED 7
449 #define BTUSB_FIRMWARE_FAILED 8
450 #define BTUSB_BOOTING 9
451 #define BTUSB_DIAG_RUNNING 10
452 #define BTUSB_OOB_WAKE_ENABLED 11
453 #define BTUSB_HW_RESET_ACTIVE 12
454 #define BTUSB_TX_WAIT_VND_EVT 13
455 #define BTUSB_WAKEUP_DISABLE 14
457 struct btusb_data {
458 struct hci_dev *hdev;
459 struct usb_device *udev;
460 struct usb_interface *intf;
461 struct usb_interface *isoc;
462 struct usb_interface *diag;
463 unsigned isoc_ifnum;
465 unsigned long flags;
467 struct work_struct work;
468 struct work_struct waker;
470 struct usb_anchor deferred;
471 struct usb_anchor tx_anchor;
472 int tx_in_flight;
473 spinlock_t txlock;
475 struct usb_anchor intr_anchor;
476 struct usb_anchor bulk_anchor;
477 struct usb_anchor isoc_anchor;
478 struct usb_anchor diag_anchor;
479 struct usb_anchor ctrl_anchor;
480 spinlock_t rxlock;
482 struct sk_buff *evt_skb;
483 struct sk_buff *acl_skb;
484 struct sk_buff *sco_skb;
486 struct usb_endpoint_descriptor *intr_ep;
487 struct usb_endpoint_descriptor *bulk_tx_ep;
488 struct usb_endpoint_descriptor *bulk_rx_ep;
489 struct usb_endpoint_descriptor *isoc_tx_ep;
490 struct usb_endpoint_descriptor *isoc_rx_ep;
491 struct usb_endpoint_descriptor *diag_tx_ep;
492 struct usb_endpoint_descriptor *diag_rx_ep;
494 struct gpio_desc *reset_gpio;
496 __u8 cmdreq_type;
497 __u8 cmdreq;
499 unsigned int sco_num;
500 unsigned int air_mode;
501 bool usb_alt6_packet_flow;
502 int isoc_altsetting;
503 int suspend_count;
505 int (*recv_event)(struct hci_dev *hdev, struct sk_buff *skb);
506 int (*recv_bulk)(struct btusb_data *data, void *buffer, int count);
508 int (*setup_on_usb)(struct hci_dev *hdev);
510 int oob_wake_irq; /* irq for out-of-band wake-on-bt */
511 unsigned cmd_timeout_cnt;
515 static void btusb_intel_cmd_timeout(struct hci_dev *hdev)
517 struct btusb_data *data = hci_get_drvdata(hdev);
518 struct gpio_desc *reset_gpio = data->reset_gpio;
520 if (++data->cmd_timeout_cnt < 5)
521 return;
523 if (!reset_gpio) {
524 bt_dev_err(hdev, "No way to reset. Ignoring and continuing");
525 return;
529 * Toggle the hard reset line if the platform provides one. The reset
530 * is going to yank the device off the USB and then replug. So doing
531 * once is enough. The cleanup is handled correctly on the way out
532 * (standard USB disconnect), and the new device is detected cleanly
533 * and bound to the driver again like it should be.
535 if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
536 bt_dev_err(hdev, "last reset failed? Not resetting again");
537 return;
540 bt_dev_err(hdev, "Initiating HW reset via gpio");
541 gpiod_set_value_cansleep(reset_gpio, 1);
542 msleep(100);
543 gpiod_set_value_cansleep(reset_gpio, 0);
546 static void btusb_rtl_cmd_timeout(struct hci_dev *hdev)
548 struct btusb_data *data = hci_get_drvdata(hdev);
549 struct gpio_desc *reset_gpio = data->reset_gpio;
551 if (++data->cmd_timeout_cnt < 5)
552 return;
554 if (!reset_gpio) {
555 bt_dev_err(hdev, "No gpio to reset Realtek device, ignoring");
556 return;
559 /* Toggle the hard reset line. The Realtek device is going to
560 * yank itself off the USB and then replug. The cleanup is handled
561 * correctly on the way out (standard USB disconnect), and the new
562 * device is detected cleanly and bound to the driver again like
563 * it should be.
565 if (test_and_set_bit(BTUSB_HW_RESET_ACTIVE, &data->flags)) {
566 bt_dev_err(hdev, "last reset failed? Not resetting again");
567 return;
570 bt_dev_err(hdev, "Reset Realtek device via gpio");
571 gpiod_set_value_cansleep(reset_gpio, 1);
572 msleep(200);
573 gpiod_set_value_cansleep(reset_gpio, 0);
576 static inline void btusb_free_frags(struct btusb_data *data)
578 unsigned long flags;
580 spin_lock_irqsave(&data->rxlock, flags);
582 kfree_skb(data->evt_skb);
583 data->evt_skb = NULL;
585 kfree_skb(data->acl_skb);
586 data->acl_skb = NULL;
588 kfree_skb(data->sco_skb);
589 data->sco_skb = NULL;
591 spin_unlock_irqrestore(&data->rxlock, flags);
594 static int btusb_recv_intr(struct btusb_data *data, void *buffer, int count)
596 struct sk_buff *skb;
597 unsigned long flags;
598 int err = 0;
600 spin_lock_irqsave(&data->rxlock, flags);
601 skb = data->evt_skb;
603 while (count) {
604 int len;
606 if (!skb) {
607 skb = bt_skb_alloc(HCI_MAX_EVENT_SIZE, GFP_ATOMIC);
608 if (!skb) {
609 err = -ENOMEM;
610 break;
613 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
614 hci_skb_expect(skb) = HCI_EVENT_HDR_SIZE;
617 len = min_t(uint, hci_skb_expect(skb), count);
618 skb_put_data(skb, buffer, len);
620 count -= len;
621 buffer += len;
622 hci_skb_expect(skb) -= len;
624 if (skb->len == HCI_EVENT_HDR_SIZE) {
625 /* Complete event header */
626 hci_skb_expect(skb) = hci_event_hdr(skb)->plen;
628 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
629 kfree_skb(skb);
630 skb = NULL;
632 err = -EILSEQ;
633 break;
637 if (!hci_skb_expect(skb)) {
638 /* Complete frame */
639 data->recv_event(data->hdev, skb);
640 skb = NULL;
644 data->evt_skb = skb;
645 spin_unlock_irqrestore(&data->rxlock, flags);
647 return err;
650 static int btusb_recv_bulk(struct btusb_data *data, void *buffer, int count)
652 struct sk_buff *skb;
653 unsigned long flags;
654 int err = 0;
656 spin_lock_irqsave(&data->rxlock, flags);
657 skb = data->acl_skb;
659 while (count) {
660 int len;
662 if (!skb) {
663 skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
664 if (!skb) {
665 err = -ENOMEM;
666 break;
669 hci_skb_pkt_type(skb) = HCI_ACLDATA_PKT;
670 hci_skb_expect(skb) = HCI_ACL_HDR_SIZE;
673 len = min_t(uint, hci_skb_expect(skb), count);
674 skb_put_data(skb, buffer, len);
676 count -= len;
677 buffer += len;
678 hci_skb_expect(skb) -= len;
680 if (skb->len == HCI_ACL_HDR_SIZE) {
681 __le16 dlen = hci_acl_hdr(skb)->dlen;
683 /* Complete ACL header */
684 hci_skb_expect(skb) = __le16_to_cpu(dlen);
686 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
687 kfree_skb(skb);
688 skb = NULL;
690 err = -EILSEQ;
691 break;
695 if (!hci_skb_expect(skb)) {
696 /* Complete frame */
697 hci_recv_frame(data->hdev, skb);
698 skb = NULL;
702 data->acl_skb = skb;
703 spin_unlock_irqrestore(&data->rxlock, flags);
705 return err;
708 static int btusb_recv_isoc(struct btusb_data *data, void *buffer, int count)
710 struct sk_buff *skb;
711 unsigned long flags;
712 int err = 0;
714 spin_lock_irqsave(&data->rxlock, flags);
715 skb = data->sco_skb;
717 while (count) {
718 int len;
720 if (!skb) {
721 skb = bt_skb_alloc(HCI_MAX_SCO_SIZE, GFP_ATOMIC);
722 if (!skb) {
723 err = -ENOMEM;
724 break;
727 hci_skb_pkt_type(skb) = HCI_SCODATA_PKT;
728 hci_skb_expect(skb) = HCI_SCO_HDR_SIZE;
731 len = min_t(uint, hci_skb_expect(skb), count);
732 skb_put_data(skb, buffer, len);
734 count -= len;
735 buffer += len;
736 hci_skb_expect(skb) -= len;
738 if (skb->len == HCI_SCO_HDR_SIZE) {
739 /* Complete SCO header */
740 hci_skb_expect(skb) = hci_sco_hdr(skb)->dlen;
742 if (skb_tailroom(skb) < hci_skb_expect(skb)) {
743 kfree_skb(skb);
744 skb = NULL;
746 err = -EILSEQ;
747 break;
751 if (!hci_skb_expect(skb)) {
752 /* Complete frame */
753 hci_recv_frame(data->hdev, skb);
754 skb = NULL;
758 data->sco_skb = skb;
759 spin_unlock_irqrestore(&data->rxlock, flags);
761 return err;
764 static void btusb_intr_complete(struct urb *urb)
766 struct hci_dev *hdev = urb->context;
767 struct btusb_data *data = hci_get_drvdata(hdev);
768 int err;
770 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
771 urb->actual_length);
773 if (!test_bit(HCI_RUNNING, &hdev->flags))
774 return;
776 if (urb->status == 0) {
777 hdev->stat.byte_rx += urb->actual_length;
779 if (btusb_recv_intr(data, urb->transfer_buffer,
780 urb->actual_length) < 0) {
781 bt_dev_err(hdev, "corrupted event packet");
782 hdev->stat.err_rx++;
784 } else if (urb->status == -ENOENT) {
785 /* Avoid suspend failed when usb_kill_urb */
786 return;
789 if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
790 return;
792 usb_mark_last_busy(data->udev);
793 usb_anchor_urb(urb, &data->intr_anchor);
795 err = usb_submit_urb(urb, GFP_ATOMIC);
796 if (err < 0) {
797 /* -EPERM: urb is being killed;
798 * -ENODEV: device got disconnected
800 if (err != -EPERM && err != -ENODEV)
801 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
802 urb, -err);
803 usb_unanchor_urb(urb);
807 static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
809 struct btusb_data *data = hci_get_drvdata(hdev);
810 struct urb *urb;
811 unsigned char *buf;
812 unsigned int pipe;
813 int err, size;
815 BT_DBG("%s", hdev->name);
817 if (!data->intr_ep)
818 return -ENODEV;
820 urb = usb_alloc_urb(0, mem_flags);
821 if (!urb)
822 return -ENOMEM;
824 size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
826 buf = kmalloc(size, mem_flags);
827 if (!buf) {
828 usb_free_urb(urb);
829 return -ENOMEM;
832 pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
834 usb_fill_int_urb(urb, data->udev, pipe, buf, size,
835 btusb_intr_complete, hdev, data->intr_ep->bInterval);
837 urb->transfer_flags |= URB_FREE_BUFFER;
839 usb_anchor_urb(urb, &data->intr_anchor);
841 err = usb_submit_urb(urb, mem_flags);
842 if (err < 0) {
843 if (err != -EPERM && err != -ENODEV)
844 bt_dev_err(hdev, "urb %p submission failed (%d)",
845 urb, -err);
846 usb_unanchor_urb(urb);
849 usb_free_urb(urb);
851 return err;
854 static void btusb_bulk_complete(struct urb *urb)
856 struct hci_dev *hdev = urb->context;
857 struct btusb_data *data = hci_get_drvdata(hdev);
858 int err;
860 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
861 urb->actual_length);
863 if (!test_bit(HCI_RUNNING, &hdev->flags))
864 return;
866 if (urb->status == 0) {
867 hdev->stat.byte_rx += urb->actual_length;
869 if (data->recv_bulk(data, urb->transfer_buffer,
870 urb->actual_length) < 0) {
871 bt_dev_err(hdev, "corrupted ACL packet");
872 hdev->stat.err_rx++;
874 } else if (urb->status == -ENOENT) {
875 /* Avoid suspend failed when usb_kill_urb */
876 return;
879 if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
880 return;
882 usb_anchor_urb(urb, &data->bulk_anchor);
883 usb_mark_last_busy(data->udev);
885 err = usb_submit_urb(urb, GFP_ATOMIC);
886 if (err < 0) {
887 /* -EPERM: urb is being killed;
888 * -ENODEV: device got disconnected
890 if (err != -EPERM && err != -ENODEV)
891 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
892 urb, -err);
893 usb_unanchor_urb(urb);
897 static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
899 struct btusb_data *data = hci_get_drvdata(hdev);
900 struct urb *urb;
901 unsigned char *buf;
902 unsigned int pipe;
903 int err, size = HCI_MAX_FRAME_SIZE;
905 BT_DBG("%s", hdev->name);
907 if (!data->bulk_rx_ep)
908 return -ENODEV;
910 urb = usb_alloc_urb(0, mem_flags);
911 if (!urb)
912 return -ENOMEM;
914 buf = kmalloc(size, mem_flags);
915 if (!buf) {
916 usb_free_urb(urb);
917 return -ENOMEM;
920 pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
922 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
923 btusb_bulk_complete, hdev);
925 urb->transfer_flags |= URB_FREE_BUFFER;
927 usb_mark_last_busy(data->udev);
928 usb_anchor_urb(urb, &data->bulk_anchor);
930 err = usb_submit_urb(urb, mem_flags);
931 if (err < 0) {
932 if (err != -EPERM && err != -ENODEV)
933 bt_dev_err(hdev, "urb %p submission failed (%d)",
934 urb, -err);
935 usb_unanchor_urb(urb);
938 usb_free_urb(urb);
940 return err;
943 static void btusb_isoc_complete(struct urb *urb)
945 struct hci_dev *hdev = urb->context;
946 struct btusb_data *data = hci_get_drvdata(hdev);
947 int i, err;
949 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
950 urb->actual_length);
952 if (!test_bit(HCI_RUNNING, &hdev->flags))
953 return;
955 if (urb->status == 0) {
956 for (i = 0; i < urb->number_of_packets; i++) {
957 unsigned int offset = urb->iso_frame_desc[i].offset;
958 unsigned int length = urb->iso_frame_desc[i].actual_length;
960 if (urb->iso_frame_desc[i].status)
961 continue;
963 hdev->stat.byte_rx += length;
965 if (btusb_recv_isoc(data, urb->transfer_buffer + offset,
966 length) < 0) {
967 bt_dev_err(hdev, "corrupted SCO packet");
968 hdev->stat.err_rx++;
971 } else if (urb->status == -ENOENT) {
972 /* Avoid suspend failed when usb_kill_urb */
973 return;
976 if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
977 return;
979 usb_anchor_urb(urb, &data->isoc_anchor);
981 err = usb_submit_urb(urb, GFP_ATOMIC);
982 if (err < 0) {
983 /* -EPERM: urb is being killed;
984 * -ENODEV: device got disconnected
986 if (err != -EPERM && err != -ENODEV)
987 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
988 urb, -err);
989 usb_unanchor_urb(urb);
993 static inline void __fill_isoc_descriptor_msbc(struct urb *urb, int len,
994 int mtu, struct btusb_data *data)
996 int i, offset = 0;
997 unsigned int interval;
999 BT_DBG("len %d mtu %d", len, mtu);
1001 /* For mSBC ALT 6 setting the host will send the packet at continuous
1002 * flow. As per core spec 5, vol 4, part B, table 2.1. For ALT setting
1003 * 6 the HCI PACKET INTERVAL should be 7.5ms for every usb packets.
1004 * To maintain the rate we send 63bytes of usb packets alternatively for
1005 * 7ms and 8ms to maintain the rate as 7.5ms.
1007 if (data->usb_alt6_packet_flow) {
1008 interval = 7;
1009 data->usb_alt6_packet_flow = false;
1010 } else {
1011 interval = 6;
1012 data->usb_alt6_packet_flow = true;
1015 for (i = 0; i < interval; i++) {
1016 urb->iso_frame_desc[i].offset = offset;
1017 urb->iso_frame_desc[i].length = offset;
1020 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
1021 urb->iso_frame_desc[i].offset = offset;
1022 urb->iso_frame_desc[i].length = len;
1023 i++;
1026 urb->number_of_packets = i;
1029 static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
1031 int i, offset = 0;
1033 BT_DBG("len %d mtu %d", len, mtu);
1035 for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
1036 i++, offset += mtu, len -= mtu) {
1037 urb->iso_frame_desc[i].offset = offset;
1038 urb->iso_frame_desc[i].length = mtu;
1041 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
1042 urb->iso_frame_desc[i].offset = offset;
1043 urb->iso_frame_desc[i].length = len;
1044 i++;
1047 urb->number_of_packets = i;
1050 static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
1052 struct btusb_data *data = hci_get_drvdata(hdev);
1053 struct urb *urb;
1054 unsigned char *buf;
1055 unsigned int pipe;
1056 int err, size;
1058 BT_DBG("%s", hdev->name);
1060 if (!data->isoc_rx_ep)
1061 return -ENODEV;
1063 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
1064 if (!urb)
1065 return -ENOMEM;
1067 size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
1068 BTUSB_MAX_ISOC_FRAMES;
1070 buf = kmalloc(size, mem_flags);
1071 if (!buf) {
1072 usb_free_urb(urb);
1073 return -ENOMEM;
1076 pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
1078 usb_fill_int_urb(urb, data->udev, pipe, buf, size, btusb_isoc_complete,
1079 hdev, data->isoc_rx_ep->bInterval);
1081 urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
1083 __fill_isoc_descriptor(urb, size,
1084 le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
1086 usb_anchor_urb(urb, &data->isoc_anchor);
1088 err = usb_submit_urb(urb, mem_flags);
1089 if (err < 0) {
1090 if (err != -EPERM && err != -ENODEV)
1091 bt_dev_err(hdev, "urb %p submission failed (%d)",
1092 urb, -err);
1093 usb_unanchor_urb(urb);
1096 usb_free_urb(urb);
1098 return err;
1101 static void btusb_diag_complete(struct urb *urb)
1103 struct hci_dev *hdev = urb->context;
1104 struct btusb_data *data = hci_get_drvdata(hdev);
1105 int err;
1107 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1108 urb->actual_length);
1110 if (urb->status == 0) {
1111 struct sk_buff *skb;
1113 skb = bt_skb_alloc(urb->actual_length, GFP_ATOMIC);
1114 if (skb) {
1115 skb_put_data(skb, urb->transfer_buffer,
1116 urb->actual_length);
1117 hci_recv_diag(hdev, skb);
1119 } else if (urb->status == -ENOENT) {
1120 /* Avoid suspend failed when usb_kill_urb */
1121 return;
1124 if (!test_bit(BTUSB_DIAG_RUNNING, &data->flags))
1125 return;
1127 usb_anchor_urb(urb, &data->diag_anchor);
1128 usb_mark_last_busy(data->udev);
1130 err = usb_submit_urb(urb, GFP_ATOMIC);
1131 if (err < 0) {
1132 /* -EPERM: urb is being killed;
1133 * -ENODEV: device got disconnected
1135 if (err != -EPERM && err != -ENODEV)
1136 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
1137 urb, -err);
1138 usb_unanchor_urb(urb);
1142 static int btusb_submit_diag_urb(struct hci_dev *hdev, gfp_t mem_flags)
1144 struct btusb_data *data = hci_get_drvdata(hdev);
1145 struct urb *urb;
1146 unsigned char *buf;
1147 unsigned int pipe;
1148 int err, size = HCI_MAX_FRAME_SIZE;
1150 BT_DBG("%s", hdev->name);
1152 if (!data->diag_rx_ep)
1153 return -ENODEV;
1155 urb = usb_alloc_urb(0, mem_flags);
1156 if (!urb)
1157 return -ENOMEM;
1159 buf = kmalloc(size, mem_flags);
1160 if (!buf) {
1161 usb_free_urb(urb);
1162 return -ENOMEM;
1165 pipe = usb_rcvbulkpipe(data->udev, data->diag_rx_ep->bEndpointAddress);
1167 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
1168 btusb_diag_complete, hdev);
1170 urb->transfer_flags |= URB_FREE_BUFFER;
1172 usb_mark_last_busy(data->udev);
1173 usb_anchor_urb(urb, &data->diag_anchor);
1175 err = usb_submit_urb(urb, mem_flags);
1176 if (err < 0) {
1177 if (err != -EPERM && err != -ENODEV)
1178 bt_dev_err(hdev, "urb %p submission failed (%d)",
1179 urb, -err);
1180 usb_unanchor_urb(urb);
1183 usb_free_urb(urb);
1185 return err;
1188 static void btusb_tx_complete(struct urb *urb)
1190 struct sk_buff *skb = urb->context;
1191 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1192 struct btusb_data *data = hci_get_drvdata(hdev);
1193 unsigned long flags;
1195 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1196 urb->actual_length);
1198 if (!test_bit(HCI_RUNNING, &hdev->flags))
1199 goto done;
1201 if (!urb->status)
1202 hdev->stat.byte_tx += urb->transfer_buffer_length;
1203 else
1204 hdev->stat.err_tx++;
1206 done:
1207 spin_lock_irqsave(&data->txlock, flags);
1208 data->tx_in_flight--;
1209 spin_unlock_irqrestore(&data->txlock, flags);
1211 kfree(urb->setup_packet);
1213 kfree_skb(skb);
1216 static void btusb_isoc_tx_complete(struct urb *urb)
1218 struct sk_buff *skb = urb->context;
1219 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
1221 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
1222 urb->actual_length);
1224 if (!test_bit(HCI_RUNNING, &hdev->flags))
1225 goto done;
1227 if (!urb->status)
1228 hdev->stat.byte_tx += urb->transfer_buffer_length;
1229 else
1230 hdev->stat.err_tx++;
1232 done:
1233 kfree(urb->setup_packet);
1235 kfree_skb(skb);
1238 static int btusb_open(struct hci_dev *hdev)
1240 struct btusb_data *data = hci_get_drvdata(hdev);
1241 int err;
1243 BT_DBG("%s", hdev->name);
1245 err = usb_autopm_get_interface(data->intf);
1246 if (err < 0)
1247 return err;
1249 /* Patching USB firmware files prior to starting any URBs of HCI path
1250 * It is more safe to use USB bulk channel for downloading USB patch
1252 if (data->setup_on_usb) {
1253 err = data->setup_on_usb(hdev);
1254 if (err < 0)
1255 goto setup_fail;
1258 data->intf->needs_remote_wakeup = 1;
1260 /* Disable device remote wakeup when host is suspended
1261 * For Realtek chips, global suspend without
1262 * SET_FEATURE (DEVICE_REMOTE_WAKEUP) can save more power in device.
1264 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1265 device_wakeup_disable(&data->udev->dev);
1267 if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
1268 goto done;
1270 err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
1271 if (err < 0)
1272 goto failed;
1274 err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1275 if (err < 0) {
1276 usb_kill_anchored_urbs(&data->intr_anchor);
1277 goto failed;
1280 set_bit(BTUSB_BULK_RUNNING, &data->flags);
1281 btusb_submit_bulk_urb(hdev, GFP_KERNEL);
1283 if (data->diag) {
1284 if (!btusb_submit_diag_urb(hdev, GFP_KERNEL))
1285 set_bit(BTUSB_DIAG_RUNNING, &data->flags);
1288 done:
1289 usb_autopm_put_interface(data->intf);
1290 return 0;
1292 failed:
1293 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1294 setup_fail:
1295 usb_autopm_put_interface(data->intf);
1296 return err;
1299 static void btusb_stop_traffic(struct btusb_data *data)
1301 usb_kill_anchored_urbs(&data->intr_anchor);
1302 usb_kill_anchored_urbs(&data->bulk_anchor);
1303 usb_kill_anchored_urbs(&data->isoc_anchor);
1304 usb_kill_anchored_urbs(&data->diag_anchor);
1305 usb_kill_anchored_urbs(&data->ctrl_anchor);
1308 static int btusb_close(struct hci_dev *hdev)
1310 struct btusb_data *data = hci_get_drvdata(hdev);
1311 int err;
1313 BT_DBG("%s", hdev->name);
1315 cancel_work_sync(&data->work);
1316 cancel_work_sync(&data->waker);
1318 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1319 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
1320 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1321 clear_bit(BTUSB_DIAG_RUNNING, &data->flags);
1323 btusb_stop_traffic(data);
1324 btusb_free_frags(data);
1326 err = usb_autopm_get_interface(data->intf);
1327 if (err < 0)
1328 goto failed;
1330 data->intf->needs_remote_wakeup = 0;
1332 /* Enable remote wake up for auto-suspend */
1333 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1334 data->intf->needs_remote_wakeup = 1;
1336 usb_autopm_put_interface(data->intf);
1338 failed:
1339 usb_scuttle_anchored_urbs(&data->deferred);
1340 return 0;
1343 static int btusb_flush(struct hci_dev *hdev)
1345 struct btusb_data *data = hci_get_drvdata(hdev);
1347 BT_DBG("%s", hdev->name);
1349 usb_kill_anchored_urbs(&data->tx_anchor);
1350 btusb_free_frags(data);
1352 return 0;
1355 static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1357 struct btusb_data *data = hci_get_drvdata(hdev);
1358 struct usb_ctrlrequest *dr;
1359 struct urb *urb;
1360 unsigned int pipe;
1362 urb = usb_alloc_urb(0, GFP_KERNEL);
1363 if (!urb)
1364 return ERR_PTR(-ENOMEM);
1366 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1367 if (!dr) {
1368 usb_free_urb(urb);
1369 return ERR_PTR(-ENOMEM);
1372 dr->bRequestType = data->cmdreq_type;
1373 dr->bRequest = data->cmdreq;
1374 dr->wIndex = 0;
1375 dr->wValue = 0;
1376 dr->wLength = __cpu_to_le16(skb->len);
1378 pipe = usb_sndctrlpipe(data->udev, 0x00);
1380 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1381 skb->data, skb->len, btusb_tx_complete, skb);
1383 skb->dev = (void *)hdev;
1385 return urb;
1388 static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1390 struct btusb_data *data = hci_get_drvdata(hdev);
1391 struct urb *urb;
1392 unsigned int pipe;
1394 if (!data->bulk_tx_ep)
1395 return ERR_PTR(-ENODEV);
1397 urb = usb_alloc_urb(0, GFP_KERNEL);
1398 if (!urb)
1399 return ERR_PTR(-ENOMEM);
1401 pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1403 usb_fill_bulk_urb(urb, data->udev, pipe,
1404 skb->data, skb->len, btusb_tx_complete, skb);
1406 skb->dev = (void *)hdev;
1408 return urb;
1411 static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1413 struct btusb_data *data = hci_get_drvdata(hdev);
1414 struct urb *urb;
1415 unsigned int pipe;
1417 if (!data->isoc_tx_ep)
1418 return ERR_PTR(-ENODEV);
1420 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1421 if (!urb)
1422 return ERR_PTR(-ENOMEM);
1424 pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1426 usb_fill_int_urb(urb, data->udev, pipe,
1427 skb->data, skb->len, btusb_isoc_tx_complete,
1428 skb, data->isoc_tx_ep->bInterval);
1430 urb->transfer_flags = URB_ISO_ASAP;
1432 if (data->isoc_altsetting == 6)
1433 __fill_isoc_descriptor_msbc(urb, skb->len,
1434 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize),
1435 data);
1436 else
1437 __fill_isoc_descriptor(urb, skb->len,
1438 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1439 skb->dev = (void *)hdev;
1441 return urb;
1444 static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1446 struct btusb_data *data = hci_get_drvdata(hdev);
1447 int err;
1449 usb_anchor_urb(urb, &data->tx_anchor);
1451 err = usb_submit_urb(urb, GFP_KERNEL);
1452 if (err < 0) {
1453 if (err != -EPERM && err != -ENODEV)
1454 bt_dev_err(hdev, "urb %p submission failed (%d)",
1455 urb, -err);
1456 kfree(urb->setup_packet);
1457 usb_unanchor_urb(urb);
1458 } else {
1459 usb_mark_last_busy(data->udev);
1462 usb_free_urb(urb);
1463 return err;
1466 static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1468 struct btusb_data *data = hci_get_drvdata(hdev);
1469 unsigned long flags;
1470 bool suspending;
1472 spin_lock_irqsave(&data->txlock, flags);
1473 suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1474 if (!suspending)
1475 data->tx_in_flight++;
1476 spin_unlock_irqrestore(&data->txlock, flags);
1478 if (!suspending)
1479 return submit_tx_urb(hdev, urb);
1481 usb_anchor_urb(urb, &data->deferred);
1482 schedule_work(&data->waker);
1484 usb_free_urb(urb);
1485 return 0;
1488 static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1490 struct urb *urb;
1492 BT_DBG("%s", hdev->name);
1494 switch (hci_skb_pkt_type(skb)) {
1495 case HCI_COMMAND_PKT:
1496 urb = alloc_ctrl_urb(hdev, skb);
1497 if (IS_ERR(urb))
1498 return PTR_ERR(urb);
1500 hdev->stat.cmd_tx++;
1501 return submit_or_queue_tx_urb(hdev, urb);
1503 case HCI_ACLDATA_PKT:
1504 urb = alloc_bulk_urb(hdev, skb);
1505 if (IS_ERR(urb))
1506 return PTR_ERR(urb);
1508 hdev->stat.acl_tx++;
1509 return submit_or_queue_tx_urb(hdev, urb);
1511 case HCI_SCODATA_PKT:
1512 if (hci_conn_num(hdev, SCO_LINK) < 1)
1513 return -ENODEV;
1515 urb = alloc_isoc_urb(hdev, skb);
1516 if (IS_ERR(urb))
1517 return PTR_ERR(urb);
1519 hdev->stat.sco_tx++;
1520 return submit_tx_urb(hdev, urb);
1523 return -EILSEQ;
1526 static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1528 struct btusb_data *data = hci_get_drvdata(hdev);
1530 BT_DBG("%s evt %d", hdev->name, evt);
1532 if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1533 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1534 data->air_mode = evt;
1535 schedule_work(&data->work);
1539 static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1541 struct btusb_data *data = hci_get_drvdata(hdev);
1542 struct usb_interface *intf = data->isoc;
1543 struct usb_endpoint_descriptor *ep_desc;
1544 int i, err;
1546 if (!data->isoc)
1547 return -ENODEV;
1549 err = usb_set_interface(data->udev, data->isoc_ifnum, altsetting);
1550 if (err < 0) {
1551 bt_dev_err(hdev, "setting interface failed (%d)", -err);
1552 return err;
1555 data->isoc_altsetting = altsetting;
1557 data->isoc_tx_ep = NULL;
1558 data->isoc_rx_ep = NULL;
1560 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1561 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1563 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1564 data->isoc_tx_ep = ep_desc;
1565 continue;
1568 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1569 data->isoc_rx_ep = ep_desc;
1570 continue;
1574 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1575 bt_dev_err(hdev, "invalid SCO descriptors");
1576 return -ENODEV;
1579 return 0;
1582 static int btusb_switch_alt_setting(struct hci_dev *hdev, int new_alts)
1584 struct btusb_data *data = hci_get_drvdata(hdev);
1585 int err;
1587 if (data->isoc_altsetting != new_alts) {
1588 unsigned long flags;
1590 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1591 usb_kill_anchored_urbs(&data->isoc_anchor);
1593 /* When isochronous alternate setting needs to be
1594 * changed, because SCO connection has been added
1595 * or removed, a packet fragment may be left in the
1596 * reassembling state. This could lead to wrongly
1597 * assembled fragments.
1599 * Clear outstanding fragment when selecting a new
1600 * alternate setting.
1602 spin_lock_irqsave(&data->rxlock, flags);
1603 kfree_skb(data->sco_skb);
1604 data->sco_skb = NULL;
1605 spin_unlock_irqrestore(&data->rxlock, flags);
1607 err = __set_isoc_interface(hdev, new_alts);
1608 if (err < 0)
1609 return err;
1612 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1613 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1614 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1615 else
1616 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1619 return 0;
1622 static struct usb_host_interface *btusb_find_altsetting(struct btusb_data *data,
1623 int alt)
1625 struct usb_interface *intf = data->isoc;
1626 int i;
1628 BT_DBG("Looking for Alt no :%d", alt);
1630 if (!intf)
1631 return NULL;
1633 for (i = 0; i < intf->num_altsetting; i++) {
1634 if (intf->altsetting[i].desc.bAlternateSetting == alt)
1635 return &intf->altsetting[i];
1638 return NULL;
1641 static void btusb_work(struct work_struct *work)
1643 struct btusb_data *data = container_of(work, struct btusb_data, work);
1644 struct hci_dev *hdev = data->hdev;
1645 int new_alts = 0;
1646 int err;
1648 if (data->sco_num > 0) {
1649 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1650 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1651 if (err < 0) {
1652 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1653 usb_kill_anchored_urbs(&data->isoc_anchor);
1654 return;
1657 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1660 if (data->air_mode == HCI_NOTIFY_ENABLE_SCO_CVSD) {
1661 if (hdev->voice_setting & 0x0020) {
1662 static const int alts[3] = { 2, 4, 5 };
1664 new_alts = alts[data->sco_num - 1];
1665 } else {
1666 new_alts = data->sco_num;
1668 } else if (data->air_mode == HCI_NOTIFY_ENABLE_SCO_TRANSP) {
1670 data->usb_alt6_packet_flow = true;
1672 /* Check if Alt 6 is supported for Transparent audio */
1673 if (btusb_find_altsetting(data, 6))
1674 new_alts = 6;
1675 else
1676 bt_dev_err(hdev, "Device does not support ALT setting 6");
1679 if (btusb_switch_alt_setting(hdev, new_alts) < 0)
1680 bt_dev_err(hdev, "set USB alt:(%d) failed!", new_alts);
1681 } else {
1682 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1683 usb_kill_anchored_urbs(&data->isoc_anchor);
1685 __set_isoc_interface(hdev, 0);
1686 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1687 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1691 static void btusb_waker(struct work_struct *work)
1693 struct btusb_data *data = container_of(work, struct btusb_data, waker);
1694 int err;
1696 err = usb_autopm_get_interface(data->intf);
1697 if (err < 0)
1698 return;
1700 usb_autopm_put_interface(data->intf);
1703 static int btusb_setup_bcm92035(struct hci_dev *hdev)
1705 struct sk_buff *skb;
1706 u8 val = 0x00;
1708 BT_DBG("%s", hdev->name);
1710 skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1711 if (IS_ERR(skb))
1712 bt_dev_err(hdev, "BCM92035 command failed (%ld)", PTR_ERR(skb));
1713 else
1714 kfree_skb(skb);
1716 return 0;
1719 static int btusb_setup_csr(struct hci_dev *hdev)
1721 struct hci_rp_read_local_version *rp;
1722 struct sk_buff *skb;
1724 BT_DBG("%s", hdev->name);
1726 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1727 HCI_INIT_TIMEOUT);
1728 if (IS_ERR(skb)) {
1729 int err = PTR_ERR(skb);
1730 bt_dev_err(hdev, "CSR: Local version failed (%d)", err);
1731 return err;
1734 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1735 bt_dev_err(hdev, "CSR: Local version length mismatch");
1736 kfree_skb(skb);
1737 return -EIO;
1740 rp = (struct hci_rp_read_local_version *)skb->data;
1742 /* Detect controllers which aren't real CSR ones. */
1743 if (le16_to_cpu(rp->manufacturer) != 10 ||
1744 le16_to_cpu(rp->lmp_subver) == 0x0c5c) {
1745 /* Clear the reset quirk since this is not an actual
1746 * early Bluetooth 1.1 device from CSR.
1748 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1750 /* These fake CSR controllers have all a broken
1751 * stored link key handling and so just disable it.
1753 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
1756 kfree_skb(skb);
1758 return 0;
1761 static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1762 struct intel_version *ver)
1764 const struct firmware *fw;
1765 char fwname[64];
1766 int ret;
1768 snprintf(fwname, sizeof(fwname),
1769 "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1770 ver->hw_platform, ver->hw_variant, ver->hw_revision,
1771 ver->fw_variant, ver->fw_revision, ver->fw_build_num,
1772 ver->fw_build_ww, ver->fw_build_yy);
1774 ret = request_firmware(&fw, fwname, &hdev->dev);
1775 if (ret < 0) {
1776 if (ret == -EINVAL) {
1777 bt_dev_err(hdev, "Intel firmware file request failed (%d)",
1778 ret);
1779 return NULL;
1782 bt_dev_err(hdev, "failed to open Intel firmware file: %s (%d)",
1783 fwname, ret);
1785 /* If the correct firmware patch file is not found, use the
1786 * default firmware patch file instead
1788 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1789 ver->hw_platform, ver->hw_variant);
1790 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1791 bt_dev_err(hdev, "failed to open default fw file: %s",
1792 fwname);
1793 return NULL;
1797 bt_dev_info(hdev, "Intel Bluetooth firmware file: %s", fwname);
1799 return fw;
1802 static int btusb_setup_intel_patching(struct hci_dev *hdev,
1803 const struct firmware *fw,
1804 const u8 **fw_ptr, int *disable_patch)
1806 struct sk_buff *skb;
1807 struct hci_command_hdr *cmd;
1808 const u8 *cmd_param;
1809 struct hci_event_hdr *evt = NULL;
1810 const u8 *evt_param = NULL;
1811 int remain = fw->size - (*fw_ptr - fw->data);
1813 /* The first byte indicates the types of the patch command or event.
1814 * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1815 * in the current firmware buffer doesn't start with 0x01 or
1816 * the size of remain buffer is smaller than HCI command header,
1817 * the firmware file is corrupted and it should stop the patching
1818 * process.
1820 if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1821 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd read");
1822 return -EINVAL;
1824 (*fw_ptr)++;
1825 remain--;
1827 cmd = (struct hci_command_hdr *)(*fw_ptr);
1828 *fw_ptr += sizeof(*cmd);
1829 remain -= sizeof(*cmd);
1831 /* Ensure that the remain firmware data is long enough than the length
1832 * of command parameter. If not, the firmware file is corrupted.
1834 if (remain < cmd->plen) {
1835 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd len");
1836 return -EFAULT;
1839 /* If there is a command that loads a patch in the firmware
1840 * file, then enable the patch upon success, otherwise just
1841 * disable the manufacturer mode, for example patch activation
1842 * is not required when the default firmware patch file is used
1843 * because there are no patch data to load.
1845 if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
1846 *disable_patch = 0;
1848 cmd_param = *fw_ptr;
1849 *fw_ptr += cmd->plen;
1850 remain -= cmd->plen;
1852 /* This reads the expected events when the above command is sent to the
1853 * device. Some vendor commands expects more than one events, for
1854 * example command status event followed by vendor specific event.
1855 * For this case, it only keeps the last expected event. so the command
1856 * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
1857 * last expected event.
1859 while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
1860 (*fw_ptr)++;
1861 remain--;
1863 evt = (struct hci_event_hdr *)(*fw_ptr);
1864 *fw_ptr += sizeof(*evt);
1865 remain -= sizeof(*evt);
1867 if (remain < evt->plen) {
1868 bt_dev_err(hdev, "Intel fw corrupted: invalid evt len");
1869 return -EFAULT;
1872 evt_param = *fw_ptr;
1873 *fw_ptr += evt->plen;
1874 remain -= evt->plen;
1877 /* Every HCI commands in the firmware file has its correspond event.
1878 * If event is not found or remain is smaller than zero, the firmware
1879 * file is corrupted.
1881 if (!evt || !evt_param || remain < 0) {
1882 bt_dev_err(hdev, "Intel fw corrupted: invalid evt read");
1883 return -EFAULT;
1886 skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
1887 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
1888 if (IS_ERR(skb)) {
1889 bt_dev_err(hdev, "sending Intel patch command (0x%4.4x) failed (%ld)",
1890 cmd->opcode, PTR_ERR(skb));
1891 return PTR_ERR(skb);
1894 /* It ensures that the returned event matches the event data read from
1895 * the firmware file. At fist, it checks the length and then
1896 * the contents of the event.
1898 if (skb->len != evt->plen) {
1899 bt_dev_err(hdev, "mismatch event length (opcode 0x%4.4x)",
1900 le16_to_cpu(cmd->opcode));
1901 kfree_skb(skb);
1902 return -EFAULT;
1905 if (memcmp(skb->data, evt_param, evt->plen)) {
1906 bt_dev_err(hdev, "mismatch event parameter (opcode 0x%4.4x)",
1907 le16_to_cpu(cmd->opcode));
1908 kfree_skb(skb);
1909 return -EFAULT;
1911 kfree_skb(skb);
1913 return 0;
1916 static int btusb_setup_intel(struct hci_dev *hdev)
1918 struct sk_buff *skb;
1919 const struct firmware *fw;
1920 const u8 *fw_ptr;
1921 int disable_patch, err;
1922 struct intel_version ver;
1924 BT_DBG("%s", hdev->name);
1926 /* The controller has a bug with the first HCI command sent to it
1927 * returning number of completed commands as zero. This would stall the
1928 * command processing in the Bluetooth core.
1930 * As a workaround, send HCI Reset command first which will reset the
1931 * number of completed commands and allow normal command processing
1932 * from now on.
1934 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
1935 if (IS_ERR(skb)) {
1936 bt_dev_err(hdev, "sending initial HCI reset command failed (%ld)",
1937 PTR_ERR(skb));
1938 return PTR_ERR(skb);
1940 kfree_skb(skb);
1942 /* Read Intel specific controller version first to allow selection of
1943 * which firmware file to load.
1945 * The returned information are hardware variant and revision plus
1946 * firmware variant, revision and build number.
1948 err = btintel_read_version(hdev, &ver);
1949 if (err)
1950 return err;
1952 bt_dev_info(hdev, "read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
1953 ver.hw_platform, ver.hw_variant, ver.hw_revision,
1954 ver.fw_variant, ver.fw_revision, ver.fw_build_num,
1955 ver.fw_build_ww, ver.fw_build_yy, ver.fw_patch_num);
1957 /* fw_patch_num indicates the version of patch the device currently
1958 * have. If there is no patch data in the device, it is always 0x00.
1959 * So, if it is other than 0x00, no need to patch the device again.
1961 if (ver.fw_patch_num) {
1962 bt_dev_info(hdev, "Intel device is already patched. "
1963 "patch num: %02x", ver.fw_patch_num);
1964 goto complete;
1967 /* Opens the firmware patch file based on the firmware version read
1968 * from the controller. If it fails to open the matching firmware
1969 * patch file, it tries to open the default firmware patch file.
1970 * If no patch file is found, allow the device to operate without
1971 * a patch.
1973 fw = btusb_setup_intel_get_fw(hdev, &ver);
1974 if (!fw)
1975 goto complete;
1976 fw_ptr = fw->data;
1978 /* Enable the manufacturer mode of the controller.
1979 * Only while this mode is enabled, the driver can download the
1980 * firmware patch data and configuration parameters.
1982 err = btintel_enter_mfg(hdev);
1983 if (err) {
1984 release_firmware(fw);
1985 return err;
1988 disable_patch = 1;
1990 /* The firmware data file consists of list of Intel specific HCI
1991 * commands and its expected events. The first byte indicates the
1992 * type of the message, either HCI command or HCI event.
1994 * It reads the command and its expected event from the firmware file,
1995 * and send to the controller. Once __hci_cmd_sync_ev() returns,
1996 * the returned event is compared with the event read from the firmware
1997 * file and it will continue until all the messages are downloaded to
1998 * the controller.
2000 * Once the firmware patching is completed successfully,
2001 * the manufacturer mode is disabled with reset and activating the
2002 * downloaded patch.
2004 * If the firmware patching fails, the manufacturer mode is
2005 * disabled with reset and deactivating the patch.
2007 * If the default patch file is used, no reset is done when disabling
2008 * the manufacturer.
2010 while (fw->size > fw_ptr - fw->data) {
2011 int ret;
2013 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
2014 &disable_patch);
2015 if (ret < 0)
2016 goto exit_mfg_deactivate;
2019 release_firmware(fw);
2021 if (disable_patch)
2022 goto exit_mfg_disable;
2024 /* Patching completed successfully and disable the manufacturer mode
2025 * with reset and activate the downloaded firmware patches.
2027 err = btintel_exit_mfg(hdev, true, true);
2028 if (err)
2029 return err;
2031 /* Need build number for downloaded fw patches in
2032 * every power-on boot
2034 err = btintel_read_version(hdev, &ver);
2035 if (err)
2036 return err;
2037 bt_dev_info(hdev, "Intel BT fw patch 0x%02x completed & activated",
2038 ver.fw_patch_num);
2040 goto complete;
2042 exit_mfg_disable:
2043 /* Disable the manufacturer mode without reset */
2044 err = btintel_exit_mfg(hdev, false, false);
2045 if (err)
2046 return err;
2048 bt_dev_info(hdev, "Intel firmware patch completed");
2050 goto complete;
2052 exit_mfg_deactivate:
2053 release_firmware(fw);
2055 /* Patching failed. Disable the manufacturer mode with reset and
2056 * deactivate the downloaded firmware patches.
2058 err = btintel_exit_mfg(hdev, true, false);
2059 if (err)
2060 return err;
2062 bt_dev_info(hdev, "Intel firmware patch completed and deactivated");
2064 complete:
2065 /* Set the event mask for Intel specific vendor events. This enables
2066 * a few extra events that are useful during general operation.
2068 btintel_set_event_mask_mfg(hdev, false);
2070 btintel_check_bdaddr(hdev);
2071 return 0;
2074 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
2076 struct sk_buff *skb;
2077 struct hci_event_hdr *hdr;
2078 struct hci_ev_cmd_complete *evt;
2080 skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_KERNEL);
2081 if (!skb)
2082 return -ENOMEM;
2084 hdr = skb_put(skb, sizeof(*hdr));
2085 hdr->evt = HCI_EV_CMD_COMPLETE;
2086 hdr->plen = sizeof(*evt) + 1;
2088 evt = skb_put(skb, sizeof(*evt));
2089 evt->ncmd = 0x01;
2090 evt->opcode = cpu_to_le16(opcode);
2092 skb_put_u8(skb, 0x00);
2094 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
2096 return hci_recv_frame(hdev, skb);
2099 static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
2100 int count)
2102 /* When the device is in bootloader mode, then it can send
2103 * events via the bulk endpoint. These events are treated the
2104 * same way as the ones received from the interrupt endpoint.
2106 if (test_bit(BTUSB_BOOTLOADER, &data->flags))
2107 return btusb_recv_intr(data, buffer, count);
2109 return btusb_recv_bulk(data, buffer, count);
2112 static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
2113 unsigned int len)
2115 const struct intel_bootup *evt = ptr;
2117 if (len != sizeof(*evt))
2118 return;
2120 if (test_and_clear_bit(BTUSB_BOOTING, &data->flags))
2121 wake_up_bit(&data->flags, BTUSB_BOOTING);
2124 static void btusb_intel_secure_send_result(struct btusb_data *data,
2125 const void *ptr, unsigned int len)
2127 const struct intel_secure_send_result *evt = ptr;
2129 if (len != sizeof(*evt))
2130 return;
2132 if (evt->result)
2133 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
2135 if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
2136 test_bit(BTUSB_FIRMWARE_LOADED, &data->flags))
2137 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
2140 static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
2142 struct btusb_data *data = hci_get_drvdata(hdev);
2144 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2145 struct hci_event_hdr *hdr = (void *)skb->data;
2147 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
2148 hdr->plen > 0) {
2149 const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
2150 unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
2152 switch (skb->data[2]) {
2153 case 0x02:
2154 /* When switching to the operational firmware
2155 * the device sends a vendor specific event
2156 * indicating that the bootup completed.
2158 btusb_intel_bootup(data, ptr, len);
2159 break;
2160 case 0x06:
2161 /* When the firmware loading completes the
2162 * device sends out a vendor specific event
2163 * indicating the result of the firmware
2164 * loading.
2166 btusb_intel_secure_send_result(data, ptr, len);
2167 break;
2172 return hci_recv_frame(hdev, skb);
2175 static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
2177 struct btusb_data *data = hci_get_drvdata(hdev);
2178 struct urb *urb;
2180 BT_DBG("%s", hdev->name);
2182 switch (hci_skb_pkt_type(skb)) {
2183 case HCI_COMMAND_PKT:
2184 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2185 struct hci_command_hdr *cmd = (void *)skb->data;
2186 __u16 opcode = le16_to_cpu(cmd->opcode);
2188 /* When in bootloader mode and the command 0xfc09
2189 * is received, it needs to be send down the
2190 * bulk endpoint. So allocate a bulk URB instead.
2192 if (opcode == 0xfc09)
2193 urb = alloc_bulk_urb(hdev, skb);
2194 else
2195 urb = alloc_ctrl_urb(hdev, skb);
2197 /* When the 0xfc01 command is issued to boot into
2198 * the operational firmware, it will actually not
2199 * send a command complete event. To keep the flow
2200 * control working inject that event here.
2202 if (opcode == 0xfc01)
2203 inject_cmd_complete(hdev, opcode);
2204 } else {
2205 urb = alloc_ctrl_urb(hdev, skb);
2207 if (IS_ERR(urb))
2208 return PTR_ERR(urb);
2210 hdev->stat.cmd_tx++;
2211 return submit_or_queue_tx_urb(hdev, urb);
2213 case HCI_ACLDATA_PKT:
2214 urb = alloc_bulk_urb(hdev, skb);
2215 if (IS_ERR(urb))
2216 return PTR_ERR(urb);
2218 hdev->stat.acl_tx++;
2219 return submit_or_queue_tx_urb(hdev, urb);
2221 case HCI_SCODATA_PKT:
2222 if (hci_conn_num(hdev, SCO_LINK) < 1)
2223 return -ENODEV;
2225 urb = alloc_isoc_urb(hdev, skb);
2226 if (IS_ERR(urb))
2227 return PTR_ERR(urb);
2229 hdev->stat.sco_tx++;
2230 return submit_tx_urb(hdev, urb);
2233 return -EILSEQ;
2236 static bool btusb_setup_intel_new_get_fw_name(struct intel_version *ver,
2237 struct intel_boot_params *params,
2238 char *fw_name, size_t len,
2239 const char *suffix)
2241 switch (ver->hw_variant) {
2242 case 0x0b: /* SfP */
2243 case 0x0c: /* WsP */
2244 snprintf(fw_name, len, "intel/ibt-%u-%u.%s",
2245 le16_to_cpu(ver->hw_variant),
2246 le16_to_cpu(params->dev_revid),
2247 suffix);
2248 break;
2249 case 0x11: /* JfP */
2250 case 0x12: /* ThP */
2251 case 0x13: /* HrP */
2252 case 0x14: /* CcP */
2253 snprintf(fw_name, len, "intel/ibt-%u-%u-%u.%s",
2254 le16_to_cpu(ver->hw_variant),
2255 le16_to_cpu(ver->hw_revision),
2256 le16_to_cpu(ver->fw_revision),
2257 suffix);
2258 break;
2259 default:
2260 return false;
2262 return true;
2265 static int btusb_setup_intel_new(struct hci_dev *hdev)
2267 struct btusb_data *data = hci_get_drvdata(hdev);
2268 struct intel_version ver;
2269 struct intel_boot_params params;
2270 const struct firmware *fw;
2271 u32 boot_param;
2272 char fwname[64];
2273 ktime_t calltime, delta, rettime;
2274 unsigned long long duration;
2275 int err;
2277 BT_DBG("%s", hdev->name);
2279 /* Set the default boot parameter to 0x0 and it is updated to
2280 * SKU specific boot parameter after reading Intel_Write_Boot_Params
2281 * command while downloading the firmware.
2283 boot_param = 0x00000000;
2285 calltime = ktime_get();
2287 /* Read the Intel version information to determine if the device
2288 * is in bootloader mode or if it already has operational firmware
2289 * loaded.
2291 err = btintel_read_version(hdev, &ver);
2292 if (err) {
2293 bt_dev_err(hdev, "Intel Read version failed (%d)", err);
2294 btintel_reset_to_bootloader(hdev);
2295 return err;
2298 /* The hardware platform number has a fixed value of 0x37 and
2299 * for now only accept this single value.
2301 if (ver.hw_platform != 0x37) {
2302 bt_dev_err(hdev, "Unsupported Intel hardware platform (%u)",
2303 ver.hw_platform);
2304 return -EINVAL;
2307 /* Check for supported iBT hardware variants of this firmware
2308 * loading method.
2310 * This check has been put in place to ensure correct forward
2311 * compatibility options when newer hardware variants come along.
2313 switch (ver.hw_variant) {
2314 case 0x0b: /* SfP */
2315 case 0x0c: /* WsP */
2316 case 0x11: /* JfP */
2317 case 0x12: /* ThP */
2318 case 0x13: /* HrP */
2319 case 0x14: /* CcP */
2320 break;
2321 default:
2322 bt_dev_err(hdev, "Unsupported Intel hardware variant (%u)",
2323 ver.hw_variant);
2324 return -EINVAL;
2327 btintel_version_info(hdev, &ver);
2329 /* The firmware variant determines if the device is in bootloader
2330 * mode or is running operational firmware. The value 0x06 identifies
2331 * the bootloader and the value 0x23 identifies the operational
2332 * firmware.
2334 * When the operational firmware is already present, then only
2335 * the check for valid Bluetooth device address is needed. This
2336 * determines if the device will be added as configured or
2337 * unconfigured controller.
2339 * It is not possible to use the Secure Boot Parameters in this
2340 * case since that command is only available in bootloader mode.
2342 if (ver.fw_variant == 0x23) {
2343 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2344 btintel_check_bdaddr(hdev);
2345 goto finish;
2348 /* If the device is not in bootloader mode, then the only possible
2349 * choice is to return an error and abort the device initialization.
2351 if (ver.fw_variant != 0x06) {
2352 bt_dev_err(hdev, "Unsupported Intel firmware variant (%u)",
2353 ver.fw_variant);
2354 return -ENODEV;
2357 /* Read the secure boot parameters to identify the operating
2358 * details of the bootloader.
2360 err = btintel_read_boot_params(hdev, &params);
2361 if (err)
2362 return err;
2364 /* It is required that every single firmware fragment is acknowledged
2365 * with a command complete event. If the boot parameters indicate
2366 * that this bootloader does not send them, then abort the setup.
2368 if (params.limited_cce != 0x00) {
2369 bt_dev_err(hdev, "Unsupported Intel firmware loading method (%u)",
2370 params.limited_cce);
2371 return -EINVAL;
2374 /* If the OTP has no valid Bluetooth device address, then there will
2375 * also be no valid address for the operational firmware.
2377 if (!bacmp(&params.otp_bdaddr, BDADDR_ANY)) {
2378 bt_dev_info(hdev, "No device address configured");
2379 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2382 /* With this Intel bootloader only the hardware variant and device
2383 * revision information are used to select the right firmware for SfP
2384 * and WsP.
2386 * The firmware filename is ibt-<hw_variant>-<dev_revid>.sfi.
2388 * Currently the supported hardware variants are:
2389 * 11 (0x0b) for iBT3.0 (LnP/SfP)
2390 * 12 (0x0c) for iBT3.5 (WsP)
2392 * For ThP/JfP and for future SKU's, the FW name varies based on HW
2393 * variant, HW revision and FW revision, as these are dependent on CNVi
2394 * and RF Combination.
2396 * 17 (0x11) for iBT3.5 (JfP)
2397 * 18 (0x12) for iBT3.5 (ThP)
2399 * The firmware file name for these will be
2400 * ibt-<hw_variant>-<hw_revision>-<fw_revision>.sfi.
2403 err = btusb_setup_intel_new_get_fw_name(&ver, &params, fwname,
2404 sizeof(fwname), "sfi");
2405 if (!err) {
2406 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2407 return -EINVAL;
2410 err = request_firmware(&fw, fwname, &hdev->dev);
2411 if (err < 0) {
2412 bt_dev_err(hdev, "Failed to load Intel firmware file (%d)", err);
2413 return err;
2416 bt_dev_info(hdev, "Found device firmware: %s", fwname);
2418 /* Save the DDC file name for later use to apply once the firmware
2419 * downloading is done.
2421 err = btusb_setup_intel_new_get_fw_name(&ver, &params, fwname,
2422 sizeof(fwname), "ddc");
2423 if (!err) {
2424 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2425 return -EINVAL;
2428 if (fw->size < 644) {
2429 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
2430 fw->size);
2431 err = -EBADF;
2432 goto done;
2435 set_bit(BTUSB_DOWNLOADING, &data->flags);
2437 /* Start firmware downloading and get boot parameter */
2438 err = btintel_download_firmware(hdev, fw, &boot_param);
2439 if (err < 0) {
2440 /* When FW download fails, send Intel Reset to retry
2441 * FW download.
2443 btintel_reset_to_bootloader(hdev);
2444 goto done;
2446 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2448 bt_dev_info(hdev, "Waiting for firmware download to complete");
2450 /* Before switching the device into operational mode and with that
2451 * booting the loaded firmware, wait for the bootloader notification
2452 * that all fragments have been successfully received.
2454 * When the event processing receives the notification, then the
2455 * BTUSB_DOWNLOADING flag will be cleared.
2457 * The firmware loading should not take longer than 5 seconds
2458 * and thus just timeout if that happens and fail the setup
2459 * of this device.
2461 err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2462 TASK_INTERRUPTIBLE,
2463 msecs_to_jiffies(5000));
2464 if (err == -EINTR) {
2465 bt_dev_err(hdev, "Firmware loading interrupted");
2466 goto done;
2469 if (err) {
2470 bt_dev_err(hdev, "Firmware loading timeout");
2471 err = -ETIMEDOUT;
2472 btintel_reset_to_bootloader(hdev);
2473 goto done;
2476 if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2477 bt_dev_err(hdev, "Firmware loading failed");
2478 err = -ENOEXEC;
2479 goto done;
2482 rettime = ktime_get();
2483 delta = ktime_sub(rettime, calltime);
2484 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2486 bt_dev_info(hdev, "Firmware loaded in %llu usecs", duration);
2488 done:
2489 release_firmware(fw);
2491 if (err < 0)
2492 return err;
2494 calltime = ktime_get();
2496 set_bit(BTUSB_BOOTING, &data->flags);
2498 err = btintel_send_intel_reset(hdev, boot_param);
2499 if (err) {
2500 bt_dev_err(hdev, "Intel Soft Reset failed (%d)", err);
2501 btintel_reset_to_bootloader(hdev);
2502 return err;
2505 /* The bootloader will not indicate when the device is ready. This
2506 * is done by the operational firmware sending bootup notification.
2508 * Booting into operational firmware should not take longer than
2509 * 1 second. However if that happens, then just fail the setup
2510 * since something went wrong.
2512 bt_dev_info(hdev, "Waiting for device to boot");
2514 err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2515 TASK_INTERRUPTIBLE,
2516 msecs_to_jiffies(1000));
2518 if (err == -EINTR) {
2519 bt_dev_err(hdev, "Device boot interrupted");
2520 return -EINTR;
2523 if (err) {
2524 bt_dev_err(hdev, "Device boot timeout");
2525 btintel_reset_to_bootloader(hdev);
2526 return -ETIMEDOUT;
2529 rettime = ktime_get();
2530 delta = ktime_sub(rettime, calltime);
2531 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2533 bt_dev_info(hdev, "Device booted in %llu usecs", duration);
2535 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2537 /* Once the device is running in operational mode, it needs to apply
2538 * the device configuration (DDC) parameters.
2540 * The device can work without DDC parameters, so even if it fails
2541 * to load the file, no need to fail the setup.
2543 btintel_load_ddc_config(hdev, fwname);
2545 /* Read the Intel version information after loading the FW */
2546 err = btintel_read_version(hdev, &ver);
2547 if (err)
2548 return err;
2550 btintel_version_info(hdev, &ver);
2552 finish:
2553 /* All Intel controllers that support the Microsoft vendor
2554 * extension are using 0xFC1E for VsMsftOpCode.
2556 switch (ver.hw_variant) {
2557 case 0x12: /* ThP */
2558 hci_set_msft_opcode(hdev, 0xFC1E);
2559 break;
2562 /* Set the event mask for Intel specific vendor events. This enables
2563 * a few extra events that are useful during general operation. It
2564 * does not enable any debugging related events.
2566 * The device will function correctly without these events enabled
2567 * and thus no need to fail the setup.
2569 btintel_set_event_mask(hdev, false);
2571 return 0;
2574 static int btusb_shutdown_intel(struct hci_dev *hdev)
2576 struct sk_buff *skb;
2577 long ret;
2579 /* In the shutdown sequence where Bluetooth is turned off followed
2580 * by WiFi being turned off, turning WiFi back on causes issue with
2581 * the RF calibration.
2583 * To ensure that any RF activity has been stopped, issue HCI Reset
2584 * command to clear all ongoing activity including advertising,
2585 * scanning etc.
2587 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2588 if (IS_ERR(skb)) {
2589 ret = PTR_ERR(skb);
2590 bt_dev_err(hdev, "HCI reset during shutdown failed");
2591 return ret;
2593 kfree_skb(skb);
2595 /* Some platforms have an issue with BT LED when the interface is
2596 * down or BT radio is turned off, which takes 5 seconds to BT LED
2597 * goes off. This command turns off the BT LED immediately.
2599 skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
2600 if (IS_ERR(skb)) {
2601 ret = PTR_ERR(skb);
2602 bt_dev_err(hdev, "turning off Intel device LED failed");
2603 return ret;
2605 kfree_skb(skb);
2607 return 0;
2610 static int btusb_shutdown_intel_new(struct hci_dev *hdev)
2612 struct sk_buff *skb;
2614 /* Send HCI Reset to the controller to stop any BT activity which
2615 * were triggered. This will help to save power and maintain the
2616 * sync b/w Host and controller
2618 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2619 if (IS_ERR(skb)) {
2620 bt_dev_err(hdev, "HCI reset during shutdown failed");
2621 return PTR_ERR(skb);
2623 kfree_skb(skb);
2625 return 0;
2628 #define FIRMWARE_MT7663 "mediatek/mt7663pr2h.bin"
2629 #define FIRMWARE_MT7668 "mediatek/mt7668pr2h.bin"
2631 #define HCI_WMT_MAX_EVENT_SIZE 64
2633 enum {
2634 BTMTK_WMT_PATCH_DWNLD = 0x1,
2635 BTMTK_WMT_FUNC_CTRL = 0x6,
2636 BTMTK_WMT_RST = 0x7,
2637 BTMTK_WMT_SEMAPHORE = 0x17,
2640 enum {
2641 BTMTK_WMT_INVALID,
2642 BTMTK_WMT_PATCH_UNDONE,
2643 BTMTK_WMT_PATCH_DONE,
2644 BTMTK_WMT_ON_UNDONE,
2645 BTMTK_WMT_ON_DONE,
2646 BTMTK_WMT_ON_PROGRESS,
2649 struct btmtk_wmt_hdr {
2650 u8 dir;
2651 u8 op;
2652 __le16 dlen;
2653 u8 flag;
2654 } __packed;
2656 struct btmtk_hci_wmt_cmd {
2657 struct btmtk_wmt_hdr hdr;
2658 u8 data[256];
2659 } __packed;
2661 struct btmtk_hci_wmt_evt {
2662 struct hci_event_hdr hhdr;
2663 struct btmtk_wmt_hdr whdr;
2664 } __packed;
2666 struct btmtk_hci_wmt_evt_funcc {
2667 struct btmtk_hci_wmt_evt hwhdr;
2668 __be16 status;
2669 } __packed;
2671 struct btmtk_tci_sleep {
2672 u8 mode;
2673 __le16 duration;
2674 __le16 host_duration;
2675 u8 host_wakeup_pin;
2676 u8 time_compensation;
2677 } __packed;
2679 struct btmtk_hci_wmt_params {
2680 u8 op;
2681 u8 flag;
2682 u16 dlen;
2683 const void *data;
2684 u32 *status;
2687 static void btusb_mtk_wmt_recv(struct urb *urb)
2689 struct hci_dev *hdev = urb->context;
2690 struct btusb_data *data = hci_get_drvdata(hdev);
2691 struct hci_event_hdr *hdr;
2692 struct sk_buff *skb;
2693 int err;
2695 if (urb->status == 0 && urb->actual_length > 0) {
2696 hdev->stat.byte_rx += urb->actual_length;
2698 /* WMT event shouldn't be fragmented and the size should be
2699 * less than HCI_WMT_MAX_EVENT_SIZE.
2701 skb = bt_skb_alloc(HCI_WMT_MAX_EVENT_SIZE, GFP_ATOMIC);
2702 if (!skb) {
2703 hdev->stat.err_rx++;
2704 goto err_out;
2707 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
2708 skb_put_data(skb, urb->transfer_buffer, urb->actual_length);
2710 hdr = (void *)skb->data;
2711 /* Fix up the vendor event id with 0xff for vendor specific
2712 * instead of 0xe4 so that event send via monitoring socket can
2713 * be parsed properly.
2715 hdr->evt = 0xff;
2717 /* When someone waits for the WMT event, the skb is being cloned
2718 * and being processed the events from there then.
2720 if (test_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags)) {
2721 data->evt_skb = skb_clone(skb, GFP_ATOMIC);
2722 if (!data->evt_skb)
2723 goto err_out;
2726 err = hci_recv_frame(hdev, skb);
2727 if (err < 0)
2728 goto err_free_skb;
2730 if (test_and_clear_bit(BTUSB_TX_WAIT_VND_EVT,
2731 &data->flags)) {
2732 /* Barrier to sync with other CPUs */
2733 smp_mb__after_atomic();
2734 wake_up_bit(&data->flags,
2735 BTUSB_TX_WAIT_VND_EVT);
2737 err_out:
2738 return;
2739 err_free_skb:
2740 kfree_skb(data->evt_skb);
2741 data->evt_skb = NULL;
2742 return;
2743 } else if (urb->status == -ENOENT) {
2744 /* Avoid suspend failed when usb_kill_urb */
2745 return;
2748 usb_mark_last_busy(data->udev);
2750 /* The URB complete handler is still called with urb->actual_length = 0
2751 * when the event is not available, so we should keep re-submitting
2752 * URB until WMT event returns, Also, It's necessary to wait some time
2753 * between the two consecutive control URBs to relax the target device
2754 * to generate the event. Otherwise, the WMT event cannot return from
2755 * the device successfully.
2757 udelay(100);
2759 usb_anchor_urb(urb, &data->ctrl_anchor);
2760 err = usb_submit_urb(urb, GFP_ATOMIC);
2761 if (err < 0) {
2762 /* -EPERM: urb is being killed;
2763 * -ENODEV: device got disconnected
2765 if (err != -EPERM && err != -ENODEV)
2766 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
2767 urb, -err);
2768 usb_unanchor_urb(urb);
2772 static int btusb_mtk_submit_wmt_recv_urb(struct hci_dev *hdev)
2774 struct btusb_data *data = hci_get_drvdata(hdev);
2775 struct usb_ctrlrequest *dr;
2776 unsigned char *buf;
2777 int err, size = 64;
2778 unsigned int pipe;
2779 struct urb *urb;
2781 urb = usb_alloc_urb(0, GFP_KERNEL);
2782 if (!urb)
2783 return -ENOMEM;
2785 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
2786 if (!dr) {
2787 usb_free_urb(urb);
2788 return -ENOMEM;
2791 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_IN;
2792 dr->bRequest = 1;
2793 dr->wIndex = cpu_to_le16(0);
2794 dr->wValue = cpu_to_le16(48);
2795 dr->wLength = cpu_to_le16(size);
2797 buf = kmalloc(size, GFP_KERNEL);
2798 if (!buf) {
2799 kfree(dr);
2800 return -ENOMEM;
2803 pipe = usb_rcvctrlpipe(data->udev, 0);
2805 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
2806 buf, size, btusb_mtk_wmt_recv, hdev);
2808 urb->transfer_flags |= URB_FREE_BUFFER;
2810 usb_anchor_urb(urb, &data->ctrl_anchor);
2811 err = usb_submit_urb(urb, GFP_KERNEL);
2812 if (err < 0) {
2813 if (err != -EPERM && err != -ENODEV)
2814 bt_dev_err(hdev, "urb %p submission failed (%d)",
2815 urb, -err);
2816 usb_unanchor_urb(urb);
2819 usb_free_urb(urb);
2821 return err;
2824 static int btusb_mtk_hci_wmt_sync(struct hci_dev *hdev,
2825 struct btmtk_hci_wmt_params *wmt_params)
2827 struct btusb_data *data = hci_get_drvdata(hdev);
2828 struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
2829 u32 hlen, status = BTMTK_WMT_INVALID;
2830 struct btmtk_hci_wmt_evt *wmt_evt;
2831 struct btmtk_hci_wmt_cmd wc;
2832 struct btmtk_wmt_hdr *hdr;
2833 int err;
2835 /* Submit control IN URB on demand to process the WMT event */
2836 err = btusb_mtk_submit_wmt_recv_urb(hdev);
2837 if (err < 0)
2838 return err;
2840 /* Send the WMT command and wait until the WMT event returns */
2841 hlen = sizeof(*hdr) + wmt_params->dlen;
2842 if (hlen > 255)
2843 return -EINVAL;
2845 hdr = (struct btmtk_wmt_hdr *)&wc;
2846 hdr->dir = 1;
2847 hdr->op = wmt_params->op;
2848 hdr->dlen = cpu_to_le16(wmt_params->dlen + 1);
2849 hdr->flag = wmt_params->flag;
2850 memcpy(wc.data, wmt_params->data, wmt_params->dlen);
2852 set_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2854 err = __hci_cmd_send(hdev, 0xfc6f, hlen, &wc);
2856 if (err < 0) {
2857 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2858 return err;
2861 /* The vendor specific WMT commands are all answered by a vendor
2862 * specific event and will have the Command Status or Command
2863 * Complete as with usual HCI command flow control.
2865 * After sending the command, wait for BTUSB_TX_WAIT_VND_EVT
2866 * state to be cleared. The driver specific event receive routine
2867 * will clear that state and with that indicate completion of the
2868 * WMT command.
2870 err = wait_on_bit_timeout(&data->flags, BTUSB_TX_WAIT_VND_EVT,
2871 TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
2872 if (err == -EINTR) {
2873 bt_dev_err(hdev, "Execution of wmt command interrupted");
2874 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2875 return err;
2878 if (err) {
2879 bt_dev_err(hdev, "Execution of wmt command timed out");
2880 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2881 return -ETIMEDOUT;
2884 /* Parse and handle the return WMT event */
2885 wmt_evt = (struct btmtk_hci_wmt_evt *)data->evt_skb->data;
2886 if (wmt_evt->whdr.op != hdr->op) {
2887 bt_dev_err(hdev, "Wrong op received %d expected %d",
2888 wmt_evt->whdr.op, hdr->op);
2889 err = -EIO;
2890 goto err_free_skb;
2893 switch (wmt_evt->whdr.op) {
2894 case BTMTK_WMT_SEMAPHORE:
2895 if (wmt_evt->whdr.flag == 2)
2896 status = BTMTK_WMT_PATCH_UNDONE;
2897 else
2898 status = BTMTK_WMT_PATCH_DONE;
2899 break;
2900 case BTMTK_WMT_FUNC_CTRL:
2901 wmt_evt_funcc = (struct btmtk_hci_wmt_evt_funcc *)wmt_evt;
2902 if (be16_to_cpu(wmt_evt_funcc->status) == 0x404)
2903 status = BTMTK_WMT_ON_DONE;
2904 else if (be16_to_cpu(wmt_evt_funcc->status) == 0x420)
2905 status = BTMTK_WMT_ON_PROGRESS;
2906 else
2907 status = BTMTK_WMT_ON_UNDONE;
2908 break;
2911 if (wmt_params->status)
2912 *wmt_params->status = status;
2914 err_free_skb:
2915 kfree_skb(data->evt_skb);
2916 data->evt_skb = NULL;
2918 return err;
2921 static int btusb_mtk_setup_firmware(struct hci_dev *hdev, const char *fwname)
2923 struct btmtk_hci_wmt_params wmt_params;
2924 const struct firmware *fw;
2925 const u8 *fw_ptr;
2926 size_t fw_size;
2927 int err, dlen;
2928 u8 flag;
2930 err = request_firmware(&fw, fwname, &hdev->dev);
2931 if (err < 0) {
2932 bt_dev_err(hdev, "Failed to load firmware file (%d)", err);
2933 return err;
2936 fw_ptr = fw->data;
2937 fw_size = fw->size;
2939 /* The size of patch header is 30 bytes, should be skip */
2940 if (fw_size < 30) {
2941 err = -EINVAL;
2942 goto err_release_fw;
2945 fw_size -= 30;
2946 fw_ptr += 30;
2947 flag = 1;
2949 wmt_params.op = BTMTK_WMT_PATCH_DWNLD;
2950 wmt_params.status = NULL;
2952 while (fw_size > 0) {
2953 dlen = min_t(int, 250, fw_size);
2955 /* Tell deivice the position in sequence */
2956 if (fw_size - dlen <= 0)
2957 flag = 3;
2958 else if (fw_size < fw->size - 30)
2959 flag = 2;
2961 wmt_params.flag = flag;
2962 wmt_params.dlen = dlen;
2963 wmt_params.data = fw_ptr;
2965 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2966 if (err < 0) {
2967 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
2968 err);
2969 goto err_release_fw;
2972 fw_size -= dlen;
2973 fw_ptr += dlen;
2976 wmt_params.op = BTMTK_WMT_RST;
2977 wmt_params.flag = 4;
2978 wmt_params.dlen = 0;
2979 wmt_params.data = NULL;
2980 wmt_params.status = NULL;
2982 /* Activate funciton the firmware providing to */
2983 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2984 if (err < 0) {
2985 bt_dev_err(hdev, "Failed to send wmt rst (%d)", err);
2986 goto err_release_fw;
2989 /* Wait a few moments for firmware activation done */
2990 usleep_range(10000, 12000);
2992 err_release_fw:
2993 release_firmware(fw);
2995 return err;
2998 static int btusb_mtk_func_query(struct hci_dev *hdev)
3000 struct btmtk_hci_wmt_params wmt_params;
3001 int status, err;
3002 u8 param = 0;
3004 /* Query whether the function is enabled */
3005 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3006 wmt_params.flag = 4;
3007 wmt_params.dlen = sizeof(param);
3008 wmt_params.data = &param;
3009 wmt_params.status = &status;
3011 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3012 if (err < 0) {
3013 bt_dev_err(hdev, "Failed to query function status (%d)", err);
3014 return err;
3017 return status;
3020 static int btusb_mtk_reg_read(struct btusb_data *data, u32 reg, u32 *val)
3022 int pipe, err, size = sizeof(u32);
3023 void *buf;
3025 buf = kzalloc(size, GFP_KERNEL);
3026 if (!buf)
3027 return -ENOMEM;
3029 pipe = usb_rcvctrlpipe(data->udev, 0);
3030 err = usb_control_msg(data->udev, pipe, 0x63,
3031 USB_TYPE_VENDOR | USB_DIR_IN,
3032 reg >> 16, reg & 0xffff,
3033 buf, size, USB_CTRL_SET_TIMEOUT);
3034 if (err < 0)
3035 goto err_free_buf;
3037 *val = get_unaligned_le32(buf);
3039 err_free_buf:
3040 kfree(buf);
3042 return err;
3045 static int btusb_mtk_id_get(struct btusb_data *data, u32 *id)
3047 return btusb_mtk_reg_read(data, 0x80000008, id);
3050 static int btusb_mtk_setup(struct hci_dev *hdev)
3052 struct btusb_data *data = hci_get_drvdata(hdev);
3053 struct btmtk_hci_wmt_params wmt_params;
3054 ktime_t calltime, delta, rettime;
3055 struct btmtk_tci_sleep tci_sleep;
3056 unsigned long long duration;
3057 struct sk_buff *skb;
3058 const char *fwname;
3059 int err, status;
3060 u32 dev_id;
3061 u8 param;
3063 calltime = ktime_get();
3065 err = btusb_mtk_id_get(data, &dev_id);
3066 if (err < 0) {
3067 bt_dev_err(hdev, "Failed to get device id (%d)", err);
3068 return err;
3071 switch (dev_id) {
3072 case 0x7663:
3073 fwname = FIRMWARE_MT7663;
3074 break;
3075 case 0x7668:
3076 fwname = FIRMWARE_MT7668;
3077 break;
3078 default:
3079 bt_dev_err(hdev, "Unsupported support hardware variant (%08x)",
3080 dev_id);
3081 return -ENODEV;
3084 /* Query whether the firmware is already download */
3085 wmt_params.op = BTMTK_WMT_SEMAPHORE;
3086 wmt_params.flag = 1;
3087 wmt_params.dlen = 0;
3088 wmt_params.data = NULL;
3089 wmt_params.status = &status;
3091 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3092 if (err < 0) {
3093 bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
3094 return err;
3097 if (status == BTMTK_WMT_PATCH_DONE) {
3098 bt_dev_info(hdev, "firmware already downloaded");
3099 goto ignore_setup_fw;
3102 /* Setup a firmware which the device definitely requires */
3103 err = btusb_mtk_setup_firmware(hdev, fwname);
3104 if (err < 0)
3105 return err;
3107 ignore_setup_fw:
3108 err = readx_poll_timeout(btusb_mtk_func_query, hdev, status,
3109 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
3110 2000, 5000000);
3111 /* -ETIMEDOUT happens */
3112 if (err < 0)
3113 return err;
3115 /* The other errors happen in btusb_mtk_func_query */
3116 if (status < 0)
3117 return status;
3119 if (status == BTMTK_WMT_ON_DONE) {
3120 bt_dev_info(hdev, "function already on");
3121 goto ignore_func_on;
3124 /* Enable Bluetooth protocol */
3125 param = 1;
3126 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3127 wmt_params.flag = 0;
3128 wmt_params.dlen = sizeof(param);
3129 wmt_params.data = &param;
3130 wmt_params.status = NULL;
3132 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3133 if (err < 0) {
3134 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3135 return err;
3138 ignore_func_on:
3139 /* Apply the low power environment setup */
3140 tci_sleep.mode = 0x5;
3141 tci_sleep.duration = cpu_to_le16(0x640);
3142 tci_sleep.host_duration = cpu_to_le16(0x640);
3143 tci_sleep.host_wakeup_pin = 0;
3144 tci_sleep.time_compensation = 0;
3146 skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
3147 HCI_INIT_TIMEOUT);
3148 if (IS_ERR(skb)) {
3149 err = PTR_ERR(skb);
3150 bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
3151 return err;
3153 kfree_skb(skb);
3155 rettime = ktime_get();
3156 delta = ktime_sub(rettime, calltime);
3157 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
3159 bt_dev_info(hdev, "Device setup in %llu usecs", duration);
3161 return 0;
3164 static int btusb_mtk_shutdown(struct hci_dev *hdev)
3166 struct btmtk_hci_wmt_params wmt_params;
3167 u8 param = 0;
3168 int err;
3170 /* Disable the device */
3171 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3172 wmt_params.flag = 0;
3173 wmt_params.dlen = sizeof(param);
3174 wmt_params.data = &param;
3175 wmt_params.status = NULL;
3177 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3178 if (err < 0) {
3179 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3180 return err;
3183 return 0;
3186 MODULE_FIRMWARE(FIRMWARE_MT7663);
3187 MODULE_FIRMWARE(FIRMWARE_MT7668);
3189 #ifdef CONFIG_PM
3190 /* Configure an out-of-band gpio as wake-up pin, if specified in device tree */
3191 static int marvell_config_oob_wake(struct hci_dev *hdev)
3193 struct sk_buff *skb;
3194 struct btusb_data *data = hci_get_drvdata(hdev);
3195 struct device *dev = &data->udev->dev;
3196 u16 pin, gap, opcode;
3197 int ret;
3198 u8 cmd[5];
3200 /* Move on if no wakeup pin specified */
3201 if (of_property_read_u16(dev->of_node, "marvell,wakeup-pin", &pin) ||
3202 of_property_read_u16(dev->of_node, "marvell,wakeup-gap-ms", &gap))
3203 return 0;
3205 /* Vendor specific command to configure a GPIO as wake-up pin */
3206 opcode = hci_opcode_pack(0x3F, 0x59);
3207 cmd[0] = opcode & 0xFF;
3208 cmd[1] = opcode >> 8;
3209 cmd[2] = 2; /* length of parameters that follow */
3210 cmd[3] = pin;
3211 cmd[4] = gap; /* time in ms, for which wakeup pin should be asserted */
3213 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
3214 if (!skb) {
3215 bt_dev_err(hdev, "%s: No memory\n", __func__);
3216 return -ENOMEM;
3219 skb_put_data(skb, cmd, sizeof(cmd));
3220 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
3222 ret = btusb_send_frame(hdev, skb);
3223 if (ret) {
3224 bt_dev_err(hdev, "%s: configuration failed\n", __func__);
3225 kfree_skb(skb);
3226 return ret;
3229 return 0;
3231 #endif
3233 static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
3234 const bdaddr_t *bdaddr)
3236 struct sk_buff *skb;
3237 u8 buf[8];
3238 long ret;
3240 buf[0] = 0xfe;
3241 buf[1] = sizeof(bdaddr_t);
3242 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
3244 skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3245 if (IS_ERR(skb)) {
3246 ret = PTR_ERR(skb);
3247 bt_dev_err(hdev, "changing Marvell device address failed (%ld)",
3248 ret);
3249 return ret;
3251 kfree_skb(skb);
3253 return 0;
3256 static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
3257 const bdaddr_t *bdaddr)
3259 struct sk_buff *skb;
3260 u8 buf[10];
3261 long ret;
3263 buf[0] = 0x01;
3264 buf[1] = 0x01;
3265 buf[2] = 0x00;
3266 buf[3] = sizeof(bdaddr_t);
3267 memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
3269 skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3270 if (IS_ERR(skb)) {
3271 ret = PTR_ERR(skb);
3272 bt_dev_err(hdev, "Change address command failed (%ld)", ret);
3273 return ret;
3275 kfree_skb(skb);
3277 return 0;
3280 #define QCA_DFU_PACKET_LEN 4096
3282 #define QCA_GET_TARGET_VERSION 0x09
3283 #define QCA_CHECK_STATUS 0x05
3284 #define QCA_DFU_DOWNLOAD 0x01
3286 #define QCA_SYSCFG_UPDATED 0x40
3287 #define QCA_PATCH_UPDATED 0x80
3288 #define QCA_DFU_TIMEOUT 3000
3290 struct qca_version {
3291 __le32 rom_version;
3292 __le32 patch_version;
3293 __le32 ram_version;
3294 __le32 ref_clock;
3295 __u8 reserved[4];
3296 } __packed;
3298 struct qca_rampatch_version {
3299 __le16 rom_version;
3300 __le16 patch_version;
3301 } __packed;
3303 struct qca_device_info {
3304 u32 rom_version;
3305 u8 rampatch_hdr; /* length of header in rampatch */
3306 u8 nvm_hdr; /* length of header in NVM */
3307 u8 ver_offset; /* offset of version structure in rampatch */
3310 static const struct qca_device_info qca_devices_table[] = {
3311 { 0x00000100, 20, 4, 10 }, /* Rome 1.0 */
3312 { 0x00000101, 20, 4, 10 }, /* Rome 1.1 */
3313 { 0x00000200, 28, 4, 18 }, /* Rome 2.0 */
3314 { 0x00000201, 28, 4, 18 }, /* Rome 2.1 */
3315 { 0x00000300, 28, 4, 18 }, /* Rome 3.0 */
3316 { 0x00000302, 28, 4, 18 }, /* Rome 3.2 */
3319 static int btusb_qca_send_vendor_req(struct usb_device *udev, u8 request,
3320 void *data, u16 size)
3322 int pipe, err;
3323 u8 *buf;
3325 buf = kmalloc(size, GFP_KERNEL);
3326 if (!buf)
3327 return -ENOMEM;
3329 /* Found some of USB hosts have IOT issues with ours so that we should
3330 * not wait until HCI layer is ready.
3332 pipe = usb_rcvctrlpipe(udev, 0);
3333 err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
3334 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3335 if (err < 0) {
3336 dev_err(&udev->dev, "Failed to access otp area (%d)", err);
3337 goto done;
3340 memcpy(data, buf, size);
3342 done:
3343 kfree(buf);
3345 return err;
3348 static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
3349 const struct firmware *firmware,
3350 size_t hdr_size)
3352 struct btusb_data *btdata = hci_get_drvdata(hdev);
3353 struct usb_device *udev = btdata->udev;
3354 size_t count, size, sent = 0;
3355 int pipe, len, err;
3356 u8 *buf;
3358 buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
3359 if (!buf)
3360 return -ENOMEM;
3362 count = firmware->size;
3364 size = min_t(size_t, count, hdr_size);
3365 memcpy(buf, firmware->data, size);
3367 /* USB patches should go down to controller through USB path
3368 * because binary format fits to go down through USB channel.
3369 * USB control path is for patching headers and USB bulk is for
3370 * patch body.
3372 pipe = usb_sndctrlpipe(udev, 0);
3373 err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
3374 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3375 if (err < 0) {
3376 bt_dev_err(hdev, "Failed to send headers (%d)", err);
3377 goto done;
3380 sent += size;
3381 count -= size;
3383 while (count) {
3384 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
3386 memcpy(buf, firmware->data + sent, size);
3388 pipe = usb_sndbulkpipe(udev, 0x02);
3389 err = usb_bulk_msg(udev, pipe, buf, size, &len,
3390 QCA_DFU_TIMEOUT);
3391 if (err < 0) {
3392 bt_dev_err(hdev, "Failed to send body at %zd of %zd (%d)",
3393 sent, firmware->size, err);
3394 break;
3397 if (size != len) {
3398 bt_dev_err(hdev, "Failed to get bulk buffer");
3399 err = -EILSEQ;
3400 break;
3403 sent += size;
3404 count -= size;
3407 done:
3408 kfree(buf);
3409 return err;
3412 static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
3413 struct qca_version *ver,
3414 const struct qca_device_info *info)
3416 struct qca_rampatch_version *rver;
3417 const struct firmware *fw;
3418 u32 ver_rom, ver_patch;
3419 u16 rver_rom, rver_patch;
3420 char fwname[64];
3421 int err;
3423 ver_rom = le32_to_cpu(ver->rom_version);
3424 ver_patch = le32_to_cpu(ver->patch_version);
3426 snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
3428 err = request_firmware(&fw, fwname, &hdev->dev);
3429 if (err) {
3430 bt_dev_err(hdev, "failed to request rampatch file: %s (%d)",
3431 fwname, err);
3432 return err;
3435 bt_dev_info(hdev, "using rampatch file: %s", fwname);
3437 rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
3438 rver_rom = le16_to_cpu(rver->rom_version);
3439 rver_patch = le16_to_cpu(rver->patch_version);
3441 bt_dev_info(hdev, "QCA: patch rome 0x%x build 0x%x, "
3442 "firmware rome 0x%x build 0x%x",
3443 rver_rom, rver_patch, ver_rom, ver_patch);
3445 if (rver_rom != ver_rom || rver_patch <= ver_patch) {
3446 bt_dev_err(hdev, "rampatch file version did not match with firmware");
3447 err = -EINVAL;
3448 goto done;
3451 err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
3453 done:
3454 release_firmware(fw);
3456 return err;
3459 static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
3460 struct qca_version *ver,
3461 const struct qca_device_info *info)
3463 const struct firmware *fw;
3464 char fwname[64];
3465 int err;
3467 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
3468 le32_to_cpu(ver->rom_version));
3470 err = request_firmware(&fw, fwname, &hdev->dev);
3471 if (err) {
3472 bt_dev_err(hdev, "failed to request NVM file: %s (%d)",
3473 fwname, err);
3474 return err;
3477 bt_dev_info(hdev, "using NVM file: %s", fwname);
3479 err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
3481 release_firmware(fw);
3483 return err;
3486 /* identify the ROM version and check whether patches are needed */
3487 static bool btusb_qca_need_patch(struct usb_device *udev)
3489 struct qca_version ver;
3491 if (btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
3492 sizeof(ver)) < 0)
3493 return false;
3494 /* only low ROM versions need patches */
3495 return !(le32_to_cpu(ver.rom_version) & ~0xffffU);
3498 static int btusb_setup_qca(struct hci_dev *hdev)
3500 struct btusb_data *btdata = hci_get_drvdata(hdev);
3501 struct usb_device *udev = btdata->udev;
3502 const struct qca_device_info *info = NULL;
3503 struct qca_version ver;
3504 u32 ver_rom;
3505 u8 status;
3506 int i, err;
3508 err = btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
3509 sizeof(ver));
3510 if (err < 0)
3511 return err;
3513 ver_rom = le32_to_cpu(ver.rom_version);
3514 /* Don't care about high ROM versions */
3515 if (ver_rom & ~0xffffU)
3516 return 0;
3518 for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
3519 if (ver_rom == qca_devices_table[i].rom_version)
3520 info = &qca_devices_table[i];
3522 if (!info) {
3523 bt_dev_err(hdev, "don't support firmware rome 0x%x", ver_rom);
3524 return -ENODEV;
3527 err = btusb_qca_send_vendor_req(udev, QCA_CHECK_STATUS, &status,
3528 sizeof(status));
3529 if (err < 0)
3530 return err;
3532 if (!(status & QCA_PATCH_UPDATED)) {
3533 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
3534 if (err < 0)
3535 return err;
3538 if (!(status & QCA_SYSCFG_UPDATED)) {
3539 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
3540 if (err < 0)
3541 return err;
3544 return 0;
3547 static inline int __set_diag_interface(struct hci_dev *hdev)
3549 struct btusb_data *data = hci_get_drvdata(hdev);
3550 struct usb_interface *intf = data->diag;
3551 int i;
3553 if (!data->diag)
3554 return -ENODEV;
3556 data->diag_tx_ep = NULL;
3557 data->diag_rx_ep = NULL;
3559 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3560 struct usb_endpoint_descriptor *ep_desc;
3562 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3564 if (!data->diag_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3565 data->diag_tx_ep = ep_desc;
3566 continue;
3569 if (!data->diag_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3570 data->diag_rx_ep = ep_desc;
3571 continue;
3575 if (!data->diag_tx_ep || !data->diag_rx_ep) {
3576 bt_dev_err(hdev, "invalid diagnostic descriptors");
3577 return -ENODEV;
3580 return 0;
3583 static struct urb *alloc_diag_urb(struct hci_dev *hdev, bool enable)
3585 struct btusb_data *data = hci_get_drvdata(hdev);
3586 struct sk_buff *skb;
3587 struct urb *urb;
3588 unsigned int pipe;
3590 if (!data->diag_tx_ep)
3591 return ERR_PTR(-ENODEV);
3593 urb = usb_alloc_urb(0, GFP_KERNEL);
3594 if (!urb)
3595 return ERR_PTR(-ENOMEM);
3597 skb = bt_skb_alloc(2, GFP_KERNEL);
3598 if (!skb) {
3599 usb_free_urb(urb);
3600 return ERR_PTR(-ENOMEM);
3603 skb_put_u8(skb, 0xf0);
3604 skb_put_u8(skb, enable);
3606 pipe = usb_sndbulkpipe(data->udev, data->diag_tx_ep->bEndpointAddress);
3608 usb_fill_bulk_urb(urb, data->udev, pipe,
3609 skb->data, skb->len, btusb_tx_complete, skb);
3611 skb->dev = (void *)hdev;
3613 return urb;
3616 static int btusb_bcm_set_diag(struct hci_dev *hdev, bool enable)
3618 struct btusb_data *data = hci_get_drvdata(hdev);
3619 struct urb *urb;
3621 if (!data->diag)
3622 return -ENODEV;
3624 if (!test_bit(HCI_RUNNING, &hdev->flags))
3625 return -ENETDOWN;
3627 urb = alloc_diag_urb(hdev, enable);
3628 if (IS_ERR(urb))
3629 return PTR_ERR(urb);
3631 return submit_or_queue_tx_urb(hdev, urb);
3634 #ifdef CONFIG_PM
3635 static irqreturn_t btusb_oob_wake_handler(int irq, void *priv)
3637 struct btusb_data *data = priv;
3639 pm_wakeup_event(&data->udev->dev, 0);
3640 pm_system_wakeup();
3642 /* Disable only if not already disabled (keep it balanced) */
3643 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
3644 disable_irq_nosync(irq);
3645 disable_irq_wake(irq);
3647 return IRQ_HANDLED;
3650 static const struct of_device_id btusb_match_table[] = {
3651 { .compatible = "usb1286,204e" },
3652 { .compatible = "usbcf3,e300" }, /* QCA6174A */
3653 { .compatible = "usb4ca,301a" }, /* QCA6174A (Lite-On) */
3656 MODULE_DEVICE_TABLE(of, btusb_match_table);
3658 /* Use an oob wakeup pin? */
3659 static int btusb_config_oob_wake(struct hci_dev *hdev)
3661 struct btusb_data *data = hci_get_drvdata(hdev);
3662 struct device *dev = &data->udev->dev;
3663 int irq, ret;
3665 clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
3667 if (!of_match_device(btusb_match_table, dev))
3668 return 0;
3670 /* Move on if no IRQ specified */
3671 irq = of_irq_get_byname(dev->of_node, "wakeup");
3672 if (irq <= 0) {
3673 bt_dev_dbg(hdev, "%s: no OOB Wakeup IRQ in DT", __func__);
3674 return 0;
3677 irq_set_status_flags(irq, IRQ_NOAUTOEN);
3678 ret = devm_request_irq(&hdev->dev, irq, btusb_oob_wake_handler,
3679 0, "OOB Wake-on-BT", data);
3680 if (ret) {
3681 bt_dev_err(hdev, "%s: IRQ request failed", __func__);
3682 return ret;
3685 ret = device_init_wakeup(dev, true);
3686 if (ret) {
3687 bt_dev_err(hdev, "%s: failed to init_wakeup", __func__);
3688 return ret;
3691 data->oob_wake_irq = irq;
3692 bt_dev_info(hdev, "OOB Wake-on-BT configured at IRQ %u", irq);
3693 return 0;
3695 #endif
3697 static void btusb_check_needs_reset_resume(struct usb_interface *intf)
3699 if (dmi_check_system(btusb_needs_reset_resume_table))
3700 interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
3703 static bool btusb_prevent_wake(struct hci_dev *hdev)
3705 struct btusb_data *data = hci_get_drvdata(hdev);
3707 return !device_may_wakeup(&data->udev->dev);
3710 static int btusb_probe(struct usb_interface *intf,
3711 const struct usb_device_id *id)
3713 struct usb_endpoint_descriptor *ep_desc;
3714 struct gpio_desc *reset_gpio;
3715 struct btusb_data *data;
3716 struct hci_dev *hdev;
3717 unsigned ifnum_base;
3718 int i, err;
3720 BT_DBG("intf %p id %p", intf, id);
3722 /* interface numbers are hardcoded in the spec */
3723 if (intf->cur_altsetting->desc.bInterfaceNumber != 0) {
3724 if (!(id->driver_info & BTUSB_IFNUM_2))
3725 return -ENODEV;
3726 if (intf->cur_altsetting->desc.bInterfaceNumber != 2)
3727 return -ENODEV;
3730 ifnum_base = intf->cur_altsetting->desc.bInterfaceNumber;
3732 if (!id->driver_info) {
3733 const struct usb_device_id *match;
3735 match = usb_match_id(intf, blacklist_table);
3736 if (match)
3737 id = match;
3740 if (id->driver_info == BTUSB_IGNORE)
3741 return -ENODEV;
3743 if (id->driver_info & BTUSB_ATH3012) {
3744 struct usb_device *udev = interface_to_usbdev(intf);
3746 /* Old firmware would otherwise let ath3k driver load
3747 * patch and sysconfig files
3749 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001 &&
3750 !btusb_qca_need_patch(udev))
3751 return -ENODEV;
3754 data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
3755 if (!data)
3756 return -ENOMEM;
3758 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3759 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3761 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
3762 data->intr_ep = ep_desc;
3763 continue;
3766 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3767 data->bulk_tx_ep = ep_desc;
3768 continue;
3771 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3772 data->bulk_rx_ep = ep_desc;
3773 continue;
3777 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
3778 return -ENODEV;
3780 if (id->driver_info & BTUSB_AMP) {
3781 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
3782 data->cmdreq = 0x2b;
3783 } else {
3784 data->cmdreq_type = USB_TYPE_CLASS;
3785 data->cmdreq = 0x00;
3788 data->udev = interface_to_usbdev(intf);
3789 data->intf = intf;
3791 INIT_WORK(&data->work, btusb_work);
3792 INIT_WORK(&data->waker, btusb_waker);
3793 init_usb_anchor(&data->deferred);
3794 init_usb_anchor(&data->tx_anchor);
3795 spin_lock_init(&data->txlock);
3797 init_usb_anchor(&data->intr_anchor);
3798 init_usb_anchor(&data->bulk_anchor);
3799 init_usb_anchor(&data->isoc_anchor);
3800 init_usb_anchor(&data->diag_anchor);
3801 init_usb_anchor(&data->ctrl_anchor);
3802 spin_lock_init(&data->rxlock);
3804 if (id->driver_info & BTUSB_INTEL_NEW) {
3805 data->recv_event = btusb_recv_event_intel;
3806 data->recv_bulk = btusb_recv_bulk_intel;
3807 set_bit(BTUSB_BOOTLOADER, &data->flags);
3808 } else {
3809 data->recv_event = hci_recv_frame;
3810 data->recv_bulk = btusb_recv_bulk;
3813 hdev = hci_alloc_dev();
3814 if (!hdev)
3815 return -ENOMEM;
3817 hdev->bus = HCI_USB;
3818 hci_set_drvdata(hdev, data);
3820 if (id->driver_info & BTUSB_AMP)
3821 hdev->dev_type = HCI_AMP;
3822 else
3823 hdev->dev_type = HCI_PRIMARY;
3825 data->hdev = hdev;
3827 SET_HCIDEV_DEV(hdev, &intf->dev);
3829 reset_gpio = gpiod_get_optional(&data->udev->dev, "reset",
3830 GPIOD_OUT_LOW);
3831 if (IS_ERR(reset_gpio)) {
3832 err = PTR_ERR(reset_gpio);
3833 goto out_free_dev;
3834 } else if (reset_gpio) {
3835 data->reset_gpio = reset_gpio;
3838 hdev->open = btusb_open;
3839 hdev->close = btusb_close;
3840 hdev->flush = btusb_flush;
3841 hdev->send = btusb_send_frame;
3842 hdev->notify = btusb_notify;
3843 hdev->prevent_wake = btusb_prevent_wake;
3845 #ifdef CONFIG_PM
3846 err = btusb_config_oob_wake(hdev);
3847 if (err)
3848 goto out_free_dev;
3850 /* Marvell devices may need a specific chip configuration */
3851 if (id->driver_info & BTUSB_MARVELL && data->oob_wake_irq) {
3852 err = marvell_config_oob_wake(hdev);
3853 if (err)
3854 goto out_free_dev;
3856 #endif
3857 if (id->driver_info & BTUSB_CW6622)
3858 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3860 if (id->driver_info & BTUSB_BCM2045)
3861 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3863 if (id->driver_info & BTUSB_BCM92035)
3864 hdev->setup = btusb_setup_bcm92035;
3866 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) &&
3867 (id->driver_info & BTUSB_BCM_PATCHRAM)) {
3868 hdev->manufacturer = 15;
3869 hdev->setup = btbcm_setup_patchram;
3870 hdev->set_diag = btusb_bcm_set_diag;
3871 hdev->set_bdaddr = btbcm_set_bdaddr;
3873 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3874 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3877 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) &&
3878 (id->driver_info & BTUSB_BCM_APPLE)) {
3879 hdev->manufacturer = 15;
3880 hdev->setup = btbcm_setup_apple;
3881 hdev->set_diag = btusb_bcm_set_diag;
3883 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3884 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3887 if (id->driver_info & BTUSB_INTEL) {
3888 hdev->manufacturer = 2;
3889 hdev->setup = btusb_setup_intel;
3890 hdev->shutdown = btusb_shutdown_intel;
3891 hdev->set_diag = btintel_set_diag_mfg;
3892 hdev->set_bdaddr = btintel_set_bdaddr;
3893 hdev->cmd_timeout = btusb_intel_cmd_timeout;
3894 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3895 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3896 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
3899 if (id->driver_info & BTUSB_INTEL_NEW) {
3900 hdev->manufacturer = 2;
3901 hdev->send = btusb_send_frame_intel;
3902 hdev->setup = btusb_setup_intel_new;
3903 hdev->shutdown = btusb_shutdown_intel_new;
3904 hdev->hw_error = btintel_hw_error;
3905 hdev->set_diag = btintel_set_diag;
3906 hdev->set_bdaddr = btintel_set_bdaddr;
3907 hdev->cmd_timeout = btusb_intel_cmd_timeout;
3908 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3909 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3910 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
3913 if (id->driver_info & BTUSB_MARVELL)
3914 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
3916 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_MTK) &&
3917 (id->driver_info & BTUSB_MEDIATEK)) {
3918 hdev->setup = btusb_mtk_setup;
3919 hdev->shutdown = btusb_mtk_shutdown;
3920 hdev->manufacturer = 70;
3921 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
3924 if (id->driver_info & BTUSB_SWAVE) {
3925 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
3926 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
3929 if (id->driver_info & BTUSB_INTEL_BOOT) {
3930 hdev->manufacturer = 2;
3931 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
3934 if (id->driver_info & BTUSB_ATH3012) {
3935 data->setup_on_usb = btusb_setup_qca;
3936 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
3937 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3938 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3941 if (id->driver_info & BTUSB_QCA_ROME) {
3942 data->setup_on_usb = btusb_setup_qca;
3943 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
3944 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3945 btusb_check_needs_reset_resume(intf);
3948 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_RTL) &&
3949 (id->driver_info & BTUSB_REALTEK)) {
3950 hdev->setup = btrtl_setup_realtek;
3951 hdev->shutdown = btrtl_shutdown_realtek;
3952 hdev->cmd_timeout = btusb_rtl_cmd_timeout;
3954 /* Realtek devices lose their updated firmware over global
3955 * suspend that means host doesn't send SET_FEATURE
3956 * (DEVICE_REMOTE_WAKEUP)
3958 set_bit(BTUSB_WAKEUP_DISABLE, &data->flags);
3960 err = usb_autopm_get_interface(intf);
3961 if (err < 0)
3962 goto out_free_dev;
3965 if (id->driver_info & BTUSB_AMP) {
3966 /* AMP controllers do not support SCO packets */
3967 data->isoc = NULL;
3968 } else {
3969 /* Interface orders are hardcoded in the specification */
3970 data->isoc = usb_ifnum_to_if(data->udev, ifnum_base + 1);
3971 data->isoc_ifnum = ifnum_base + 1;
3974 if (!reset)
3975 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3977 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
3978 if (!disable_scofix)
3979 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
3982 if (id->driver_info & BTUSB_BROKEN_ISOC)
3983 data->isoc = NULL;
3985 if (id->driver_info & BTUSB_WIDEBAND_SPEECH)
3986 set_bit(HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED, &hdev->quirks);
3988 if (id->driver_info & BTUSB_VALID_LE_STATES)
3989 set_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks);
3991 if (id->driver_info & BTUSB_DIGIANSWER) {
3992 data->cmdreq_type = USB_TYPE_VENDOR;
3993 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3996 if (id->driver_info & BTUSB_CSR) {
3997 struct usb_device *udev = data->udev;
3998 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
4000 /* Old firmware would otherwise execute USB reset */
4001 if (bcdDevice < 0x117)
4002 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
4004 /* Fake CSR devices with broken commands */
4005 if (bcdDevice <= 0x100 || bcdDevice == 0x134)
4006 hdev->setup = btusb_setup_csr;
4008 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
4011 if (id->driver_info & BTUSB_SNIFFER) {
4012 struct usb_device *udev = data->udev;
4014 /* New sniffer firmware has crippled HCI interface */
4015 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
4016 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
4019 if (id->driver_info & BTUSB_INTEL_BOOT) {
4020 /* A bug in the bootloader causes that interrupt interface is
4021 * only enabled after receiving SetInterface(0, AltSetting=0).
4023 err = usb_set_interface(data->udev, 0, 0);
4024 if (err < 0) {
4025 BT_ERR("failed to set interface 0, alt 0 %d", err);
4026 goto out_free_dev;
4030 if (data->isoc) {
4031 err = usb_driver_claim_interface(&btusb_driver,
4032 data->isoc, data);
4033 if (err < 0)
4034 goto out_free_dev;
4037 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_BCM) && data->diag) {
4038 if (!usb_driver_claim_interface(&btusb_driver,
4039 data->diag, data))
4040 __set_diag_interface(hdev);
4041 else
4042 data->diag = NULL;
4045 if (enable_autosuspend)
4046 usb_enable_autosuspend(data->udev);
4048 err = hci_register_dev(hdev);
4049 if (err < 0)
4050 goto out_free_dev;
4052 usb_set_intfdata(intf, data);
4054 return 0;
4056 out_free_dev:
4057 if (data->reset_gpio)
4058 gpiod_put(data->reset_gpio);
4059 hci_free_dev(hdev);
4060 return err;
4063 static void btusb_disconnect(struct usb_interface *intf)
4065 struct btusb_data *data = usb_get_intfdata(intf);
4066 struct hci_dev *hdev;
4068 BT_DBG("intf %p", intf);
4070 if (!data)
4071 return;
4073 hdev = data->hdev;
4074 usb_set_intfdata(data->intf, NULL);
4076 if (data->isoc)
4077 usb_set_intfdata(data->isoc, NULL);
4079 if (data->diag)
4080 usb_set_intfdata(data->diag, NULL);
4082 hci_unregister_dev(hdev);
4084 if (intf == data->intf) {
4085 if (data->isoc)
4086 usb_driver_release_interface(&btusb_driver, data->isoc);
4087 if (data->diag)
4088 usb_driver_release_interface(&btusb_driver, data->diag);
4089 } else if (intf == data->isoc) {
4090 if (data->diag)
4091 usb_driver_release_interface(&btusb_driver, data->diag);
4092 usb_driver_release_interface(&btusb_driver, data->intf);
4093 } else if (intf == data->diag) {
4094 usb_driver_release_interface(&btusb_driver, data->intf);
4095 if (data->isoc)
4096 usb_driver_release_interface(&btusb_driver, data->isoc);
4099 if (data->oob_wake_irq)
4100 device_init_wakeup(&data->udev->dev, false);
4102 if (data->reset_gpio)
4103 gpiod_put(data->reset_gpio);
4105 hci_free_dev(hdev);
4108 #ifdef CONFIG_PM
4109 static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
4111 struct btusb_data *data = usb_get_intfdata(intf);
4113 BT_DBG("intf %p", intf);
4115 if (data->suspend_count++)
4116 return 0;
4118 spin_lock_irq(&data->txlock);
4119 if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
4120 set_bit(BTUSB_SUSPENDING, &data->flags);
4121 spin_unlock_irq(&data->txlock);
4122 } else {
4123 spin_unlock_irq(&data->txlock);
4124 data->suspend_count--;
4125 return -EBUSY;
4128 cancel_work_sync(&data->work);
4130 btusb_stop_traffic(data);
4131 usb_kill_anchored_urbs(&data->tx_anchor);
4133 if (data->oob_wake_irq && device_may_wakeup(&data->udev->dev)) {
4134 set_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
4135 enable_irq_wake(data->oob_wake_irq);
4136 enable_irq(data->oob_wake_irq);
4139 /* For global suspend, Realtek devices lose the loaded fw
4140 * in them. But for autosuspend, firmware should remain.
4141 * Actually, it depends on whether the usb host sends
4142 * set feature (enable wakeup) or not.
4144 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags)) {
4145 if (PMSG_IS_AUTO(message) &&
4146 device_can_wakeup(&data->udev->dev))
4147 data->udev->do_remote_wakeup = 1;
4148 else if (!PMSG_IS_AUTO(message))
4149 data->udev->reset_resume = 1;
4152 return 0;
4155 static void play_deferred(struct btusb_data *data)
4157 struct urb *urb;
4158 int err;
4160 while ((urb = usb_get_from_anchor(&data->deferred))) {
4161 usb_anchor_urb(urb, &data->tx_anchor);
4163 err = usb_submit_urb(urb, GFP_ATOMIC);
4164 if (err < 0) {
4165 if (err != -EPERM && err != -ENODEV)
4166 BT_ERR("%s urb %p submission failed (%d)",
4167 data->hdev->name, urb, -err);
4168 kfree(urb->setup_packet);
4169 usb_unanchor_urb(urb);
4170 usb_free_urb(urb);
4171 break;
4174 data->tx_in_flight++;
4175 usb_free_urb(urb);
4178 /* Cleanup the rest deferred urbs. */
4179 while ((urb = usb_get_from_anchor(&data->deferred))) {
4180 kfree(urb->setup_packet);
4181 usb_free_urb(urb);
4185 static int btusb_resume(struct usb_interface *intf)
4187 struct btusb_data *data = usb_get_intfdata(intf);
4188 struct hci_dev *hdev = data->hdev;
4189 int err = 0;
4191 BT_DBG("intf %p", intf);
4193 if (--data->suspend_count)
4194 return 0;
4196 /* Disable only if not already disabled (keep it balanced) */
4197 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
4198 disable_irq(data->oob_wake_irq);
4199 disable_irq_wake(data->oob_wake_irq);
4202 if (!test_bit(HCI_RUNNING, &hdev->flags))
4203 goto done;
4205 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
4206 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
4207 if (err < 0) {
4208 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
4209 goto failed;
4213 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
4214 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
4215 if (err < 0) {
4216 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
4217 goto failed;
4220 btusb_submit_bulk_urb(hdev, GFP_NOIO);
4223 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
4224 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
4225 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
4226 else
4227 btusb_submit_isoc_urb(hdev, GFP_NOIO);
4230 spin_lock_irq(&data->txlock);
4231 play_deferred(data);
4232 clear_bit(BTUSB_SUSPENDING, &data->flags);
4233 spin_unlock_irq(&data->txlock);
4234 schedule_work(&data->work);
4236 return 0;
4238 failed:
4239 usb_scuttle_anchored_urbs(&data->deferred);
4240 done:
4241 spin_lock_irq(&data->txlock);
4242 clear_bit(BTUSB_SUSPENDING, &data->flags);
4243 spin_unlock_irq(&data->txlock);
4245 return err;
4247 #endif
4249 static struct usb_driver btusb_driver = {
4250 .name = "btusb",
4251 .probe = btusb_probe,
4252 .disconnect = btusb_disconnect,
4253 #ifdef CONFIG_PM
4254 .suspend = btusb_suspend,
4255 .resume = btusb_resume,
4256 #endif
4257 .id_table = btusb_table,
4258 .supports_autosuspend = 1,
4259 .disable_hub_initiated_lpm = 1,
4262 module_usb_driver(btusb_driver);
4264 module_param(disable_scofix, bool, 0644);
4265 MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
4267 module_param(force_scofix, bool, 0644);
4268 MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
4270 module_param(enable_autosuspend, bool, 0644);
4271 MODULE_PARM_DESC(enable_autosuspend, "Enable USB autosuspend by default");
4273 module_param(reset, bool, 0644);
4274 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
4276 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
4277 MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
4278 MODULE_VERSION(VERSION);
4279 MODULE_LICENSE("GPL");