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