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