]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/bluetooth/ath3k.c
Bluetooth: btusb: Add a new AR3012 ID 04ca:3014
[mirror_ubuntu-bionic-kernel.git] / drivers / bluetooth / ath3k.c
1 /*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 */
19
20
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/types.h>
26 #include <linux/errno.h>
27 #include <linux/device.h>
28 #include <linux/firmware.h>
29 #include <linux/usb.h>
30 #include <asm/unaligned.h>
31 #include <net/bluetooth/bluetooth.h>
32
33 #define VERSION "1.0"
34 #define ATH3K_FIRMWARE "ath3k-1.fw"
35
36 #define ATH3K_DNLOAD 0x01
37 #define ATH3K_GETSTATE 0x05
38 #define ATH3K_SET_NORMAL_MODE 0x07
39 #define ATH3K_GETVERSION 0x09
40 #define USB_REG_SWITCH_VID_PID 0x0a
41
42 #define ATH3K_MODE_MASK 0x3F
43 #define ATH3K_NORMAL_MODE 0x0E
44
45 #define ATH3K_PATCH_UPDATE 0x80
46 #define ATH3K_SYSCFG_UPDATE 0x40
47
48 #define ATH3K_XTAL_FREQ_26M 0x00
49 #define ATH3K_XTAL_FREQ_40M 0x01
50 #define ATH3K_XTAL_FREQ_19P2 0x02
51 #define ATH3K_NAME_LEN 0xFF
52
53 struct ath3k_version {
54 __le32 rom_version;
55 __le32 build_version;
56 __le32 ram_version;
57 __u8 ref_clock;
58 __u8 reserved[7];
59 } __packed;
60
61 static const struct usb_device_id ath3k_table[] = {
62 /* Atheros AR3011 */
63 { USB_DEVICE(0x0CF3, 0x3000) },
64
65 /* Atheros AR3011 with sflash firmware*/
66 { USB_DEVICE(0x0489, 0xE027) },
67 { USB_DEVICE(0x0489, 0xE03D) },
68 { USB_DEVICE(0x04F2, 0xAFF1) },
69 { USB_DEVICE(0x0930, 0x0215) },
70 { USB_DEVICE(0x0CF3, 0x3002) },
71 { USB_DEVICE(0x0CF3, 0xE019) },
72 { USB_DEVICE(0x13d3, 0x3304) },
73
74 /* Atheros AR9285 Malbec with sflash firmware */
75 { USB_DEVICE(0x03F0, 0x311D) },
76
77 /* Atheros AR3012 with sflash firmware*/
78 { USB_DEVICE(0x0489, 0xe04d) },
79 { USB_DEVICE(0x0489, 0xe04e) },
80 { USB_DEVICE(0x0489, 0xe057) },
81 { USB_DEVICE(0x0489, 0xe056) },
82 { USB_DEVICE(0x0489, 0xe05f) },
83 { USB_DEVICE(0x0489, 0xe076) },
84 { USB_DEVICE(0x0489, 0xe078) },
85 { USB_DEVICE(0x0489, 0xe095) },
86 { USB_DEVICE(0x04c5, 0x1330) },
87 { USB_DEVICE(0x04CA, 0x3004) },
88 { USB_DEVICE(0x04CA, 0x3005) },
89 { USB_DEVICE(0x04CA, 0x3006) },
90 { USB_DEVICE(0x04CA, 0x3007) },
91 { USB_DEVICE(0x04CA, 0x3008) },
92 { USB_DEVICE(0x04CA, 0x300b) },
93 { USB_DEVICE(0x04CA, 0x300d) },
94 { USB_DEVICE(0x04CA, 0x300f) },
95 { USB_DEVICE(0x04CA, 0x3010) },
96 { USB_DEVICE(0x04CA, 0x3014) },
97 { USB_DEVICE(0x0930, 0x0219) },
98 { USB_DEVICE(0x0930, 0x021c) },
99 { USB_DEVICE(0x0930, 0x0220) },
100 { USB_DEVICE(0x0930, 0x0227) },
101 { USB_DEVICE(0x0b05, 0x17d0) },
102 { USB_DEVICE(0x0CF3, 0x0036) },
103 { USB_DEVICE(0x0CF3, 0x3004) },
104 { USB_DEVICE(0x0CF3, 0x3008) },
105 { USB_DEVICE(0x0CF3, 0x311D) },
106 { USB_DEVICE(0x0CF3, 0x311E) },
107 { USB_DEVICE(0x0CF3, 0x311F) },
108 { USB_DEVICE(0x0cf3, 0x3121) },
109 { USB_DEVICE(0x0CF3, 0x817a) },
110 { USB_DEVICE(0x0CF3, 0x817b) },
111 { USB_DEVICE(0x0cf3, 0xe003) },
112 { USB_DEVICE(0x0CF3, 0xE004) },
113 { USB_DEVICE(0x0CF3, 0xE005) },
114 { USB_DEVICE(0x0CF3, 0xE006) },
115 { USB_DEVICE(0x13d3, 0x3362) },
116 { USB_DEVICE(0x13d3, 0x3375) },
117 { USB_DEVICE(0x13d3, 0x3393) },
118 { USB_DEVICE(0x13d3, 0x3395) },
119 { USB_DEVICE(0x13d3, 0x3402) },
120 { USB_DEVICE(0x13d3, 0x3408) },
121 { USB_DEVICE(0x13d3, 0x3423) },
122 { USB_DEVICE(0x13d3, 0x3432) },
123 { USB_DEVICE(0x13d3, 0x3474) },
124
125 /* Atheros AR5BBU12 with sflash firmware */
126 { USB_DEVICE(0x0489, 0xE02C) },
127
128 /* Atheros AR5BBU22 with sflash firmware */
129 { USB_DEVICE(0x0489, 0xE036) },
130 { USB_DEVICE(0x0489, 0xE03C) },
131
132 { } /* Terminating entry */
133 };
134
135 MODULE_DEVICE_TABLE(usb, ath3k_table);
136
137 #define BTUSB_ATH3012 0x80
138 /* This table is to load patch and sysconfig files
139 * for AR3012 */
140 static const struct usb_device_id ath3k_blist_tbl[] = {
141
142 /* Atheros AR3012 with sflash firmware*/
143 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
144 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
145 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
146 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
147 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
169 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
170 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
171 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
173 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
174 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
175 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
176 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
177 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
189
190 /* Atheros AR5BBU22 with sflash firmware */
191 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
193
194 { } /* Terminating entry */
195 };
196
197 #define USB_REQ_DFU_DNLOAD 1
198 #define BULK_SIZE 4096
199 #define FW_HDR_SIZE 20
200 #define TIMEGAP_USEC_MIN 50
201 #define TIMEGAP_USEC_MAX 100
202
203 static int ath3k_load_firmware(struct usb_device *udev,
204 const struct firmware *firmware)
205 {
206 u8 *send_buf;
207 int err, pipe, len, size, sent = 0;
208 int count = firmware->size;
209
210 BT_DBG("udev %p", udev);
211
212 pipe = usb_sndctrlpipe(udev, 0);
213
214 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
215 if (!send_buf) {
216 BT_ERR("Can't allocate memory chunk for firmware");
217 return -ENOMEM;
218 }
219
220 memcpy(send_buf, firmware->data, 20);
221 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
222 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
223 if (err < 0) {
224 BT_ERR("Can't change to loading configuration err");
225 goto error;
226 }
227 sent += 20;
228 count -= 20;
229
230 pipe = usb_sndbulkpipe(udev, 0x02);
231
232 while (count) {
233 /* workaround the compatibility issue with xHCI controller*/
234 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
235
236 size = min_t(uint, count, BULK_SIZE);
237 memcpy(send_buf, firmware->data + sent, size);
238
239 err = usb_bulk_msg(udev, pipe, send_buf, size,
240 &len, 3000);
241
242 if (err || (len != size)) {
243 BT_ERR("Error in firmware loading err = %d,"
244 "len = %d, size = %d", err, len, size);
245 goto error;
246 }
247
248 sent += size;
249 count -= size;
250 }
251
252 error:
253 kfree(send_buf);
254 return err;
255 }
256
257 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
258 {
259 int ret, pipe = 0;
260 char *buf;
261
262 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
263 if (!buf)
264 return -ENOMEM;
265
266 pipe = usb_rcvctrlpipe(udev, 0);
267 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
268 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
269 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
270
271 *state = *buf;
272 kfree(buf);
273
274 return ret;
275 }
276
277 static int ath3k_get_version(struct usb_device *udev,
278 struct ath3k_version *version)
279 {
280 int ret, pipe = 0;
281 struct ath3k_version *buf;
282 const int size = sizeof(*buf);
283
284 buf = kmalloc(size, GFP_KERNEL);
285 if (!buf)
286 return -ENOMEM;
287
288 pipe = usb_rcvctrlpipe(udev, 0);
289 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
290 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
291 buf, size, USB_CTRL_SET_TIMEOUT);
292
293 memcpy(version, buf, size);
294 kfree(buf);
295
296 return ret;
297 }
298
299 static int ath3k_load_fwfile(struct usb_device *udev,
300 const struct firmware *firmware)
301 {
302 u8 *send_buf;
303 int err, pipe, len, size, count, sent = 0;
304 int ret;
305
306 count = firmware->size;
307
308 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
309 if (!send_buf) {
310 BT_ERR("Can't allocate memory chunk for firmware");
311 return -ENOMEM;
312 }
313
314 size = min_t(uint, count, FW_HDR_SIZE);
315 memcpy(send_buf, firmware->data, size);
316
317 pipe = usb_sndctrlpipe(udev, 0);
318 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
319 USB_TYPE_VENDOR, 0, 0, send_buf,
320 size, USB_CTRL_SET_TIMEOUT);
321 if (ret < 0) {
322 BT_ERR("Can't change to loading configuration err");
323 kfree(send_buf);
324 return ret;
325 }
326
327 sent += size;
328 count -= size;
329
330 pipe = usb_sndbulkpipe(udev, 0x02);
331
332 while (count) {
333 /* workaround the compatibility issue with xHCI controller*/
334 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
335
336 size = min_t(uint, count, BULK_SIZE);
337 memcpy(send_buf, firmware->data + sent, size);
338
339 err = usb_bulk_msg(udev, pipe, send_buf, size,
340 &len, 3000);
341 if (err || (len != size)) {
342 BT_ERR("Error in firmware loading err = %d,"
343 "len = %d, size = %d", err, len, size);
344 kfree(send_buf);
345 return err;
346 }
347 sent += size;
348 count -= size;
349 }
350
351 kfree(send_buf);
352 return 0;
353 }
354
355 static int ath3k_switch_pid(struct usb_device *udev)
356 {
357 int pipe = 0;
358
359 pipe = usb_sndctrlpipe(udev, 0);
360 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
361 USB_TYPE_VENDOR, 0, 0,
362 NULL, 0, USB_CTRL_SET_TIMEOUT);
363 }
364
365 static int ath3k_set_normal_mode(struct usb_device *udev)
366 {
367 unsigned char fw_state;
368 int pipe = 0, ret;
369
370 ret = ath3k_get_state(udev, &fw_state);
371 if (ret < 0) {
372 BT_ERR("Can't get state to change to normal mode err");
373 return ret;
374 }
375
376 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
377 BT_DBG("firmware was already in normal mode");
378 return 0;
379 }
380
381 pipe = usb_sndctrlpipe(udev, 0);
382 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
383 USB_TYPE_VENDOR, 0, 0,
384 NULL, 0, USB_CTRL_SET_TIMEOUT);
385 }
386
387 static int ath3k_load_patch(struct usb_device *udev)
388 {
389 unsigned char fw_state;
390 char filename[ATH3K_NAME_LEN] = {0};
391 const struct firmware *firmware;
392 struct ath3k_version fw_version;
393 __u32 pt_rom_version, pt_build_version;
394 int ret;
395
396 ret = ath3k_get_state(udev, &fw_state);
397 if (ret < 0) {
398 BT_ERR("Can't get state to change to load ram patch err");
399 return ret;
400 }
401
402 if (fw_state & ATH3K_PATCH_UPDATE) {
403 BT_DBG("Patch was already downloaded");
404 return 0;
405 }
406
407 ret = ath3k_get_version(udev, &fw_version);
408 if (ret < 0) {
409 BT_ERR("Can't get version to change to load ram patch err");
410 return ret;
411 }
412
413 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
414 le32_to_cpu(fw_version.rom_version));
415
416 ret = request_firmware(&firmware, filename, &udev->dev);
417 if (ret < 0) {
418 BT_ERR("Patch file not found %s", filename);
419 return ret;
420 }
421
422 pt_rom_version = get_unaligned_le32(firmware->data +
423 firmware->size - 8);
424 pt_build_version = get_unaligned_le32(firmware->data +
425 firmware->size - 4);
426
427 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
428 pt_build_version <= le32_to_cpu(fw_version.build_version)) {
429 BT_ERR("Patch file version did not match with firmware");
430 release_firmware(firmware);
431 return -EINVAL;
432 }
433
434 ret = ath3k_load_fwfile(udev, firmware);
435 release_firmware(firmware);
436
437 return ret;
438 }
439
440 static int ath3k_load_syscfg(struct usb_device *udev)
441 {
442 unsigned char fw_state;
443 char filename[ATH3K_NAME_LEN] = {0};
444 const struct firmware *firmware;
445 struct ath3k_version fw_version;
446 int clk_value, ret;
447
448 ret = ath3k_get_state(udev, &fw_state);
449 if (ret < 0) {
450 BT_ERR("Can't get state to change to load configuration err");
451 return -EBUSY;
452 }
453
454 ret = ath3k_get_version(udev, &fw_version);
455 if (ret < 0) {
456 BT_ERR("Can't get version to change to load ram patch err");
457 return ret;
458 }
459
460 switch (fw_version.ref_clock) {
461
462 case ATH3K_XTAL_FREQ_26M:
463 clk_value = 26;
464 break;
465 case ATH3K_XTAL_FREQ_40M:
466 clk_value = 40;
467 break;
468 case ATH3K_XTAL_FREQ_19P2:
469 clk_value = 19;
470 break;
471 default:
472 clk_value = 0;
473 break;
474 }
475
476 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
477 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
478
479 ret = request_firmware(&firmware, filename, &udev->dev);
480 if (ret < 0) {
481 BT_ERR("Configuration file not found %s", filename);
482 return ret;
483 }
484
485 ret = ath3k_load_fwfile(udev, firmware);
486 release_firmware(firmware);
487
488 return ret;
489 }
490
491 static int ath3k_probe(struct usb_interface *intf,
492 const struct usb_device_id *id)
493 {
494 const struct firmware *firmware;
495 struct usb_device *udev = interface_to_usbdev(intf);
496 int ret;
497
498 BT_DBG("intf %p id %p", intf, id);
499
500 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
501 return -ENODEV;
502
503 /* match device ID in ath3k blacklist table */
504 if (!id->driver_info) {
505 const struct usb_device_id *match;
506
507 match = usb_match_id(intf, ath3k_blist_tbl);
508 if (match)
509 id = match;
510 }
511
512 /* load patch and sysconfig files for AR3012 */
513 if (id->driver_info & BTUSB_ATH3012) {
514
515 /* New firmware with patch and sysconfig files already loaded */
516 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
517 return -ENODEV;
518
519 ret = ath3k_load_patch(udev);
520 if (ret < 0) {
521 BT_ERR("Loading patch file failed");
522 return ret;
523 }
524 ret = ath3k_load_syscfg(udev);
525 if (ret < 0) {
526 BT_ERR("Loading sysconfig file failed");
527 return ret;
528 }
529 ret = ath3k_set_normal_mode(udev);
530 if (ret < 0) {
531 BT_ERR("Set normal mode failed");
532 return ret;
533 }
534 ath3k_switch_pid(udev);
535 return 0;
536 }
537
538 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
539 if (ret < 0) {
540 if (ret == -ENOENT)
541 BT_ERR("Firmware file \"%s\" not found",
542 ATH3K_FIRMWARE);
543 else
544 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
545 ATH3K_FIRMWARE, ret);
546 return ret;
547 }
548
549 ret = ath3k_load_firmware(udev, firmware);
550 release_firmware(firmware);
551
552 return ret;
553 }
554
555 static void ath3k_disconnect(struct usb_interface *intf)
556 {
557 BT_DBG("ath3k_disconnect intf %p", intf);
558 }
559
560 static struct usb_driver ath3k_driver = {
561 .name = "ath3k",
562 .probe = ath3k_probe,
563 .disconnect = ath3k_disconnect,
564 .id_table = ath3k_table,
565 .disable_hub_initiated_lpm = 1,
566 };
567
568 module_usb_driver(ath3k_driver);
569
570 MODULE_AUTHOR("Atheros Communications");
571 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
572 MODULE_VERSION(VERSION);
573 MODULE_LICENSE("GPL");
574 MODULE_FIRMWARE(ATH3K_FIRMWARE);