blob: 6d643651d69f7c92d6defcfd937ad1c254c4ebab [file] [log] [blame]
David Brazdil0f672f62019-12-10 10:32:29 +00001// SPDX-License-Identifier: GPL-2.0-or-later
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002/*
3 *
4 * Generic Bluetooth USB driver
5 *
6 * Copyright (C) 2005-2008 Marcel Holtmann <marcel@holtmann.org>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007 */
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>
David Brazdil0f672f62019-12-10 10:32:29 +000014#include <linux/iopoll.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000015#include <linux/of_device.h>
16#include <linux/of_irq.h>
17#include <linux/suspend.h>
David Brazdil0f672f62019-12-10 10:32:29 +000018#include <linux/gpio/consumer.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000019#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
David Brazdil0f672f62019-12-10 10:32:29 +000059#define BTUSB_MEDIATEK 0x200000
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000060
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 */
David Brazdil0f672f62019-12-10 10:32:29 +0000255 { USB_DEVICE(0x0cf3, 0x535b), .driver_info = BTUSB_QCA_ROME },
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000256 { 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 },
David Brazdil0f672f62019-12-10 10:32:29 +0000269 { USB_DEVICE(0x13d3, 0x3491), .driver_info = BTUSB_QCA_ROME },
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000270 { USB_DEVICE(0x13d3, 0x3496), .driver_info = BTUSB_QCA_ROME },
David Brazdil0f672f62019-12-10 10:32:29 +0000271 { USB_DEVICE(0x13d3, 0x3501), .driver_info = BTUSB_QCA_ROME },
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000272
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 },
David Brazdil0f672f62019-12-10 10:32:29 +0000337 { USB_DEVICE(0x8087, 0x0029), .driver_info = BTUSB_INTEL_NEW },
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000338 { 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
David Brazdil0f672f62019-12-10 10:32:29 +0000353 /* MediaTek Bluetooth devices */
354 { USB_VENDOR_AND_INTERFACE_INFO(0x0e8d, 0xe0, 0x01, 0x01),
355 .driver_info = BTUSB_MEDIATEK },
356
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000357 /* 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
David Brazdil0f672f62019-12-10 10:32:29 +0000387 /* Additional Realtek 8822CE Bluetooth devices */
388 { USB_DEVICE(0x04ca, 0x4005), .driver_info = BTUSB_REALTEK },
389
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000390 /* 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
David Brazdil0f672f62019-12-10 10:32:29 +0000439#define BTUSB_HW_RESET_ACTIVE 12
440#define BTUSB_TX_WAIT_VND_EVT 13
441#define BTUSB_WAKEUP_DISABLE 14
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000442
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;
David Brazdil0f672f62019-12-10 10:32:29 +0000465 struct usb_anchor ctrl_anchor;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000466 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
David Brazdil0f672f62019-12-10 10:32:29 +0000480 struct gpio_desc *reset_gpio;
481
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000482 __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 */
David Brazdil0f672f62019-12-10 10:32:29 +0000495 unsigned cmd_timeout_cnt;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000496};
497
David Brazdil0f672f62019-12-10 10:32:29 +0000498
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
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000560static 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)
Olivier Deprez0e641232021-09-23 10:07:05 +02001203 goto setup_fail;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001204 }
1205
1206 data->intf->needs_remote_wakeup = 1;
David Brazdil0f672f62019-12-10 10:32:29 +00001207
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.
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001211 */
David Brazdil0f672f62019-12-10 10:32:29 +00001212 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1213 device_wakeup_disable(&data->udev->dev);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001214
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);
Olivier Deprez0e641232021-09-23 10:07:05 +02001242setup_fail:
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001243 usb_autopm_put_interface(data->intf);
1244 return err;
1245}
1246
1247static void btusb_stop_traffic(struct btusb_data *data)
1248{
1249 usb_kill_anchored_urbs(&data->intr_anchor);
1250 usb_kill_anchored_urbs(&data->bulk_anchor);
1251 usb_kill_anchored_urbs(&data->isoc_anchor);
1252 usb_kill_anchored_urbs(&data->diag_anchor);
David Brazdil0f672f62019-12-10 10:32:29 +00001253 usb_kill_anchored_urbs(&data->ctrl_anchor);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001254}
1255
1256static int btusb_close(struct hci_dev *hdev)
1257{
1258 struct btusb_data *data = hci_get_drvdata(hdev);
1259 int err;
1260
1261 BT_DBG("%s", hdev->name);
1262
1263 cancel_work_sync(&data->work);
1264 cancel_work_sync(&data->waker);
1265
1266 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1267 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
1268 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
1269 clear_bit(BTUSB_DIAG_RUNNING, &data->flags);
1270
1271 btusb_stop_traffic(data);
1272 btusb_free_frags(data);
1273
1274 err = usb_autopm_get_interface(data->intf);
1275 if (err < 0)
1276 goto failed;
1277
1278 data->intf->needs_remote_wakeup = 0;
David Brazdil0f672f62019-12-10 10:32:29 +00001279
1280 /* Enable remote wake up for auto-suspend */
1281 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags))
1282 data->intf->needs_remote_wakeup = 1;
1283
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001284 usb_autopm_put_interface(data->intf);
1285
1286failed:
1287 usb_scuttle_anchored_urbs(&data->deferred);
1288 return 0;
1289}
1290
1291static int btusb_flush(struct hci_dev *hdev)
1292{
1293 struct btusb_data *data = hci_get_drvdata(hdev);
1294
1295 BT_DBG("%s", hdev->name);
1296
1297 usb_kill_anchored_urbs(&data->tx_anchor);
1298 btusb_free_frags(data);
1299
1300 return 0;
1301}
1302
1303static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1304{
1305 struct btusb_data *data = hci_get_drvdata(hdev);
1306 struct usb_ctrlrequest *dr;
1307 struct urb *urb;
1308 unsigned int pipe;
1309
1310 urb = usb_alloc_urb(0, GFP_KERNEL);
1311 if (!urb)
1312 return ERR_PTR(-ENOMEM);
1313
1314 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1315 if (!dr) {
1316 usb_free_urb(urb);
1317 return ERR_PTR(-ENOMEM);
1318 }
1319
1320 dr->bRequestType = data->cmdreq_type;
1321 dr->bRequest = data->cmdreq;
1322 dr->wIndex = 0;
1323 dr->wValue = 0;
1324 dr->wLength = __cpu_to_le16(skb->len);
1325
1326 pipe = usb_sndctrlpipe(data->udev, 0x00);
1327
1328 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1329 skb->data, skb->len, btusb_tx_complete, skb);
1330
1331 skb->dev = (void *)hdev;
1332
1333 return urb;
1334}
1335
1336static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1337{
1338 struct btusb_data *data = hci_get_drvdata(hdev);
1339 struct urb *urb;
1340 unsigned int pipe;
1341
1342 if (!data->bulk_tx_ep)
1343 return ERR_PTR(-ENODEV);
1344
1345 urb = usb_alloc_urb(0, GFP_KERNEL);
1346 if (!urb)
1347 return ERR_PTR(-ENOMEM);
1348
1349 pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1350
1351 usb_fill_bulk_urb(urb, data->udev, pipe,
1352 skb->data, skb->len, btusb_tx_complete, skb);
1353
1354 skb->dev = (void *)hdev;
1355
1356 return urb;
1357}
1358
1359static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1360{
1361 struct btusb_data *data = hci_get_drvdata(hdev);
1362 struct urb *urb;
1363 unsigned int pipe;
1364
1365 if (!data->isoc_tx_ep)
1366 return ERR_PTR(-ENODEV);
1367
1368 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1369 if (!urb)
1370 return ERR_PTR(-ENOMEM);
1371
1372 pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1373
1374 usb_fill_int_urb(urb, data->udev, pipe,
1375 skb->data, skb->len, btusb_isoc_tx_complete,
1376 skb, data->isoc_tx_ep->bInterval);
1377
1378 urb->transfer_flags = URB_ISO_ASAP;
1379
1380 __fill_isoc_descriptor(urb, skb->len,
1381 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1382
1383 skb->dev = (void *)hdev;
1384
1385 return urb;
1386}
1387
1388static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1389{
1390 struct btusb_data *data = hci_get_drvdata(hdev);
1391 int err;
1392
1393 usb_anchor_urb(urb, &data->tx_anchor);
1394
1395 err = usb_submit_urb(urb, GFP_KERNEL);
1396 if (err < 0) {
1397 if (err != -EPERM && err != -ENODEV)
1398 bt_dev_err(hdev, "urb %p submission failed (%d)",
1399 urb, -err);
1400 kfree(urb->setup_packet);
1401 usb_unanchor_urb(urb);
1402 } else {
1403 usb_mark_last_busy(data->udev);
1404 }
1405
1406 usb_free_urb(urb);
1407 return err;
1408}
1409
1410static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1411{
1412 struct btusb_data *data = hci_get_drvdata(hdev);
1413 unsigned long flags;
1414 bool suspending;
1415
1416 spin_lock_irqsave(&data->txlock, flags);
1417 suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1418 if (!suspending)
1419 data->tx_in_flight++;
1420 spin_unlock_irqrestore(&data->txlock, flags);
1421
1422 if (!suspending)
1423 return submit_tx_urb(hdev, urb);
1424
1425 usb_anchor_urb(urb, &data->deferred);
1426 schedule_work(&data->waker);
1427
1428 usb_free_urb(urb);
1429 return 0;
1430}
1431
1432static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1433{
1434 struct urb *urb;
1435
1436 BT_DBG("%s", hdev->name);
1437
1438 switch (hci_skb_pkt_type(skb)) {
1439 case HCI_COMMAND_PKT:
1440 urb = alloc_ctrl_urb(hdev, skb);
1441 if (IS_ERR(urb))
1442 return PTR_ERR(urb);
1443
1444 hdev->stat.cmd_tx++;
1445 return submit_or_queue_tx_urb(hdev, urb);
1446
1447 case HCI_ACLDATA_PKT:
1448 urb = alloc_bulk_urb(hdev, skb);
1449 if (IS_ERR(urb))
1450 return PTR_ERR(urb);
1451
1452 hdev->stat.acl_tx++;
1453 return submit_or_queue_tx_urb(hdev, urb);
1454
1455 case HCI_SCODATA_PKT:
1456 if (hci_conn_num(hdev, SCO_LINK) < 1)
1457 return -ENODEV;
1458
1459 urb = alloc_isoc_urb(hdev, skb);
1460 if (IS_ERR(urb))
1461 return PTR_ERR(urb);
1462
1463 hdev->stat.sco_tx++;
1464 return submit_tx_urb(hdev, urb);
1465 }
1466
1467 return -EILSEQ;
1468}
1469
1470static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1471{
1472 struct btusb_data *data = hci_get_drvdata(hdev);
1473
1474 BT_DBG("%s evt %d", hdev->name, evt);
1475
1476 if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1477 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1478 schedule_work(&data->work);
1479 }
1480}
1481
1482static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1483{
1484 struct btusb_data *data = hci_get_drvdata(hdev);
1485 struct usb_interface *intf = data->isoc;
1486 struct usb_endpoint_descriptor *ep_desc;
1487 int i, err;
1488
1489 if (!data->isoc)
1490 return -ENODEV;
1491
1492 err = usb_set_interface(data->udev, data->isoc_ifnum, altsetting);
1493 if (err < 0) {
1494 bt_dev_err(hdev, "setting interface failed (%d)", -err);
1495 return err;
1496 }
1497
1498 data->isoc_altsetting = altsetting;
1499
1500 data->isoc_tx_ep = NULL;
1501 data->isoc_rx_ep = NULL;
1502
1503 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1504 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1505
1506 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1507 data->isoc_tx_ep = ep_desc;
1508 continue;
1509 }
1510
1511 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1512 data->isoc_rx_ep = ep_desc;
1513 continue;
1514 }
1515 }
1516
1517 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1518 bt_dev_err(hdev, "invalid SCO descriptors");
1519 return -ENODEV;
1520 }
1521
1522 return 0;
1523}
1524
1525static void btusb_work(struct work_struct *work)
1526{
1527 struct btusb_data *data = container_of(work, struct btusb_data, work);
1528 struct hci_dev *hdev = data->hdev;
1529 int new_alts;
1530 int err;
1531
1532 if (data->sco_num > 0) {
1533 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1534 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1535 if (err < 0) {
1536 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1537 usb_kill_anchored_urbs(&data->isoc_anchor);
1538 return;
1539 }
1540
1541 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1542 }
1543
1544 if (hdev->voice_setting & 0x0020) {
1545 static const int alts[3] = { 2, 4, 5 };
1546
1547 new_alts = alts[data->sco_num - 1];
1548 } else {
1549 new_alts = data->sco_num;
1550 }
1551
1552 if (data->isoc_altsetting != new_alts) {
1553 unsigned long flags;
1554
1555 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1556 usb_kill_anchored_urbs(&data->isoc_anchor);
1557
1558 /* When isochronous alternate setting needs to be
1559 * changed, because SCO connection has been added
1560 * or removed, a packet fragment may be left in the
1561 * reassembling state. This could lead to wrongly
1562 * assembled fragments.
1563 *
1564 * Clear outstanding fragment when selecting a new
1565 * alternate setting.
1566 */
1567 spin_lock_irqsave(&data->rxlock, flags);
1568 kfree_skb(data->sco_skb);
1569 data->sco_skb = NULL;
1570 spin_unlock_irqrestore(&data->rxlock, flags);
1571
1572 if (__set_isoc_interface(hdev, new_alts) < 0)
1573 return;
1574 }
1575
1576 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1577 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1578 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1579 else
1580 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1581 }
1582 } else {
1583 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1584 usb_kill_anchored_urbs(&data->isoc_anchor);
1585
1586 __set_isoc_interface(hdev, 0);
1587 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1588 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1589 }
1590}
1591
1592static void btusb_waker(struct work_struct *work)
1593{
1594 struct btusb_data *data = container_of(work, struct btusb_data, waker);
1595 int err;
1596
1597 err = usb_autopm_get_interface(data->intf);
1598 if (err < 0)
1599 return;
1600
1601 usb_autopm_put_interface(data->intf);
1602}
1603
1604static int btusb_setup_bcm92035(struct hci_dev *hdev)
1605{
1606 struct sk_buff *skb;
1607 u8 val = 0x00;
1608
1609 BT_DBG("%s", hdev->name);
1610
1611 skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1612 if (IS_ERR(skb))
1613 bt_dev_err(hdev, "BCM92035 command failed (%ld)", PTR_ERR(skb));
1614 else
1615 kfree_skb(skb);
1616
1617 return 0;
1618}
1619
1620static int btusb_setup_csr(struct hci_dev *hdev)
1621{
1622 struct hci_rp_read_local_version *rp;
1623 struct sk_buff *skb;
1624
1625 BT_DBG("%s", hdev->name);
1626
1627 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1628 HCI_INIT_TIMEOUT);
1629 if (IS_ERR(skb)) {
1630 int err = PTR_ERR(skb);
1631 bt_dev_err(hdev, "CSR: Local version failed (%d)", err);
1632 return err;
1633 }
1634
1635 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1636 bt_dev_err(hdev, "CSR: Local version length mismatch");
1637 kfree_skb(skb);
1638 return -EIO;
1639 }
1640
1641 rp = (struct hci_rp_read_local_version *)skb->data;
1642
1643 /* Detect controllers which aren't real CSR ones. */
1644 if (le16_to_cpu(rp->manufacturer) != 10 ||
1645 le16_to_cpu(rp->lmp_subver) == 0x0c5c) {
1646 /* Clear the reset quirk since this is not an actual
1647 * early Bluetooth 1.1 device from CSR.
1648 */
1649 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1650
1651 /* These fake CSR controllers have all a broken
1652 * stored link key handling and so just disable it.
1653 */
1654 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
1655 }
1656
1657 kfree_skb(skb);
1658
1659 return 0;
1660}
1661
1662static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1663 struct intel_version *ver)
1664{
1665 const struct firmware *fw;
1666 char fwname[64];
1667 int ret;
1668
1669 snprintf(fwname, sizeof(fwname),
1670 "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1671 ver->hw_platform, ver->hw_variant, ver->hw_revision,
1672 ver->fw_variant, ver->fw_revision, ver->fw_build_num,
1673 ver->fw_build_ww, ver->fw_build_yy);
1674
1675 ret = request_firmware(&fw, fwname, &hdev->dev);
1676 if (ret < 0) {
1677 if (ret == -EINVAL) {
1678 bt_dev_err(hdev, "Intel firmware file request failed (%d)",
1679 ret);
1680 return NULL;
1681 }
1682
1683 bt_dev_err(hdev, "failed to open Intel firmware file: %s (%d)",
1684 fwname, ret);
1685
1686 /* If the correct firmware patch file is not found, use the
1687 * default firmware patch file instead
1688 */
1689 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1690 ver->hw_platform, ver->hw_variant);
1691 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1692 bt_dev_err(hdev, "failed to open default fw file: %s",
1693 fwname);
1694 return NULL;
1695 }
1696 }
1697
1698 bt_dev_info(hdev, "Intel Bluetooth firmware file: %s", fwname);
1699
1700 return fw;
1701}
1702
1703static int btusb_setup_intel_patching(struct hci_dev *hdev,
1704 const struct firmware *fw,
1705 const u8 **fw_ptr, int *disable_patch)
1706{
1707 struct sk_buff *skb;
1708 struct hci_command_hdr *cmd;
1709 const u8 *cmd_param;
1710 struct hci_event_hdr *evt = NULL;
1711 const u8 *evt_param = NULL;
1712 int remain = fw->size - (*fw_ptr - fw->data);
1713
1714 /* The first byte indicates the types of the patch command or event.
1715 * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1716 * in the current firmware buffer doesn't start with 0x01 or
1717 * the size of remain buffer is smaller than HCI command header,
1718 * the firmware file is corrupted and it should stop the patching
1719 * process.
1720 */
1721 if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1722 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd read");
1723 return -EINVAL;
1724 }
1725 (*fw_ptr)++;
1726 remain--;
1727
1728 cmd = (struct hci_command_hdr *)(*fw_ptr);
1729 *fw_ptr += sizeof(*cmd);
1730 remain -= sizeof(*cmd);
1731
1732 /* Ensure that the remain firmware data is long enough than the length
1733 * of command parameter. If not, the firmware file is corrupted.
1734 */
1735 if (remain < cmd->plen) {
1736 bt_dev_err(hdev, "Intel fw corrupted: invalid cmd len");
1737 return -EFAULT;
1738 }
1739
1740 /* If there is a command that loads a patch in the firmware
1741 * file, then enable the patch upon success, otherwise just
1742 * disable the manufacturer mode, for example patch activation
1743 * is not required when the default firmware patch file is used
1744 * because there are no patch data to load.
1745 */
1746 if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
1747 *disable_patch = 0;
1748
1749 cmd_param = *fw_ptr;
1750 *fw_ptr += cmd->plen;
1751 remain -= cmd->plen;
1752
1753 /* This reads the expected events when the above command is sent to the
1754 * device. Some vendor commands expects more than one events, for
1755 * example command status event followed by vendor specific event.
1756 * For this case, it only keeps the last expected event. so the command
1757 * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
1758 * last expected event.
1759 */
1760 while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
1761 (*fw_ptr)++;
1762 remain--;
1763
1764 evt = (struct hci_event_hdr *)(*fw_ptr);
1765 *fw_ptr += sizeof(*evt);
1766 remain -= sizeof(*evt);
1767
1768 if (remain < evt->plen) {
1769 bt_dev_err(hdev, "Intel fw corrupted: invalid evt len");
1770 return -EFAULT;
1771 }
1772
1773 evt_param = *fw_ptr;
1774 *fw_ptr += evt->plen;
1775 remain -= evt->plen;
1776 }
1777
1778 /* Every HCI commands in the firmware file has its correspond event.
1779 * If event is not found or remain is smaller than zero, the firmware
1780 * file is corrupted.
1781 */
1782 if (!evt || !evt_param || remain < 0) {
1783 bt_dev_err(hdev, "Intel fw corrupted: invalid evt read");
1784 return -EFAULT;
1785 }
1786
1787 skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
1788 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
1789 if (IS_ERR(skb)) {
1790 bt_dev_err(hdev, "sending Intel patch command (0x%4.4x) failed (%ld)",
1791 cmd->opcode, PTR_ERR(skb));
1792 return PTR_ERR(skb);
1793 }
1794
1795 /* It ensures that the returned event matches the event data read from
1796 * the firmware file. At fist, it checks the length and then
1797 * the contents of the event.
1798 */
1799 if (skb->len != evt->plen) {
1800 bt_dev_err(hdev, "mismatch event length (opcode 0x%4.4x)",
1801 le16_to_cpu(cmd->opcode));
1802 kfree_skb(skb);
1803 return -EFAULT;
1804 }
1805
1806 if (memcmp(skb->data, evt_param, evt->plen)) {
1807 bt_dev_err(hdev, "mismatch event parameter (opcode 0x%4.4x)",
1808 le16_to_cpu(cmd->opcode));
1809 kfree_skb(skb);
1810 return -EFAULT;
1811 }
1812 kfree_skb(skb);
1813
1814 return 0;
1815}
1816
1817static int btusb_setup_intel(struct hci_dev *hdev)
1818{
1819 struct sk_buff *skb;
1820 const struct firmware *fw;
1821 const u8 *fw_ptr;
1822 int disable_patch, err;
1823 struct intel_version ver;
1824
1825 BT_DBG("%s", hdev->name);
1826
1827 /* The controller has a bug with the first HCI command sent to it
1828 * returning number of completed commands as zero. This would stall the
1829 * command processing in the Bluetooth core.
1830 *
1831 * As a workaround, send HCI Reset command first which will reset the
1832 * number of completed commands and allow normal command processing
1833 * from now on.
1834 */
1835 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
1836 if (IS_ERR(skb)) {
1837 bt_dev_err(hdev, "sending initial HCI reset command failed (%ld)",
1838 PTR_ERR(skb));
1839 return PTR_ERR(skb);
1840 }
1841 kfree_skb(skb);
1842
1843 /* Read Intel specific controller version first to allow selection of
1844 * which firmware file to load.
1845 *
1846 * The returned information are hardware variant and revision plus
1847 * firmware variant, revision and build number.
1848 */
1849 err = btintel_read_version(hdev, &ver);
1850 if (err)
1851 return err;
1852
1853 bt_dev_info(hdev, "read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
1854 ver.hw_platform, ver.hw_variant, ver.hw_revision,
1855 ver.fw_variant, ver.fw_revision, ver.fw_build_num,
1856 ver.fw_build_ww, ver.fw_build_yy, ver.fw_patch_num);
1857
1858 /* fw_patch_num indicates the version of patch the device currently
1859 * have. If there is no patch data in the device, it is always 0x00.
1860 * So, if it is other than 0x00, no need to patch the device again.
1861 */
1862 if (ver.fw_patch_num) {
1863 bt_dev_info(hdev, "Intel device is already patched. "
1864 "patch num: %02x", ver.fw_patch_num);
1865 goto complete;
1866 }
1867
1868 /* Opens the firmware patch file based on the firmware version read
1869 * from the controller. If it fails to open the matching firmware
1870 * patch file, it tries to open the default firmware patch file.
1871 * If no patch file is found, allow the device to operate without
1872 * a patch.
1873 */
1874 fw = btusb_setup_intel_get_fw(hdev, &ver);
1875 if (!fw)
1876 goto complete;
1877 fw_ptr = fw->data;
1878
1879 /* Enable the manufacturer mode of the controller.
1880 * Only while this mode is enabled, the driver can download the
1881 * firmware patch data and configuration parameters.
1882 */
1883 err = btintel_enter_mfg(hdev);
1884 if (err) {
1885 release_firmware(fw);
1886 return err;
1887 }
1888
1889 disable_patch = 1;
1890
1891 /* The firmware data file consists of list of Intel specific HCI
1892 * commands and its expected events. The first byte indicates the
1893 * type of the message, either HCI command or HCI event.
1894 *
1895 * It reads the command and its expected event from the firmware file,
1896 * and send to the controller. Once __hci_cmd_sync_ev() returns,
1897 * the returned event is compared with the event read from the firmware
1898 * file and it will continue until all the messages are downloaded to
1899 * the controller.
1900 *
1901 * Once the firmware patching is completed successfully,
1902 * the manufacturer mode is disabled with reset and activating the
1903 * downloaded patch.
1904 *
1905 * If the firmware patching fails, the manufacturer mode is
1906 * disabled with reset and deactivating the patch.
1907 *
1908 * If the default patch file is used, no reset is done when disabling
1909 * the manufacturer.
1910 */
1911 while (fw->size > fw_ptr - fw->data) {
1912 int ret;
1913
1914 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
1915 &disable_patch);
1916 if (ret < 0)
1917 goto exit_mfg_deactivate;
1918 }
1919
1920 release_firmware(fw);
1921
1922 if (disable_patch)
1923 goto exit_mfg_disable;
1924
1925 /* Patching completed successfully and disable the manufacturer mode
1926 * with reset and activate the downloaded firmware patches.
1927 */
1928 err = btintel_exit_mfg(hdev, true, true);
1929 if (err)
1930 return err;
1931
1932 bt_dev_info(hdev, "Intel firmware patch completed and activated");
1933
1934 goto complete;
1935
1936exit_mfg_disable:
1937 /* Disable the manufacturer mode without reset */
1938 err = btintel_exit_mfg(hdev, false, false);
1939 if (err)
1940 return err;
1941
1942 bt_dev_info(hdev, "Intel firmware patch completed");
1943
1944 goto complete;
1945
1946exit_mfg_deactivate:
1947 release_firmware(fw);
1948
1949 /* Patching failed. Disable the manufacturer mode with reset and
1950 * deactivate the downloaded firmware patches.
1951 */
1952 err = btintel_exit_mfg(hdev, true, false);
1953 if (err)
1954 return err;
1955
1956 bt_dev_info(hdev, "Intel firmware patch completed and deactivated");
1957
1958complete:
1959 /* Set the event mask for Intel specific vendor events. This enables
1960 * a few extra events that are useful during general operation.
1961 */
1962 btintel_set_event_mask_mfg(hdev, false);
1963
1964 btintel_check_bdaddr(hdev);
1965 return 0;
1966}
1967
1968static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
1969{
1970 struct sk_buff *skb;
1971 struct hci_event_hdr *hdr;
1972 struct hci_ev_cmd_complete *evt;
1973
1974 skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_KERNEL);
1975 if (!skb)
1976 return -ENOMEM;
1977
1978 hdr = skb_put(skb, sizeof(*hdr));
1979 hdr->evt = HCI_EV_CMD_COMPLETE;
1980 hdr->plen = sizeof(*evt) + 1;
1981
1982 evt = skb_put(skb, sizeof(*evt));
1983 evt->ncmd = 0x01;
1984 evt->opcode = cpu_to_le16(opcode);
1985
1986 skb_put_u8(skb, 0x00);
1987
1988 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
1989
1990 return hci_recv_frame(hdev, skb);
1991}
1992
1993static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
1994 int count)
1995{
1996 /* When the device is in bootloader mode, then it can send
1997 * events via the bulk endpoint. These events are treated the
1998 * same way as the ones received from the interrupt endpoint.
1999 */
2000 if (test_bit(BTUSB_BOOTLOADER, &data->flags))
2001 return btusb_recv_intr(data, buffer, count);
2002
2003 return btusb_recv_bulk(data, buffer, count);
2004}
2005
2006static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
2007 unsigned int len)
2008{
2009 const struct intel_bootup *evt = ptr;
2010
2011 if (len != sizeof(*evt))
2012 return;
2013
David Brazdil0f672f62019-12-10 10:32:29 +00002014 if (test_and_clear_bit(BTUSB_BOOTING, &data->flags))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002015 wake_up_bit(&data->flags, BTUSB_BOOTING);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002016}
2017
2018static void btusb_intel_secure_send_result(struct btusb_data *data,
2019 const void *ptr, unsigned int len)
2020{
2021 const struct intel_secure_send_result *evt = ptr;
2022
2023 if (len != sizeof(*evt))
2024 return;
2025
2026 if (evt->result)
2027 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
2028
2029 if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
David Brazdil0f672f62019-12-10 10:32:29 +00002030 test_bit(BTUSB_FIRMWARE_LOADED, &data->flags))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002031 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002032}
2033
2034static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
2035{
2036 struct btusb_data *data = hci_get_drvdata(hdev);
2037
2038 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2039 struct hci_event_hdr *hdr = (void *)skb->data;
2040
2041 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
2042 hdr->plen > 0) {
2043 const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
2044 unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
2045
2046 switch (skb->data[2]) {
2047 case 0x02:
2048 /* When switching to the operational firmware
2049 * the device sends a vendor specific event
2050 * indicating that the bootup completed.
2051 */
2052 btusb_intel_bootup(data, ptr, len);
2053 break;
2054 case 0x06:
2055 /* When the firmware loading completes the
2056 * device sends out a vendor specific event
2057 * indicating the result of the firmware
2058 * loading.
2059 */
2060 btusb_intel_secure_send_result(data, ptr, len);
2061 break;
2062 }
2063 }
2064 }
2065
2066 return hci_recv_frame(hdev, skb);
2067}
2068
2069static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
2070{
2071 struct btusb_data *data = hci_get_drvdata(hdev);
2072 struct urb *urb;
2073
2074 BT_DBG("%s", hdev->name);
2075
2076 switch (hci_skb_pkt_type(skb)) {
2077 case HCI_COMMAND_PKT:
2078 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
2079 struct hci_command_hdr *cmd = (void *)skb->data;
2080 __u16 opcode = le16_to_cpu(cmd->opcode);
2081
2082 /* When in bootloader mode and the command 0xfc09
2083 * is received, it needs to be send down the
2084 * bulk endpoint. So allocate a bulk URB instead.
2085 */
2086 if (opcode == 0xfc09)
2087 urb = alloc_bulk_urb(hdev, skb);
2088 else
2089 urb = alloc_ctrl_urb(hdev, skb);
2090
2091 /* When the 0xfc01 command is issued to boot into
2092 * the operational firmware, it will actually not
2093 * send a command complete event. To keep the flow
2094 * control working inject that event here.
2095 */
2096 if (opcode == 0xfc01)
2097 inject_cmd_complete(hdev, opcode);
2098 } else {
2099 urb = alloc_ctrl_urb(hdev, skb);
2100 }
2101 if (IS_ERR(urb))
2102 return PTR_ERR(urb);
2103
2104 hdev->stat.cmd_tx++;
2105 return submit_or_queue_tx_urb(hdev, urb);
2106
2107 case HCI_ACLDATA_PKT:
2108 urb = alloc_bulk_urb(hdev, skb);
2109 if (IS_ERR(urb))
2110 return PTR_ERR(urb);
2111
2112 hdev->stat.acl_tx++;
2113 return submit_or_queue_tx_urb(hdev, urb);
2114
2115 case HCI_SCODATA_PKT:
2116 if (hci_conn_num(hdev, SCO_LINK) < 1)
2117 return -ENODEV;
2118
2119 urb = alloc_isoc_urb(hdev, skb);
2120 if (IS_ERR(urb))
2121 return PTR_ERR(urb);
2122
2123 hdev->stat.sco_tx++;
2124 return submit_tx_urb(hdev, urb);
2125 }
2126
2127 return -EILSEQ;
2128}
2129
David Brazdil0f672f62019-12-10 10:32:29 +00002130static bool btusb_setup_intel_new_get_fw_name(struct intel_version *ver,
2131 struct intel_boot_params *params,
2132 char *fw_name, size_t len,
2133 const char *suffix)
2134{
2135 switch (ver->hw_variant) {
2136 case 0x0b: /* SfP */
2137 case 0x0c: /* WsP */
2138 snprintf(fw_name, len, "intel/ibt-%u-%u.%s",
2139 le16_to_cpu(ver->hw_variant),
2140 le16_to_cpu(params->dev_revid),
2141 suffix);
2142 break;
2143 case 0x11: /* JfP */
2144 case 0x12: /* ThP */
2145 case 0x13: /* HrP */
2146 case 0x14: /* CcP */
2147 snprintf(fw_name, len, "intel/ibt-%u-%u-%u.%s",
2148 le16_to_cpu(ver->hw_variant),
2149 le16_to_cpu(ver->hw_revision),
2150 le16_to_cpu(ver->fw_revision),
2151 suffix);
2152 break;
2153 default:
2154 return false;
2155 }
2156 return true;
2157}
2158
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002159static int btusb_setup_intel_new(struct hci_dev *hdev)
2160{
2161 struct btusb_data *data = hci_get_drvdata(hdev);
2162 struct intel_version ver;
2163 struct intel_boot_params params;
2164 const struct firmware *fw;
2165 u32 boot_param;
2166 char fwname[64];
2167 ktime_t calltime, delta, rettime;
2168 unsigned long long duration;
2169 int err;
2170
2171 BT_DBG("%s", hdev->name);
2172
2173 /* Set the default boot parameter to 0x0 and it is updated to
2174 * SKU specific boot parameter after reading Intel_Write_Boot_Params
2175 * command while downloading the firmware.
2176 */
2177 boot_param = 0x00000000;
2178
2179 calltime = ktime_get();
2180
2181 /* Read the Intel version information to determine if the device
2182 * is in bootloader mode or if it already has operational firmware
2183 * loaded.
2184 */
2185 err = btintel_read_version(hdev, &ver);
2186 if (err)
2187 return err;
2188
2189 /* The hardware platform number has a fixed value of 0x37 and
2190 * for now only accept this single value.
2191 */
2192 if (ver.hw_platform != 0x37) {
2193 bt_dev_err(hdev, "Unsupported Intel hardware platform (%u)",
2194 ver.hw_platform);
2195 return -EINVAL;
2196 }
2197
2198 /* Check for supported iBT hardware variants of this firmware
2199 * loading method.
2200 *
2201 * This check has been put in place to ensure correct forward
2202 * compatibility options when newer hardware variants come along.
2203 */
2204 switch (ver.hw_variant) {
2205 case 0x0b: /* SfP */
2206 case 0x0c: /* WsP */
2207 case 0x11: /* JfP */
2208 case 0x12: /* ThP */
2209 case 0x13: /* HrP */
David Brazdil0f672f62019-12-10 10:32:29 +00002210 case 0x14: /* CcP */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002211 break;
2212 default:
2213 bt_dev_err(hdev, "Unsupported Intel hardware variant (%u)",
2214 ver.hw_variant);
2215 return -EINVAL;
2216 }
2217
2218 btintel_version_info(hdev, &ver);
2219
2220 /* The firmware variant determines if the device is in bootloader
2221 * mode or is running operational firmware. The value 0x06 identifies
2222 * the bootloader and the value 0x23 identifies the operational
2223 * firmware.
2224 *
2225 * When the operational firmware is already present, then only
2226 * the check for valid Bluetooth device address is needed. This
2227 * determines if the device will be added as configured or
2228 * unconfigured controller.
2229 *
2230 * It is not possible to use the Secure Boot Parameters in this
2231 * case since that command is only available in bootloader mode.
2232 */
2233 if (ver.fw_variant == 0x23) {
2234 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2235 btintel_check_bdaddr(hdev);
2236 return 0;
2237 }
2238
2239 /* If the device is not in bootloader mode, then the only possible
2240 * choice is to return an error and abort the device initialization.
2241 */
2242 if (ver.fw_variant != 0x06) {
2243 bt_dev_err(hdev, "Unsupported Intel firmware variant (%u)",
2244 ver.fw_variant);
2245 return -ENODEV;
2246 }
2247
2248 /* Read the secure boot parameters to identify the operating
2249 * details of the bootloader.
2250 */
2251 err = btintel_read_boot_params(hdev, &params);
2252 if (err)
2253 return err;
2254
2255 /* It is required that every single firmware fragment is acknowledged
2256 * with a command complete event. If the boot parameters indicate
2257 * that this bootloader does not send them, then abort the setup.
2258 */
2259 if (params.limited_cce != 0x00) {
2260 bt_dev_err(hdev, "Unsupported Intel firmware loading method (%u)",
2261 params.limited_cce);
2262 return -EINVAL;
2263 }
2264
2265 /* If the OTP has no valid Bluetooth device address, then there will
2266 * also be no valid address for the operational firmware.
2267 */
2268 if (!bacmp(&params.otp_bdaddr, BDADDR_ANY)) {
2269 bt_dev_info(hdev, "No device address configured");
2270 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2271 }
2272
2273 /* With this Intel bootloader only the hardware variant and device
2274 * revision information are used to select the right firmware for SfP
2275 * and WsP.
2276 *
2277 * The firmware filename is ibt-<hw_variant>-<dev_revid>.sfi.
2278 *
2279 * Currently the supported hardware variants are:
2280 * 11 (0x0b) for iBT3.0 (LnP/SfP)
2281 * 12 (0x0c) for iBT3.5 (WsP)
2282 *
2283 * For ThP/JfP and for future SKU's, the FW name varies based on HW
2284 * variant, HW revision and FW revision, as these are dependent on CNVi
2285 * and RF Combination.
2286 *
2287 * 17 (0x11) for iBT3.5 (JfP)
2288 * 18 (0x12) for iBT3.5 (ThP)
2289 *
2290 * The firmware file name for these will be
2291 * ibt-<hw_variant>-<hw_revision>-<fw_revision>.sfi.
2292 *
2293 */
David Brazdil0f672f62019-12-10 10:32:29 +00002294 err = btusb_setup_intel_new_get_fw_name(&ver, &params, fwname,
2295 sizeof(fwname), "sfi");
2296 if (!err) {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002297 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2298 return -EINVAL;
2299 }
2300
2301 err = request_firmware(&fw, fwname, &hdev->dev);
2302 if (err < 0) {
2303 bt_dev_err(hdev, "Failed to load Intel firmware file (%d)", err);
2304 return err;
2305 }
2306
2307 bt_dev_info(hdev, "Found device firmware: %s", fwname);
2308
2309 /* Save the DDC file name for later use to apply once the firmware
2310 * downloading is done.
2311 */
David Brazdil0f672f62019-12-10 10:32:29 +00002312 err = btusb_setup_intel_new_get_fw_name(&ver, &params, fwname,
2313 sizeof(fwname), "ddc");
2314 if (!err) {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002315 bt_dev_err(hdev, "Unsupported Intel firmware naming");
2316 return -EINVAL;
2317 }
2318
2319 if (fw->size < 644) {
2320 bt_dev_err(hdev, "Invalid size of firmware file (%zu)",
2321 fw->size);
2322 err = -EBADF;
2323 goto done;
2324 }
2325
2326 set_bit(BTUSB_DOWNLOADING, &data->flags);
2327
2328 /* Start firmware downloading and get boot parameter */
2329 err = btintel_download_firmware(hdev, fw, &boot_param);
2330 if (err < 0)
2331 goto done;
2332
2333 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2334
2335 bt_dev_info(hdev, "Waiting for firmware download to complete");
2336
2337 /* Before switching the device into operational mode and with that
2338 * booting the loaded firmware, wait for the bootloader notification
2339 * that all fragments have been successfully received.
2340 *
2341 * When the event processing receives the notification, then the
2342 * BTUSB_DOWNLOADING flag will be cleared.
2343 *
2344 * The firmware loading should not take longer than 5 seconds
2345 * and thus just timeout if that happens and fail the setup
2346 * of this device.
2347 */
2348 err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2349 TASK_INTERRUPTIBLE,
2350 msecs_to_jiffies(5000));
2351 if (err == -EINTR) {
2352 bt_dev_err(hdev, "Firmware loading interrupted");
2353 goto done;
2354 }
2355
2356 if (err) {
2357 bt_dev_err(hdev, "Firmware loading timeout");
2358 err = -ETIMEDOUT;
2359 goto done;
2360 }
2361
2362 if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2363 bt_dev_err(hdev, "Firmware loading failed");
2364 err = -ENOEXEC;
2365 goto done;
2366 }
2367
2368 rettime = ktime_get();
2369 delta = ktime_sub(rettime, calltime);
2370 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2371
2372 bt_dev_info(hdev, "Firmware loaded in %llu usecs", duration);
2373
2374done:
2375 release_firmware(fw);
2376
2377 if (err < 0)
2378 return err;
2379
2380 calltime = ktime_get();
2381
2382 set_bit(BTUSB_BOOTING, &data->flags);
2383
2384 err = btintel_send_intel_reset(hdev, boot_param);
2385 if (err)
2386 return err;
2387
2388 /* The bootloader will not indicate when the device is ready. This
2389 * is done by the operational firmware sending bootup notification.
2390 *
2391 * Booting into operational firmware should not take longer than
2392 * 1 second. However if that happens, then just fail the setup
2393 * since something went wrong.
2394 */
2395 bt_dev_info(hdev, "Waiting for device to boot");
2396
2397 err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2398 TASK_INTERRUPTIBLE,
2399 msecs_to_jiffies(1000));
2400
2401 if (err == -EINTR) {
2402 bt_dev_err(hdev, "Device boot interrupted");
2403 return -EINTR;
2404 }
2405
2406 if (err) {
2407 bt_dev_err(hdev, "Device boot timeout");
2408 return -ETIMEDOUT;
2409 }
2410
2411 rettime = ktime_get();
2412 delta = ktime_sub(rettime, calltime);
2413 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2414
2415 bt_dev_info(hdev, "Device booted in %llu usecs", duration);
2416
2417 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2418
2419 /* Once the device is running in operational mode, it needs to apply
2420 * the device configuration (DDC) parameters.
2421 *
2422 * The device can work without DDC parameters, so even if it fails
2423 * to load the file, no need to fail the setup.
2424 */
2425 btintel_load_ddc_config(hdev, fwname);
2426
2427 /* Set the event mask for Intel specific vendor events. This enables
2428 * a few extra events that are useful during general operation. It
2429 * does not enable any debugging related events.
2430 *
2431 * The device will function correctly without these events enabled
2432 * and thus no need to fail the setup.
2433 */
2434 btintel_set_event_mask(hdev, false);
2435
2436 return 0;
2437}
2438
2439static int btusb_shutdown_intel(struct hci_dev *hdev)
2440{
2441 struct sk_buff *skb;
2442 long ret;
2443
2444 /* In the shutdown sequence where Bluetooth is turned off followed
2445 * by WiFi being turned off, turning WiFi back on causes issue with
2446 * the RF calibration.
2447 *
2448 * To ensure that any RF activity has been stopped, issue HCI Reset
2449 * command to clear all ongoing activity including advertising,
2450 * scanning etc.
2451 */
2452 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2453 if (IS_ERR(skb)) {
2454 ret = PTR_ERR(skb);
2455 bt_dev_err(hdev, "HCI reset during shutdown failed");
2456 return ret;
2457 }
2458 kfree_skb(skb);
2459
2460 /* Some platforms have an issue with BT LED when the interface is
2461 * down or BT radio is turned off, which takes 5 seconds to BT LED
2462 * goes off. This command turns off the BT LED immediately.
2463 */
2464 skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
2465 if (IS_ERR(skb)) {
2466 ret = PTR_ERR(skb);
2467 bt_dev_err(hdev, "turning off Intel device LED failed");
2468 return ret;
2469 }
2470 kfree_skb(skb);
2471
2472 return 0;
2473}
2474
David Brazdil0f672f62019-12-10 10:32:29 +00002475static int btusb_shutdown_intel_new(struct hci_dev *hdev)
2476{
2477 struct sk_buff *skb;
2478
2479 /* Send HCI Reset to the controller to stop any BT activity which
2480 * were triggered. This will help to save power and maintain the
2481 * sync b/w Host and controller
2482 */
2483 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2484 if (IS_ERR(skb)) {
2485 bt_dev_err(hdev, "HCI reset during shutdown failed");
2486 return PTR_ERR(skb);
2487 }
2488 kfree_skb(skb);
2489
2490 return 0;
2491}
2492
2493#ifdef CONFIG_BT_HCIBTUSB_MTK
2494
2495#define FIRMWARE_MT7663 "mediatek/mt7663pr2h.bin"
2496#define FIRMWARE_MT7668 "mediatek/mt7668pr2h.bin"
2497
2498#define HCI_WMT_MAX_EVENT_SIZE 64
2499
2500enum {
2501 BTMTK_WMT_PATCH_DWNLD = 0x1,
2502 BTMTK_WMT_FUNC_CTRL = 0x6,
2503 BTMTK_WMT_RST = 0x7,
2504 BTMTK_WMT_SEMAPHORE = 0x17,
2505};
2506
2507enum {
2508 BTMTK_WMT_INVALID,
2509 BTMTK_WMT_PATCH_UNDONE,
2510 BTMTK_WMT_PATCH_DONE,
2511 BTMTK_WMT_ON_UNDONE,
2512 BTMTK_WMT_ON_DONE,
2513 BTMTK_WMT_ON_PROGRESS,
2514};
2515
2516struct btmtk_wmt_hdr {
2517 u8 dir;
2518 u8 op;
2519 __le16 dlen;
2520 u8 flag;
2521} __packed;
2522
2523struct btmtk_hci_wmt_cmd {
2524 struct btmtk_wmt_hdr hdr;
2525 u8 data[256];
2526} __packed;
2527
2528struct btmtk_hci_wmt_evt {
2529 struct hci_event_hdr hhdr;
2530 struct btmtk_wmt_hdr whdr;
2531} __packed;
2532
2533struct btmtk_hci_wmt_evt_funcc {
2534 struct btmtk_hci_wmt_evt hwhdr;
2535 __be16 status;
2536} __packed;
2537
2538struct btmtk_tci_sleep {
2539 u8 mode;
2540 __le16 duration;
2541 __le16 host_duration;
2542 u8 host_wakeup_pin;
2543 u8 time_compensation;
2544} __packed;
2545
2546struct btmtk_hci_wmt_params {
2547 u8 op;
2548 u8 flag;
2549 u16 dlen;
2550 const void *data;
2551 u32 *status;
2552};
2553
2554static void btusb_mtk_wmt_recv(struct urb *urb)
2555{
2556 struct hci_dev *hdev = urb->context;
2557 struct btusb_data *data = hci_get_drvdata(hdev);
2558 struct hci_event_hdr *hdr;
2559 struct sk_buff *skb;
2560 int err;
2561
2562 if (urb->status == 0 && urb->actual_length > 0) {
2563 hdev->stat.byte_rx += urb->actual_length;
2564
2565 /* WMT event shouldn't be fragmented and the size should be
2566 * less than HCI_WMT_MAX_EVENT_SIZE.
2567 */
2568 skb = bt_skb_alloc(HCI_WMT_MAX_EVENT_SIZE, GFP_ATOMIC);
2569 if (!skb) {
2570 hdev->stat.err_rx++;
Olivier Deprez0e641232021-09-23 10:07:05 +02002571 return;
David Brazdil0f672f62019-12-10 10:32:29 +00002572 }
2573
2574 hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
2575 skb_put_data(skb, urb->transfer_buffer, urb->actual_length);
2576
2577 hdr = (void *)skb->data;
2578 /* Fix up the vendor event id with 0xff for vendor specific
2579 * instead of 0xe4 so that event send via monitoring socket can
2580 * be parsed properly.
2581 */
2582 hdr->evt = 0xff;
2583
2584 /* When someone waits for the WMT event, the skb is being cloned
2585 * and being processed the events from there then.
2586 */
2587 if (test_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags)) {
Olivier Deprez0e641232021-09-23 10:07:05 +02002588 data->evt_skb = skb_clone(skb, GFP_ATOMIC);
2589 if (!data->evt_skb) {
2590 kfree_skb(skb);
2591 return;
2592 }
David Brazdil0f672f62019-12-10 10:32:29 +00002593 }
2594
2595 err = hci_recv_frame(hdev, skb);
Olivier Deprez0e641232021-09-23 10:07:05 +02002596 if (err < 0) {
2597 kfree_skb(data->evt_skb);
2598 data->evt_skb = NULL;
2599 return;
2600 }
David Brazdil0f672f62019-12-10 10:32:29 +00002601
2602 if (test_and_clear_bit(BTUSB_TX_WAIT_VND_EVT,
2603 &data->flags)) {
2604 /* Barrier to sync with other CPUs */
2605 smp_mb__after_atomic();
2606 wake_up_bit(&data->flags,
2607 BTUSB_TX_WAIT_VND_EVT);
2608 }
David Brazdil0f672f62019-12-10 10:32:29 +00002609 return;
2610 } else if (urb->status == -ENOENT) {
2611 /* Avoid suspend failed when usb_kill_urb */
2612 return;
2613 }
2614
2615 usb_mark_last_busy(data->udev);
2616
2617 /* The URB complete handler is still called with urb->actual_length = 0
2618 * when the event is not available, so we should keep re-submitting
2619 * URB until WMT event returns, Also, It's necessary to wait some time
2620 * between the two consecutive control URBs to relax the target device
2621 * to generate the event. Otherwise, the WMT event cannot return from
2622 * the device successfully.
2623 */
2624 udelay(100);
2625
2626 usb_anchor_urb(urb, &data->ctrl_anchor);
2627 err = usb_submit_urb(urb, GFP_ATOMIC);
2628 if (err < 0) {
2629 /* -EPERM: urb is being killed;
2630 * -ENODEV: device got disconnected
2631 */
2632 if (err != -EPERM && err != -ENODEV)
2633 bt_dev_err(hdev, "urb %p failed to resubmit (%d)",
2634 urb, -err);
2635 usb_unanchor_urb(urb);
2636 }
2637}
2638
2639static int btusb_mtk_submit_wmt_recv_urb(struct hci_dev *hdev)
2640{
2641 struct btusb_data *data = hci_get_drvdata(hdev);
2642 struct usb_ctrlrequest *dr;
2643 unsigned char *buf;
2644 int err, size = 64;
2645 unsigned int pipe;
2646 struct urb *urb;
2647
2648 urb = usb_alloc_urb(0, GFP_KERNEL);
2649 if (!urb)
2650 return -ENOMEM;
2651
2652 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
2653 if (!dr) {
2654 usb_free_urb(urb);
2655 return -ENOMEM;
2656 }
2657
2658 dr->bRequestType = USB_TYPE_VENDOR | USB_DIR_IN;
2659 dr->bRequest = 1;
2660 dr->wIndex = cpu_to_le16(0);
2661 dr->wValue = cpu_to_le16(48);
2662 dr->wLength = cpu_to_le16(size);
2663
2664 buf = kmalloc(size, GFP_KERNEL);
2665 if (!buf) {
2666 kfree(dr);
Olivier Deprez0e641232021-09-23 10:07:05 +02002667 usb_free_urb(urb);
David Brazdil0f672f62019-12-10 10:32:29 +00002668 return -ENOMEM;
2669 }
2670
2671 pipe = usb_rcvctrlpipe(data->udev, 0);
2672
2673 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
2674 buf, size, btusb_mtk_wmt_recv, hdev);
2675
2676 urb->transfer_flags |= URB_FREE_BUFFER;
2677
2678 usb_anchor_urb(urb, &data->ctrl_anchor);
2679 err = usb_submit_urb(urb, GFP_KERNEL);
2680 if (err < 0) {
2681 if (err != -EPERM && err != -ENODEV)
2682 bt_dev_err(hdev, "urb %p submission failed (%d)",
2683 urb, -err);
2684 usb_unanchor_urb(urb);
2685 }
2686
2687 usb_free_urb(urb);
2688
2689 return err;
2690}
2691
2692static int btusb_mtk_hci_wmt_sync(struct hci_dev *hdev,
2693 struct btmtk_hci_wmt_params *wmt_params)
2694{
2695 struct btusb_data *data = hci_get_drvdata(hdev);
2696 struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
2697 u32 hlen, status = BTMTK_WMT_INVALID;
2698 struct btmtk_hci_wmt_evt *wmt_evt;
2699 struct btmtk_hci_wmt_cmd wc;
2700 struct btmtk_wmt_hdr *hdr;
2701 int err;
2702
David Brazdil0f672f62019-12-10 10:32:29 +00002703 /* Send the WMT command and wait until the WMT event returns */
2704 hlen = sizeof(*hdr) + wmt_params->dlen;
2705 if (hlen > 255)
2706 return -EINVAL;
2707
2708 hdr = (struct btmtk_wmt_hdr *)&wc;
2709 hdr->dir = 1;
2710 hdr->op = wmt_params->op;
2711 hdr->dlen = cpu_to_le16(wmt_params->dlen + 1);
2712 hdr->flag = wmt_params->flag;
2713 memcpy(wc.data, wmt_params->data, wmt_params->dlen);
2714
2715 set_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2716
2717 err = __hci_cmd_send(hdev, 0xfc6f, hlen, &wc);
2718
2719 if (err < 0) {
2720 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2721 return err;
2722 }
2723
Olivier Deprez0e641232021-09-23 10:07:05 +02002724 /* Submit control IN URB on demand to process the WMT event */
2725 err = btusb_mtk_submit_wmt_recv_urb(hdev);
2726 if (err < 0)
2727 return err;
2728
David Brazdil0f672f62019-12-10 10:32:29 +00002729 /* The vendor specific WMT commands are all answered by a vendor
2730 * specific event and will have the Command Status or Command
2731 * Complete as with usual HCI command flow control.
2732 *
2733 * After sending the command, wait for BTUSB_TX_WAIT_VND_EVT
2734 * state to be cleared. The driver specific event receive routine
2735 * will clear that state and with that indicate completion of the
2736 * WMT command.
2737 */
2738 err = wait_on_bit_timeout(&data->flags, BTUSB_TX_WAIT_VND_EVT,
2739 TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
2740 if (err == -EINTR) {
2741 bt_dev_err(hdev, "Execution of wmt command interrupted");
2742 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2743 return err;
2744 }
2745
2746 if (err) {
2747 bt_dev_err(hdev, "Execution of wmt command timed out");
2748 clear_bit(BTUSB_TX_WAIT_VND_EVT, &data->flags);
2749 return -ETIMEDOUT;
2750 }
2751
2752 /* Parse and handle the return WMT event */
2753 wmt_evt = (struct btmtk_hci_wmt_evt *)data->evt_skb->data;
2754 if (wmt_evt->whdr.op != hdr->op) {
2755 bt_dev_err(hdev, "Wrong op received %d expected %d",
2756 wmt_evt->whdr.op, hdr->op);
2757 err = -EIO;
2758 goto err_free_skb;
2759 }
2760
2761 switch (wmt_evt->whdr.op) {
2762 case BTMTK_WMT_SEMAPHORE:
2763 if (wmt_evt->whdr.flag == 2)
2764 status = BTMTK_WMT_PATCH_UNDONE;
2765 else
2766 status = BTMTK_WMT_PATCH_DONE;
2767 break;
2768 case BTMTK_WMT_FUNC_CTRL:
2769 wmt_evt_funcc = (struct btmtk_hci_wmt_evt_funcc *)wmt_evt;
2770 if (be16_to_cpu(wmt_evt_funcc->status) == 0x404)
2771 status = BTMTK_WMT_ON_DONE;
2772 else if (be16_to_cpu(wmt_evt_funcc->status) == 0x420)
2773 status = BTMTK_WMT_ON_PROGRESS;
2774 else
2775 status = BTMTK_WMT_ON_UNDONE;
2776 break;
2777 }
2778
2779 if (wmt_params->status)
2780 *wmt_params->status = status;
2781
2782err_free_skb:
2783 kfree_skb(data->evt_skb);
2784 data->evt_skb = NULL;
2785
2786 return err;
2787}
2788
2789static int btusb_mtk_setup_firmware(struct hci_dev *hdev, const char *fwname)
2790{
2791 struct btmtk_hci_wmt_params wmt_params;
2792 const struct firmware *fw;
2793 const u8 *fw_ptr;
2794 size_t fw_size;
2795 int err, dlen;
Olivier Deprez0e641232021-09-23 10:07:05 +02002796 u8 flag, param;
David Brazdil0f672f62019-12-10 10:32:29 +00002797
2798 err = request_firmware(&fw, fwname, &hdev->dev);
2799 if (err < 0) {
2800 bt_dev_err(hdev, "Failed to load firmware file (%d)", err);
2801 return err;
2802 }
2803
Olivier Deprez0e641232021-09-23 10:07:05 +02002804 /* Power on data RAM the firmware relies on. */
2805 param = 1;
2806 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
2807 wmt_params.flag = 3;
2808 wmt_params.dlen = sizeof(param);
2809 wmt_params.data = &param;
2810 wmt_params.status = NULL;
2811
2812 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2813 if (err < 0) {
2814 bt_dev_err(hdev, "Failed to power on data RAM (%d)", err);
2815 goto err_release_fw;
2816 }
2817
David Brazdil0f672f62019-12-10 10:32:29 +00002818 fw_ptr = fw->data;
2819 fw_size = fw->size;
2820
2821 /* The size of patch header is 30 bytes, should be skip */
2822 if (fw_size < 30) {
2823 err = -EINVAL;
2824 goto err_release_fw;
2825 }
2826
2827 fw_size -= 30;
2828 fw_ptr += 30;
2829 flag = 1;
2830
2831 wmt_params.op = BTMTK_WMT_PATCH_DWNLD;
2832 wmt_params.status = NULL;
2833
2834 while (fw_size > 0) {
2835 dlen = min_t(int, 250, fw_size);
2836
2837 /* Tell deivice the position in sequence */
2838 if (fw_size - dlen <= 0)
2839 flag = 3;
2840 else if (fw_size < fw->size - 30)
2841 flag = 2;
2842
2843 wmt_params.flag = flag;
2844 wmt_params.dlen = dlen;
2845 wmt_params.data = fw_ptr;
2846
2847 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2848 if (err < 0) {
2849 bt_dev_err(hdev, "Failed to send wmt patch dwnld (%d)",
2850 err);
2851 goto err_release_fw;
2852 }
2853
2854 fw_size -= dlen;
2855 fw_ptr += dlen;
2856 }
2857
2858 wmt_params.op = BTMTK_WMT_RST;
2859 wmt_params.flag = 4;
2860 wmt_params.dlen = 0;
2861 wmt_params.data = NULL;
2862 wmt_params.status = NULL;
2863
2864 /* Activate funciton the firmware providing to */
2865 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2866 if (err < 0) {
2867 bt_dev_err(hdev, "Failed to send wmt rst (%d)", err);
Olivier Deprez0e641232021-09-23 10:07:05 +02002868 goto err_release_fw;
David Brazdil0f672f62019-12-10 10:32:29 +00002869 }
2870
2871 /* Wait a few moments for firmware activation done */
2872 usleep_range(10000, 12000);
2873
2874err_release_fw:
2875 release_firmware(fw);
2876
2877 return err;
2878}
2879
2880static int btusb_mtk_func_query(struct hci_dev *hdev)
2881{
2882 struct btmtk_hci_wmt_params wmt_params;
2883 int status, err;
2884 u8 param = 0;
2885
2886 /* Query whether the function is enabled */
2887 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
2888 wmt_params.flag = 4;
2889 wmt_params.dlen = sizeof(param);
2890 wmt_params.data = &param;
2891 wmt_params.status = &status;
2892
2893 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2894 if (err < 0) {
2895 bt_dev_err(hdev, "Failed to query function status (%d)", err);
2896 return err;
2897 }
2898
2899 return status;
2900}
2901
2902static int btusb_mtk_reg_read(struct btusb_data *data, u32 reg, u32 *val)
2903{
2904 int pipe, err, size = sizeof(u32);
2905 void *buf;
2906
2907 buf = kzalloc(size, GFP_KERNEL);
2908 if (!buf)
2909 return -ENOMEM;
2910
2911 pipe = usb_rcvctrlpipe(data->udev, 0);
2912 err = usb_control_msg(data->udev, pipe, 0x63,
2913 USB_TYPE_VENDOR | USB_DIR_IN,
2914 reg >> 16, reg & 0xffff,
2915 buf, size, USB_CTRL_SET_TIMEOUT);
2916 if (err < 0)
2917 goto err_free_buf;
2918
2919 *val = get_unaligned_le32(buf);
2920
2921err_free_buf:
2922 kfree(buf);
2923
2924 return err;
2925}
2926
2927static int btusb_mtk_id_get(struct btusb_data *data, u32 *id)
2928{
2929 return btusb_mtk_reg_read(data, 0x80000008, id);
2930}
2931
2932static int btusb_mtk_setup(struct hci_dev *hdev)
2933{
2934 struct btusb_data *data = hci_get_drvdata(hdev);
2935 struct btmtk_hci_wmt_params wmt_params;
2936 ktime_t calltime, delta, rettime;
2937 struct btmtk_tci_sleep tci_sleep;
2938 unsigned long long duration;
2939 struct sk_buff *skb;
2940 const char *fwname;
2941 int err, status;
2942 u32 dev_id;
2943 u8 param;
2944
2945 calltime = ktime_get();
2946
2947 err = btusb_mtk_id_get(data, &dev_id);
2948 if (err < 0) {
2949 bt_dev_err(hdev, "Failed to get device id (%d)", err);
2950 return err;
2951 }
2952
2953 switch (dev_id) {
2954 case 0x7663:
2955 fwname = FIRMWARE_MT7663;
2956 break;
2957 case 0x7668:
2958 fwname = FIRMWARE_MT7668;
2959 break;
2960 default:
2961 bt_dev_err(hdev, "Unsupported support hardware variant (%08x)",
2962 dev_id);
2963 return -ENODEV;
2964 }
2965
2966 /* Query whether the firmware is already download */
2967 wmt_params.op = BTMTK_WMT_SEMAPHORE;
2968 wmt_params.flag = 1;
2969 wmt_params.dlen = 0;
2970 wmt_params.data = NULL;
2971 wmt_params.status = &status;
2972
2973 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
2974 if (err < 0) {
2975 bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
2976 return err;
2977 }
2978
2979 if (status == BTMTK_WMT_PATCH_DONE) {
2980 bt_dev_info(hdev, "firmware already downloaded");
2981 goto ignore_setup_fw;
2982 }
2983
2984 /* Setup a firmware which the device definitely requires */
2985 err = btusb_mtk_setup_firmware(hdev, fwname);
2986 if (err < 0)
2987 return err;
2988
2989ignore_setup_fw:
2990 err = readx_poll_timeout(btusb_mtk_func_query, hdev, status,
2991 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
2992 2000, 5000000);
2993 /* -ETIMEDOUT happens */
2994 if (err < 0)
2995 return err;
2996
2997 /* The other errors happen in btusb_mtk_func_query */
2998 if (status < 0)
2999 return status;
3000
3001 if (status == BTMTK_WMT_ON_DONE) {
3002 bt_dev_info(hdev, "function already on");
3003 goto ignore_func_on;
3004 }
3005
3006 /* Enable Bluetooth protocol */
3007 param = 1;
3008 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3009 wmt_params.flag = 0;
3010 wmt_params.dlen = sizeof(param);
3011 wmt_params.data = &param;
3012 wmt_params.status = NULL;
3013
3014 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3015 if (err < 0) {
3016 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3017 return err;
3018 }
3019
3020ignore_func_on:
3021 /* Apply the low power environment setup */
3022 tci_sleep.mode = 0x5;
3023 tci_sleep.duration = cpu_to_le16(0x640);
3024 tci_sleep.host_duration = cpu_to_le16(0x640);
3025 tci_sleep.host_wakeup_pin = 0;
3026 tci_sleep.time_compensation = 0;
3027
3028 skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
3029 HCI_INIT_TIMEOUT);
3030 if (IS_ERR(skb)) {
3031 err = PTR_ERR(skb);
3032 bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
3033 return err;
3034 }
3035 kfree_skb(skb);
3036
3037 rettime = ktime_get();
3038 delta = ktime_sub(rettime, calltime);
3039 duration = (unsigned long long)ktime_to_ns(delta) >> 10;
3040
3041 bt_dev_info(hdev, "Device setup in %llu usecs", duration);
3042
3043 return 0;
3044}
3045
3046static int btusb_mtk_shutdown(struct hci_dev *hdev)
3047{
3048 struct btmtk_hci_wmt_params wmt_params;
3049 u8 param = 0;
3050 int err;
3051
3052 /* Disable the device */
3053 wmt_params.op = BTMTK_WMT_FUNC_CTRL;
3054 wmt_params.flag = 0;
3055 wmt_params.dlen = sizeof(param);
3056 wmt_params.data = &param;
3057 wmt_params.status = NULL;
3058
3059 err = btusb_mtk_hci_wmt_sync(hdev, &wmt_params);
3060 if (err < 0) {
3061 bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
3062 return err;
3063 }
3064
3065 return 0;
3066}
3067
3068MODULE_FIRMWARE(FIRMWARE_MT7663);
3069MODULE_FIRMWARE(FIRMWARE_MT7668);
3070#endif
3071
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003072#ifdef CONFIG_PM
3073/* Configure an out-of-band gpio as wake-up pin, if specified in device tree */
3074static int marvell_config_oob_wake(struct hci_dev *hdev)
3075{
3076 struct sk_buff *skb;
3077 struct btusb_data *data = hci_get_drvdata(hdev);
3078 struct device *dev = &data->udev->dev;
3079 u16 pin, gap, opcode;
3080 int ret;
3081 u8 cmd[5];
3082
3083 /* Move on if no wakeup pin specified */
3084 if (of_property_read_u16(dev->of_node, "marvell,wakeup-pin", &pin) ||
3085 of_property_read_u16(dev->of_node, "marvell,wakeup-gap-ms", &gap))
3086 return 0;
3087
3088 /* Vendor specific command to configure a GPIO as wake-up pin */
3089 opcode = hci_opcode_pack(0x3F, 0x59);
3090 cmd[0] = opcode & 0xFF;
3091 cmd[1] = opcode >> 8;
3092 cmd[2] = 2; /* length of parameters that follow */
3093 cmd[3] = pin;
3094 cmd[4] = gap; /* time in ms, for which wakeup pin should be asserted */
3095
3096 skb = bt_skb_alloc(sizeof(cmd), GFP_KERNEL);
3097 if (!skb) {
3098 bt_dev_err(hdev, "%s: No memory\n", __func__);
3099 return -ENOMEM;
3100 }
3101
3102 skb_put_data(skb, cmd, sizeof(cmd));
3103 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
3104
3105 ret = btusb_send_frame(hdev, skb);
3106 if (ret) {
3107 bt_dev_err(hdev, "%s: configuration failed\n", __func__);
3108 kfree_skb(skb);
3109 return ret;
3110 }
3111
3112 return 0;
3113}
3114#endif
3115
3116static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
3117 const bdaddr_t *bdaddr)
3118{
3119 struct sk_buff *skb;
3120 u8 buf[8];
3121 long ret;
3122
3123 buf[0] = 0xfe;
3124 buf[1] = sizeof(bdaddr_t);
3125 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
3126
3127 skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3128 if (IS_ERR(skb)) {
3129 ret = PTR_ERR(skb);
3130 bt_dev_err(hdev, "changing Marvell device address failed (%ld)",
3131 ret);
3132 return ret;
3133 }
3134 kfree_skb(skb);
3135
3136 return 0;
3137}
3138
3139static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
3140 const bdaddr_t *bdaddr)
3141{
3142 struct sk_buff *skb;
3143 u8 buf[10];
3144 long ret;
3145
3146 buf[0] = 0x01;
3147 buf[1] = 0x01;
3148 buf[2] = 0x00;
3149 buf[3] = sizeof(bdaddr_t);
3150 memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
3151
3152 skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
3153 if (IS_ERR(skb)) {
3154 ret = PTR_ERR(skb);
3155 bt_dev_err(hdev, "Change address command failed (%ld)", ret);
3156 return ret;
3157 }
3158 kfree_skb(skb);
3159
3160 return 0;
3161}
3162
3163#define QCA_DFU_PACKET_LEN 4096
3164
3165#define QCA_GET_TARGET_VERSION 0x09
3166#define QCA_CHECK_STATUS 0x05
3167#define QCA_DFU_DOWNLOAD 0x01
3168
3169#define QCA_SYSCFG_UPDATED 0x40
3170#define QCA_PATCH_UPDATED 0x80
3171#define QCA_DFU_TIMEOUT 3000
3172
3173struct qca_version {
3174 __le32 rom_version;
3175 __le32 patch_version;
3176 __le32 ram_version;
3177 __le32 ref_clock;
3178 __u8 reserved[4];
3179} __packed;
3180
3181struct qca_rampatch_version {
3182 __le16 rom_version;
3183 __le16 patch_version;
3184} __packed;
3185
3186struct qca_device_info {
3187 u32 rom_version;
3188 u8 rampatch_hdr; /* length of header in rampatch */
3189 u8 nvm_hdr; /* length of header in NVM */
3190 u8 ver_offset; /* offset of version structure in rampatch */
3191};
3192
3193static const struct qca_device_info qca_devices_table[] = {
3194 { 0x00000100, 20, 4, 10 }, /* Rome 1.0 */
3195 { 0x00000101, 20, 4, 10 }, /* Rome 1.1 */
3196 { 0x00000200, 28, 4, 18 }, /* Rome 2.0 */
3197 { 0x00000201, 28, 4, 18 }, /* Rome 2.1 */
3198 { 0x00000300, 28, 4, 18 }, /* Rome 3.0 */
3199 { 0x00000302, 28, 4, 18 }, /* Rome 3.2 */
3200};
3201
3202static int btusb_qca_send_vendor_req(struct usb_device *udev, u8 request,
3203 void *data, u16 size)
3204{
3205 int pipe, err;
3206 u8 *buf;
3207
3208 buf = kmalloc(size, GFP_KERNEL);
3209 if (!buf)
3210 return -ENOMEM;
3211
3212 /* Found some of USB hosts have IOT issues with ours so that we should
3213 * not wait until HCI layer is ready.
3214 */
3215 pipe = usb_rcvctrlpipe(udev, 0);
3216 err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
3217 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3218 if (err < 0) {
3219 dev_err(&udev->dev, "Failed to access otp area (%d)", err);
3220 goto done;
3221 }
3222
3223 memcpy(data, buf, size);
3224
3225done:
3226 kfree(buf);
3227
3228 return err;
3229}
3230
3231static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
3232 const struct firmware *firmware,
3233 size_t hdr_size)
3234{
3235 struct btusb_data *btdata = hci_get_drvdata(hdev);
3236 struct usb_device *udev = btdata->udev;
3237 size_t count, size, sent = 0;
3238 int pipe, len, err;
3239 u8 *buf;
3240
3241 buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
3242 if (!buf)
3243 return -ENOMEM;
3244
3245 count = firmware->size;
3246
3247 size = min_t(size_t, count, hdr_size);
3248 memcpy(buf, firmware->data, size);
3249
3250 /* USB patches should go down to controller through USB path
3251 * because binary format fits to go down through USB channel.
3252 * USB control path is for patching headers and USB bulk is for
3253 * patch body.
3254 */
3255 pipe = usb_sndctrlpipe(udev, 0);
3256 err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
3257 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
3258 if (err < 0) {
3259 bt_dev_err(hdev, "Failed to send headers (%d)", err);
3260 goto done;
3261 }
3262
3263 sent += size;
3264 count -= size;
3265
Olivier Deprez0e641232021-09-23 10:07:05 +02003266 /* ep2 need time to switch from function acl to function dfu,
3267 * so we add 20ms delay here.
3268 */
3269 msleep(20);
3270
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003271 while (count) {
3272 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
3273
3274 memcpy(buf, firmware->data + sent, size);
3275
3276 pipe = usb_sndbulkpipe(udev, 0x02);
3277 err = usb_bulk_msg(udev, pipe, buf, size, &len,
3278 QCA_DFU_TIMEOUT);
3279 if (err < 0) {
3280 bt_dev_err(hdev, "Failed to send body at %zd of %zd (%d)",
3281 sent, firmware->size, err);
3282 break;
3283 }
3284
3285 if (size != len) {
3286 bt_dev_err(hdev, "Failed to get bulk buffer");
3287 err = -EILSEQ;
3288 break;
3289 }
3290
3291 sent += size;
3292 count -= size;
3293 }
3294
3295done:
3296 kfree(buf);
3297 return err;
3298}
3299
3300static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
3301 struct qca_version *ver,
3302 const struct qca_device_info *info)
3303{
3304 struct qca_rampatch_version *rver;
3305 const struct firmware *fw;
3306 u32 ver_rom, ver_patch;
3307 u16 rver_rom, rver_patch;
3308 char fwname[64];
3309 int err;
3310
3311 ver_rom = le32_to_cpu(ver->rom_version);
3312 ver_patch = le32_to_cpu(ver->patch_version);
3313
3314 snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
3315
3316 err = request_firmware(&fw, fwname, &hdev->dev);
3317 if (err) {
3318 bt_dev_err(hdev, "failed to request rampatch file: %s (%d)",
3319 fwname, err);
3320 return err;
3321 }
3322
3323 bt_dev_info(hdev, "using rampatch file: %s", fwname);
3324
3325 rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
3326 rver_rom = le16_to_cpu(rver->rom_version);
3327 rver_patch = le16_to_cpu(rver->patch_version);
3328
3329 bt_dev_info(hdev, "QCA: patch rome 0x%x build 0x%x, "
3330 "firmware rome 0x%x build 0x%x",
3331 rver_rom, rver_patch, ver_rom, ver_patch);
3332
3333 if (rver_rom != ver_rom || rver_patch <= ver_patch) {
3334 bt_dev_err(hdev, "rampatch file version did not match with firmware");
3335 err = -EINVAL;
3336 goto done;
3337 }
3338
3339 err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
3340
3341done:
3342 release_firmware(fw);
3343
3344 return err;
3345}
3346
3347static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
3348 struct qca_version *ver,
3349 const struct qca_device_info *info)
3350{
3351 const struct firmware *fw;
3352 char fwname[64];
3353 int err;
3354
3355 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
3356 le32_to_cpu(ver->rom_version));
3357
3358 err = request_firmware(&fw, fwname, &hdev->dev);
3359 if (err) {
3360 bt_dev_err(hdev, "failed to request NVM file: %s (%d)",
3361 fwname, err);
3362 return err;
3363 }
3364
3365 bt_dev_info(hdev, "using NVM file: %s", fwname);
3366
3367 err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
3368
3369 release_firmware(fw);
3370
3371 return err;
3372}
3373
3374/* identify the ROM version and check whether patches are needed */
3375static bool btusb_qca_need_patch(struct usb_device *udev)
3376{
3377 struct qca_version ver;
3378
3379 if (btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
3380 sizeof(ver)) < 0)
3381 return false;
3382 /* only low ROM versions need patches */
3383 return !(le32_to_cpu(ver.rom_version) & ~0xffffU);
3384}
3385
3386static int btusb_setup_qca(struct hci_dev *hdev)
3387{
3388 struct btusb_data *btdata = hci_get_drvdata(hdev);
3389 struct usb_device *udev = btdata->udev;
3390 const struct qca_device_info *info = NULL;
3391 struct qca_version ver;
3392 u32 ver_rom;
3393 u8 status;
3394 int i, err;
3395
3396 err = btusb_qca_send_vendor_req(udev, QCA_GET_TARGET_VERSION, &ver,
3397 sizeof(ver));
3398 if (err < 0)
3399 return err;
3400
3401 ver_rom = le32_to_cpu(ver.rom_version);
3402 /* Don't care about high ROM versions */
3403 if (ver_rom & ~0xffffU)
3404 return 0;
3405
3406 for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
3407 if (ver_rom == qca_devices_table[i].rom_version)
3408 info = &qca_devices_table[i];
3409 }
3410 if (!info) {
3411 bt_dev_err(hdev, "don't support firmware rome 0x%x", ver_rom);
3412 return -ENODEV;
3413 }
3414
3415 err = btusb_qca_send_vendor_req(udev, QCA_CHECK_STATUS, &status,
3416 sizeof(status));
3417 if (err < 0)
3418 return err;
3419
3420 if (!(status & QCA_PATCH_UPDATED)) {
3421 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
3422 if (err < 0)
3423 return err;
3424 }
3425
3426 if (!(status & QCA_SYSCFG_UPDATED)) {
3427 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
3428 if (err < 0)
3429 return err;
3430 }
3431
3432 return 0;
3433}
3434
3435#ifdef CONFIG_BT_HCIBTUSB_BCM
3436static inline int __set_diag_interface(struct hci_dev *hdev)
3437{
3438 struct btusb_data *data = hci_get_drvdata(hdev);
3439 struct usb_interface *intf = data->diag;
3440 int i;
3441
3442 if (!data->diag)
3443 return -ENODEV;
3444
3445 data->diag_tx_ep = NULL;
3446 data->diag_rx_ep = NULL;
3447
3448 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3449 struct usb_endpoint_descriptor *ep_desc;
3450
3451 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3452
3453 if (!data->diag_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3454 data->diag_tx_ep = ep_desc;
3455 continue;
3456 }
3457
3458 if (!data->diag_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3459 data->diag_rx_ep = ep_desc;
3460 continue;
3461 }
3462 }
3463
3464 if (!data->diag_tx_ep || !data->diag_rx_ep) {
3465 bt_dev_err(hdev, "invalid diagnostic descriptors");
3466 return -ENODEV;
3467 }
3468
3469 return 0;
3470}
3471
3472static struct urb *alloc_diag_urb(struct hci_dev *hdev, bool enable)
3473{
3474 struct btusb_data *data = hci_get_drvdata(hdev);
3475 struct sk_buff *skb;
3476 struct urb *urb;
3477 unsigned int pipe;
3478
3479 if (!data->diag_tx_ep)
3480 return ERR_PTR(-ENODEV);
3481
3482 urb = usb_alloc_urb(0, GFP_KERNEL);
3483 if (!urb)
3484 return ERR_PTR(-ENOMEM);
3485
3486 skb = bt_skb_alloc(2, GFP_KERNEL);
3487 if (!skb) {
3488 usb_free_urb(urb);
3489 return ERR_PTR(-ENOMEM);
3490 }
3491
3492 skb_put_u8(skb, 0xf0);
3493 skb_put_u8(skb, enable);
3494
3495 pipe = usb_sndbulkpipe(data->udev, data->diag_tx_ep->bEndpointAddress);
3496
3497 usb_fill_bulk_urb(urb, data->udev, pipe,
3498 skb->data, skb->len, btusb_tx_complete, skb);
3499
3500 skb->dev = (void *)hdev;
3501
3502 return urb;
3503}
3504
3505static int btusb_bcm_set_diag(struct hci_dev *hdev, bool enable)
3506{
3507 struct btusb_data *data = hci_get_drvdata(hdev);
3508 struct urb *urb;
3509
3510 if (!data->diag)
3511 return -ENODEV;
3512
3513 if (!test_bit(HCI_RUNNING, &hdev->flags))
3514 return -ENETDOWN;
3515
3516 urb = alloc_diag_urb(hdev, enable);
3517 if (IS_ERR(urb))
3518 return PTR_ERR(urb);
3519
3520 return submit_or_queue_tx_urb(hdev, urb);
3521}
3522#endif
3523
3524#ifdef CONFIG_PM
3525static irqreturn_t btusb_oob_wake_handler(int irq, void *priv)
3526{
3527 struct btusb_data *data = priv;
3528
3529 pm_wakeup_event(&data->udev->dev, 0);
3530 pm_system_wakeup();
3531
3532 /* Disable only if not already disabled (keep it balanced) */
3533 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
3534 disable_irq_nosync(irq);
3535 disable_irq_wake(irq);
3536 }
3537 return IRQ_HANDLED;
3538}
3539
3540static const struct of_device_id btusb_match_table[] = {
3541 { .compatible = "usb1286,204e" },
David Brazdil0f672f62019-12-10 10:32:29 +00003542 { .compatible = "usbcf3,e300" }, /* QCA6174A */
3543 { .compatible = "usb4ca,301a" }, /* QCA6174A (Lite-On) */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003544 { }
3545};
3546MODULE_DEVICE_TABLE(of, btusb_match_table);
3547
3548/* Use an oob wakeup pin? */
3549static int btusb_config_oob_wake(struct hci_dev *hdev)
3550{
3551 struct btusb_data *data = hci_get_drvdata(hdev);
3552 struct device *dev = &data->udev->dev;
3553 int irq, ret;
3554
3555 clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
3556
3557 if (!of_match_device(btusb_match_table, dev))
3558 return 0;
3559
3560 /* Move on if no IRQ specified */
3561 irq = of_irq_get_byname(dev->of_node, "wakeup");
3562 if (irq <= 0) {
3563 bt_dev_dbg(hdev, "%s: no OOB Wakeup IRQ in DT", __func__);
3564 return 0;
3565 }
3566
David Brazdil0f672f62019-12-10 10:32:29 +00003567 irq_set_status_flags(irq, IRQ_NOAUTOEN);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003568 ret = devm_request_irq(&hdev->dev, irq, btusb_oob_wake_handler,
3569 0, "OOB Wake-on-BT", data);
3570 if (ret) {
3571 bt_dev_err(hdev, "%s: IRQ request failed", __func__);
3572 return ret;
3573 }
3574
3575 ret = device_init_wakeup(dev, true);
3576 if (ret) {
3577 bt_dev_err(hdev, "%s: failed to init_wakeup", __func__);
3578 return ret;
3579 }
3580
3581 data->oob_wake_irq = irq;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003582 bt_dev_info(hdev, "OOB Wake-on-BT configured at IRQ %u", irq);
3583 return 0;
3584}
3585#endif
3586
3587static void btusb_check_needs_reset_resume(struct usb_interface *intf)
3588{
3589 if (dmi_check_system(btusb_needs_reset_resume_table))
3590 interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
3591}
3592
3593static int btusb_probe(struct usb_interface *intf,
3594 const struct usb_device_id *id)
3595{
3596 struct usb_endpoint_descriptor *ep_desc;
David Brazdil0f672f62019-12-10 10:32:29 +00003597 struct gpio_desc *reset_gpio;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003598 struct btusb_data *data;
3599 struct hci_dev *hdev;
3600 unsigned ifnum_base;
3601 int i, err;
3602
3603 BT_DBG("intf %p id %p", intf, id);
3604
3605 /* interface numbers are hardcoded in the spec */
3606 if (intf->cur_altsetting->desc.bInterfaceNumber != 0) {
3607 if (!(id->driver_info & BTUSB_IFNUM_2))
3608 return -ENODEV;
3609 if (intf->cur_altsetting->desc.bInterfaceNumber != 2)
3610 return -ENODEV;
3611 }
3612
3613 ifnum_base = intf->cur_altsetting->desc.bInterfaceNumber;
3614
3615 if (!id->driver_info) {
3616 const struct usb_device_id *match;
3617
3618 match = usb_match_id(intf, blacklist_table);
3619 if (match)
3620 id = match;
3621 }
3622
3623 if (id->driver_info == BTUSB_IGNORE)
3624 return -ENODEV;
3625
3626 if (id->driver_info & BTUSB_ATH3012) {
3627 struct usb_device *udev = interface_to_usbdev(intf);
3628
3629 /* Old firmware would otherwise let ath3k driver load
3630 * patch and sysconfig files
3631 */
3632 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001 &&
3633 !btusb_qca_need_patch(udev))
3634 return -ENODEV;
3635 }
3636
3637 data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
3638 if (!data)
3639 return -ENOMEM;
3640
3641 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
3642 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
3643
3644 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
3645 data->intr_ep = ep_desc;
3646 continue;
3647 }
3648
3649 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
3650 data->bulk_tx_ep = ep_desc;
3651 continue;
3652 }
3653
3654 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
3655 data->bulk_rx_ep = ep_desc;
3656 continue;
3657 }
3658 }
3659
3660 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
3661 return -ENODEV;
3662
3663 if (id->driver_info & BTUSB_AMP) {
3664 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
3665 data->cmdreq = 0x2b;
3666 } else {
3667 data->cmdreq_type = USB_TYPE_CLASS;
3668 data->cmdreq = 0x00;
3669 }
3670
3671 data->udev = interface_to_usbdev(intf);
3672 data->intf = intf;
3673
3674 INIT_WORK(&data->work, btusb_work);
3675 INIT_WORK(&data->waker, btusb_waker);
3676 init_usb_anchor(&data->deferred);
3677 init_usb_anchor(&data->tx_anchor);
3678 spin_lock_init(&data->txlock);
3679
3680 init_usb_anchor(&data->intr_anchor);
3681 init_usb_anchor(&data->bulk_anchor);
3682 init_usb_anchor(&data->isoc_anchor);
3683 init_usb_anchor(&data->diag_anchor);
David Brazdil0f672f62019-12-10 10:32:29 +00003684 init_usb_anchor(&data->ctrl_anchor);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003685 spin_lock_init(&data->rxlock);
3686
3687 if (id->driver_info & BTUSB_INTEL_NEW) {
3688 data->recv_event = btusb_recv_event_intel;
3689 data->recv_bulk = btusb_recv_bulk_intel;
3690 set_bit(BTUSB_BOOTLOADER, &data->flags);
3691 } else {
3692 data->recv_event = hci_recv_frame;
3693 data->recv_bulk = btusb_recv_bulk;
3694 }
3695
3696 hdev = hci_alloc_dev();
3697 if (!hdev)
3698 return -ENOMEM;
3699
3700 hdev->bus = HCI_USB;
3701 hci_set_drvdata(hdev, data);
3702
3703 if (id->driver_info & BTUSB_AMP)
3704 hdev->dev_type = HCI_AMP;
3705 else
3706 hdev->dev_type = HCI_PRIMARY;
3707
3708 data->hdev = hdev;
3709
3710 SET_HCIDEV_DEV(hdev, &intf->dev);
3711
David Brazdil0f672f62019-12-10 10:32:29 +00003712 reset_gpio = gpiod_get_optional(&data->udev->dev, "reset",
3713 GPIOD_OUT_LOW);
3714 if (IS_ERR(reset_gpio)) {
3715 err = PTR_ERR(reset_gpio);
3716 goto out_free_dev;
3717 } else if (reset_gpio) {
3718 data->reset_gpio = reset_gpio;
3719 }
3720
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003721 hdev->open = btusb_open;
3722 hdev->close = btusb_close;
3723 hdev->flush = btusb_flush;
3724 hdev->send = btusb_send_frame;
3725 hdev->notify = btusb_notify;
3726
3727#ifdef CONFIG_PM
3728 err = btusb_config_oob_wake(hdev);
3729 if (err)
3730 goto out_free_dev;
3731
3732 /* Marvell devices may need a specific chip configuration */
3733 if (id->driver_info & BTUSB_MARVELL && data->oob_wake_irq) {
3734 err = marvell_config_oob_wake(hdev);
3735 if (err)
3736 goto out_free_dev;
3737 }
3738#endif
3739 if (id->driver_info & BTUSB_CW6622)
3740 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3741
3742 if (id->driver_info & BTUSB_BCM2045)
3743 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
3744
3745 if (id->driver_info & BTUSB_BCM92035)
3746 hdev->setup = btusb_setup_bcm92035;
3747
3748#ifdef CONFIG_BT_HCIBTUSB_BCM
3749 if (id->driver_info & BTUSB_BCM_PATCHRAM) {
3750 hdev->manufacturer = 15;
3751 hdev->setup = btbcm_setup_patchram;
3752 hdev->set_diag = btusb_bcm_set_diag;
3753 hdev->set_bdaddr = btbcm_set_bdaddr;
3754
3755 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3756 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3757 }
3758
3759 if (id->driver_info & BTUSB_BCM_APPLE) {
3760 hdev->manufacturer = 15;
3761 hdev->setup = btbcm_setup_apple;
3762 hdev->set_diag = btusb_bcm_set_diag;
3763
3764 /* Broadcom LM_DIAG Interface numbers are hardcoded */
3765 data->diag = usb_ifnum_to_if(data->udev, ifnum_base + 2);
3766 }
3767#endif
3768
3769 if (id->driver_info & BTUSB_INTEL) {
3770 hdev->manufacturer = 2;
3771 hdev->setup = btusb_setup_intel;
3772 hdev->shutdown = btusb_shutdown_intel;
3773 hdev->set_diag = btintel_set_diag_mfg;
3774 hdev->set_bdaddr = btintel_set_bdaddr;
David Brazdil0f672f62019-12-10 10:32:29 +00003775 hdev->cmd_timeout = btusb_intel_cmd_timeout;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003776 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3777 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3778 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
3779 }
3780
3781 if (id->driver_info & BTUSB_INTEL_NEW) {
3782 hdev->manufacturer = 2;
3783 hdev->send = btusb_send_frame_intel;
3784 hdev->setup = btusb_setup_intel_new;
David Brazdil0f672f62019-12-10 10:32:29 +00003785 hdev->shutdown = btusb_shutdown_intel_new;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003786 hdev->hw_error = btintel_hw_error;
3787 hdev->set_diag = btintel_set_diag;
3788 hdev->set_bdaddr = btintel_set_bdaddr;
David Brazdil0f672f62019-12-10 10:32:29 +00003789 hdev->cmd_timeout = btusb_intel_cmd_timeout;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003790 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
David Brazdil0f672f62019-12-10 10:32:29 +00003791 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003792 set_bit(HCI_QUIRK_NON_PERSISTENT_DIAG, &hdev->quirks);
3793 }
3794
3795 if (id->driver_info & BTUSB_MARVELL)
3796 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
3797
David Brazdil0f672f62019-12-10 10:32:29 +00003798#ifdef CONFIG_BT_HCIBTUSB_MTK
3799 if (id->driver_info & BTUSB_MEDIATEK) {
3800 hdev->setup = btusb_mtk_setup;
3801 hdev->shutdown = btusb_mtk_shutdown;
3802 hdev->manufacturer = 70;
3803 set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
3804 }
3805#endif
3806
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003807 if (id->driver_info & BTUSB_SWAVE) {
3808 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
3809 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
3810 }
3811
3812 if (id->driver_info & BTUSB_INTEL_BOOT) {
3813 hdev->manufacturer = 2;
3814 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
3815 }
3816
3817 if (id->driver_info & BTUSB_ATH3012) {
3818 data->setup_on_usb = btusb_setup_qca;
3819 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
3820 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3821 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
3822 }
3823
3824 if (id->driver_info & BTUSB_QCA_ROME) {
3825 data->setup_on_usb = btusb_setup_qca;
3826 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
3827 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3828 btusb_check_needs_reset_resume(intf);
3829 }
3830
Olivier Deprez0e641232021-09-23 10:07:05 +02003831 if (IS_ENABLED(CONFIG_BT_HCIBTUSB_RTL) &&
3832 (id->driver_info & BTUSB_REALTEK)) {
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003833 hdev->setup = btrtl_setup_realtek;
David Brazdil0f672f62019-12-10 10:32:29 +00003834 hdev->shutdown = btrtl_shutdown_realtek;
3835 hdev->cmd_timeout = btusb_rtl_cmd_timeout;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003836
David Brazdil0f672f62019-12-10 10:32:29 +00003837 /* Realtek devices lose their updated firmware over global
3838 * suspend that means host doesn't send SET_FEATURE
3839 * (DEVICE_REMOTE_WAKEUP)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003840 */
David Brazdil0f672f62019-12-10 10:32:29 +00003841 set_bit(BTUSB_WAKEUP_DISABLE, &data->flags);
Olivier Deprez0e641232021-09-23 10:07:05 +02003842
3843 err = usb_autopm_get_interface(intf);
3844 if (err < 0)
3845 goto out_free_dev;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003846 }
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003847
3848 if (id->driver_info & BTUSB_AMP) {
3849 /* AMP controllers do not support SCO packets */
3850 data->isoc = NULL;
3851 } else {
3852 /* Interface orders are hardcoded in the specification */
3853 data->isoc = usb_ifnum_to_if(data->udev, ifnum_base + 1);
3854 data->isoc_ifnum = ifnum_base + 1;
3855 }
3856
3857 if (!reset)
3858 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3859
3860 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
3861 if (!disable_scofix)
3862 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
3863 }
3864
3865 if (id->driver_info & BTUSB_BROKEN_ISOC)
3866 data->isoc = NULL;
3867
3868 if (id->driver_info & BTUSB_DIGIANSWER) {
3869 data->cmdreq_type = USB_TYPE_VENDOR;
3870 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3871 }
3872
3873 if (id->driver_info & BTUSB_CSR) {
3874 struct usb_device *udev = data->udev;
3875 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
3876
3877 /* Old firmware would otherwise execute USB reset */
3878 if (bcdDevice < 0x117)
3879 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
3880
3881 /* Fake CSR devices with broken commands */
3882 if (bcdDevice <= 0x100 || bcdDevice == 0x134)
3883 hdev->setup = btusb_setup_csr;
3884
3885 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
3886 }
3887
3888 if (id->driver_info & BTUSB_SNIFFER) {
3889 struct usb_device *udev = data->udev;
3890
3891 /* New sniffer firmware has crippled HCI interface */
3892 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
3893 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
3894 }
3895
3896 if (id->driver_info & BTUSB_INTEL_BOOT) {
3897 /* A bug in the bootloader causes that interrupt interface is
3898 * only enabled after receiving SetInterface(0, AltSetting=0).
3899 */
3900 err = usb_set_interface(data->udev, 0, 0);
3901 if (err < 0) {
3902 BT_ERR("failed to set interface 0, alt 0 %d", err);
3903 goto out_free_dev;
3904 }
3905 }
3906
3907 if (data->isoc) {
3908 err = usb_driver_claim_interface(&btusb_driver,
3909 data->isoc, data);
3910 if (err < 0)
3911 goto out_free_dev;
3912 }
3913
3914#ifdef CONFIG_BT_HCIBTUSB_BCM
3915 if (data->diag) {
3916 if (!usb_driver_claim_interface(&btusb_driver,
3917 data->diag, data))
3918 __set_diag_interface(hdev);
3919 else
3920 data->diag = NULL;
3921 }
3922#endif
3923
3924 if (enable_autosuspend)
3925 usb_enable_autosuspend(data->udev);
3926
3927 err = hci_register_dev(hdev);
3928 if (err < 0)
3929 goto out_free_dev;
3930
3931 usb_set_intfdata(intf, data);
3932
3933 return 0;
3934
3935out_free_dev:
David Brazdil0f672f62019-12-10 10:32:29 +00003936 if (data->reset_gpio)
3937 gpiod_put(data->reset_gpio);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003938 hci_free_dev(hdev);
3939 return err;
3940}
3941
3942static void btusb_disconnect(struct usb_interface *intf)
3943{
3944 struct btusb_data *data = usb_get_intfdata(intf);
3945 struct hci_dev *hdev;
3946
3947 BT_DBG("intf %p", intf);
3948
3949 if (!data)
3950 return;
3951
3952 hdev = data->hdev;
3953 usb_set_intfdata(data->intf, NULL);
3954
3955 if (data->isoc)
3956 usb_set_intfdata(data->isoc, NULL);
3957
3958 if (data->diag)
3959 usb_set_intfdata(data->diag, NULL);
3960
3961 hci_unregister_dev(hdev);
3962
3963 if (intf == data->intf) {
3964 if (data->isoc)
3965 usb_driver_release_interface(&btusb_driver, data->isoc);
3966 if (data->diag)
3967 usb_driver_release_interface(&btusb_driver, data->diag);
3968 } else if (intf == data->isoc) {
3969 if (data->diag)
3970 usb_driver_release_interface(&btusb_driver, data->diag);
3971 usb_driver_release_interface(&btusb_driver, data->intf);
3972 } else if (intf == data->diag) {
3973 usb_driver_release_interface(&btusb_driver, data->intf);
3974 if (data->isoc)
3975 usb_driver_release_interface(&btusb_driver, data->isoc);
3976 }
3977
3978 if (data->oob_wake_irq)
3979 device_init_wakeup(&data->udev->dev, false);
3980
David Brazdil0f672f62019-12-10 10:32:29 +00003981 if (data->reset_gpio)
3982 gpiod_put(data->reset_gpio);
3983
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00003984 hci_free_dev(hdev);
3985}
3986
3987#ifdef CONFIG_PM
3988static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
3989{
3990 struct btusb_data *data = usb_get_intfdata(intf);
3991
3992 BT_DBG("intf %p", intf);
3993
3994 if (data->suspend_count++)
3995 return 0;
3996
3997 spin_lock_irq(&data->txlock);
3998 if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
3999 set_bit(BTUSB_SUSPENDING, &data->flags);
4000 spin_unlock_irq(&data->txlock);
4001 } else {
4002 spin_unlock_irq(&data->txlock);
4003 data->suspend_count--;
4004 return -EBUSY;
4005 }
4006
4007 cancel_work_sync(&data->work);
4008
4009 btusb_stop_traffic(data);
4010 usb_kill_anchored_urbs(&data->tx_anchor);
4011
4012 if (data->oob_wake_irq && device_may_wakeup(&data->udev->dev)) {
4013 set_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags);
4014 enable_irq_wake(data->oob_wake_irq);
4015 enable_irq(data->oob_wake_irq);
4016 }
4017
David Brazdil0f672f62019-12-10 10:32:29 +00004018 /* For global suspend, Realtek devices lose the loaded fw
4019 * in them. But for autosuspend, firmware should remain.
4020 * Actually, it depends on whether the usb host sends
4021 * set feature (enable wakeup) or not.
4022 */
4023 if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags)) {
4024 if (PMSG_IS_AUTO(message) &&
4025 device_can_wakeup(&data->udev->dev))
4026 data->udev->do_remote_wakeup = 1;
4027 else if (!PMSG_IS_AUTO(message))
4028 data->udev->reset_resume = 1;
4029 }
4030
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00004031 return 0;
4032}
4033
4034static void play_deferred(struct btusb_data *data)
4035{
4036 struct urb *urb;
4037 int err;
4038
4039 while ((urb = usb_get_from_anchor(&data->deferred))) {
4040 usb_anchor_urb(urb, &data->tx_anchor);
4041
4042 err = usb_submit_urb(urb, GFP_ATOMIC);
4043 if (err < 0) {
4044 if (err != -EPERM && err != -ENODEV)
4045 BT_ERR("%s urb %p submission failed (%d)",
4046 data->hdev->name, urb, -err);
4047 kfree(urb->setup_packet);
4048 usb_unanchor_urb(urb);
4049 usb_free_urb(urb);
4050 break;
4051 }
4052
4053 data->tx_in_flight++;
4054 usb_free_urb(urb);
4055 }
4056
4057 /* Cleanup the rest deferred urbs. */
4058 while ((urb = usb_get_from_anchor(&data->deferred))) {
4059 kfree(urb->setup_packet);
4060 usb_free_urb(urb);
4061 }
4062}
4063
4064static int btusb_resume(struct usb_interface *intf)
4065{
4066 struct btusb_data *data = usb_get_intfdata(intf);
4067 struct hci_dev *hdev = data->hdev;
4068 int err = 0;
4069
4070 BT_DBG("intf %p", intf);
4071
4072 if (--data->suspend_count)
4073 return 0;
4074
4075 /* Disable only if not already disabled (keep it balanced) */
4076 if (test_and_clear_bit(BTUSB_OOB_WAKE_ENABLED, &data->flags)) {
4077 disable_irq(data->oob_wake_irq);
4078 disable_irq_wake(data->oob_wake_irq);
4079 }
4080
4081 if (!test_bit(HCI_RUNNING, &hdev->flags))
4082 goto done;
4083
4084 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
4085 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
4086 if (err < 0) {
4087 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
4088 goto failed;
4089 }
4090 }
4091
4092 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
4093 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
4094 if (err < 0) {
4095 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
4096 goto failed;
4097 }
4098
4099 btusb_submit_bulk_urb(hdev, GFP_NOIO);
4100 }
4101
4102 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
4103 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
4104 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
4105 else
4106 btusb_submit_isoc_urb(hdev, GFP_NOIO);
4107 }
4108
4109 spin_lock_irq(&data->txlock);
4110 play_deferred(data);
4111 clear_bit(BTUSB_SUSPENDING, &data->flags);
4112 spin_unlock_irq(&data->txlock);
4113 schedule_work(&data->work);
4114
4115 return 0;
4116
4117failed:
4118 usb_scuttle_anchored_urbs(&data->deferred);
4119done:
4120 spin_lock_irq(&data->txlock);
4121 clear_bit(BTUSB_SUSPENDING, &data->flags);
4122 spin_unlock_irq(&data->txlock);
4123
4124 return err;
4125}
4126#endif
4127
4128static struct usb_driver btusb_driver = {
4129 .name = "btusb",
4130 .probe = btusb_probe,
4131 .disconnect = btusb_disconnect,
4132#ifdef CONFIG_PM
4133 .suspend = btusb_suspend,
4134 .resume = btusb_resume,
4135#endif
4136 .id_table = btusb_table,
4137 .supports_autosuspend = 1,
4138 .disable_hub_initiated_lpm = 1,
4139};
4140
4141module_usb_driver(btusb_driver);
4142
4143module_param(disable_scofix, bool, 0644);
4144MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
4145
4146module_param(force_scofix, bool, 0644);
4147MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
4148
4149module_param(enable_autosuspend, bool, 0644);
4150MODULE_PARM_DESC(enable_autosuspend, "Enable USB autosuspend by default");
4151
4152module_param(reset, bool, 0644);
4153MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
4154
4155MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
4156MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
4157MODULE_VERSION(VERSION);
4158MODULE_LICENSE("GPL");