3 * Generic Bluetooth USB driver
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/module.h>
25 #include <linux/usb.h>
26 #include <linux/firmware.h>
27 #include <asm/unaligned.h>
29 #include <net/bluetooth/bluetooth.h>
30 #include <net/bluetooth/hci_core.h>
38 static bool disable_scofix;
39 static bool force_scofix;
41 static bool reset = true;
43 static struct usb_driver btusb_driver;
45 #define BTUSB_IGNORE 0x01
46 #define BTUSB_DIGIANSWER 0x02
47 #define BTUSB_CSR 0x04
48 #define BTUSB_SNIFFER 0x08
49 #define BTUSB_BCM92035 0x10
50 #define BTUSB_BROKEN_ISOC 0x20
51 #define BTUSB_WRONG_SCO_MTU 0x40
52 #define BTUSB_ATH3012 0x80
53 #define BTUSB_INTEL 0x100
54 #define BTUSB_INTEL_BOOT 0x200
55 #define BTUSB_BCM_PATCHRAM 0x400
56 #define BTUSB_MARVELL 0x800
57 #define BTUSB_SWAVE 0x1000
58 #define BTUSB_INTEL_NEW 0x2000
59 #define BTUSB_AMP 0x4000
60 #define BTUSB_QCA_ROME 0x8000
61 #define BTUSB_BCM_APPLE 0x10000
62 #define BTUSB_REALTEK 0x20000
64 static const struct usb_device_id btusb_table[] = {
65 /* Generic Bluetooth USB device */
66 { USB_DEVICE_INFO(0xe0, 0x01, 0x01) },
68 /* Generic Bluetooth AMP device */
69 { USB_DEVICE_INFO(0xe0, 0x01, 0x04), .driver_info = BTUSB_AMP },
71 /* Generic Bluetooth USB interface */
72 { USB_INTERFACE_INFO(0xe0, 0x01, 0x01) },
74 /* Apple-specific (Broadcom) devices */
75 { USB_VENDOR_AND_INTERFACE_INFO(0x05ac, 0xff, 0x01, 0x01),
76 .driver_info = BTUSB_BCM_APPLE },
78 /* MediaTek MT76x0E */
79 { USB_DEVICE(0x0e8d, 0x763f) },
81 /* Broadcom SoftSailing reporting vendor specific */
82 { USB_DEVICE(0x0a5c, 0x21e1) },
84 /* Apple MacBookPro 7,1 */
85 { USB_DEVICE(0x05ac, 0x8213) },
88 { USB_DEVICE(0x05ac, 0x8215) },
90 /* Apple MacBookPro6,2 */
91 { USB_DEVICE(0x05ac, 0x8218) },
93 /* Apple MacBookAir3,1, MacBookAir3,2 */
94 { USB_DEVICE(0x05ac, 0x821b) },
96 /* Apple MacBookAir4,1 */
97 { USB_DEVICE(0x05ac, 0x821f) },
99 /* Apple MacBookPro8,2 */
100 { USB_DEVICE(0x05ac, 0x821a) },
102 /* Apple MacMini5,1 */
103 { USB_DEVICE(0x05ac, 0x8281) },
105 /* AVM BlueFRITZ! USB v2.0 */
106 { USB_DEVICE(0x057c, 0x3800), .driver_info = BTUSB_SWAVE },
108 /* Bluetooth Ultraport Module from IBM */
109 { USB_DEVICE(0x04bf, 0x030a) },
111 /* ALPS Modules with non-standard id */
112 { USB_DEVICE(0x044e, 0x3001) },
113 { USB_DEVICE(0x044e, 0x3002) },
115 /* Ericsson with non-standard id */
116 { USB_DEVICE(0x0bdb, 0x1002) },
118 /* Canyon CN-BTU1 with HID interfaces */
119 { USB_DEVICE(0x0c10, 0x0000) },
121 /* Broadcom BCM20702A0 */
122 { USB_DEVICE(0x413c, 0x8197) },
124 /* Broadcom BCM20702B0 (Dynex/Insignia) */
125 { USB_DEVICE(0x19ff, 0x0239), .driver_info = BTUSB_BCM_PATCHRAM },
127 /* Foxconn - Hon Hai */
128 { USB_VENDOR_AND_INTERFACE_INFO(0x0489, 0xff, 0x01, 0x01),
129 .driver_info = BTUSB_BCM_PATCHRAM },
131 /* Lite-On Technology - Broadcom based */
132 { USB_VENDOR_AND_INTERFACE_INFO(0x04ca, 0xff, 0x01, 0x01),
133 .driver_info = BTUSB_BCM_PATCHRAM },
135 /* Broadcom devices with vendor specific id */
136 { USB_VENDOR_AND_INTERFACE_INFO(0x0a5c, 0xff, 0x01, 0x01),
137 .driver_info = BTUSB_BCM_PATCHRAM },
139 /* ASUSTek Computer - Broadcom based */
140 { USB_VENDOR_AND_INTERFACE_INFO(0x0b05, 0xff, 0x01, 0x01),
141 .driver_info = BTUSB_BCM_PATCHRAM },
143 /* Belkin F8065bf - Broadcom based */
144 { USB_VENDOR_AND_INTERFACE_INFO(0x050d, 0xff, 0x01, 0x01),
145 .driver_info = BTUSB_BCM_PATCHRAM },
147 /* IMC Networks - Broadcom based */
148 { USB_VENDOR_AND_INTERFACE_INFO(0x13d3, 0xff, 0x01, 0x01),
149 .driver_info = BTUSB_BCM_PATCHRAM },
151 /* Intel Bluetooth USB Bootloader (RAM module) */
152 { USB_DEVICE(0x8087, 0x0a5a),
153 .driver_info = BTUSB_INTEL_BOOT | BTUSB_BROKEN_ISOC },
155 { } /* Terminating entry */
158 MODULE_DEVICE_TABLE(usb, btusb_table);
160 static const struct usb_device_id blacklist_table[] = {
161 /* CSR BlueCore devices */
162 { USB_DEVICE(0x0a12, 0x0001), .driver_info = BTUSB_CSR },
164 /* Broadcom BCM2033 without firmware */
165 { USB_DEVICE(0x0a5c, 0x2033), .driver_info = BTUSB_IGNORE },
167 /* Atheros 3011 with sflash firmware */
168 { USB_DEVICE(0x0489, 0xe027), .driver_info = BTUSB_IGNORE },
169 { USB_DEVICE(0x0489, 0xe03d), .driver_info = BTUSB_IGNORE },
170 { USB_DEVICE(0x04f2, 0xaff1), .driver_info = BTUSB_IGNORE },
171 { USB_DEVICE(0x0930, 0x0215), .driver_info = BTUSB_IGNORE },
172 { USB_DEVICE(0x0cf3, 0x3002), .driver_info = BTUSB_IGNORE },
173 { USB_DEVICE(0x0cf3, 0xe019), .driver_info = BTUSB_IGNORE },
174 { USB_DEVICE(0x13d3, 0x3304), .driver_info = BTUSB_IGNORE },
176 /* Atheros AR9285 Malbec with sflash firmware */
177 { USB_DEVICE(0x03f0, 0x311d), .driver_info = BTUSB_IGNORE },
179 /* Atheros 3012 with sflash firmware */
180 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
191 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
193 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
194 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
195 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
196 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
197 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
198 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
199 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
200 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
201 { USB_DEVICE(0x0cf3, 0x0036), .driver_info = BTUSB_ATH3012 },
202 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
203 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
204 { USB_DEVICE(0x0cf3, 0x311d), .driver_info = BTUSB_ATH3012 },
205 { USB_DEVICE(0x0cf3, 0x311e), .driver_info = BTUSB_ATH3012 },
206 { USB_DEVICE(0x0cf3, 0x311f), .driver_info = BTUSB_ATH3012 },
207 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
208 { USB_DEVICE(0x0cf3, 0x817a), .driver_info = BTUSB_ATH3012 },
209 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
210 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
211 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
212 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
213 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
214 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
215 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
216 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
217 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
218 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
219 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
220 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
222 /* Atheros AR5BBU12 with sflash firmware */
223 { USB_DEVICE(0x0489, 0xe02c), .driver_info = BTUSB_IGNORE },
225 /* Atheros AR5BBU12 with sflash firmware */
226 { USB_DEVICE(0x0489, 0xe036), .driver_info = BTUSB_ATH3012 },
227 { USB_DEVICE(0x0489, 0xe03c), .driver_info = BTUSB_ATH3012 },
229 /* QCA ROME chipset */
230 { USB_DEVICE(0x0cf3, 0xe007), .driver_info = BTUSB_QCA_ROME },
231 { USB_DEVICE(0x0cf3, 0xe300), .driver_info = BTUSB_QCA_ROME },
232 { USB_DEVICE(0x0cf3, 0xe360), .driver_info = BTUSB_QCA_ROME },
234 /* Broadcom BCM2035 */
235 { USB_DEVICE(0x0a5c, 0x2009), .driver_info = BTUSB_BCM92035 },
236 { USB_DEVICE(0x0a5c, 0x200a), .driver_info = BTUSB_WRONG_SCO_MTU },
237 { USB_DEVICE(0x0a5c, 0x2035), .driver_info = BTUSB_WRONG_SCO_MTU },
239 /* Broadcom BCM2045 */
240 { USB_DEVICE(0x0a5c, 0x2039), .driver_info = BTUSB_WRONG_SCO_MTU },
241 { USB_DEVICE(0x0a5c, 0x2101), .driver_info = BTUSB_WRONG_SCO_MTU },
243 /* IBM/Lenovo ThinkPad with Broadcom chip */
244 { USB_DEVICE(0x0a5c, 0x201e), .driver_info = BTUSB_WRONG_SCO_MTU },
245 { USB_DEVICE(0x0a5c, 0x2110), .driver_info = BTUSB_WRONG_SCO_MTU },
247 /* HP laptop with Broadcom chip */
248 { USB_DEVICE(0x03f0, 0x171d), .driver_info = BTUSB_WRONG_SCO_MTU },
250 /* Dell laptop with Broadcom chip */
251 { USB_DEVICE(0x413c, 0x8126), .driver_info = BTUSB_WRONG_SCO_MTU },
253 /* Dell Wireless 370 and 410 devices */
254 { USB_DEVICE(0x413c, 0x8152), .driver_info = BTUSB_WRONG_SCO_MTU },
255 { USB_DEVICE(0x413c, 0x8156), .driver_info = BTUSB_WRONG_SCO_MTU },
257 /* Belkin F8T012 and F8T013 devices */
258 { USB_DEVICE(0x050d, 0x0012), .driver_info = BTUSB_WRONG_SCO_MTU },
259 { USB_DEVICE(0x050d, 0x0013), .driver_info = BTUSB_WRONG_SCO_MTU },
261 /* Asus WL-BTD202 device */
262 { USB_DEVICE(0x0b05, 0x1715), .driver_info = BTUSB_WRONG_SCO_MTU },
264 /* Kensington Bluetooth USB adapter */
265 { USB_DEVICE(0x047d, 0x105e), .driver_info = BTUSB_WRONG_SCO_MTU },
267 /* RTX Telecom based adapters with buggy SCO support */
268 { USB_DEVICE(0x0400, 0x0807), .driver_info = BTUSB_BROKEN_ISOC },
269 { USB_DEVICE(0x0400, 0x080a), .driver_info = BTUSB_BROKEN_ISOC },
271 /* CONWISE Technology based adapters with buggy SCO support */
272 { USB_DEVICE(0x0e5e, 0x6622), .driver_info = BTUSB_BROKEN_ISOC },
274 /* Roper Class 1 Bluetooth Dongle (Silicon Wave based) */
275 { USB_DEVICE(0x1310, 0x0001), .driver_info = BTUSB_SWAVE },
277 /* Digianswer devices */
278 { USB_DEVICE(0x08fd, 0x0001), .driver_info = BTUSB_DIGIANSWER },
279 { USB_DEVICE(0x08fd, 0x0002), .driver_info = BTUSB_IGNORE },
281 /* CSR BlueCore Bluetooth Sniffer */
282 { USB_DEVICE(0x0a12, 0x0002),
283 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
285 /* Frontline ComProbe Bluetooth Sniffer */
286 { USB_DEVICE(0x16d3, 0x0002),
287 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
289 /* Marvell Bluetooth devices */
290 { USB_DEVICE(0x1286, 0x2044), .driver_info = BTUSB_MARVELL },
291 { USB_DEVICE(0x1286, 0x2046), .driver_info = BTUSB_MARVELL },
293 /* Intel Bluetooth devices */
294 { USB_DEVICE(0x8087, 0x07da), .driver_info = BTUSB_CSR },
295 { USB_DEVICE(0x8087, 0x07dc), .driver_info = BTUSB_INTEL },
296 { USB_DEVICE(0x8087, 0x0a2a), .driver_info = BTUSB_INTEL },
297 { USB_DEVICE(0x8087, 0x0a2b), .driver_info = BTUSB_INTEL_NEW },
299 /* Other Intel Bluetooth devices */
300 { USB_VENDOR_AND_INTERFACE_INFO(0x8087, 0xe0, 0x01, 0x01),
301 .driver_info = BTUSB_IGNORE },
303 /* Realtek Bluetooth devices */
304 { USB_VENDOR_AND_INTERFACE_INFO(0x0bda, 0xe0, 0x01, 0x01),
305 .driver_info = BTUSB_REALTEK },
307 /* Additional Realtek 8723AE Bluetooth devices */
308 { USB_DEVICE(0x0930, 0x021d), .driver_info = BTUSB_REALTEK },
309 { USB_DEVICE(0x13d3, 0x3394), .driver_info = BTUSB_REALTEK },
311 /* Additional Realtek 8723BE Bluetooth devices */
312 { USB_DEVICE(0x0489, 0xe085), .driver_info = BTUSB_REALTEK },
313 { USB_DEVICE(0x0489, 0xe08b), .driver_info = BTUSB_REALTEK },
314 { USB_DEVICE(0x13d3, 0x3410), .driver_info = BTUSB_REALTEK },
315 { USB_DEVICE(0x13d3, 0x3416), .driver_info = BTUSB_REALTEK },
316 { USB_DEVICE(0x13d3, 0x3459), .driver_info = BTUSB_REALTEK },
318 /* Additional Realtek 8821AE Bluetooth devices */
319 { USB_DEVICE(0x0b05, 0x17dc), .driver_info = BTUSB_REALTEK },
320 { USB_DEVICE(0x13d3, 0x3414), .driver_info = BTUSB_REALTEK },
321 { USB_DEVICE(0x13d3, 0x3458), .driver_info = BTUSB_REALTEK },
322 { USB_DEVICE(0x13d3, 0x3461), .driver_info = BTUSB_REALTEK },
323 { USB_DEVICE(0x13d3, 0x3462), .driver_info = BTUSB_REALTEK },
325 /* Silicon Wave based devices */
326 { USB_DEVICE(0x0c10, 0x0000), .driver_info = BTUSB_SWAVE },
328 { } /* Terminating entry */
331 #define BTUSB_MAX_ISOC_FRAMES 10
333 #define BTUSB_INTR_RUNNING 0
334 #define BTUSB_BULK_RUNNING 1
335 #define BTUSB_ISOC_RUNNING 2
336 #define BTUSB_SUSPENDING 3
337 #define BTUSB_DID_ISO_RESUME 4
338 #define BTUSB_BOOTLOADER 5
339 #define BTUSB_DOWNLOADING 6
340 #define BTUSB_FIRMWARE_LOADED 7
341 #define BTUSB_FIRMWARE_FAILED 8
342 #define BTUSB_BOOTING 9
343 #define BTUSB_RESET_RESUME 10
346 struct hci_dev *hdev;
347 struct usb_device *udev;
348 struct usb_interface *intf;
349 struct usb_interface *isoc;
353 struct work_struct work;
354 struct work_struct waker;
356 struct usb_anchor deferred;
357 struct usb_anchor tx_anchor;
361 struct usb_anchor intr_anchor;
362 struct usb_anchor bulk_anchor;
363 struct usb_anchor isoc_anchor;
366 struct sk_buff *evt_skb;
367 struct sk_buff *acl_skb;
368 struct sk_buff *sco_skb;
370 struct usb_endpoint_descriptor *intr_ep;
371 struct usb_endpoint_descriptor *bulk_tx_ep;
372 struct usb_endpoint_descriptor *bulk_rx_ep;
373 struct usb_endpoint_descriptor *isoc_tx_ep;
374 struct usb_endpoint_descriptor *isoc_rx_ep;
379 unsigned int sco_num;
383 int (*recv_event)(struct hci_dev *hdev, struct sk_buff *skb);
384 int (*recv_bulk)(struct btusb_data *data, void *buffer, int count);
386 int (*setup_on_usb)(struct hci_dev *hdev);
389 static inline void btusb_free_frags(struct btusb_data *data)
393 spin_lock_irqsave(&data->rxlock, flags);
395 kfree_skb(data->evt_skb);
396 data->evt_skb = NULL;
398 kfree_skb(data->acl_skb);
399 data->acl_skb = NULL;
401 kfree_skb(data->sco_skb);
402 data->sco_skb = NULL;
404 spin_unlock_irqrestore(&data->rxlock, flags);
407 static int btusb_recv_intr(struct btusb_data *data, void *buffer, int count)
412 spin_lock(&data->rxlock);
419 skb = bt_skb_alloc(HCI_MAX_EVENT_SIZE, GFP_ATOMIC);
425 bt_cb(skb)->pkt_type = HCI_EVENT_PKT;
426 bt_cb(skb)->expect = HCI_EVENT_HDR_SIZE;
429 len = min_t(uint, bt_cb(skb)->expect, count);
430 memcpy(skb_put(skb, len), buffer, len);
434 bt_cb(skb)->expect -= len;
436 if (skb->len == HCI_EVENT_HDR_SIZE) {
437 /* Complete event header */
438 bt_cb(skb)->expect = hci_event_hdr(skb)->plen;
440 if (skb_tailroom(skb) < bt_cb(skb)->expect) {
449 if (bt_cb(skb)->expect == 0) {
451 data->recv_event(data->hdev, skb);
457 spin_unlock(&data->rxlock);
462 static int btusb_recv_bulk(struct btusb_data *data, void *buffer, int count)
467 spin_lock(&data->rxlock);
474 skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
480 bt_cb(skb)->pkt_type = HCI_ACLDATA_PKT;
481 bt_cb(skb)->expect = HCI_ACL_HDR_SIZE;
484 len = min_t(uint, bt_cb(skb)->expect, count);
485 memcpy(skb_put(skb, len), buffer, len);
489 bt_cb(skb)->expect -= len;
491 if (skb->len == HCI_ACL_HDR_SIZE) {
492 __le16 dlen = hci_acl_hdr(skb)->dlen;
494 /* Complete ACL header */
495 bt_cb(skb)->expect = __le16_to_cpu(dlen);
497 if (skb_tailroom(skb) < bt_cb(skb)->expect) {
506 if (bt_cb(skb)->expect == 0) {
508 hci_recv_frame(data->hdev, skb);
514 spin_unlock(&data->rxlock);
519 static int btusb_recv_isoc(struct btusb_data *data, void *buffer, int count)
524 spin_lock(&data->rxlock);
531 skb = bt_skb_alloc(HCI_MAX_SCO_SIZE, GFP_ATOMIC);
537 bt_cb(skb)->pkt_type = HCI_SCODATA_PKT;
538 bt_cb(skb)->expect = HCI_SCO_HDR_SIZE;
541 len = min_t(uint, bt_cb(skb)->expect, count);
542 memcpy(skb_put(skb, len), buffer, len);
546 bt_cb(skb)->expect -= len;
548 if (skb->len == HCI_SCO_HDR_SIZE) {
549 /* Complete SCO header */
550 bt_cb(skb)->expect = hci_sco_hdr(skb)->dlen;
552 if (skb_tailroom(skb) < bt_cb(skb)->expect) {
561 if (bt_cb(skb)->expect == 0) {
563 hci_recv_frame(data->hdev, skb);
569 spin_unlock(&data->rxlock);
574 static void btusb_intr_complete(struct urb *urb)
576 struct hci_dev *hdev = urb->context;
577 struct btusb_data *data = hci_get_drvdata(hdev);
580 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
583 if (!test_bit(HCI_RUNNING, &hdev->flags))
586 if (urb->status == 0) {
587 hdev->stat.byte_rx += urb->actual_length;
589 if (btusb_recv_intr(data, urb->transfer_buffer,
590 urb->actual_length) < 0) {
591 BT_ERR("%s corrupted event packet", hdev->name);
594 } else if (urb->status == -ENOENT) {
595 /* Avoid suspend failed when usb_kill_urb */
599 if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
602 usb_mark_last_busy(data->udev);
603 usb_anchor_urb(urb, &data->intr_anchor);
605 err = usb_submit_urb(urb, GFP_ATOMIC);
607 /* -EPERM: urb is being killed;
608 * -ENODEV: device got disconnected */
609 if (err != -EPERM && err != -ENODEV)
610 BT_ERR("%s urb %p failed to resubmit (%d)",
611 hdev->name, urb, -err);
612 usb_unanchor_urb(urb);
616 static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
618 struct btusb_data *data = hci_get_drvdata(hdev);
624 BT_DBG("%s", hdev->name);
629 urb = usb_alloc_urb(0, mem_flags);
633 size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
635 buf = kmalloc(size, mem_flags);
641 pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
643 usb_fill_int_urb(urb, data->udev, pipe, buf, size,
644 btusb_intr_complete, hdev, data->intr_ep->bInterval);
646 urb->transfer_flags |= URB_FREE_BUFFER;
648 usb_anchor_urb(urb, &data->intr_anchor);
650 err = usb_submit_urb(urb, mem_flags);
652 if (err != -EPERM && err != -ENODEV)
653 BT_ERR("%s urb %p submission failed (%d)",
654 hdev->name, urb, -err);
655 usb_unanchor_urb(urb);
663 static void btusb_bulk_complete(struct urb *urb)
665 struct hci_dev *hdev = urb->context;
666 struct btusb_data *data = hci_get_drvdata(hdev);
669 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
672 if (!test_bit(HCI_RUNNING, &hdev->flags))
675 if (urb->status == 0) {
676 hdev->stat.byte_rx += urb->actual_length;
678 if (data->recv_bulk(data, urb->transfer_buffer,
679 urb->actual_length) < 0) {
680 BT_ERR("%s corrupted ACL packet", hdev->name);
683 } else if (urb->status == -ENOENT) {
684 /* Avoid suspend failed when usb_kill_urb */
688 if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
691 usb_anchor_urb(urb, &data->bulk_anchor);
692 usb_mark_last_busy(data->udev);
694 err = usb_submit_urb(urb, GFP_ATOMIC);
696 /* -EPERM: urb is being killed;
697 * -ENODEV: device got disconnected */
698 if (err != -EPERM && err != -ENODEV)
699 BT_ERR("%s urb %p failed to resubmit (%d)",
700 hdev->name, urb, -err);
701 usb_unanchor_urb(urb);
705 static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
707 struct btusb_data *data = hci_get_drvdata(hdev);
711 int err, size = HCI_MAX_FRAME_SIZE;
713 BT_DBG("%s", hdev->name);
715 if (!data->bulk_rx_ep)
718 urb = usb_alloc_urb(0, mem_flags);
722 buf = kmalloc(size, mem_flags);
728 pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
730 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
731 btusb_bulk_complete, hdev);
733 urb->transfer_flags |= URB_FREE_BUFFER;
735 usb_mark_last_busy(data->udev);
736 usb_anchor_urb(urb, &data->bulk_anchor);
738 err = usb_submit_urb(urb, mem_flags);
740 if (err != -EPERM && err != -ENODEV)
741 BT_ERR("%s urb %p submission failed (%d)",
742 hdev->name, urb, -err);
743 usb_unanchor_urb(urb);
751 static void btusb_isoc_complete(struct urb *urb)
753 struct hci_dev *hdev = urb->context;
754 struct btusb_data *data = hci_get_drvdata(hdev);
757 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
760 if (!test_bit(HCI_RUNNING, &hdev->flags))
763 if (urb->status == 0) {
764 for (i = 0; i < urb->number_of_packets; i++) {
765 unsigned int offset = urb->iso_frame_desc[i].offset;
766 unsigned int length = urb->iso_frame_desc[i].actual_length;
768 if (urb->iso_frame_desc[i].status)
771 hdev->stat.byte_rx += length;
773 if (btusb_recv_isoc(data, urb->transfer_buffer + offset,
775 BT_ERR("%s corrupted SCO packet", hdev->name);
779 } else if (urb->status == -ENOENT) {
780 /* Avoid suspend failed when usb_kill_urb */
784 if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
787 usb_anchor_urb(urb, &data->isoc_anchor);
789 err = usb_submit_urb(urb, GFP_ATOMIC);
791 /* -EPERM: urb is being killed;
792 * -ENODEV: device got disconnected */
793 if (err != -EPERM && err != -ENODEV)
794 BT_ERR("%s urb %p failed to resubmit (%d)",
795 hdev->name, urb, -err);
796 usb_unanchor_urb(urb);
800 static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
804 BT_DBG("len %d mtu %d", len, mtu);
806 for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
807 i++, offset += mtu, len -= mtu) {
808 urb->iso_frame_desc[i].offset = offset;
809 urb->iso_frame_desc[i].length = mtu;
812 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
813 urb->iso_frame_desc[i].offset = offset;
814 urb->iso_frame_desc[i].length = len;
818 urb->number_of_packets = i;
821 static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
823 struct btusb_data *data = hci_get_drvdata(hdev);
829 BT_DBG("%s", hdev->name);
831 if (!data->isoc_rx_ep)
834 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
838 size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
839 BTUSB_MAX_ISOC_FRAMES;
841 buf = kmalloc(size, mem_flags);
847 pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
849 usb_fill_int_urb(urb, data->udev, pipe, buf, size, btusb_isoc_complete,
850 hdev, data->isoc_rx_ep->bInterval);
852 urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
854 __fill_isoc_descriptor(urb, size,
855 le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
857 usb_anchor_urb(urb, &data->isoc_anchor);
859 err = usb_submit_urb(urb, mem_flags);
861 if (err != -EPERM && err != -ENODEV)
862 BT_ERR("%s urb %p submission failed (%d)",
863 hdev->name, urb, -err);
864 usb_unanchor_urb(urb);
872 static void btusb_tx_complete(struct urb *urb)
874 struct sk_buff *skb = urb->context;
875 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
876 struct btusb_data *data = hci_get_drvdata(hdev);
878 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
881 if (!test_bit(HCI_RUNNING, &hdev->flags))
885 hdev->stat.byte_tx += urb->transfer_buffer_length;
890 spin_lock(&data->txlock);
891 data->tx_in_flight--;
892 spin_unlock(&data->txlock);
894 kfree(urb->setup_packet);
899 static void btusb_isoc_tx_complete(struct urb *urb)
901 struct sk_buff *skb = urb->context;
902 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
904 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
907 if (!test_bit(HCI_RUNNING, &hdev->flags))
911 hdev->stat.byte_tx += urb->transfer_buffer_length;
916 kfree(urb->setup_packet);
921 static int btusb_open(struct hci_dev *hdev)
923 struct btusb_data *data = hci_get_drvdata(hdev);
926 BT_DBG("%s", hdev->name);
928 /* Patching USB firmware files prior to starting any URBs of HCI path
929 * It is more safe to use USB bulk channel for downloading USB patch
931 if (data->setup_on_usb) {
932 err = data->setup_on_usb(hdev);
937 err = usb_autopm_get_interface(data->intf);
941 data->intf->needs_remote_wakeup = 1;
943 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
946 if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
949 err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
953 err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
955 usb_kill_anchored_urbs(&data->intr_anchor);
959 set_bit(BTUSB_BULK_RUNNING, &data->flags);
960 btusb_submit_bulk_urb(hdev, GFP_KERNEL);
963 usb_autopm_put_interface(data->intf);
967 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
968 clear_bit(HCI_RUNNING, &hdev->flags);
969 usb_autopm_put_interface(data->intf);
973 static void btusb_stop_traffic(struct btusb_data *data)
975 usb_kill_anchored_urbs(&data->intr_anchor);
976 usb_kill_anchored_urbs(&data->bulk_anchor);
977 usb_kill_anchored_urbs(&data->isoc_anchor);
980 static int btusb_close(struct hci_dev *hdev)
982 struct btusb_data *data = hci_get_drvdata(hdev);
985 BT_DBG("%s", hdev->name);
987 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
990 cancel_work_sync(&data->work);
991 cancel_work_sync(&data->waker);
993 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
994 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
995 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
997 btusb_stop_traffic(data);
998 btusb_free_frags(data);
1000 err = usb_autopm_get_interface(data->intf);
1004 data->intf->needs_remote_wakeup = 0;
1005 usb_autopm_put_interface(data->intf);
1008 usb_scuttle_anchored_urbs(&data->deferred);
1012 static int btusb_flush(struct hci_dev *hdev)
1014 struct btusb_data *data = hci_get_drvdata(hdev);
1016 BT_DBG("%s", hdev->name);
1018 usb_kill_anchored_urbs(&data->tx_anchor);
1019 btusb_free_frags(data);
1024 static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1026 struct btusb_data *data = hci_get_drvdata(hdev);
1027 struct usb_ctrlrequest *dr;
1031 urb = usb_alloc_urb(0, GFP_KERNEL);
1033 return ERR_PTR(-ENOMEM);
1035 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1038 return ERR_PTR(-ENOMEM);
1041 dr->bRequestType = data->cmdreq_type;
1042 dr->bRequest = data->cmdreq;
1045 dr->wLength = __cpu_to_le16(skb->len);
1047 pipe = usb_sndctrlpipe(data->udev, 0x00);
1049 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1050 skb->data, skb->len, btusb_tx_complete, skb);
1052 skb->dev = (void *)hdev;
1057 static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1059 struct btusb_data *data = hci_get_drvdata(hdev);
1063 if (!data->bulk_tx_ep)
1064 return ERR_PTR(-ENODEV);
1066 urb = usb_alloc_urb(0, GFP_KERNEL);
1068 return ERR_PTR(-ENOMEM);
1070 pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1072 usb_fill_bulk_urb(urb, data->udev, pipe,
1073 skb->data, skb->len, btusb_tx_complete, skb);
1075 skb->dev = (void *)hdev;
1080 static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1082 struct btusb_data *data = hci_get_drvdata(hdev);
1086 if (!data->isoc_tx_ep)
1087 return ERR_PTR(-ENODEV);
1089 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1091 return ERR_PTR(-ENOMEM);
1093 pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1095 usb_fill_int_urb(urb, data->udev, pipe,
1096 skb->data, skb->len, btusb_isoc_tx_complete,
1097 skb, data->isoc_tx_ep->bInterval);
1099 urb->transfer_flags = URB_ISO_ASAP;
1101 __fill_isoc_descriptor(urb, skb->len,
1102 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1104 skb->dev = (void *)hdev;
1109 static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1111 struct btusb_data *data = hci_get_drvdata(hdev);
1114 usb_anchor_urb(urb, &data->tx_anchor);
1116 err = usb_submit_urb(urb, GFP_KERNEL);
1118 if (err != -EPERM && err != -ENODEV)
1119 BT_ERR("%s urb %p submission failed (%d)",
1120 hdev->name, urb, -err);
1121 kfree(urb->setup_packet);
1122 usb_unanchor_urb(urb);
1124 usb_mark_last_busy(data->udev);
1131 static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1133 struct btusb_data *data = hci_get_drvdata(hdev);
1134 unsigned long flags;
1137 spin_lock_irqsave(&data->txlock, flags);
1138 suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1140 data->tx_in_flight++;
1141 spin_unlock_irqrestore(&data->txlock, flags);
1144 return submit_tx_urb(hdev, urb);
1146 usb_anchor_urb(urb, &data->deferred);
1147 schedule_work(&data->waker);
1153 static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1157 BT_DBG("%s", hdev->name);
1159 if (!test_bit(HCI_RUNNING, &hdev->flags))
1162 switch (bt_cb(skb)->pkt_type) {
1163 case HCI_COMMAND_PKT:
1164 urb = alloc_ctrl_urb(hdev, skb);
1166 return PTR_ERR(urb);
1168 hdev->stat.cmd_tx++;
1169 return submit_or_queue_tx_urb(hdev, urb);
1171 case HCI_ACLDATA_PKT:
1172 urb = alloc_bulk_urb(hdev, skb);
1174 return PTR_ERR(urb);
1176 hdev->stat.acl_tx++;
1177 return submit_or_queue_tx_urb(hdev, urb);
1179 case HCI_SCODATA_PKT:
1180 if (hci_conn_num(hdev, SCO_LINK) < 1)
1183 urb = alloc_isoc_urb(hdev, skb);
1185 return PTR_ERR(urb);
1187 hdev->stat.sco_tx++;
1188 return submit_tx_urb(hdev, urb);
1194 static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1196 struct btusb_data *data = hci_get_drvdata(hdev);
1198 BT_DBG("%s evt %d", hdev->name, evt);
1200 if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1201 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1202 schedule_work(&data->work);
1206 static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1208 struct btusb_data *data = hci_get_drvdata(hdev);
1209 struct usb_interface *intf = data->isoc;
1210 struct usb_endpoint_descriptor *ep_desc;
1216 err = usb_set_interface(data->udev, 1, altsetting);
1218 BT_ERR("%s setting interface failed (%d)", hdev->name, -err);
1222 data->isoc_altsetting = altsetting;
1224 data->isoc_tx_ep = NULL;
1225 data->isoc_rx_ep = NULL;
1227 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1228 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1230 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1231 data->isoc_tx_ep = ep_desc;
1235 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1236 data->isoc_rx_ep = ep_desc;
1241 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1242 BT_ERR("%s invalid SCO descriptors", hdev->name);
1249 static void btusb_work(struct work_struct *work)
1251 struct btusb_data *data = container_of(work, struct btusb_data, work);
1252 struct hci_dev *hdev = data->hdev;
1256 if (data->sco_num > 0) {
1257 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1258 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1260 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1261 usb_kill_anchored_urbs(&data->isoc_anchor);
1265 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1268 if (hdev->voice_setting & 0x0020) {
1269 static const int alts[3] = { 2, 4, 5 };
1271 new_alts = alts[data->sco_num - 1];
1273 new_alts = data->sco_num;
1276 if (data->isoc_altsetting != new_alts) {
1277 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1278 usb_kill_anchored_urbs(&data->isoc_anchor);
1280 if (__set_isoc_interface(hdev, new_alts) < 0)
1284 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1285 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1286 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1288 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1291 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1292 usb_kill_anchored_urbs(&data->isoc_anchor);
1294 __set_isoc_interface(hdev, 0);
1295 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1296 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1300 static void btusb_waker(struct work_struct *work)
1302 struct btusb_data *data = container_of(work, struct btusb_data, waker);
1305 err = usb_autopm_get_interface(data->intf);
1309 usb_autopm_put_interface(data->intf);
1312 static int btusb_setup_bcm92035(struct hci_dev *hdev)
1314 struct sk_buff *skb;
1317 BT_DBG("%s", hdev->name);
1319 skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1321 BT_ERR("BCM92035 command failed (%ld)", -PTR_ERR(skb));
1328 static int btusb_setup_csr(struct hci_dev *hdev)
1330 struct hci_rp_read_local_version *rp;
1331 struct sk_buff *skb;
1333 BT_DBG("%s", hdev->name);
1335 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1338 int err = PTR_ERR(skb);
1339 BT_ERR("%s: CSR: Local version failed (%d)", hdev->name, err);
1343 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1344 BT_ERR("%s: CSR: Local version length mismatch", hdev->name);
1349 rp = (struct hci_rp_read_local_version *)skb->data;
1351 if (le16_to_cpu(rp->manufacturer) != 10) {
1352 /* Clear the reset quirk since this is not an actual
1353 * early Bluetooth 1.1 device from CSR.
1355 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1357 /* These fake CSR controllers have all a broken
1358 * stored link key handling and so just disable it.
1360 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY, &hdev->quirks);
1368 static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1369 struct intel_version *ver)
1371 const struct firmware *fw;
1375 snprintf(fwname, sizeof(fwname),
1376 "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1377 ver->hw_platform, ver->hw_variant, ver->hw_revision,
1378 ver->fw_variant, ver->fw_revision, ver->fw_build_num,
1379 ver->fw_build_ww, ver->fw_build_yy);
1381 ret = request_firmware(&fw, fwname, &hdev->dev);
1383 if (ret == -EINVAL) {
1384 BT_ERR("%s Intel firmware file request failed (%d)",
1389 BT_ERR("%s failed to open Intel firmware file: %s(%d)",
1390 hdev->name, fwname, ret);
1392 /* If the correct firmware patch file is not found, use the
1393 * default firmware patch file instead
1395 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1396 ver->hw_platform, ver->hw_variant);
1397 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1398 BT_ERR("%s failed to open default Intel fw file: %s",
1399 hdev->name, fwname);
1404 BT_INFO("%s: Intel Bluetooth firmware file: %s", hdev->name, fwname);
1409 static int btusb_setup_intel_patching(struct hci_dev *hdev,
1410 const struct firmware *fw,
1411 const u8 **fw_ptr, int *disable_patch)
1413 struct sk_buff *skb;
1414 struct hci_command_hdr *cmd;
1415 const u8 *cmd_param;
1416 struct hci_event_hdr *evt = NULL;
1417 const u8 *evt_param = NULL;
1418 int remain = fw->size - (*fw_ptr - fw->data);
1420 /* The first byte indicates the types of the patch command or event.
1421 * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1422 * in the current firmware buffer doesn't start with 0x01 or
1423 * the size of remain buffer is smaller than HCI command header,
1424 * the firmware file is corrupted and it should stop the patching
1427 if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1428 BT_ERR("%s Intel fw corrupted: invalid cmd read", hdev->name);
1434 cmd = (struct hci_command_hdr *)(*fw_ptr);
1435 *fw_ptr += sizeof(*cmd);
1436 remain -= sizeof(*cmd);
1438 /* Ensure that the remain firmware data is long enough than the length
1439 * of command parameter. If not, the firmware file is corrupted.
1441 if (remain < cmd->plen) {
1442 BT_ERR("%s Intel fw corrupted: invalid cmd len", hdev->name);
1446 /* If there is a command that loads a patch in the firmware
1447 * file, then enable the patch upon success, otherwise just
1448 * disable the manufacturer mode, for example patch activation
1449 * is not required when the default firmware patch file is used
1450 * because there are no patch data to load.
1452 if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
1455 cmd_param = *fw_ptr;
1456 *fw_ptr += cmd->plen;
1457 remain -= cmd->plen;
1459 /* This reads the expected events when the above command is sent to the
1460 * device. Some vendor commands expects more than one events, for
1461 * example command status event followed by vendor specific event.
1462 * For this case, it only keeps the last expected event. so the command
1463 * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
1464 * last expected event.
1466 while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
1470 evt = (struct hci_event_hdr *)(*fw_ptr);
1471 *fw_ptr += sizeof(*evt);
1472 remain -= sizeof(*evt);
1474 if (remain < evt->plen) {
1475 BT_ERR("%s Intel fw corrupted: invalid evt len",
1480 evt_param = *fw_ptr;
1481 *fw_ptr += evt->plen;
1482 remain -= evt->plen;
1485 /* Every HCI commands in the firmware file has its correspond event.
1486 * If event is not found or remain is smaller than zero, the firmware
1487 * file is corrupted.
1489 if (!evt || !evt_param || remain < 0) {
1490 BT_ERR("%s Intel fw corrupted: invalid evt read", hdev->name);
1494 skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
1495 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
1497 BT_ERR("%s sending Intel patch command (0x%4.4x) failed (%ld)",
1498 hdev->name, cmd->opcode, PTR_ERR(skb));
1499 return PTR_ERR(skb);
1502 /* It ensures that the returned event matches the event data read from
1503 * the firmware file. At fist, it checks the length and then
1504 * the contents of the event.
1506 if (skb->len != evt->plen) {
1507 BT_ERR("%s mismatch event length (opcode 0x%4.4x)", hdev->name,
1508 le16_to_cpu(cmd->opcode));
1513 if (memcmp(skb->data, evt_param, evt->plen)) {
1514 BT_ERR("%s mismatch event parameter (opcode 0x%4.4x)",
1515 hdev->name, le16_to_cpu(cmd->opcode));
1524 static int btusb_setup_intel(struct hci_dev *hdev)
1526 struct sk_buff *skb;
1527 const struct firmware *fw;
1530 struct intel_version *ver;
1532 const u8 mfg_enable[] = { 0x01, 0x00 };
1533 const u8 mfg_disable[] = { 0x00, 0x00 };
1534 const u8 mfg_reset_deactivate[] = { 0x00, 0x01 };
1535 const u8 mfg_reset_activate[] = { 0x00, 0x02 };
1537 BT_DBG("%s", hdev->name);
1539 /* The controller has a bug with the first HCI command sent to it
1540 * returning number of completed commands as zero. This would stall the
1541 * command processing in the Bluetooth core.
1543 * As a workaround, send HCI Reset command first which will reset the
1544 * number of completed commands and allow normal command processing
1547 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
1549 BT_ERR("%s sending initial HCI reset command failed (%ld)",
1550 hdev->name, PTR_ERR(skb));
1551 return PTR_ERR(skb);
1555 /* Read Intel specific controller version first to allow selection of
1556 * which firmware file to load.
1558 * The returned information are hardware variant and revision plus
1559 * firmware variant, revision and build number.
1561 skb = __hci_cmd_sync(hdev, 0xfc05, 0, NULL, HCI_INIT_TIMEOUT);
1563 BT_ERR("%s reading Intel fw version command failed (%ld)",
1564 hdev->name, PTR_ERR(skb));
1565 return PTR_ERR(skb);
1568 if (skb->len != sizeof(*ver)) {
1569 BT_ERR("%s Intel version event length mismatch", hdev->name);
1574 ver = (struct intel_version *)skb->data;
1576 BT_INFO("%s: read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
1577 hdev->name, ver->hw_platform, ver->hw_variant,
1578 ver->hw_revision, ver->fw_variant, ver->fw_revision,
1579 ver->fw_build_num, ver->fw_build_ww, ver->fw_build_yy,
1582 /* fw_patch_num indicates the version of patch the device currently
1583 * have. If there is no patch data in the device, it is always 0x00.
1584 * So, if it is other than 0x00, no need to patch the device again.
1586 if (ver->fw_patch_num) {
1587 BT_INFO("%s: Intel device is already patched. patch num: %02x",
1588 hdev->name, ver->fw_patch_num);
1590 btintel_check_bdaddr(hdev);
1594 /* Opens the firmware patch file based on the firmware version read
1595 * from the controller. If it fails to open the matching firmware
1596 * patch file, it tries to open the default firmware patch file.
1597 * If no patch file is found, allow the device to operate without
1600 fw = btusb_setup_intel_get_fw(hdev, ver);
1603 btintel_check_bdaddr(hdev);
1610 /* This Intel specific command enables the manufacturer mode of the
1613 * Only while this mode is enabled, the driver can download the
1614 * firmware patch data and configuration parameters.
1616 skb = __hci_cmd_sync(hdev, 0xfc11, 2, mfg_enable, HCI_INIT_TIMEOUT);
1618 BT_ERR("%s entering Intel manufacturer mode failed (%ld)",
1619 hdev->name, PTR_ERR(skb));
1620 release_firmware(fw);
1621 return PTR_ERR(skb);
1628 /* The firmware data file consists of list of Intel specific HCI
1629 * commands and its expected events. The first byte indicates the
1630 * type of the message, either HCI command or HCI event.
1632 * It reads the command and its expected event from the firmware file,
1633 * and send to the controller. Once __hci_cmd_sync_ev() returns,
1634 * the returned event is compared with the event read from the firmware
1635 * file and it will continue until all the messages are downloaded to
1638 * Once the firmware patching is completed successfully,
1639 * the manufacturer mode is disabled with reset and activating the
1642 * If the firmware patching fails, the manufacturer mode is
1643 * disabled with reset and deactivating the patch.
1645 * If the default patch file is used, no reset is done when disabling
1648 while (fw->size > fw_ptr - fw->data) {
1651 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
1654 goto exit_mfg_deactivate;
1657 release_firmware(fw);
1660 goto exit_mfg_disable;
1662 /* Patching completed successfully and disable the manufacturer mode
1663 * with reset and activate the downloaded firmware patches.
1665 skb = __hci_cmd_sync(hdev, 0xfc11, sizeof(mfg_reset_activate),
1666 mfg_reset_activate, HCI_INIT_TIMEOUT);
1668 BT_ERR("%s exiting Intel manufacturer mode failed (%ld)",
1669 hdev->name, PTR_ERR(skb));
1670 return PTR_ERR(skb);
1674 BT_INFO("%s: Intel Bluetooth firmware patch completed and activated",
1677 btintel_check_bdaddr(hdev);
1681 /* Disable the manufacturer mode without reset */
1682 skb = __hci_cmd_sync(hdev, 0xfc11, sizeof(mfg_disable), mfg_disable,
1685 BT_ERR("%s exiting Intel manufacturer mode failed (%ld)",
1686 hdev->name, PTR_ERR(skb));
1687 return PTR_ERR(skb);
1691 BT_INFO("%s: Intel Bluetooth firmware patch completed", hdev->name);
1693 btintel_check_bdaddr(hdev);
1696 exit_mfg_deactivate:
1697 release_firmware(fw);
1699 /* Patching failed. Disable the manufacturer mode with reset and
1700 * deactivate the downloaded firmware patches.
1702 skb = __hci_cmd_sync(hdev, 0xfc11, sizeof(mfg_reset_deactivate),
1703 mfg_reset_deactivate, HCI_INIT_TIMEOUT);
1705 BT_ERR("%s exiting Intel manufacturer mode failed (%ld)",
1706 hdev->name, PTR_ERR(skb));
1707 return PTR_ERR(skb);
1711 BT_INFO("%s: Intel Bluetooth firmware patch completed and deactivated",
1714 btintel_check_bdaddr(hdev);
1718 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
1720 struct sk_buff *skb;
1721 struct hci_event_hdr *hdr;
1722 struct hci_ev_cmd_complete *evt;
1724 skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_ATOMIC);
1728 hdr = (struct hci_event_hdr *)skb_put(skb, sizeof(*hdr));
1729 hdr->evt = HCI_EV_CMD_COMPLETE;
1730 hdr->plen = sizeof(*evt) + 1;
1732 evt = (struct hci_ev_cmd_complete *)skb_put(skb, sizeof(*evt));
1734 evt->opcode = cpu_to_le16(opcode);
1736 *skb_put(skb, 1) = 0x00;
1738 bt_cb(skb)->pkt_type = HCI_EVENT_PKT;
1740 return hci_recv_frame(hdev, skb);
1743 static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
1746 /* When the device is in bootloader mode, then it can send
1747 * events via the bulk endpoint. These events are treated the
1748 * same way as the ones received from the interrupt endpoint.
1750 if (test_bit(BTUSB_BOOTLOADER, &data->flags))
1751 return btusb_recv_intr(data, buffer, count);
1753 return btusb_recv_bulk(data, buffer, count);
1756 static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
1759 const struct intel_bootup *evt = ptr;
1761 if (len != sizeof(*evt))
1764 if (test_and_clear_bit(BTUSB_BOOTING, &data->flags)) {
1765 smp_mb__after_atomic();
1766 wake_up_bit(&data->flags, BTUSB_BOOTING);
1770 static void btusb_intel_secure_send_result(struct btusb_data *data,
1771 const void *ptr, unsigned int len)
1773 const struct intel_secure_send_result *evt = ptr;
1775 if (len != sizeof(*evt))
1779 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
1781 if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
1782 test_bit(BTUSB_FIRMWARE_LOADED, &data->flags)) {
1783 smp_mb__after_atomic();
1784 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
1788 static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
1790 struct btusb_data *data = hci_get_drvdata(hdev);
1792 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
1793 struct hci_event_hdr *hdr = (void *)skb->data;
1795 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
1797 const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
1798 unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
1800 switch (skb->data[2]) {
1802 /* When switching to the operational firmware
1803 * the device sends a vendor specific event
1804 * indicating that the bootup completed.
1806 btusb_intel_bootup(data, ptr, len);
1809 /* When the firmware loading completes the
1810 * device sends out a vendor specific event
1811 * indicating the result of the firmware
1814 btusb_intel_secure_send_result(data, ptr, len);
1820 return hci_recv_frame(hdev, skb);
1823 static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
1825 struct btusb_data *data = hci_get_drvdata(hdev);
1828 BT_DBG("%s", hdev->name);
1830 if (!test_bit(HCI_RUNNING, &hdev->flags))
1833 switch (bt_cb(skb)->pkt_type) {
1834 case HCI_COMMAND_PKT:
1835 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
1836 struct hci_command_hdr *cmd = (void *)skb->data;
1837 __u16 opcode = le16_to_cpu(cmd->opcode);
1839 /* When in bootloader mode and the command 0xfc09
1840 * is received, it needs to be send down the
1841 * bulk endpoint. So allocate a bulk URB instead.
1843 if (opcode == 0xfc09)
1844 urb = alloc_bulk_urb(hdev, skb);
1846 urb = alloc_ctrl_urb(hdev, skb);
1848 /* When the 0xfc01 command is issued to boot into
1849 * the operational firmware, it will actually not
1850 * send a command complete event. To keep the flow
1851 * control working inject that event here.
1853 if (opcode == 0xfc01)
1854 inject_cmd_complete(hdev, opcode);
1856 urb = alloc_ctrl_urb(hdev, skb);
1859 return PTR_ERR(urb);
1861 hdev->stat.cmd_tx++;
1862 return submit_or_queue_tx_urb(hdev, urb);
1864 case HCI_ACLDATA_PKT:
1865 urb = alloc_bulk_urb(hdev, skb);
1867 return PTR_ERR(urb);
1869 hdev->stat.acl_tx++;
1870 return submit_or_queue_tx_urb(hdev, urb);
1872 case HCI_SCODATA_PKT:
1873 if (hci_conn_num(hdev, SCO_LINK) < 1)
1876 urb = alloc_isoc_urb(hdev, skb);
1878 return PTR_ERR(urb);
1880 hdev->stat.sco_tx++;
1881 return submit_tx_urb(hdev, urb);
1887 static int btusb_setup_intel_new(struct hci_dev *hdev)
1889 static const u8 reset_param[] = { 0x00, 0x01, 0x00, 0x01,
1890 0x00, 0x08, 0x04, 0x00 };
1891 struct btusb_data *data = hci_get_drvdata(hdev);
1892 struct sk_buff *skb;
1893 struct intel_version *ver;
1894 struct intel_boot_params *params;
1895 const struct firmware *fw;
1899 ktime_t calltime, delta, rettime;
1900 unsigned long long duration;
1903 BT_DBG("%s", hdev->name);
1905 calltime = ktime_get();
1907 /* Read the Intel version information to determine if the device
1908 * is in bootloader mode or if it already has operational firmware
1911 skb = __hci_cmd_sync(hdev, 0xfc05, 0, NULL, HCI_INIT_TIMEOUT);
1913 BT_ERR("%s: Reading Intel version information failed (%ld)",
1914 hdev->name, PTR_ERR(skb));
1915 return PTR_ERR(skb);
1918 if (skb->len != sizeof(*ver)) {
1919 BT_ERR("%s: Intel version event size mismatch", hdev->name);
1924 ver = (struct intel_version *)skb->data;
1926 /* The hardware platform number has a fixed value of 0x37 and
1927 * for now only accept this single value.
1929 if (ver->hw_platform != 0x37) {
1930 BT_ERR("%s: Unsupported Intel hardware platform (%u)",
1931 hdev->name, ver->hw_platform);
1936 /* At the moment only the hardware variant iBT 3.0 (LnP/SfP) is
1937 * supported by this firmware loading method. This check has been
1938 * put in place to ensure correct forward compatibility options
1939 * when newer hardware variants come along.
1941 if (ver->hw_variant != 0x0b) {
1942 BT_ERR("%s: Unsupported Intel hardware variant (%u)",
1943 hdev->name, ver->hw_variant);
1948 btintel_version_info(hdev, ver);
1950 /* The firmware variant determines if the device is in bootloader
1951 * mode or is running operational firmware. The value 0x06 identifies
1952 * the bootloader and the value 0x23 identifies the operational
1955 * When the operational firmware is already present, then only
1956 * the check for valid Bluetooth device address is needed. This
1957 * determines if the device will be added as configured or
1958 * unconfigured controller.
1960 * It is not possible to use the Secure Boot Parameters in this
1961 * case since that command is only available in bootloader mode.
1963 if (ver->fw_variant == 0x23) {
1965 clear_bit(BTUSB_BOOTLOADER, &data->flags);
1966 btintel_check_bdaddr(hdev);
1970 /* If the device is not in bootloader mode, then the only possible
1971 * choice is to return an error and abort the device initialization.
1973 if (ver->fw_variant != 0x06) {
1974 BT_ERR("%s: Unsupported Intel firmware variant (%u)",
1975 hdev->name, ver->fw_variant);
1982 /* Read the secure boot parameters to identify the operating
1983 * details of the bootloader.
1985 skb = __hci_cmd_sync(hdev, 0xfc0d, 0, NULL, HCI_INIT_TIMEOUT);
1987 BT_ERR("%s: Reading Intel boot parameters failed (%ld)",
1988 hdev->name, PTR_ERR(skb));
1989 return PTR_ERR(skb);
1992 if (skb->len != sizeof(*params)) {
1993 BT_ERR("%s: Intel boot parameters size mismatch", hdev->name);
1998 params = (struct intel_boot_params *)skb->data;
2000 BT_INFO("%s: Device revision is %u", hdev->name,
2001 le16_to_cpu(params->dev_revid));
2003 BT_INFO("%s: Secure boot is %s", hdev->name,
2004 params->secure_boot ? "enabled" : "disabled");
2006 BT_INFO("%s: Minimum firmware build %u week %u %u", hdev->name,
2007 params->min_fw_build_nn, params->min_fw_build_cw,
2008 2000 + params->min_fw_build_yy);
2010 /* It is required that every single firmware fragment is acknowledged
2011 * with a command complete event. If the boot parameters indicate
2012 * that this bootloader does not send them, then abort the setup.
2014 if (params->limited_cce != 0x00) {
2015 BT_ERR("%s: Unsupported Intel firmware loading method (%u)",
2016 hdev->name, params->limited_cce);
2021 /* If the OTP has no valid Bluetooth device address, then there will
2022 * also be no valid address for the operational firmware.
2024 if (!bacmp(¶ms->otp_bdaddr, BDADDR_ANY)) {
2025 BT_INFO("%s: No device address configured", hdev->name);
2026 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2029 /* With this Intel bootloader only the hardware variant and device
2030 * revision information are used to select the right firmware.
2032 * Currently this bootloader support is limited to hardware variant
2033 * iBT 3.0 (LnP/SfP) which is identified by the value 11 (0x0b).
2035 snprintf(fwname, sizeof(fwname), "intel/ibt-11-%u.sfi",
2036 le16_to_cpu(params->dev_revid));
2038 err = request_firmware(&fw, fwname, &hdev->dev);
2040 BT_ERR("%s: Failed to load Intel firmware file (%d)",
2046 BT_INFO("%s: Found device firmware: %s", hdev->name, fwname);
2048 /* Save the DDC file name for later use to apply once the firmware
2049 * downloading is done.
2051 snprintf(fwname, sizeof(fwname), "intel/ibt-11-%u.ddc",
2052 le16_to_cpu(params->dev_revid));
2056 if (fw->size < 644) {
2057 BT_ERR("%s: Invalid size of firmware file (%zu)",
2058 hdev->name, fw->size);
2063 set_bit(BTUSB_DOWNLOADING, &data->flags);
2065 /* Start the firmware download transaction with the Init fragment
2066 * represented by the 128 bytes of CSS header.
2068 err = btintel_secure_send(hdev, 0x00, 128, fw->data);
2070 BT_ERR("%s: Failed to send firmware header (%d)",
2075 /* Send the 256 bytes of public key information from the firmware
2076 * as the PKey fragment.
2078 err = btintel_secure_send(hdev, 0x03, 256, fw->data + 128);
2080 BT_ERR("%s: Failed to send firmware public key (%d)",
2085 /* Send the 256 bytes of signature information from the firmware
2086 * as the Sign fragment.
2088 err = btintel_secure_send(hdev, 0x02, 256, fw->data + 388);
2090 BT_ERR("%s: Failed to send firmware signature (%d)",
2095 fw_ptr = fw->data + 644;
2098 while (fw_ptr - fw->data < fw->size) {
2099 struct hci_command_hdr *cmd = (void *)(fw_ptr + frag_len);
2101 frag_len += sizeof(*cmd) + cmd->plen;
2103 /* The parameter length of the secure send command requires
2104 * a 4 byte alignment. It happens so that the firmware file
2105 * contains proper Intel_NOP commands to align the fragments
2108 * Send set of commands with 4 byte alignment from the
2109 * firmware data buffer as a single Data fragement.
2111 if (!(frag_len % 4)) {
2112 err = btintel_secure_send(hdev, 0x01, frag_len, fw_ptr);
2114 BT_ERR("%s: Failed to send firmware data (%d)",
2124 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2126 BT_INFO("%s: Waiting for firmware download to complete", hdev->name);
2128 /* Before switching the device into operational mode and with that
2129 * booting the loaded firmware, wait for the bootloader notification
2130 * that all fragments have been successfully received.
2132 * When the event processing receives the notification, then the
2133 * BTUSB_DOWNLOADING flag will be cleared.
2135 * The firmware loading should not take longer than 5 seconds
2136 * and thus just timeout if that happens and fail the setup
2139 err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2141 msecs_to_jiffies(5000));
2143 BT_ERR("%s: Firmware loading interrupted", hdev->name);
2149 BT_ERR("%s: Firmware loading timeout", hdev->name);
2154 if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2155 BT_ERR("%s: Firmware loading failed", hdev->name);
2160 rettime = ktime_get();
2161 delta = ktime_sub(rettime, calltime);
2162 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2164 BT_INFO("%s: Firmware loaded in %llu usecs", hdev->name, duration);
2167 release_firmware(fw);
2172 calltime = ktime_get();
2174 set_bit(BTUSB_BOOTING, &data->flags);
2176 skb = __hci_cmd_sync(hdev, 0xfc01, sizeof(reset_param), reset_param,
2179 return PTR_ERR(skb);
2183 /* The bootloader will not indicate when the device is ready. This
2184 * is done by the operational firmware sending bootup notification.
2186 * Booting into operational firmware should not take longer than
2187 * 1 second. However if that happens, then just fail the setup
2188 * since something went wrong.
2190 BT_INFO("%s: Waiting for device to boot", hdev->name);
2192 err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2194 msecs_to_jiffies(1000));
2197 BT_ERR("%s: Device boot interrupted", hdev->name);
2202 BT_ERR("%s: Device boot timeout", hdev->name);
2206 rettime = ktime_get();
2207 delta = ktime_sub(rettime, calltime);
2208 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2210 BT_INFO("%s: Device booted in %llu usecs", hdev->name, duration);
2212 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2214 /* Once the device is running in operational mode, it needs to apply
2215 * the device configuration (DDC) parameters.
2217 * The device can work without DDC parameters, so even if it fails
2218 * to load the file, no need to fail the setup.
2220 err = request_firmware_direct(&fw, fwname, &hdev->dev);
2224 BT_INFO("%s: Found Intel DDC parameters: %s", hdev->name, fwname);
2228 /* DDC file contains one or more DDC structure which has
2229 * Length (1 byte), DDC ID (2 bytes), and DDC value (Length - 2).
2231 while (fw->size > fw_ptr - fw->data) {
2232 u8 cmd_plen = fw_ptr[0] + sizeof(u8);
2234 skb = __hci_cmd_sync(hdev, 0xfc8b, cmd_plen, fw_ptr,
2237 BT_ERR("%s: Failed to send Intel_Write_DDC (%ld)",
2238 hdev->name, PTR_ERR(skb));
2239 release_firmware(fw);
2240 return PTR_ERR(skb);
2247 release_firmware(fw);
2249 BT_INFO("%s: Applying Intel DDC parameters completed", hdev->name);
2254 static int btusb_shutdown_intel(struct hci_dev *hdev)
2256 struct sk_buff *skb;
2259 /* Some platforms have an issue with BT LED when the interface is
2260 * down or BT radio is turned off, which takes 5 seconds to BT LED
2261 * goes off. This command turns off the BT LED immediately.
2263 skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
2266 BT_ERR("%s: turning off Intel device LED failed (%ld)",
2275 static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
2276 const bdaddr_t *bdaddr)
2278 struct sk_buff *skb;
2283 buf[1] = sizeof(bdaddr_t);
2284 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
2286 skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
2289 BT_ERR("%s: changing Marvell device address failed (%ld)",
2298 static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
2299 const bdaddr_t *bdaddr)
2301 struct sk_buff *skb;
2308 buf[3] = sizeof(bdaddr_t);
2309 memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
2311 skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
2314 BT_ERR("%s: Change address command failed (%ld)",
2323 #define QCA_DFU_PACKET_LEN 4096
2325 #define QCA_GET_TARGET_VERSION 0x09
2326 #define QCA_CHECK_STATUS 0x05
2327 #define QCA_DFU_DOWNLOAD 0x01
2329 #define QCA_SYSCFG_UPDATED 0x40
2330 #define QCA_PATCH_UPDATED 0x80
2331 #define QCA_DFU_TIMEOUT 3000
2333 struct qca_version {
2335 __le32 patch_version;
2341 struct qca_rampatch_version {
2343 __le16 patch_version;
2346 struct qca_device_info {
2348 u8 rampatch_hdr; /* length of header in rampatch */
2349 u8 nvm_hdr; /* length of header in NVM */
2350 u8 ver_offset; /* offset of version structure in rampatch */
2353 static const struct qca_device_info qca_devices_table[] = {
2354 { 0x00000100, 20, 4, 10 }, /* Rome 1.0 */
2355 { 0x00000101, 20, 4, 10 }, /* Rome 1.1 */
2356 { 0x00000200, 28, 4, 18 }, /* Rome 2.0 */
2357 { 0x00000201, 28, 4, 18 }, /* Rome 2.1 */
2358 { 0x00000300, 28, 4, 18 }, /* Rome 3.0 */
2359 { 0x00000302, 28, 4, 18 }, /* Rome 3.2 */
2362 static int btusb_qca_send_vendor_req(struct hci_dev *hdev, u8 request,
2363 void *data, u16 size)
2365 struct btusb_data *btdata = hci_get_drvdata(hdev);
2366 struct usb_device *udev = btdata->udev;
2370 buf = kmalloc(size, GFP_KERNEL);
2374 /* Found some of USB hosts have IOT issues with ours so that we should
2375 * not wait until HCI layer is ready.
2377 pipe = usb_rcvctrlpipe(udev, 0);
2378 err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
2379 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
2381 BT_ERR("%s: Failed to access otp area (%d)", hdev->name, err);
2385 memcpy(data, buf, size);
2393 static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
2394 const struct firmware *firmware,
2397 struct btusb_data *btdata = hci_get_drvdata(hdev);
2398 struct usb_device *udev = btdata->udev;
2399 size_t count, size, sent = 0;
2403 buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
2407 count = firmware->size;
2409 size = min_t(size_t, count, hdr_size);
2410 memcpy(buf, firmware->data, size);
2412 /* USB patches should go down to controller through USB path
2413 * because binary format fits to go down through USB channel.
2414 * USB control path is for patching headers and USB bulk is for
2417 pipe = usb_sndctrlpipe(udev, 0);
2418 err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
2419 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
2421 BT_ERR("%s: Failed to send headers (%d)", hdev->name, err);
2429 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
2431 memcpy(buf, firmware->data + sent, size);
2433 pipe = usb_sndbulkpipe(udev, 0x02);
2434 err = usb_bulk_msg(udev, pipe, buf, size, &len,
2437 BT_ERR("%s: Failed to send body at %zd of %zd (%d)",
2438 hdev->name, sent, firmware->size, err);
2443 BT_ERR("%s: Failed to get bulk buffer", hdev->name);
2457 static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
2458 struct qca_version *ver,
2459 const struct qca_device_info *info)
2461 struct qca_rampatch_version *rver;
2462 const struct firmware *fw;
2463 u32 ver_rom, ver_patch;
2464 u16 rver_rom, rver_patch;
2468 ver_rom = le32_to_cpu(ver->rom_version);
2469 ver_patch = le32_to_cpu(ver->patch_version);
2471 snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
2473 err = request_firmware(&fw, fwname, &hdev->dev);
2475 BT_ERR("%s: failed to request rampatch file: %s (%d)",
2476 hdev->name, fwname, err);
2480 BT_INFO("%s: using rampatch file: %s", hdev->name, fwname);
2482 rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
2483 rver_rom = le16_to_cpu(rver->rom_version);
2484 rver_patch = le16_to_cpu(rver->patch_version);
2486 BT_INFO("%s: QCA: patch rome 0x%x build 0x%x, firmware rome 0x%x "
2487 "build 0x%x", hdev->name, rver_rom, rver_patch, ver_rom,
2490 if (rver_rom != ver_rom || rver_patch <= ver_patch) {
2491 BT_ERR("%s: rampatch file version did not match with firmware",
2497 err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
2500 release_firmware(fw);
2505 static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
2506 struct qca_version *ver,
2507 const struct qca_device_info *info)
2509 const struct firmware *fw;
2513 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
2514 le32_to_cpu(ver->rom_version));
2516 err = request_firmware(&fw, fwname, &hdev->dev);
2518 BT_ERR("%s: failed to request NVM file: %s (%d)",
2519 hdev->name, fwname, err);
2523 BT_INFO("%s: using NVM file: %s", hdev->name, fwname);
2525 err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
2527 release_firmware(fw);
2532 static int btusb_setup_qca(struct hci_dev *hdev)
2534 const struct qca_device_info *info = NULL;
2535 struct qca_version ver;
2540 err = btusb_qca_send_vendor_req(hdev, QCA_GET_TARGET_VERSION, &ver,
2545 ver_rom = le32_to_cpu(ver.rom_version);
2546 for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
2547 if (ver_rom == qca_devices_table[i].rom_version)
2548 info = &qca_devices_table[i];
2551 BT_ERR("%s: don't support firmware rome 0x%x", hdev->name,
2556 err = btusb_qca_send_vendor_req(hdev, QCA_CHECK_STATUS, &status,
2561 if (!(status & QCA_PATCH_UPDATED)) {
2562 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
2567 if (!(status & QCA_SYSCFG_UPDATED)) {
2568 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
2576 static int btusb_probe(struct usb_interface *intf,
2577 const struct usb_device_id *id)
2579 struct usb_endpoint_descriptor *ep_desc;
2580 struct btusb_data *data;
2581 struct hci_dev *hdev;
2584 BT_DBG("intf %p id %p", intf, id);
2586 /* interface numbers are hardcoded in the spec */
2587 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
2590 if (!id->driver_info) {
2591 const struct usb_device_id *match;
2593 match = usb_match_id(intf, blacklist_table);
2598 if (id->driver_info == BTUSB_IGNORE)
2601 if (id->driver_info & BTUSB_ATH3012) {
2602 struct usb_device *udev = interface_to_usbdev(intf);
2604 /* Old firmware would otherwise let ath3k driver load
2605 * patch and sysconfig files */
2606 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001)
2610 data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
2614 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
2615 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
2617 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
2618 data->intr_ep = ep_desc;
2622 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
2623 data->bulk_tx_ep = ep_desc;
2627 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
2628 data->bulk_rx_ep = ep_desc;
2633 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
2636 if (id->driver_info & BTUSB_AMP) {
2637 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
2638 data->cmdreq = 0x2b;
2640 data->cmdreq_type = USB_TYPE_CLASS;
2641 data->cmdreq = 0x00;
2644 data->udev = interface_to_usbdev(intf);
2647 INIT_WORK(&data->work, btusb_work);
2648 INIT_WORK(&data->waker, btusb_waker);
2649 init_usb_anchor(&data->deferred);
2650 init_usb_anchor(&data->tx_anchor);
2651 spin_lock_init(&data->txlock);
2653 init_usb_anchor(&data->intr_anchor);
2654 init_usb_anchor(&data->bulk_anchor);
2655 init_usb_anchor(&data->isoc_anchor);
2656 spin_lock_init(&data->rxlock);
2658 if (id->driver_info & BTUSB_INTEL_NEW) {
2659 data->recv_event = btusb_recv_event_intel;
2660 data->recv_bulk = btusb_recv_bulk_intel;
2661 set_bit(BTUSB_BOOTLOADER, &data->flags);
2663 data->recv_event = hci_recv_frame;
2664 data->recv_bulk = btusb_recv_bulk;
2667 hdev = hci_alloc_dev();
2671 hdev->bus = HCI_USB;
2672 hci_set_drvdata(hdev, data);
2674 if (id->driver_info & BTUSB_AMP)
2675 hdev->dev_type = HCI_AMP;
2677 hdev->dev_type = HCI_BREDR;
2681 SET_HCIDEV_DEV(hdev, &intf->dev);
2683 hdev->open = btusb_open;
2684 hdev->close = btusb_close;
2685 hdev->flush = btusb_flush;
2686 hdev->send = btusb_send_frame;
2687 hdev->notify = btusb_notify;
2689 if (id->driver_info & BTUSB_BCM92035)
2690 hdev->setup = btusb_setup_bcm92035;
2692 #ifdef CONFIG_BT_HCIBTUSB_BCM
2693 if (id->driver_info & BTUSB_BCM_PATCHRAM) {
2694 hdev->setup = btbcm_setup_patchram;
2695 hdev->set_bdaddr = btbcm_set_bdaddr;
2698 if (id->driver_info & BTUSB_BCM_APPLE)
2699 hdev->setup = btbcm_setup_apple;
2702 if (id->driver_info & BTUSB_INTEL) {
2703 hdev->setup = btusb_setup_intel;
2704 hdev->shutdown = btusb_shutdown_intel;
2705 hdev->set_bdaddr = btintel_set_bdaddr;
2706 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
2707 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
2710 if (id->driver_info & BTUSB_INTEL_NEW) {
2711 hdev->send = btusb_send_frame_intel;
2712 hdev->setup = btusb_setup_intel_new;
2713 hdev->hw_error = btintel_hw_error;
2714 hdev->set_bdaddr = btintel_set_bdaddr;
2715 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
2718 if (id->driver_info & BTUSB_MARVELL)
2719 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
2721 if (id->driver_info & BTUSB_SWAVE) {
2722 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
2723 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
2726 if (id->driver_info & BTUSB_INTEL_BOOT)
2727 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
2729 if (id->driver_info & BTUSB_ATH3012) {
2730 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
2731 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
2732 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
2735 if (id->driver_info & BTUSB_QCA_ROME) {
2736 data->setup_on_usb = btusb_setup_qca;
2737 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
2740 #ifdef CONFIG_BT_HCIBTUSB_RTL
2741 if (id->driver_info & BTUSB_REALTEK) {
2742 hdev->setup = btrtl_setup_realtek;
2744 /* Realtek devices lose their updated firmware over suspend,
2745 * but the USB hub doesn't notice any status change.
2746 * Explicitly request a device reset on resume.
2748 set_bit(BTUSB_RESET_RESUME, &data->flags);
2752 if (id->driver_info & BTUSB_AMP) {
2753 /* AMP controllers do not support SCO packets */
2756 /* Interface numbers are hardcoded in the specification */
2757 data->isoc = usb_ifnum_to_if(data->udev, 1);
2761 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
2763 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
2764 if (!disable_scofix)
2765 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
2768 if (id->driver_info & BTUSB_BROKEN_ISOC)
2771 if (id->driver_info & BTUSB_DIGIANSWER) {
2772 data->cmdreq_type = USB_TYPE_VENDOR;
2773 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
2776 if (id->driver_info & BTUSB_CSR) {
2777 struct usb_device *udev = data->udev;
2778 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2780 /* Old firmware would otherwise execute USB reset */
2781 if (bcdDevice < 0x117)
2782 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
2784 /* Fake CSR devices with broken commands */
2785 if (bcdDevice <= 0x100)
2786 hdev->setup = btusb_setup_csr;
2788 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
2791 if (id->driver_info & BTUSB_SNIFFER) {
2792 struct usb_device *udev = data->udev;
2794 /* New sniffer firmware has crippled HCI interface */
2795 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
2796 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
2799 if (id->driver_info & BTUSB_INTEL_BOOT) {
2800 /* A bug in the bootloader causes that interrupt interface is
2801 * only enabled after receiving SetInterface(0, AltSetting=0).
2803 err = usb_set_interface(data->udev, 0, 0);
2805 BT_ERR("failed to set interface 0, alt 0 %d", err);
2812 err = usb_driver_claim_interface(&btusb_driver,
2820 err = hci_register_dev(hdev);
2826 usb_set_intfdata(intf, data);
2831 static void btusb_disconnect(struct usb_interface *intf)
2833 struct btusb_data *data = usb_get_intfdata(intf);
2834 struct hci_dev *hdev;
2836 BT_DBG("intf %p", intf);
2842 usb_set_intfdata(data->intf, NULL);
2845 usb_set_intfdata(data->isoc, NULL);
2847 hci_unregister_dev(hdev);
2849 if (intf == data->isoc)
2850 usb_driver_release_interface(&btusb_driver, data->intf);
2851 else if (data->isoc)
2852 usb_driver_release_interface(&btusb_driver, data->isoc);
2858 static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
2860 struct btusb_data *data = usb_get_intfdata(intf);
2862 BT_DBG("intf %p", intf);
2864 if (data->suspend_count++)
2867 spin_lock_irq(&data->txlock);
2868 if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
2869 set_bit(BTUSB_SUSPENDING, &data->flags);
2870 spin_unlock_irq(&data->txlock);
2872 spin_unlock_irq(&data->txlock);
2873 data->suspend_count--;
2877 cancel_work_sync(&data->work);
2879 btusb_stop_traffic(data);
2880 usb_kill_anchored_urbs(&data->tx_anchor);
2882 /* Optionally request a device reset on resume, but only when
2883 * wakeups are disabled. If wakeups are enabled we assume the
2884 * device will stay powered up throughout suspend.
2886 if (test_bit(BTUSB_RESET_RESUME, &data->flags) &&
2887 !device_may_wakeup(&data->udev->dev))
2888 data->udev->reset_resume = 1;
2893 static void play_deferred(struct btusb_data *data)
2898 while ((urb = usb_get_from_anchor(&data->deferred))) {
2899 err = usb_submit_urb(urb, GFP_ATOMIC);
2903 data->tx_in_flight++;
2905 usb_scuttle_anchored_urbs(&data->deferred);
2908 static int btusb_resume(struct usb_interface *intf)
2910 struct btusb_data *data = usb_get_intfdata(intf);
2911 struct hci_dev *hdev = data->hdev;
2914 BT_DBG("intf %p", intf);
2916 if (--data->suspend_count)
2919 if (!test_bit(HCI_RUNNING, &hdev->flags))
2922 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
2923 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
2925 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
2930 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
2931 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
2933 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
2937 btusb_submit_bulk_urb(hdev, GFP_NOIO);
2940 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
2941 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
2942 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
2944 btusb_submit_isoc_urb(hdev, GFP_NOIO);
2947 spin_lock_irq(&data->txlock);
2948 play_deferred(data);
2949 clear_bit(BTUSB_SUSPENDING, &data->flags);
2950 spin_unlock_irq(&data->txlock);
2951 schedule_work(&data->work);
2956 usb_scuttle_anchored_urbs(&data->deferred);
2958 spin_lock_irq(&data->txlock);
2959 clear_bit(BTUSB_SUSPENDING, &data->flags);
2960 spin_unlock_irq(&data->txlock);
2966 static struct usb_driver btusb_driver = {
2968 .probe = btusb_probe,
2969 .disconnect = btusb_disconnect,
2971 .suspend = btusb_suspend,
2972 .resume = btusb_resume,
2974 .id_table = btusb_table,
2975 .supports_autosuspend = 1,
2976 .disable_hub_initiated_lpm = 1,
2979 module_usb_driver(btusb_driver);
2981 module_param(disable_scofix, bool, 0644);
2982 MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
2984 module_param(force_scofix, bool, 0644);
2985 MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
2987 module_param(reset, bool, 0644);
2988 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
2991 MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
2992 MODULE_VERSION(VERSION);
2993 MODULE_LICENSE("GPL");