3 * Generic Bluetooth USB driver
5 * Copyright (C) 2005-2008 Marcel Holtmann <marcel@holtmann.org>
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 = 1;
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 /* Apple-specific (Broadcom) devices */
72 { USB_VENDOR_AND_INTERFACE_INFO(0x05ac, 0xff, 0x01, 0x01),
73 .driver_info = BTUSB_BCM_APPLE },
75 /* MediaTek MT76x0E */
76 { USB_DEVICE(0x0e8d, 0x763f) },
78 /* Broadcom SoftSailing reporting vendor specific */
79 { USB_DEVICE(0x0a5c, 0x21e1) },
81 /* Apple MacBookPro 7,1 */
82 { USB_DEVICE(0x05ac, 0x8213) },
85 { USB_DEVICE(0x05ac, 0x8215) },
87 /* Apple MacBookPro6,2 */
88 { USB_DEVICE(0x05ac, 0x8218) },
90 /* Apple MacBookAir3,1, MacBookAir3,2 */
91 { USB_DEVICE(0x05ac, 0x821b) },
93 /* Apple MacBookAir4,1 */
94 { USB_DEVICE(0x05ac, 0x821f) },
96 /* Apple MacBookPro8,2 */
97 { USB_DEVICE(0x05ac, 0x821a) },
99 /* Apple MacMini5,1 */
100 { USB_DEVICE(0x05ac, 0x8281) },
102 /* AVM BlueFRITZ! USB v2.0 */
103 { USB_DEVICE(0x057c, 0x3800), .driver_info = BTUSB_SWAVE },
105 /* Bluetooth Ultraport Module from IBM */
106 { USB_DEVICE(0x04bf, 0x030a) },
108 /* ALPS Modules with non-standard id */
109 { USB_DEVICE(0x044e, 0x3001) },
110 { USB_DEVICE(0x044e, 0x3002) },
112 /* Ericsson with non-standard id */
113 { USB_DEVICE(0x0bdb, 0x1002) },
115 /* Canyon CN-BTU1 with HID interfaces */
116 { USB_DEVICE(0x0c10, 0x0000) },
118 /* Broadcom BCM20702A0 */
119 { USB_DEVICE(0x413c, 0x8197) },
121 /* Broadcom BCM20702B0 (Dynex/Insignia) */
122 { USB_DEVICE(0x19ff, 0x0239), .driver_info = BTUSB_BCM_PATCHRAM },
124 /* Foxconn - Hon Hai */
125 { USB_VENDOR_AND_INTERFACE_INFO(0x0489, 0xff, 0x01, 0x01),
126 .driver_info = BTUSB_BCM_PATCHRAM },
128 /* Lite-On Technology - Broadcom based */
129 { USB_VENDOR_AND_INTERFACE_INFO(0x04ca, 0xff, 0x01, 0x01),
130 .driver_info = BTUSB_BCM_PATCHRAM },
132 /* Broadcom devices with vendor specific id */
133 { USB_VENDOR_AND_INTERFACE_INFO(0x0a5c, 0xff, 0x01, 0x01),
134 .driver_info = BTUSB_BCM_PATCHRAM },
136 /* ASUSTek Computer - Broadcom based */
137 { USB_VENDOR_AND_INTERFACE_INFO(0x0b05, 0xff, 0x01, 0x01),
138 .driver_info = BTUSB_BCM_PATCHRAM },
140 /* Belkin F8065bf - Broadcom based */
141 { USB_VENDOR_AND_INTERFACE_INFO(0x050d, 0xff, 0x01, 0x01),
142 .driver_info = BTUSB_BCM_PATCHRAM },
144 /* IMC Networks - Broadcom based */
145 { USB_VENDOR_AND_INTERFACE_INFO(0x13d3, 0xff, 0x01, 0x01),
146 .driver_info = BTUSB_BCM_PATCHRAM },
148 /* Intel Bluetooth USB Bootloader (RAM module) */
149 { USB_DEVICE(0x8087, 0x0a5a),
150 .driver_info = BTUSB_INTEL_BOOT | BTUSB_BROKEN_ISOC },
152 { } /* Terminating entry */
155 MODULE_DEVICE_TABLE(usb, btusb_table);
157 static const struct usb_device_id blacklist_table[] = {
158 /* CSR BlueCore devices */
159 { USB_DEVICE(0x0a12, 0x0001), .driver_info = BTUSB_CSR },
161 /* Broadcom BCM2033 without firmware */
162 { USB_DEVICE(0x0a5c, 0x2033), .driver_info = BTUSB_IGNORE },
164 /* Atheros 3011 with sflash firmware */
165 { USB_DEVICE(0x0489, 0xe027), .driver_info = BTUSB_IGNORE },
166 { USB_DEVICE(0x0489, 0xe03d), .driver_info = BTUSB_IGNORE },
167 { USB_DEVICE(0x04f2, 0xaff1), .driver_info = BTUSB_IGNORE },
168 { USB_DEVICE(0x0930, 0x0215), .driver_info = BTUSB_IGNORE },
169 { USB_DEVICE(0x0cf3, 0x3002), .driver_info = BTUSB_IGNORE },
170 { USB_DEVICE(0x0cf3, 0xe019), .driver_info = BTUSB_IGNORE },
171 { USB_DEVICE(0x13d3, 0x3304), .driver_info = BTUSB_IGNORE },
173 /* Atheros AR9285 Malbec with sflash firmware */
174 { USB_DEVICE(0x03f0, 0x311d), .driver_info = BTUSB_IGNORE },
176 /* Atheros 3012 with sflash firmware */
177 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
191 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
193 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
194 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
195 { USB_DEVICE(0x0cf3, 0x0036), .driver_info = BTUSB_ATH3012 },
196 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
197 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
198 { USB_DEVICE(0x0cf3, 0x311d), .driver_info = BTUSB_ATH3012 },
199 { USB_DEVICE(0x0cf3, 0x311e), .driver_info = BTUSB_ATH3012 },
200 { USB_DEVICE(0x0cf3, 0x311f), .driver_info = BTUSB_ATH3012 },
201 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
202 { USB_DEVICE(0x0cf3, 0x817a), .driver_info = BTUSB_ATH3012 },
203 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
204 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
205 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
206 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
207 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
208 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
209 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
210 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
211 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
212 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
214 /* Atheros AR5BBU12 with sflash firmware */
215 { USB_DEVICE(0x0489, 0xe02c), .driver_info = BTUSB_IGNORE },
217 /* Atheros AR5BBU12 with sflash firmware */
218 { USB_DEVICE(0x0489, 0xe036), .driver_info = BTUSB_ATH3012 },
219 { USB_DEVICE(0x0489, 0xe03c), .driver_info = BTUSB_ATH3012 },
221 /* QCA ROME chipset */
222 { USB_DEVICE(0x0cf3, 0xe300), .driver_info = BTUSB_QCA_ROME },
223 { USB_DEVICE(0x0cf3, 0xe360), .driver_info = BTUSB_QCA_ROME },
225 /* Broadcom BCM2035 */
226 { USB_DEVICE(0x0a5c, 0x2009), .driver_info = BTUSB_BCM92035 },
227 { USB_DEVICE(0x0a5c, 0x200a), .driver_info = BTUSB_WRONG_SCO_MTU },
228 { USB_DEVICE(0x0a5c, 0x2035), .driver_info = BTUSB_WRONG_SCO_MTU },
230 /* Broadcom BCM2045 */
231 { USB_DEVICE(0x0a5c, 0x2039), .driver_info = BTUSB_WRONG_SCO_MTU },
232 { USB_DEVICE(0x0a5c, 0x2101), .driver_info = BTUSB_WRONG_SCO_MTU },
234 /* IBM/Lenovo ThinkPad with Broadcom chip */
235 { USB_DEVICE(0x0a5c, 0x201e), .driver_info = BTUSB_WRONG_SCO_MTU },
236 { USB_DEVICE(0x0a5c, 0x2110), .driver_info = BTUSB_WRONG_SCO_MTU },
238 /* HP laptop with Broadcom chip */
239 { USB_DEVICE(0x03f0, 0x171d), .driver_info = BTUSB_WRONG_SCO_MTU },
241 /* Dell laptop with Broadcom chip */
242 { USB_DEVICE(0x413c, 0x8126), .driver_info = BTUSB_WRONG_SCO_MTU },
244 /* Dell Wireless 370 and 410 devices */
245 { USB_DEVICE(0x413c, 0x8152), .driver_info = BTUSB_WRONG_SCO_MTU },
246 { USB_DEVICE(0x413c, 0x8156), .driver_info = BTUSB_WRONG_SCO_MTU },
248 /* Belkin F8T012 and F8T013 devices */
249 { USB_DEVICE(0x050d, 0x0012), .driver_info = BTUSB_WRONG_SCO_MTU },
250 { USB_DEVICE(0x050d, 0x0013), .driver_info = BTUSB_WRONG_SCO_MTU },
252 /* Asus WL-BTD202 device */
253 { USB_DEVICE(0x0b05, 0x1715), .driver_info = BTUSB_WRONG_SCO_MTU },
255 /* Kensington Bluetooth USB adapter */
256 { USB_DEVICE(0x047d, 0x105e), .driver_info = BTUSB_WRONG_SCO_MTU },
258 /* RTX Telecom based adapters with buggy SCO support */
259 { USB_DEVICE(0x0400, 0x0807), .driver_info = BTUSB_BROKEN_ISOC },
260 { USB_DEVICE(0x0400, 0x080a), .driver_info = BTUSB_BROKEN_ISOC },
262 /* CONWISE Technology based adapters with buggy SCO support */
263 { USB_DEVICE(0x0e5e, 0x6622), .driver_info = BTUSB_BROKEN_ISOC },
265 /* Roper Class 1 Bluetooth Dongle (Silicon Wave based) */
266 { USB_DEVICE(0x1300, 0x0001), .driver_info = BTUSB_SWAVE },
268 /* Digianswer devices */
269 { USB_DEVICE(0x08fd, 0x0001), .driver_info = BTUSB_DIGIANSWER },
270 { USB_DEVICE(0x08fd, 0x0002), .driver_info = BTUSB_IGNORE },
272 /* CSR BlueCore Bluetooth Sniffer */
273 { USB_DEVICE(0x0a12, 0x0002),
274 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
276 /* Frontline ComProbe Bluetooth Sniffer */
277 { USB_DEVICE(0x16d3, 0x0002),
278 .driver_info = BTUSB_SNIFFER | BTUSB_BROKEN_ISOC },
280 /* Marvell Bluetooth devices */
281 { USB_DEVICE(0x1286, 0x2044), .driver_info = BTUSB_MARVELL },
282 { USB_DEVICE(0x1286, 0x2046), .driver_info = BTUSB_MARVELL },
284 /* Intel Bluetooth devices */
285 { USB_DEVICE(0x8087, 0x07da), .driver_info = BTUSB_CSR },
286 { USB_DEVICE(0x8087, 0x07dc), .driver_info = BTUSB_INTEL },
287 { USB_DEVICE(0x8087, 0x0a2a), .driver_info = BTUSB_INTEL },
288 { USB_DEVICE(0x8087, 0x0a2b), .driver_info = BTUSB_INTEL_NEW },
290 /* Other Intel Bluetooth devices */
291 { USB_VENDOR_AND_INTERFACE_INFO(0x8087, 0xe0, 0x01, 0x01),
292 .driver_info = BTUSB_IGNORE },
294 /* Realtek Bluetooth devices */
295 { USB_VENDOR_AND_INTERFACE_INFO(0x0bda, 0xe0, 0x01, 0x01),
296 .driver_info = BTUSB_REALTEK },
298 /* Additional Realtek 8723AE Bluetooth devices */
299 { USB_DEVICE(0x0930, 0x021d), .driver_info = BTUSB_REALTEK },
300 { USB_DEVICE(0x13d3, 0x3394), .driver_info = BTUSB_REALTEK },
302 /* Additional Realtek 8723BE Bluetooth devices */
303 { USB_DEVICE(0x0489, 0xe085), .driver_info = BTUSB_REALTEK },
304 { USB_DEVICE(0x0489, 0xe08b), .driver_info = BTUSB_REALTEK },
305 { USB_DEVICE(0x13d3, 0x3410), .driver_info = BTUSB_REALTEK },
306 { USB_DEVICE(0x13d3, 0x3416), .driver_info = BTUSB_REALTEK },
307 { USB_DEVICE(0x13d3, 0x3459), .driver_info = BTUSB_REALTEK },
309 /* Additional Realtek 8821AE Bluetooth devices */
310 { USB_DEVICE(0x0b05, 0x17dc), .driver_info = BTUSB_REALTEK },
311 { USB_DEVICE(0x13d3, 0x3414), .driver_info = BTUSB_REALTEK },
312 { USB_DEVICE(0x13d3, 0x3458), .driver_info = BTUSB_REALTEK },
313 { USB_DEVICE(0x13d3, 0x3461), .driver_info = BTUSB_REALTEK },
314 { USB_DEVICE(0x13d3, 0x3462), .driver_info = BTUSB_REALTEK },
316 { } /* Terminating entry */
319 #define BTUSB_MAX_ISOC_FRAMES 10
321 #define BTUSB_INTR_RUNNING 0
322 #define BTUSB_BULK_RUNNING 1
323 #define BTUSB_ISOC_RUNNING 2
324 #define BTUSB_SUSPENDING 3
325 #define BTUSB_DID_ISO_RESUME 4
326 #define BTUSB_BOOTLOADER 5
327 #define BTUSB_DOWNLOADING 6
328 #define BTUSB_FIRMWARE_LOADED 7
329 #define BTUSB_FIRMWARE_FAILED 8
330 #define BTUSB_BOOTING 9
333 struct hci_dev *hdev;
334 struct usb_device *udev;
335 struct usb_interface *intf;
336 struct usb_interface *isoc;
340 struct work_struct work;
341 struct work_struct waker;
343 struct usb_anchor deferred;
344 struct usb_anchor tx_anchor;
348 struct usb_anchor intr_anchor;
349 struct usb_anchor bulk_anchor;
350 struct usb_anchor isoc_anchor;
353 struct sk_buff *evt_skb;
354 struct sk_buff *acl_skb;
355 struct sk_buff *sco_skb;
357 struct usb_endpoint_descriptor *intr_ep;
358 struct usb_endpoint_descriptor *bulk_tx_ep;
359 struct usb_endpoint_descriptor *bulk_rx_ep;
360 struct usb_endpoint_descriptor *isoc_tx_ep;
361 struct usb_endpoint_descriptor *isoc_rx_ep;
366 unsigned int sco_num;
370 int (*recv_event)(struct hci_dev *hdev, struct sk_buff *skb);
371 int (*recv_bulk)(struct btusb_data *data, void *buffer, int count);
373 int (*setup_on_usb)(struct hci_dev *hdev);
376 static inline void btusb_free_frags(struct btusb_data *data)
380 spin_lock_irqsave(&data->rxlock, flags);
382 kfree_skb(data->evt_skb);
383 data->evt_skb = NULL;
385 kfree_skb(data->acl_skb);
386 data->acl_skb = NULL;
388 kfree_skb(data->sco_skb);
389 data->sco_skb = NULL;
391 spin_unlock_irqrestore(&data->rxlock, flags);
394 static int btusb_recv_intr(struct btusb_data *data, void *buffer, int count)
399 spin_lock(&data->rxlock);
406 skb = bt_skb_alloc(HCI_MAX_EVENT_SIZE, GFP_ATOMIC);
412 bt_cb(skb)->pkt_type = HCI_EVENT_PKT;
413 bt_cb(skb)->expect = HCI_EVENT_HDR_SIZE;
416 len = min_t(uint, bt_cb(skb)->expect, count);
417 memcpy(skb_put(skb, len), buffer, len);
421 bt_cb(skb)->expect -= len;
423 if (skb->len == HCI_EVENT_HDR_SIZE) {
424 /* Complete event header */
425 bt_cb(skb)->expect = hci_event_hdr(skb)->plen;
427 if (skb_tailroom(skb) < bt_cb(skb)->expect) {
436 if (bt_cb(skb)->expect == 0) {
438 data->recv_event(data->hdev, skb);
444 spin_unlock(&data->rxlock);
449 static int btusb_recv_bulk(struct btusb_data *data, void *buffer, int count)
454 spin_lock(&data->rxlock);
461 skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
467 bt_cb(skb)->pkt_type = HCI_ACLDATA_PKT;
468 bt_cb(skb)->expect = HCI_ACL_HDR_SIZE;
471 len = min_t(uint, bt_cb(skb)->expect, count);
472 memcpy(skb_put(skb, len), buffer, len);
476 bt_cb(skb)->expect -= len;
478 if (skb->len == HCI_ACL_HDR_SIZE) {
479 __le16 dlen = hci_acl_hdr(skb)->dlen;
481 /* Complete ACL header */
482 bt_cb(skb)->expect = __le16_to_cpu(dlen);
484 if (skb_tailroom(skb) < bt_cb(skb)->expect) {
493 if (bt_cb(skb)->expect == 0) {
495 hci_recv_frame(data->hdev, skb);
501 spin_unlock(&data->rxlock);
506 static int btusb_recv_isoc(struct btusb_data *data, void *buffer, int count)
511 spin_lock(&data->rxlock);
518 skb = bt_skb_alloc(HCI_MAX_SCO_SIZE, GFP_ATOMIC);
524 bt_cb(skb)->pkt_type = HCI_SCODATA_PKT;
525 bt_cb(skb)->expect = HCI_SCO_HDR_SIZE;
528 len = min_t(uint, bt_cb(skb)->expect, count);
529 memcpy(skb_put(skb, len), buffer, len);
533 bt_cb(skb)->expect -= len;
535 if (skb->len == HCI_SCO_HDR_SIZE) {
536 /* Complete SCO header */
537 bt_cb(skb)->expect = hci_sco_hdr(skb)->dlen;
539 if (skb_tailroom(skb) < bt_cb(skb)->expect) {
548 if (bt_cb(skb)->expect == 0) {
550 hci_recv_frame(data->hdev, skb);
556 spin_unlock(&data->rxlock);
561 static void btusb_intr_complete(struct urb *urb)
563 struct hci_dev *hdev = urb->context;
564 struct btusb_data *data = hci_get_drvdata(hdev);
567 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
570 if (!test_bit(HCI_RUNNING, &hdev->flags))
573 if (urb->status == 0) {
574 hdev->stat.byte_rx += urb->actual_length;
576 if (btusb_recv_intr(data, urb->transfer_buffer,
577 urb->actual_length) < 0) {
578 BT_ERR("%s corrupted event packet", hdev->name);
581 } else if (urb->status == -ENOENT) {
582 /* Avoid suspend failed when usb_kill_urb */
586 if (!test_bit(BTUSB_INTR_RUNNING, &data->flags))
589 usb_mark_last_busy(data->udev);
590 usb_anchor_urb(urb, &data->intr_anchor);
592 err = usb_submit_urb(urb, GFP_ATOMIC);
594 /* -EPERM: urb is being killed;
595 * -ENODEV: device got disconnected */
596 if (err != -EPERM && err != -ENODEV)
597 BT_ERR("%s urb %p failed to resubmit (%d)",
598 hdev->name, urb, -err);
599 usb_unanchor_urb(urb);
603 static int btusb_submit_intr_urb(struct hci_dev *hdev, gfp_t mem_flags)
605 struct btusb_data *data = hci_get_drvdata(hdev);
611 BT_DBG("%s", hdev->name);
616 urb = usb_alloc_urb(0, mem_flags);
620 size = le16_to_cpu(data->intr_ep->wMaxPacketSize);
622 buf = kmalloc(size, mem_flags);
628 pipe = usb_rcvintpipe(data->udev, data->intr_ep->bEndpointAddress);
630 usb_fill_int_urb(urb, data->udev, pipe, buf, size,
631 btusb_intr_complete, hdev, data->intr_ep->bInterval);
633 urb->transfer_flags |= URB_FREE_BUFFER;
635 usb_anchor_urb(urb, &data->intr_anchor);
637 err = usb_submit_urb(urb, mem_flags);
639 if (err != -EPERM && err != -ENODEV)
640 BT_ERR("%s urb %p submission failed (%d)",
641 hdev->name, urb, -err);
642 usb_unanchor_urb(urb);
650 static void btusb_bulk_complete(struct urb *urb)
652 struct hci_dev *hdev = urb->context;
653 struct btusb_data *data = hci_get_drvdata(hdev);
656 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
659 if (!test_bit(HCI_RUNNING, &hdev->flags))
662 if (urb->status == 0) {
663 hdev->stat.byte_rx += urb->actual_length;
665 if (data->recv_bulk(data, urb->transfer_buffer,
666 urb->actual_length) < 0) {
667 BT_ERR("%s corrupted ACL packet", hdev->name);
670 } else if (urb->status == -ENOENT) {
671 /* Avoid suspend failed when usb_kill_urb */
675 if (!test_bit(BTUSB_BULK_RUNNING, &data->flags))
678 usb_anchor_urb(urb, &data->bulk_anchor);
679 usb_mark_last_busy(data->udev);
681 err = usb_submit_urb(urb, GFP_ATOMIC);
683 /* -EPERM: urb is being killed;
684 * -ENODEV: device got disconnected */
685 if (err != -EPERM && err != -ENODEV)
686 BT_ERR("%s urb %p failed to resubmit (%d)",
687 hdev->name, urb, -err);
688 usb_unanchor_urb(urb);
692 static int btusb_submit_bulk_urb(struct hci_dev *hdev, gfp_t mem_flags)
694 struct btusb_data *data = hci_get_drvdata(hdev);
698 int err, size = HCI_MAX_FRAME_SIZE;
700 BT_DBG("%s", hdev->name);
702 if (!data->bulk_rx_ep)
705 urb = usb_alloc_urb(0, mem_flags);
709 buf = kmalloc(size, mem_flags);
715 pipe = usb_rcvbulkpipe(data->udev, data->bulk_rx_ep->bEndpointAddress);
717 usb_fill_bulk_urb(urb, data->udev, pipe, buf, size,
718 btusb_bulk_complete, hdev);
720 urb->transfer_flags |= URB_FREE_BUFFER;
722 usb_mark_last_busy(data->udev);
723 usb_anchor_urb(urb, &data->bulk_anchor);
725 err = usb_submit_urb(urb, mem_flags);
727 if (err != -EPERM && err != -ENODEV)
728 BT_ERR("%s urb %p submission failed (%d)",
729 hdev->name, urb, -err);
730 usb_unanchor_urb(urb);
738 static void btusb_isoc_complete(struct urb *urb)
740 struct hci_dev *hdev = urb->context;
741 struct btusb_data *data = hci_get_drvdata(hdev);
744 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
747 if (!test_bit(HCI_RUNNING, &hdev->flags))
750 if (urb->status == 0) {
751 for (i = 0; i < urb->number_of_packets; i++) {
752 unsigned int offset = urb->iso_frame_desc[i].offset;
753 unsigned int length = urb->iso_frame_desc[i].actual_length;
755 if (urb->iso_frame_desc[i].status)
758 hdev->stat.byte_rx += length;
760 if (btusb_recv_isoc(data, urb->transfer_buffer + offset,
762 BT_ERR("%s corrupted SCO packet", hdev->name);
766 } else if (urb->status == -ENOENT) {
767 /* Avoid suspend failed when usb_kill_urb */
771 if (!test_bit(BTUSB_ISOC_RUNNING, &data->flags))
774 usb_anchor_urb(urb, &data->isoc_anchor);
776 err = usb_submit_urb(urb, GFP_ATOMIC);
778 /* -EPERM: urb is being killed;
779 * -ENODEV: device got disconnected */
780 if (err != -EPERM && err != -ENODEV)
781 BT_ERR("%s urb %p failed to resubmit (%d)",
782 hdev->name, urb, -err);
783 usb_unanchor_urb(urb);
787 static inline void __fill_isoc_descriptor(struct urb *urb, int len, int mtu)
791 BT_DBG("len %d mtu %d", len, mtu);
793 for (i = 0; i < BTUSB_MAX_ISOC_FRAMES && len >= mtu;
794 i++, offset += mtu, len -= mtu) {
795 urb->iso_frame_desc[i].offset = offset;
796 urb->iso_frame_desc[i].length = mtu;
799 if (len && i < BTUSB_MAX_ISOC_FRAMES) {
800 urb->iso_frame_desc[i].offset = offset;
801 urb->iso_frame_desc[i].length = len;
805 urb->number_of_packets = i;
808 static int btusb_submit_isoc_urb(struct hci_dev *hdev, gfp_t mem_flags)
810 struct btusb_data *data = hci_get_drvdata(hdev);
816 BT_DBG("%s", hdev->name);
818 if (!data->isoc_rx_ep)
821 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, mem_flags);
825 size = le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize) *
826 BTUSB_MAX_ISOC_FRAMES;
828 buf = kmalloc(size, mem_flags);
834 pipe = usb_rcvisocpipe(data->udev, data->isoc_rx_ep->bEndpointAddress);
836 usb_fill_int_urb(urb, data->udev, pipe, buf, size, btusb_isoc_complete,
837 hdev, data->isoc_rx_ep->bInterval);
839 urb->transfer_flags = URB_FREE_BUFFER | URB_ISO_ASAP;
841 __fill_isoc_descriptor(urb, size,
842 le16_to_cpu(data->isoc_rx_ep->wMaxPacketSize));
844 usb_anchor_urb(urb, &data->isoc_anchor);
846 err = usb_submit_urb(urb, mem_flags);
848 if (err != -EPERM && err != -ENODEV)
849 BT_ERR("%s urb %p submission failed (%d)",
850 hdev->name, urb, -err);
851 usb_unanchor_urb(urb);
859 static void btusb_tx_complete(struct urb *urb)
861 struct sk_buff *skb = urb->context;
862 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
863 struct btusb_data *data = hci_get_drvdata(hdev);
865 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
868 if (!test_bit(HCI_RUNNING, &hdev->flags))
872 hdev->stat.byte_tx += urb->transfer_buffer_length;
877 spin_lock(&data->txlock);
878 data->tx_in_flight--;
879 spin_unlock(&data->txlock);
881 kfree(urb->setup_packet);
886 static void btusb_isoc_tx_complete(struct urb *urb)
888 struct sk_buff *skb = urb->context;
889 struct hci_dev *hdev = (struct hci_dev *)skb->dev;
891 BT_DBG("%s urb %p status %d count %d", hdev->name, urb, urb->status,
894 if (!test_bit(HCI_RUNNING, &hdev->flags))
898 hdev->stat.byte_tx += urb->transfer_buffer_length;
903 kfree(urb->setup_packet);
908 static int btusb_open(struct hci_dev *hdev)
910 struct btusb_data *data = hci_get_drvdata(hdev);
913 BT_DBG("%s", hdev->name);
915 /* Patching USB firmware files prior to starting any URBs of HCI path
916 * It is more safe to use USB bulk channel for downloading USB patch
918 if (data->setup_on_usb) {
919 err = data->setup_on_usb(hdev);
924 err = usb_autopm_get_interface(data->intf);
928 data->intf->needs_remote_wakeup = 1;
930 if (test_and_set_bit(HCI_RUNNING, &hdev->flags))
933 if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
936 err = btusb_submit_intr_urb(hdev, GFP_KERNEL);
940 err = btusb_submit_bulk_urb(hdev, GFP_KERNEL);
942 usb_kill_anchored_urbs(&data->intr_anchor);
946 set_bit(BTUSB_BULK_RUNNING, &data->flags);
947 btusb_submit_bulk_urb(hdev, GFP_KERNEL);
950 usb_autopm_put_interface(data->intf);
954 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
955 clear_bit(HCI_RUNNING, &hdev->flags);
956 usb_autopm_put_interface(data->intf);
960 static void btusb_stop_traffic(struct btusb_data *data)
962 usb_kill_anchored_urbs(&data->intr_anchor);
963 usb_kill_anchored_urbs(&data->bulk_anchor);
964 usb_kill_anchored_urbs(&data->isoc_anchor);
967 static int btusb_close(struct hci_dev *hdev)
969 struct btusb_data *data = hci_get_drvdata(hdev);
972 BT_DBG("%s", hdev->name);
974 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
977 cancel_work_sync(&data->work);
978 cancel_work_sync(&data->waker);
980 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
981 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
982 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
984 btusb_stop_traffic(data);
985 btusb_free_frags(data);
987 err = usb_autopm_get_interface(data->intf);
991 data->intf->needs_remote_wakeup = 0;
992 usb_autopm_put_interface(data->intf);
995 usb_scuttle_anchored_urbs(&data->deferred);
999 static int btusb_flush(struct hci_dev *hdev)
1001 struct btusb_data *data = hci_get_drvdata(hdev);
1003 BT_DBG("%s", hdev->name);
1005 usb_kill_anchored_urbs(&data->tx_anchor);
1006 btusb_free_frags(data);
1011 static struct urb *alloc_ctrl_urb(struct hci_dev *hdev, struct sk_buff *skb)
1013 struct btusb_data *data = hci_get_drvdata(hdev);
1014 struct usb_ctrlrequest *dr;
1018 urb = usb_alloc_urb(0, GFP_KERNEL);
1020 return ERR_PTR(-ENOMEM);
1022 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
1025 return ERR_PTR(-ENOMEM);
1028 dr->bRequestType = data->cmdreq_type;
1029 dr->bRequest = data->cmdreq;
1032 dr->wLength = __cpu_to_le16(skb->len);
1034 pipe = usb_sndctrlpipe(data->udev, 0x00);
1036 usb_fill_control_urb(urb, data->udev, pipe, (void *)dr,
1037 skb->data, skb->len, btusb_tx_complete, skb);
1039 skb->dev = (void *)hdev;
1044 static struct urb *alloc_bulk_urb(struct hci_dev *hdev, struct sk_buff *skb)
1046 struct btusb_data *data = hci_get_drvdata(hdev);
1050 if (!data->bulk_tx_ep)
1051 return ERR_PTR(-ENODEV);
1053 urb = usb_alloc_urb(0, GFP_KERNEL);
1055 return ERR_PTR(-ENOMEM);
1057 pipe = usb_sndbulkpipe(data->udev, data->bulk_tx_ep->bEndpointAddress);
1059 usb_fill_bulk_urb(urb, data->udev, pipe,
1060 skb->data, skb->len, btusb_tx_complete, skb);
1062 skb->dev = (void *)hdev;
1067 static struct urb *alloc_isoc_urb(struct hci_dev *hdev, struct sk_buff *skb)
1069 struct btusb_data *data = hci_get_drvdata(hdev);
1073 if (!data->isoc_tx_ep)
1074 return ERR_PTR(-ENODEV);
1076 urb = usb_alloc_urb(BTUSB_MAX_ISOC_FRAMES, GFP_KERNEL);
1078 return ERR_PTR(-ENOMEM);
1080 pipe = usb_sndisocpipe(data->udev, data->isoc_tx_ep->bEndpointAddress);
1082 usb_fill_int_urb(urb, data->udev, pipe,
1083 skb->data, skb->len, btusb_isoc_tx_complete,
1084 skb, data->isoc_tx_ep->bInterval);
1086 urb->transfer_flags = URB_ISO_ASAP;
1088 __fill_isoc_descriptor(urb, skb->len,
1089 le16_to_cpu(data->isoc_tx_ep->wMaxPacketSize));
1091 skb->dev = (void *)hdev;
1096 static int submit_tx_urb(struct hci_dev *hdev, struct urb *urb)
1098 struct btusb_data *data = hci_get_drvdata(hdev);
1101 usb_anchor_urb(urb, &data->tx_anchor);
1103 err = usb_submit_urb(urb, GFP_KERNEL);
1105 if (err != -EPERM && err != -ENODEV)
1106 BT_ERR("%s urb %p submission failed (%d)",
1107 hdev->name, urb, -err);
1108 kfree(urb->setup_packet);
1109 usb_unanchor_urb(urb);
1111 usb_mark_last_busy(data->udev);
1118 static int submit_or_queue_tx_urb(struct hci_dev *hdev, struct urb *urb)
1120 struct btusb_data *data = hci_get_drvdata(hdev);
1121 unsigned long flags;
1124 spin_lock_irqsave(&data->txlock, flags);
1125 suspending = test_bit(BTUSB_SUSPENDING, &data->flags);
1127 data->tx_in_flight++;
1128 spin_unlock_irqrestore(&data->txlock, flags);
1131 return submit_tx_urb(hdev, urb);
1133 usb_anchor_urb(urb, &data->deferred);
1134 schedule_work(&data->waker);
1140 static int btusb_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
1144 BT_DBG("%s", hdev->name);
1146 if (!test_bit(HCI_RUNNING, &hdev->flags))
1149 switch (bt_cb(skb)->pkt_type) {
1150 case HCI_COMMAND_PKT:
1151 urb = alloc_ctrl_urb(hdev, skb);
1153 return PTR_ERR(urb);
1155 hdev->stat.cmd_tx++;
1156 return submit_or_queue_tx_urb(hdev, urb);
1158 case HCI_ACLDATA_PKT:
1159 urb = alloc_bulk_urb(hdev, skb);
1161 return PTR_ERR(urb);
1163 hdev->stat.acl_tx++;
1164 return submit_or_queue_tx_urb(hdev, urb);
1166 case HCI_SCODATA_PKT:
1167 if (hci_conn_num(hdev, SCO_LINK) < 1)
1170 urb = alloc_isoc_urb(hdev, skb);
1172 return PTR_ERR(urb);
1174 hdev->stat.sco_tx++;
1175 return submit_tx_urb(hdev, urb);
1181 static void btusb_notify(struct hci_dev *hdev, unsigned int evt)
1183 struct btusb_data *data = hci_get_drvdata(hdev);
1185 BT_DBG("%s evt %d", hdev->name, evt);
1187 if (hci_conn_num(hdev, SCO_LINK) != data->sco_num) {
1188 data->sco_num = hci_conn_num(hdev, SCO_LINK);
1189 schedule_work(&data->work);
1193 static inline int __set_isoc_interface(struct hci_dev *hdev, int altsetting)
1195 struct btusb_data *data = hci_get_drvdata(hdev);
1196 struct usb_interface *intf = data->isoc;
1197 struct usb_endpoint_descriptor *ep_desc;
1203 err = usb_set_interface(data->udev, 1, altsetting);
1205 BT_ERR("%s setting interface failed (%d)", hdev->name, -err);
1209 data->isoc_altsetting = altsetting;
1211 data->isoc_tx_ep = NULL;
1212 data->isoc_rx_ep = NULL;
1214 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
1215 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
1217 if (!data->isoc_tx_ep && usb_endpoint_is_isoc_out(ep_desc)) {
1218 data->isoc_tx_ep = ep_desc;
1222 if (!data->isoc_rx_ep && usb_endpoint_is_isoc_in(ep_desc)) {
1223 data->isoc_rx_ep = ep_desc;
1228 if (!data->isoc_tx_ep || !data->isoc_rx_ep) {
1229 BT_ERR("%s invalid SCO descriptors", hdev->name);
1236 static void btusb_work(struct work_struct *work)
1238 struct btusb_data *data = container_of(work, struct btusb_data, work);
1239 struct hci_dev *hdev = data->hdev;
1243 if (data->sco_num > 0) {
1244 if (!test_bit(BTUSB_DID_ISO_RESUME, &data->flags)) {
1245 err = usb_autopm_get_interface(data->isoc ? data->isoc : data->intf);
1247 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1248 usb_kill_anchored_urbs(&data->isoc_anchor);
1252 set_bit(BTUSB_DID_ISO_RESUME, &data->flags);
1255 if (hdev->voice_setting & 0x0020) {
1256 static const int alts[3] = { 2, 4, 5 };
1258 new_alts = alts[data->sco_num - 1];
1260 new_alts = data->sco_num;
1263 if (data->isoc_altsetting != new_alts) {
1264 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1265 usb_kill_anchored_urbs(&data->isoc_anchor);
1267 if (__set_isoc_interface(hdev, new_alts) < 0)
1271 if (!test_and_set_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
1272 if (btusb_submit_isoc_urb(hdev, GFP_KERNEL) < 0)
1273 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1275 btusb_submit_isoc_urb(hdev, GFP_KERNEL);
1278 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
1279 usb_kill_anchored_urbs(&data->isoc_anchor);
1281 __set_isoc_interface(hdev, 0);
1282 if (test_and_clear_bit(BTUSB_DID_ISO_RESUME, &data->flags))
1283 usb_autopm_put_interface(data->isoc ? data->isoc : data->intf);
1287 static void btusb_waker(struct work_struct *work)
1289 struct btusb_data *data = container_of(work, struct btusb_data, waker);
1292 err = usb_autopm_get_interface(data->intf);
1296 usb_autopm_put_interface(data->intf);
1299 static struct sk_buff *btusb_read_local_version(struct hci_dev *hdev)
1301 struct sk_buff *skb;
1303 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
1306 BT_ERR("%s: HCI_OP_READ_LOCAL_VERSION failed (%ld)",
1307 hdev->name, PTR_ERR(skb));
1311 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
1312 BT_ERR("%s: HCI_OP_READ_LOCAL_VERSION event length mismatch",
1315 return ERR_PTR(-EIO);
1321 static int btusb_setup_bcm92035(struct hci_dev *hdev)
1323 struct sk_buff *skb;
1326 BT_DBG("%s", hdev->name);
1328 skb = __hci_cmd_sync(hdev, 0xfc3b, 1, &val, HCI_INIT_TIMEOUT);
1330 BT_ERR("BCM92035 command failed (%ld)", -PTR_ERR(skb));
1337 static int btusb_setup_csr(struct hci_dev *hdev)
1339 struct hci_rp_read_local_version *rp;
1340 struct sk_buff *skb;
1343 BT_DBG("%s", hdev->name);
1345 skb = btusb_read_local_version(hdev);
1347 return -PTR_ERR(skb);
1349 rp = (struct hci_rp_read_local_version *)skb->data;
1352 if (le16_to_cpu(rp->manufacturer) != 10) {
1353 /* Clear the reset quirk since this is not an actual
1354 * early Bluetooth 1.1 device from CSR.
1356 clear_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
1358 /* These fake CSR controllers have all a broken
1359 * stored link key handling and so just disable it.
1361 set_bit(HCI_QUIRK_BROKEN_STORED_LINK_KEY,
1366 ret = -bt_to_errno(rp->status);
1373 static const struct firmware *btusb_setup_intel_get_fw(struct hci_dev *hdev,
1374 struct intel_version *ver)
1376 const struct firmware *fw;
1380 snprintf(fwname, sizeof(fwname),
1381 "intel/ibt-hw-%x.%x.%x-fw-%x.%x.%x.%x.%x.bseq",
1382 ver->hw_platform, ver->hw_variant, ver->hw_revision,
1383 ver->fw_variant, ver->fw_revision, ver->fw_build_num,
1384 ver->fw_build_ww, ver->fw_build_yy);
1386 ret = request_firmware(&fw, fwname, &hdev->dev);
1388 if (ret == -EINVAL) {
1389 BT_ERR("%s Intel firmware file request failed (%d)",
1394 BT_ERR("%s failed to open Intel firmware file: %s(%d)",
1395 hdev->name, fwname, ret);
1397 /* If the correct firmware patch file is not found, use the
1398 * default firmware patch file instead
1400 snprintf(fwname, sizeof(fwname), "intel/ibt-hw-%x.%x.bseq",
1401 ver->hw_platform, ver->hw_variant);
1402 if (request_firmware(&fw, fwname, &hdev->dev) < 0) {
1403 BT_ERR("%s failed to open default Intel fw file: %s",
1404 hdev->name, fwname);
1409 BT_INFO("%s: Intel Bluetooth firmware file: %s", hdev->name, fwname);
1414 static int btusb_setup_intel_patching(struct hci_dev *hdev,
1415 const struct firmware *fw,
1416 const u8 **fw_ptr, int *disable_patch)
1418 struct sk_buff *skb;
1419 struct hci_command_hdr *cmd;
1420 const u8 *cmd_param;
1421 struct hci_event_hdr *evt = NULL;
1422 const u8 *evt_param = NULL;
1423 int remain = fw->size - (*fw_ptr - fw->data);
1425 /* The first byte indicates the types of the patch command or event.
1426 * 0x01 means HCI command and 0x02 is HCI event. If the first bytes
1427 * in the current firmware buffer doesn't start with 0x01 or
1428 * the size of remain buffer is smaller than HCI command header,
1429 * the firmware file is corrupted and it should stop the patching
1432 if (remain > HCI_COMMAND_HDR_SIZE && *fw_ptr[0] != 0x01) {
1433 BT_ERR("%s Intel fw corrupted: invalid cmd read", hdev->name);
1439 cmd = (struct hci_command_hdr *)(*fw_ptr);
1440 *fw_ptr += sizeof(*cmd);
1441 remain -= sizeof(*cmd);
1443 /* Ensure that the remain firmware data is long enough than the length
1444 * of command parameter. If not, the firmware file is corrupted.
1446 if (remain < cmd->plen) {
1447 BT_ERR("%s Intel fw corrupted: invalid cmd len", hdev->name);
1451 /* If there is a command that loads a patch in the firmware
1452 * file, then enable the patch upon success, otherwise just
1453 * disable the manufacturer mode, for example patch activation
1454 * is not required when the default firmware patch file is used
1455 * because there are no patch data to load.
1457 if (*disable_patch && le16_to_cpu(cmd->opcode) == 0xfc8e)
1460 cmd_param = *fw_ptr;
1461 *fw_ptr += cmd->plen;
1462 remain -= cmd->plen;
1464 /* This reads the expected events when the above command is sent to the
1465 * device. Some vendor commands expects more than one events, for
1466 * example command status event followed by vendor specific event.
1467 * For this case, it only keeps the last expected event. so the command
1468 * can be sent with __hci_cmd_sync_ev() which returns the sk_buff of
1469 * last expected event.
1471 while (remain > HCI_EVENT_HDR_SIZE && *fw_ptr[0] == 0x02) {
1475 evt = (struct hci_event_hdr *)(*fw_ptr);
1476 *fw_ptr += sizeof(*evt);
1477 remain -= sizeof(*evt);
1479 if (remain < evt->plen) {
1480 BT_ERR("%s Intel fw corrupted: invalid evt len",
1485 evt_param = *fw_ptr;
1486 *fw_ptr += evt->plen;
1487 remain -= evt->plen;
1490 /* Every HCI commands in the firmware file has its correspond event.
1491 * If event is not found or remain is smaller than zero, the firmware
1492 * file is corrupted.
1494 if (!evt || !evt_param || remain < 0) {
1495 BT_ERR("%s Intel fw corrupted: invalid evt read", hdev->name);
1499 skb = __hci_cmd_sync_ev(hdev, le16_to_cpu(cmd->opcode), cmd->plen,
1500 cmd_param, evt->evt, HCI_INIT_TIMEOUT);
1502 BT_ERR("%s sending Intel patch command (0x%4.4x) failed (%ld)",
1503 hdev->name, cmd->opcode, PTR_ERR(skb));
1504 return PTR_ERR(skb);
1507 /* It ensures that the returned event matches the event data read from
1508 * the firmware file. At fist, it checks the length and then
1509 * the contents of the event.
1511 if (skb->len != evt->plen) {
1512 BT_ERR("%s mismatch event length (opcode 0x%4.4x)", hdev->name,
1513 le16_to_cpu(cmd->opcode));
1518 if (memcmp(skb->data, evt_param, evt->plen)) {
1519 BT_ERR("%s mismatch event parameter (opcode 0x%4.4x)",
1520 hdev->name, le16_to_cpu(cmd->opcode));
1529 static int btusb_setup_intel(struct hci_dev *hdev)
1531 struct sk_buff *skb;
1532 const struct firmware *fw;
1535 struct intel_version *ver;
1537 const u8 mfg_enable[] = { 0x01, 0x00 };
1538 const u8 mfg_disable[] = { 0x00, 0x00 };
1539 const u8 mfg_reset_deactivate[] = { 0x00, 0x01 };
1540 const u8 mfg_reset_activate[] = { 0x00, 0x02 };
1542 BT_DBG("%s", hdev->name);
1544 /* The controller has a bug with the first HCI command sent to it
1545 * returning number of completed commands as zero. This would stall the
1546 * command processing in the Bluetooth core.
1548 * As a workaround, send HCI Reset command first which will reset the
1549 * number of completed commands and allow normal command processing
1552 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
1554 BT_ERR("%s sending initial HCI reset command failed (%ld)",
1555 hdev->name, PTR_ERR(skb));
1556 return PTR_ERR(skb);
1560 /* Read Intel specific controller version first to allow selection of
1561 * which firmware file to load.
1563 * The returned information are hardware variant and revision plus
1564 * firmware variant, revision and build number.
1566 skb = __hci_cmd_sync(hdev, 0xfc05, 0, NULL, HCI_INIT_TIMEOUT);
1568 BT_ERR("%s reading Intel fw version command failed (%ld)",
1569 hdev->name, PTR_ERR(skb));
1570 return PTR_ERR(skb);
1573 if (skb->len != sizeof(*ver)) {
1574 BT_ERR("%s Intel version event length mismatch", hdev->name);
1579 ver = (struct intel_version *)skb->data;
1581 BT_ERR("%s Intel fw version event failed (%02x)", hdev->name,
1584 return -bt_to_errno(ver->status);
1587 BT_INFO("%s: read Intel version: %02x%02x%02x%02x%02x%02x%02x%02x%02x",
1588 hdev->name, ver->hw_platform, ver->hw_variant,
1589 ver->hw_revision, ver->fw_variant, ver->fw_revision,
1590 ver->fw_build_num, ver->fw_build_ww, ver->fw_build_yy,
1593 /* fw_patch_num indicates the version of patch the device currently
1594 * have. If there is no patch data in the device, it is always 0x00.
1595 * So, if it is other than 0x00, no need to patch the deivce again.
1597 if (ver->fw_patch_num) {
1598 BT_INFO("%s: Intel device is already patched. patch num: %02x",
1599 hdev->name, ver->fw_patch_num);
1601 btintel_check_bdaddr(hdev);
1605 /* Opens the firmware patch file based on the firmware version read
1606 * from the controller. If it fails to open the matching firmware
1607 * patch file, it tries to open the default firmware patch file.
1608 * If no patch file is found, allow the device to operate without
1611 fw = btusb_setup_intel_get_fw(hdev, ver);
1614 btintel_check_bdaddr(hdev);
1619 /* This Intel specific command enables the manufacturer mode of the
1622 * Only while this mode is enabled, the driver can download the
1623 * firmware patch data and configuration parameters.
1625 skb = __hci_cmd_sync(hdev, 0xfc11, 2, mfg_enable, HCI_INIT_TIMEOUT);
1627 BT_ERR("%s entering Intel manufacturer mode failed (%ld)",
1628 hdev->name, PTR_ERR(skb));
1629 release_firmware(fw);
1630 return PTR_ERR(skb);
1634 u8 evt_status = skb->data[0];
1636 BT_ERR("%s enable Intel manufacturer mode event failed (%02x)",
1637 hdev->name, evt_status);
1639 release_firmware(fw);
1640 return -bt_to_errno(evt_status);
1646 /* The firmware data file consists of list of Intel specific HCI
1647 * commands and its expected events. The first byte indicates the
1648 * type of the message, either HCI command or HCI event.
1650 * It reads the command and its expected event from the firmware file,
1651 * and send to the controller. Once __hci_cmd_sync_ev() returns,
1652 * the returned event is compared with the event read from the firmware
1653 * file and it will continue until all the messages are downloaded to
1656 * Once the firmware patching is completed successfully,
1657 * the manufacturer mode is disabled with reset and activating the
1660 * If the firmware patching fails, the manufacturer mode is
1661 * disabled with reset and deactivating the patch.
1663 * If the default patch file is used, no reset is done when disabling
1666 while (fw->size > fw_ptr - fw->data) {
1669 ret = btusb_setup_intel_patching(hdev, fw, &fw_ptr,
1672 goto exit_mfg_deactivate;
1675 release_firmware(fw);
1678 goto exit_mfg_disable;
1680 /* Patching completed successfully and disable the manufacturer mode
1681 * with reset and activate the downloaded firmware patches.
1683 skb = __hci_cmd_sync(hdev, 0xfc11, sizeof(mfg_reset_activate),
1684 mfg_reset_activate, HCI_INIT_TIMEOUT);
1686 BT_ERR("%s exiting Intel manufacturer mode failed (%ld)",
1687 hdev->name, PTR_ERR(skb));
1688 return PTR_ERR(skb);
1692 BT_INFO("%s: Intel Bluetooth firmware patch completed and activated",
1695 btintel_check_bdaddr(hdev);
1699 /* Disable the manufacturer mode without reset */
1700 skb = __hci_cmd_sync(hdev, 0xfc11, sizeof(mfg_disable), mfg_disable,
1703 BT_ERR("%s exiting Intel manufacturer mode failed (%ld)",
1704 hdev->name, PTR_ERR(skb));
1705 return PTR_ERR(skb);
1709 BT_INFO("%s: Intel Bluetooth firmware patch completed", hdev->name);
1711 btintel_check_bdaddr(hdev);
1714 exit_mfg_deactivate:
1715 release_firmware(fw);
1717 /* Patching failed. Disable the manufacturer mode with reset and
1718 * deactivate the downloaded firmware patches.
1720 skb = __hci_cmd_sync(hdev, 0xfc11, sizeof(mfg_reset_deactivate),
1721 mfg_reset_deactivate, HCI_INIT_TIMEOUT);
1723 BT_ERR("%s exiting Intel manufacturer mode failed (%ld)",
1724 hdev->name, PTR_ERR(skb));
1725 return PTR_ERR(skb);
1729 BT_INFO("%s: Intel Bluetooth firmware patch completed and deactivated",
1732 btintel_check_bdaddr(hdev);
1736 static int inject_cmd_complete(struct hci_dev *hdev, __u16 opcode)
1738 struct sk_buff *skb;
1739 struct hci_event_hdr *hdr;
1740 struct hci_ev_cmd_complete *evt;
1742 skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_ATOMIC);
1746 hdr = (struct hci_event_hdr *)skb_put(skb, sizeof(*hdr));
1747 hdr->evt = HCI_EV_CMD_COMPLETE;
1748 hdr->plen = sizeof(*evt) + 1;
1750 evt = (struct hci_ev_cmd_complete *)skb_put(skb, sizeof(*evt));
1752 evt->opcode = cpu_to_le16(opcode);
1754 *skb_put(skb, 1) = 0x00;
1756 bt_cb(skb)->pkt_type = HCI_EVENT_PKT;
1758 return hci_recv_frame(hdev, skb);
1761 static int btusb_recv_bulk_intel(struct btusb_data *data, void *buffer,
1764 /* When the device is in bootloader mode, then it can send
1765 * events via the bulk endpoint. These events are treated the
1766 * same way as the ones received from the interrupt endpoint.
1768 if (test_bit(BTUSB_BOOTLOADER, &data->flags))
1769 return btusb_recv_intr(data, buffer, count);
1771 return btusb_recv_bulk(data, buffer, count);
1774 static void btusb_intel_bootup(struct btusb_data *data, const void *ptr,
1777 const struct intel_bootup *evt = ptr;
1779 if (len != sizeof(*evt))
1782 if (test_and_clear_bit(BTUSB_BOOTING, &data->flags)) {
1783 smp_mb__after_atomic();
1784 wake_up_bit(&data->flags, BTUSB_BOOTING);
1788 static void btusb_intel_secure_send_result(struct btusb_data *data,
1789 const void *ptr, unsigned int len)
1791 const struct intel_secure_send_result *evt = ptr;
1793 if (len != sizeof(*evt))
1797 set_bit(BTUSB_FIRMWARE_FAILED, &data->flags);
1799 if (test_and_clear_bit(BTUSB_DOWNLOADING, &data->flags) &&
1800 test_bit(BTUSB_FIRMWARE_LOADED, &data->flags)) {
1801 smp_mb__after_atomic();
1802 wake_up_bit(&data->flags, BTUSB_DOWNLOADING);
1806 static int btusb_recv_event_intel(struct hci_dev *hdev, struct sk_buff *skb)
1808 struct btusb_data *data = hci_get_drvdata(hdev);
1810 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
1811 struct hci_event_hdr *hdr = (void *)skb->data;
1813 if (skb->len > HCI_EVENT_HDR_SIZE && hdr->evt == 0xff &&
1815 const void *ptr = skb->data + HCI_EVENT_HDR_SIZE + 1;
1816 unsigned int len = skb->len - HCI_EVENT_HDR_SIZE - 1;
1818 switch (skb->data[2]) {
1820 /* When switching to the operational firmware
1821 * the device sends a vendor specific event
1822 * indicating that the bootup completed.
1824 btusb_intel_bootup(data, ptr, len);
1827 /* When the firmware loading completes the
1828 * device sends out a vendor specific event
1829 * indicating the result of the firmware
1832 btusb_intel_secure_send_result(data, ptr, len);
1838 return hci_recv_frame(hdev, skb);
1841 static int btusb_send_frame_intel(struct hci_dev *hdev, struct sk_buff *skb)
1843 struct btusb_data *data = hci_get_drvdata(hdev);
1846 BT_DBG("%s", hdev->name);
1848 if (!test_bit(HCI_RUNNING, &hdev->flags))
1851 switch (bt_cb(skb)->pkt_type) {
1852 case HCI_COMMAND_PKT:
1853 if (test_bit(BTUSB_BOOTLOADER, &data->flags)) {
1854 struct hci_command_hdr *cmd = (void *)skb->data;
1855 __u16 opcode = le16_to_cpu(cmd->opcode);
1857 /* When in bootloader mode and the command 0xfc09
1858 * is received, it needs to be send down the
1859 * bulk endpoint. So allocate a bulk URB instead.
1861 if (opcode == 0xfc09)
1862 urb = alloc_bulk_urb(hdev, skb);
1864 urb = alloc_ctrl_urb(hdev, skb);
1866 /* When the 0xfc01 command is issued to boot into
1867 * the operational firmware, it will actually not
1868 * send a command complete event. To keep the flow
1869 * control working inject that event here.
1871 if (opcode == 0xfc01)
1872 inject_cmd_complete(hdev, opcode);
1874 urb = alloc_ctrl_urb(hdev, skb);
1877 return PTR_ERR(urb);
1879 hdev->stat.cmd_tx++;
1880 return submit_or_queue_tx_urb(hdev, urb);
1882 case HCI_ACLDATA_PKT:
1883 urb = alloc_bulk_urb(hdev, skb);
1885 return PTR_ERR(urb);
1887 hdev->stat.acl_tx++;
1888 return submit_or_queue_tx_urb(hdev, urb);
1890 case HCI_SCODATA_PKT:
1891 if (hci_conn_num(hdev, SCO_LINK) < 1)
1894 urb = alloc_isoc_urb(hdev, skb);
1896 return PTR_ERR(urb);
1898 hdev->stat.sco_tx++;
1899 return submit_tx_urb(hdev, urb);
1905 static int btusb_intel_secure_send(struct hci_dev *hdev, u8 fragment_type,
1906 u32 plen, const void *param)
1909 struct sk_buff *skb;
1910 u8 cmd_param[253], fragment_len = (plen > 252) ? 252 : plen;
1912 cmd_param[0] = fragment_type;
1913 memcpy(cmd_param + 1, param, fragment_len);
1915 skb = __hci_cmd_sync(hdev, 0xfc09, fragment_len + 1,
1916 cmd_param, HCI_INIT_TIMEOUT);
1918 return PTR_ERR(skb);
1922 plen -= fragment_len;
1923 param += fragment_len;
1929 static void btusb_intel_version_info(struct hci_dev *hdev,
1930 struct intel_version *ver)
1932 const char *variant;
1934 switch (ver->fw_variant) {
1936 variant = "Bootloader";
1939 variant = "Firmware";
1945 BT_INFO("%s: %s revision %u.%u build %u week %u %u", hdev->name,
1946 variant, ver->fw_revision >> 4, ver->fw_revision & 0x0f,
1947 ver->fw_build_num, ver->fw_build_ww, 2000 + ver->fw_build_yy);
1950 static int btusb_setup_intel_new(struct hci_dev *hdev)
1952 static const u8 reset_param[] = { 0x00, 0x01, 0x00, 0x01,
1953 0x00, 0x08, 0x04, 0x00 };
1954 struct btusb_data *data = hci_get_drvdata(hdev);
1955 struct sk_buff *skb;
1956 struct intel_version *ver;
1957 struct intel_boot_params *params;
1958 const struct firmware *fw;
1961 ktime_t calltime, delta, rettime;
1962 unsigned long long duration;
1965 BT_DBG("%s", hdev->name);
1967 calltime = ktime_get();
1969 /* Read the Intel version information to determine if the device
1970 * is in bootloader mode or if it already has operational firmware
1973 skb = __hci_cmd_sync(hdev, 0xfc05, 0, NULL, HCI_INIT_TIMEOUT);
1975 BT_ERR("%s: Reading Intel version information failed (%ld)",
1976 hdev->name, PTR_ERR(skb));
1977 return PTR_ERR(skb);
1980 if (skb->len != sizeof(*ver)) {
1981 BT_ERR("%s: Intel version event size mismatch", hdev->name);
1986 ver = (struct intel_version *)skb->data;
1988 BT_ERR("%s: Intel version command failure (%02x)",
1989 hdev->name, ver->status);
1990 err = -bt_to_errno(ver->status);
1995 /* The hardware platform number has a fixed value of 0x37 and
1996 * for now only accept this single value.
1998 if (ver->hw_platform != 0x37) {
1999 BT_ERR("%s: Unsupported Intel hardware platform (%u)",
2000 hdev->name, ver->hw_platform);
2005 /* At the moment only the hardware variant iBT 3.0 (LnP/SfP) is
2006 * supported by this firmware loading method. This check has been
2007 * put in place to ensure correct forward compatibility options
2008 * when newer hardware variants come along.
2010 if (ver->hw_variant != 0x0b) {
2011 BT_ERR("%s: Unsupported Intel hardware variant (%u)",
2012 hdev->name, ver->hw_variant);
2017 btusb_intel_version_info(hdev, ver);
2019 /* The firmware variant determines if the device is in bootloader
2020 * mode or is running operational firmware. The value 0x06 identifies
2021 * the bootloader and the value 0x23 identifies the operational
2024 * When the operational firmware is already present, then only
2025 * the check for valid Bluetooth device address is needed. This
2026 * determines if the device will be added as configured or
2027 * unconfigured controller.
2029 * It is not possible to use the Secure Boot Parameters in this
2030 * case since that command is only available in bootloader mode.
2032 if (ver->fw_variant == 0x23) {
2034 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2035 btintel_check_bdaddr(hdev);
2039 /* If the device is not in bootloader mode, then the only possible
2040 * choice is to return an error and abort the device initialization.
2042 if (ver->fw_variant != 0x06) {
2043 BT_ERR("%s: Unsupported Intel firmware variant (%u)",
2044 hdev->name, ver->fw_variant);
2051 /* Read the secure boot parameters to identify the operating
2052 * details of the bootloader.
2054 skb = __hci_cmd_sync(hdev, 0xfc0d, 0, NULL, HCI_INIT_TIMEOUT);
2056 BT_ERR("%s: Reading Intel boot parameters failed (%ld)",
2057 hdev->name, PTR_ERR(skb));
2058 return PTR_ERR(skb);
2061 if (skb->len != sizeof(*params)) {
2062 BT_ERR("%s: Intel boot parameters size mismatch", hdev->name);
2067 params = (struct intel_boot_params *)skb->data;
2068 if (params->status) {
2069 BT_ERR("%s: Intel boot parameters command failure (%02x)",
2070 hdev->name, params->status);
2071 err = -bt_to_errno(params->status);
2076 BT_INFO("%s: Device revision is %u", hdev->name,
2077 le16_to_cpu(params->dev_revid));
2079 BT_INFO("%s: Secure boot is %s", hdev->name,
2080 params->secure_boot ? "enabled" : "disabled");
2082 BT_INFO("%s: Minimum firmware build %u week %u %u", hdev->name,
2083 params->min_fw_build_nn, params->min_fw_build_cw,
2084 2000 + params->min_fw_build_yy);
2086 /* It is required that every single firmware fragment is acknowledged
2087 * with a command complete event. If the boot parameters indicate
2088 * that this bootloader does not send them, then abort the setup.
2090 if (params->limited_cce != 0x00) {
2091 BT_ERR("%s: Unsupported Intel firmware loading method (%u)",
2092 hdev->name, params->limited_cce);
2097 /* If the OTP has no valid Bluetooth device address, then there will
2098 * also be no valid address for the operational firmware.
2100 if (!bacmp(¶ms->otp_bdaddr, BDADDR_ANY)) {
2101 BT_INFO("%s: No device address configured", hdev->name);
2102 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
2105 /* With this Intel bootloader only the hardware variant and device
2106 * revision information are used to select the right firmware.
2108 * Currently this bootloader support is limited to hardware variant
2109 * iBT 3.0 (LnP/SfP) which is identified by the value 11 (0x0b).
2111 snprintf(fwname, sizeof(fwname), "intel/ibt-11-%u.sfi",
2112 le16_to_cpu(params->dev_revid));
2114 err = request_firmware(&fw, fwname, &hdev->dev);
2116 BT_ERR("%s: Failed to load Intel firmware file (%d)",
2122 BT_INFO("%s: Found device firmware: %s", hdev->name, fwname);
2126 if (fw->size < 644) {
2127 BT_ERR("%s: Invalid size of firmware file (%zu)",
2128 hdev->name, fw->size);
2133 set_bit(BTUSB_DOWNLOADING, &data->flags);
2135 /* Start the firmware download transaction with the Init fragment
2136 * represented by the 128 bytes of CSS header.
2138 err = btusb_intel_secure_send(hdev, 0x00, 128, fw->data);
2140 BT_ERR("%s: Failed to send firmware header (%d)",
2145 /* Send the 256 bytes of public key information from the firmware
2146 * as the PKey fragment.
2148 err = btusb_intel_secure_send(hdev, 0x03, 256, fw->data + 128);
2150 BT_ERR("%s: Failed to send firmware public key (%d)",
2155 /* Send the 256 bytes of signature information from the firmware
2156 * as the Sign fragment.
2158 err = btusb_intel_secure_send(hdev, 0x02, 256, fw->data + 388);
2160 BT_ERR("%s: Failed to send firmware signature (%d)",
2165 fw_ptr = fw->data + 644;
2167 while (fw_ptr - fw->data < fw->size) {
2168 struct hci_command_hdr *cmd = (void *)fw_ptr;
2171 cmd_len = sizeof(*cmd) + cmd->plen;
2173 /* Send each command from the firmware data buffer as
2174 * a single Data fragment.
2176 err = btusb_intel_secure_send(hdev, 0x01, cmd_len, fw_ptr);
2178 BT_ERR("%s: Failed to send firmware data (%d)",
2186 set_bit(BTUSB_FIRMWARE_LOADED, &data->flags);
2188 BT_INFO("%s: Waiting for firmware download to complete", hdev->name);
2190 /* Before switching the device into operational mode and with that
2191 * booting the loaded firmware, wait for the bootloader notification
2192 * that all fragments have been successfully received.
2194 * When the event processing receives the notification, then the
2195 * BTUSB_DOWNLOADING flag will be cleared.
2197 * The firmware loading should not take longer than 5 seconds
2198 * and thus just timeout if that happens and fail the setup
2201 err = wait_on_bit_timeout(&data->flags, BTUSB_DOWNLOADING,
2203 msecs_to_jiffies(5000));
2205 BT_ERR("%s: Firmware loading interrupted", hdev->name);
2211 BT_ERR("%s: Firmware loading timeout", hdev->name);
2216 if (test_bit(BTUSB_FIRMWARE_FAILED, &data->flags)) {
2217 BT_ERR("%s: Firmware loading failed", hdev->name);
2222 rettime = ktime_get();
2223 delta = ktime_sub(rettime, calltime);
2224 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2226 BT_INFO("%s: Firmware loaded in %llu usecs", hdev->name, duration);
2229 release_firmware(fw);
2234 calltime = ktime_get();
2236 set_bit(BTUSB_BOOTING, &data->flags);
2238 skb = __hci_cmd_sync(hdev, 0xfc01, sizeof(reset_param), reset_param,
2241 return PTR_ERR(skb);
2245 /* The bootloader will not indicate when the device is ready. This
2246 * is done by the operational firmware sending bootup notification.
2248 * Booting into operational firmware should not take longer than
2249 * 1 second. However if that happens, then just fail the setup
2250 * since something went wrong.
2252 BT_INFO("%s: Waiting for device to boot", hdev->name);
2254 err = wait_on_bit_timeout(&data->flags, BTUSB_BOOTING,
2256 msecs_to_jiffies(1000));
2259 BT_ERR("%s: Device boot interrupted", hdev->name);
2264 BT_ERR("%s: Device boot timeout", hdev->name);
2268 rettime = ktime_get();
2269 delta = ktime_sub(rettime, calltime);
2270 duration = (unsigned long long) ktime_to_ns(delta) >> 10;
2272 BT_INFO("%s: Device booted in %llu usecs", hdev->name, duration);
2274 clear_bit(BTUSB_BOOTLOADER, &data->flags);
2279 static void btusb_hw_error_intel(struct hci_dev *hdev, u8 code)
2281 struct sk_buff *skb;
2284 BT_ERR("%s: Hardware error 0x%2.2x", hdev->name, code);
2286 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
2288 BT_ERR("%s: Reset after hardware error failed (%ld)",
2289 hdev->name, PTR_ERR(skb));
2294 skb = __hci_cmd_sync(hdev, 0xfc22, 1, &type, HCI_INIT_TIMEOUT);
2296 BT_ERR("%s: Retrieving Intel exception info failed (%ld)",
2297 hdev->name, PTR_ERR(skb));
2301 if (skb->len != 13) {
2302 BT_ERR("%s: Exception info size mismatch", hdev->name);
2307 if (skb->data[0] != 0x00) {
2308 BT_ERR("%s: Exception info command failure (%02x)",
2309 hdev->name, skb->data[0]);
2314 BT_ERR("%s: Exception info %s", hdev->name, (char *)(skb->data + 1));
2319 static int btusb_shutdown_intel(struct hci_dev *hdev)
2321 struct sk_buff *skb;
2324 /* Some platforms have an issue with BT LED when the interface is
2325 * down or BT radio is turned off, which takes 5 seconds to BT LED
2326 * goes off. This command turns off the BT LED immediately.
2328 skb = __hci_cmd_sync(hdev, 0xfc3f, 0, NULL, HCI_INIT_TIMEOUT);
2331 BT_ERR("%s: turning off Intel device LED failed (%ld)",
2340 static int btusb_set_bdaddr_marvell(struct hci_dev *hdev,
2341 const bdaddr_t *bdaddr)
2343 struct sk_buff *skb;
2348 buf[1] = sizeof(bdaddr_t);
2349 memcpy(buf + 2, bdaddr, sizeof(bdaddr_t));
2351 skb = __hci_cmd_sync(hdev, 0xfc22, sizeof(buf), buf, HCI_INIT_TIMEOUT);
2354 BT_ERR("%s: changing Marvell device address failed (%ld)",
2363 static int btusb_set_bdaddr_ath3012(struct hci_dev *hdev,
2364 const bdaddr_t *bdaddr)
2366 struct sk_buff *skb;
2373 buf[3] = sizeof(bdaddr_t);
2374 memcpy(buf + 4, bdaddr, sizeof(bdaddr_t));
2376 skb = __hci_cmd_sync(hdev, 0xfc0b, sizeof(buf), buf, HCI_INIT_TIMEOUT);
2379 BT_ERR("%s: Change address command failed (%ld)",
2388 #define QCA_DFU_PACKET_LEN 4096
2390 #define QCA_GET_TARGET_VERSION 0x09
2391 #define QCA_CHECK_STATUS 0x05
2392 #define QCA_DFU_DOWNLOAD 0x01
2394 #define QCA_SYSCFG_UPDATED 0x40
2395 #define QCA_PATCH_UPDATED 0x80
2396 #define QCA_DFU_TIMEOUT 3000
2398 struct qca_version {
2400 __le32 patch_version;
2406 struct qca_rampatch_version {
2408 __le16 patch_version;
2411 struct qca_device_info {
2413 u8 rampatch_hdr; /* length of header in rampatch */
2414 u8 nvm_hdr; /* length of header in NVM */
2415 u8 ver_offset; /* offset of version structure in rampatch */
2418 static const struct qca_device_info qca_devices_table[] = {
2419 { 0x00000100, 20, 4, 10 }, /* Rome 1.0 */
2420 { 0x00000101, 20, 4, 10 }, /* Rome 1.1 */
2421 { 0x00000201, 28, 4, 18 }, /* Rome 2.1 */
2422 { 0x00000300, 28, 4, 18 }, /* Rome 3.0 */
2423 { 0x00000302, 28, 4, 18 }, /* Rome 3.2 */
2426 static int btusb_qca_send_vendor_req(struct hci_dev *hdev, u8 request,
2427 void *data, u16 size)
2429 struct btusb_data *btdata = hci_get_drvdata(hdev);
2430 struct usb_device *udev = btdata->udev;
2434 buf = kmalloc(size, GFP_KERNEL);
2438 /* Found some of USB hosts have IOT issues with ours so that we should
2439 * not wait until HCI layer is ready.
2441 pipe = usb_rcvctrlpipe(udev, 0);
2442 err = usb_control_msg(udev, pipe, request, USB_TYPE_VENDOR | USB_DIR_IN,
2443 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
2445 BT_ERR("%s: Failed to access otp area (%d)", hdev->name, err);
2449 memcpy(data, buf, size);
2457 static int btusb_setup_qca_download_fw(struct hci_dev *hdev,
2458 const struct firmware *firmware,
2461 struct btusb_data *btdata = hci_get_drvdata(hdev);
2462 struct usb_device *udev = btdata->udev;
2463 size_t count, size, sent = 0;
2467 buf = kmalloc(QCA_DFU_PACKET_LEN, GFP_KERNEL);
2471 count = firmware->size;
2473 size = min_t(size_t, count, hdr_size);
2474 memcpy(buf, firmware->data, size);
2476 /* USB patches should go down to controller through USB path
2477 * because binary format fits to go down through USB channel.
2478 * USB control path is for patching headers and USB bulk is for
2481 pipe = usb_sndctrlpipe(udev, 0);
2482 err = usb_control_msg(udev, pipe, QCA_DFU_DOWNLOAD, USB_TYPE_VENDOR,
2483 0, 0, buf, size, USB_CTRL_SET_TIMEOUT);
2485 BT_ERR("%s: Failed to send headers (%d)", hdev->name, err);
2493 size = min_t(size_t, count, QCA_DFU_PACKET_LEN);
2495 memcpy(buf, firmware->data + sent, size);
2497 pipe = usb_sndbulkpipe(udev, 0x02);
2498 err = usb_bulk_msg(udev, pipe, buf, size, &len,
2501 BT_ERR("%s: Failed to send body at %zd of %zd (%d)",
2502 hdev->name, sent, firmware->size, err);
2507 BT_ERR("%s: Failed to get bulk buffer", hdev->name);
2521 static int btusb_setup_qca_load_rampatch(struct hci_dev *hdev,
2522 struct qca_version *ver,
2523 const struct qca_device_info *info)
2525 struct qca_rampatch_version *rver;
2526 const struct firmware *fw;
2527 u32 ver_rom, ver_patch;
2528 u16 rver_rom, rver_patch;
2532 ver_rom = le32_to_cpu(ver->rom_version);
2533 ver_patch = le32_to_cpu(ver->patch_version);
2535 snprintf(fwname, sizeof(fwname), "qca/rampatch_usb_%08x.bin", ver_rom);
2537 err = request_firmware(&fw, fwname, &hdev->dev);
2539 BT_ERR("%s: failed to request rampatch file: %s (%d)",
2540 hdev->name, fwname, err);
2544 BT_INFO("%s: using rampatch file: %s", hdev->name, fwname);
2546 rver = (struct qca_rampatch_version *)(fw->data + info->ver_offset);
2547 rver_rom = le16_to_cpu(rver->rom_version);
2548 rver_patch = le16_to_cpu(rver->patch_version);
2550 BT_INFO("%s: QCA: patch rome 0x%x build 0x%x, firmware rome 0x%x "
2551 "build 0x%x", hdev->name, rver_rom, rver_patch, ver_rom,
2554 if (rver_rom != ver_rom || rver_patch <= ver_patch) {
2555 BT_ERR("%s: rampatch file version did not match with firmware",
2561 err = btusb_setup_qca_download_fw(hdev, fw, info->rampatch_hdr);
2564 release_firmware(fw);
2569 static int btusb_setup_qca_load_nvm(struct hci_dev *hdev,
2570 struct qca_version *ver,
2571 const struct qca_device_info *info)
2573 const struct firmware *fw;
2577 snprintf(fwname, sizeof(fwname), "qca/nvm_usb_%08x.bin",
2578 le32_to_cpu(ver->rom_version));
2580 err = request_firmware(&fw, fwname, &hdev->dev);
2582 BT_ERR("%s: failed to request NVM file: %s (%d)",
2583 hdev->name, fwname, err);
2587 BT_INFO("%s: using NVM file: %s", hdev->name, fwname);
2589 err = btusb_setup_qca_download_fw(hdev, fw, info->nvm_hdr);
2591 release_firmware(fw);
2596 static int btusb_setup_qca(struct hci_dev *hdev)
2598 const struct qca_device_info *info = NULL;
2599 struct qca_version ver;
2604 err = btusb_qca_send_vendor_req(hdev, QCA_GET_TARGET_VERSION, &ver,
2609 ver_rom = le32_to_cpu(ver.rom_version);
2610 for (i = 0; i < ARRAY_SIZE(qca_devices_table); i++) {
2611 if (ver_rom == qca_devices_table[i].rom_version)
2612 info = &qca_devices_table[i];
2615 BT_ERR("%s: don't support firmware rome 0x%x", hdev->name,
2620 err = btusb_qca_send_vendor_req(hdev, QCA_CHECK_STATUS, &status,
2625 if (!(status & QCA_PATCH_UPDATED)) {
2626 err = btusb_setup_qca_load_rampatch(hdev, &ver, info);
2631 if (!(status & QCA_SYSCFG_UPDATED)) {
2632 err = btusb_setup_qca_load_nvm(hdev, &ver, info);
2640 static int btusb_probe(struct usb_interface *intf,
2641 const struct usb_device_id *id)
2643 struct usb_endpoint_descriptor *ep_desc;
2644 struct btusb_data *data;
2645 struct hci_dev *hdev;
2648 BT_DBG("intf %p id %p", intf, id);
2650 /* interface numbers are hardcoded in the spec */
2651 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
2654 if (!id->driver_info) {
2655 const struct usb_device_id *match;
2657 match = usb_match_id(intf, blacklist_table);
2662 if (id->driver_info == BTUSB_IGNORE)
2665 if (id->driver_info & BTUSB_ATH3012) {
2666 struct usb_device *udev = interface_to_usbdev(intf);
2668 /* Old firmware would otherwise let ath3k driver load
2669 * patch and sysconfig files */
2670 if (le16_to_cpu(udev->descriptor.bcdDevice) <= 0x0001)
2674 data = devm_kzalloc(&intf->dev, sizeof(*data), GFP_KERNEL);
2678 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
2679 ep_desc = &intf->cur_altsetting->endpoint[i].desc;
2681 if (!data->intr_ep && usb_endpoint_is_int_in(ep_desc)) {
2682 data->intr_ep = ep_desc;
2686 if (!data->bulk_tx_ep && usb_endpoint_is_bulk_out(ep_desc)) {
2687 data->bulk_tx_ep = ep_desc;
2691 if (!data->bulk_rx_ep && usb_endpoint_is_bulk_in(ep_desc)) {
2692 data->bulk_rx_ep = ep_desc;
2697 if (!data->intr_ep || !data->bulk_tx_ep || !data->bulk_rx_ep)
2700 if (id->driver_info & BTUSB_AMP) {
2701 data->cmdreq_type = USB_TYPE_CLASS | 0x01;
2702 data->cmdreq = 0x2b;
2704 data->cmdreq_type = USB_TYPE_CLASS;
2705 data->cmdreq = 0x00;
2708 data->udev = interface_to_usbdev(intf);
2711 INIT_WORK(&data->work, btusb_work);
2712 INIT_WORK(&data->waker, btusb_waker);
2713 init_usb_anchor(&data->deferred);
2714 init_usb_anchor(&data->tx_anchor);
2715 spin_lock_init(&data->txlock);
2717 init_usb_anchor(&data->intr_anchor);
2718 init_usb_anchor(&data->bulk_anchor);
2719 init_usb_anchor(&data->isoc_anchor);
2720 spin_lock_init(&data->rxlock);
2722 if (id->driver_info & BTUSB_INTEL_NEW) {
2723 data->recv_event = btusb_recv_event_intel;
2724 data->recv_bulk = btusb_recv_bulk_intel;
2725 set_bit(BTUSB_BOOTLOADER, &data->flags);
2727 data->recv_event = hci_recv_frame;
2728 data->recv_bulk = btusb_recv_bulk;
2731 hdev = hci_alloc_dev();
2735 hdev->bus = HCI_USB;
2736 hci_set_drvdata(hdev, data);
2738 if (id->driver_info & BTUSB_AMP)
2739 hdev->dev_type = HCI_AMP;
2741 hdev->dev_type = HCI_BREDR;
2745 SET_HCIDEV_DEV(hdev, &intf->dev);
2747 hdev->open = btusb_open;
2748 hdev->close = btusb_close;
2749 hdev->flush = btusb_flush;
2750 hdev->send = btusb_send_frame;
2751 hdev->notify = btusb_notify;
2753 if (id->driver_info & BTUSB_BCM92035)
2754 hdev->setup = btusb_setup_bcm92035;
2756 #ifdef CONFIG_BT_HCIBTUSB_BCM
2757 if (id->driver_info & BTUSB_BCM_PATCHRAM) {
2758 hdev->setup = btbcm_setup_patchram;
2759 hdev->set_bdaddr = btbcm_set_bdaddr;
2762 if (id->driver_info & BTUSB_BCM_APPLE)
2763 hdev->setup = btbcm_setup_apple;
2766 if (id->driver_info & BTUSB_INTEL) {
2767 hdev->setup = btusb_setup_intel;
2768 hdev->shutdown = btusb_shutdown_intel;
2769 hdev->set_bdaddr = btintel_set_bdaddr;
2770 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
2771 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
2774 if (id->driver_info & BTUSB_INTEL_NEW) {
2775 hdev->send = btusb_send_frame_intel;
2776 hdev->setup = btusb_setup_intel_new;
2777 hdev->hw_error = btusb_hw_error_intel;
2778 hdev->set_bdaddr = btintel_set_bdaddr;
2779 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
2782 if (id->driver_info & BTUSB_MARVELL)
2783 hdev->set_bdaddr = btusb_set_bdaddr_marvell;
2785 if (id->driver_info & BTUSB_SWAVE) {
2786 set_bit(HCI_QUIRK_FIXUP_INQUIRY_MODE, &hdev->quirks);
2787 set_bit(HCI_QUIRK_BROKEN_LOCAL_COMMANDS, &hdev->quirks);
2790 if (id->driver_info & BTUSB_INTEL_BOOT)
2791 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
2793 if (id->driver_info & BTUSB_ATH3012) {
2794 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
2795 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
2796 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
2799 if (id->driver_info & BTUSB_QCA_ROME) {
2800 data->setup_on_usb = btusb_setup_qca;
2801 hdev->set_bdaddr = btusb_set_bdaddr_ath3012;
2804 #ifdef CONFIG_BT_HCIBTUSB_RTL
2805 if (id->driver_info & BTUSB_REALTEK)
2806 hdev->setup = btrtl_setup_realtek;
2809 if (id->driver_info & BTUSB_AMP) {
2810 /* AMP controllers do not support SCO packets */
2813 /* Interface numbers are hardcoded in the specification */
2814 data->isoc = usb_ifnum_to_if(data->udev, 1);
2818 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
2820 if (force_scofix || id->driver_info & BTUSB_WRONG_SCO_MTU) {
2821 if (!disable_scofix)
2822 set_bit(HCI_QUIRK_FIXUP_BUFFER_SIZE, &hdev->quirks);
2825 if (id->driver_info & BTUSB_BROKEN_ISOC)
2828 if (id->driver_info & BTUSB_DIGIANSWER) {
2829 data->cmdreq_type = USB_TYPE_VENDOR;
2830 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
2833 if (id->driver_info & BTUSB_CSR) {
2834 struct usb_device *udev = data->udev;
2835 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2837 /* Old firmware would otherwise execute USB reset */
2838 if (bcdDevice < 0x117)
2839 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
2841 /* Fake CSR devices with broken commands */
2842 if (bcdDevice <= 0x100)
2843 hdev->setup = btusb_setup_csr;
2845 set_bit(HCI_QUIRK_SIMULTANEOUS_DISCOVERY, &hdev->quirks);
2848 if (id->driver_info & BTUSB_SNIFFER) {
2849 struct usb_device *udev = data->udev;
2851 /* New sniffer firmware has crippled HCI interface */
2852 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x997)
2853 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
2856 if (id->driver_info & BTUSB_INTEL_BOOT) {
2857 /* A bug in the bootloader causes that interrupt interface is
2858 * only enabled after receiving SetInterface(0, AltSetting=0).
2860 err = usb_set_interface(data->udev, 0, 0);
2862 BT_ERR("failed to set interface 0, alt 0 %d", err);
2869 err = usb_driver_claim_interface(&btusb_driver,
2877 err = hci_register_dev(hdev);
2883 usb_set_intfdata(intf, data);
2888 static void btusb_disconnect(struct usb_interface *intf)
2890 struct btusb_data *data = usb_get_intfdata(intf);
2891 struct hci_dev *hdev;
2893 BT_DBG("intf %p", intf);
2899 usb_set_intfdata(data->intf, NULL);
2902 usb_set_intfdata(data->isoc, NULL);
2904 hci_unregister_dev(hdev);
2906 if (intf == data->isoc)
2907 usb_driver_release_interface(&btusb_driver, data->intf);
2908 else if (data->isoc)
2909 usb_driver_release_interface(&btusb_driver, data->isoc);
2915 static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
2917 struct btusb_data *data = usb_get_intfdata(intf);
2919 BT_DBG("intf %p", intf);
2921 if (data->suspend_count++)
2924 spin_lock_irq(&data->txlock);
2925 if (!(PMSG_IS_AUTO(message) && data->tx_in_flight)) {
2926 set_bit(BTUSB_SUSPENDING, &data->flags);
2927 spin_unlock_irq(&data->txlock);
2929 spin_unlock_irq(&data->txlock);
2930 data->suspend_count--;
2934 cancel_work_sync(&data->work);
2936 btusb_stop_traffic(data);
2937 usb_kill_anchored_urbs(&data->tx_anchor);
2942 static void play_deferred(struct btusb_data *data)
2947 while ((urb = usb_get_from_anchor(&data->deferred))) {
2948 err = usb_submit_urb(urb, GFP_ATOMIC);
2952 data->tx_in_flight++;
2954 usb_scuttle_anchored_urbs(&data->deferred);
2957 static int btusb_resume(struct usb_interface *intf)
2959 struct btusb_data *data = usb_get_intfdata(intf);
2960 struct hci_dev *hdev = data->hdev;
2963 BT_DBG("intf %p", intf);
2965 if (--data->suspend_count)
2968 if (!test_bit(HCI_RUNNING, &hdev->flags))
2971 if (test_bit(BTUSB_INTR_RUNNING, &data->flags)) {
2972 err = btusb_submit_intr_urb(hdev, GFP_NOIO);
2974 clear_bit(BTUSB_INTR_RUNNING, &data->flags);
2979 if (test_bit(BTUSB_BULK_RUNNING, &data->flags)) {
2980 err = btusb_submit_bulk_urb(hdev, GFP_NOIO);
2982 clear_bit(BTUSB_BULK_RUNNING, &data->flags);
2986 btusb_submit_bulk_urb(hdev, GFP_NOIO);
2989 if (test_bit(BTUSB_ISOC_RUNNING, &data->flags)) {
2990 if (btusb_submit_isoc_urb(hdev, GFP_NOIO) < 0)
2991 clear_bit(BTUSB_ISOC_RUNNING, &data->flags);
2993 btusb_submit_isoc_urb(hdev, GFP_NOIO);
2996 spin_lock_irq(&data->txlock);
2997 play_deferred(data);
2998 clear_bit(BTUSB_SUSPENDING, &data->flags);
2999 spin_unlock_irq(&data->txlock);
3000 schedule_work(&data->work);
3005 usb_scuttle_anchored_urbs(&data->deferred);
3007 spin_lock_irq(&data->txlock);
3008 clear_bit(BTUSB_SUSPENDING, &data->flags);
3009 spin_unlock_irq(&data->txlock);
3015 static struct usb_driver btusb_driver = {
3017 .probe = btusb_probe,
3018 .disconnect = btusb_disconnect,
3020 .suspend = btusb_suspend,
3021 .resume = btusb_resume,
3023 .id_table = btusb_table,
3024 .supports_autosuspend = 1,
3025 .disable_hub_initiated_lpm = 1,
3028 module_usb_driver(btusb_driver);
3030 module_param(disable_scofix, bool, 0644);
3031 MODULE_PARM_DESC(disable_scofix, "Disable fixup of wrong SCO buffer size");
3033 module_param(force_scofix, bool, 0644);
3034 MODULE_PARM_DESC(force_scofix, "Force fixup of wrong SCO buffers size");
3036 module_param(reset, bool, 0644);
3037 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
3039 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
3040 MODULE_DESCRIPTION("Generic Bluetooth USB driver ver " VERSION);
3041 MODULE_VERSION(VERSION);
3042 MODULE_LICENSE("GPL");