1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
53struct 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
61static const struct usb_device_id ath3k_table[] = {
62
63 { USB_DEVICE(0x0CF3, 0x3000) },
64
65
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
75 { USB_DEVICE(0x03F0, 0x311D) },
76
77
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, 0x3472) },
124 { USB_DEVICE(0x13d3, 0x3474) },
125 { USB_DEVICE(0x13d3, 0x3487) },
126
127
128 { USB_DEVICE(0x0489, 0xE02C) },
129
130
131 { USB_DEVICE(0x0489, 0xE036) },
132 { USB_DEVICE(0x0489, 0xE03C) },
133
134 { }
135};
136
137MODULE_DEVICE_TABLE(usb, ath3k_table);
138
139#define BTUSB_ATH3012 0x80
140
141
142static const struct usb_device_id ath3k_blist_tbl[] = {
143
144
145 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
146 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
147 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
169 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
170 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
171 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
173 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
174 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
175 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
176 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
177 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
191 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
193
194
195 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
196 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
197
198 { }
199};
200
201#define USB_REQ_DFU_DNLOAD 1
202#define BULK_SIZE 4096
203#define FW_HDR_SIZE 20
204#define TIMEGAP_USEC_MIN 50
205#define TIMEGAP_USEC_MAX 100
206
207static int ath3k_load_firmware(struct usb_device *udev,
208 const struct firmware *firmware)
209{
210 u8 *send_buf;
211 int len = 0;
212 int err, pipe, size, sent = 0;
213 int count = firmware->size;
214
215 BT_DBG("udev %p", udev);
216
217 pipe = usb_sndctrlpipe(udev, 0);
218
219 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
220 if (!send_buf) {
221 BT_ERR("Can't allocate memory chunk for firmware");
222 return -ENOMEM;
223 }
224
225 memcpy(send_buf, firmware->data, 20);
226 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
227 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
228 if (err < 0) {
229 BT_ERR("Can't change to loading configuration err");
230 goto error;
231 }
232 sent += 20;
233 count -= 20;
234
235 pipe = usb_sndbulkpipe(udev, 0x02);
236
237 while (count) {
238
239 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
240
241 size = min_t(uint, count, BULK_SIZE);
242 memcpy(send_buf, firmware->data + sent, size);
243
244 err = usb_bulk_msg(udev, pipe, send_buf, size,
245 &len, 3000);
246
247 if (err || (len != size)) {
248 BT_ERR("Error in firmware loading err = %d,"
249 "len = %d, size = %d", err, len, size);
250 goto error;
251 }
252
253 sent += size;
254 count -= size;
255 }
256
257error:
258 kfree(send_buf);
259 return err;
260}
261
262static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
263{
264 int ret, pipe = 0;
265 char *buf;
266
267 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
268 if (!buf)
269 return -ENOMEM;
270
271 pipe = usb_rcvctrlpipe(udev, 0);
272 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
273 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
274 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
275
276 *state = *buf;
277 kfree(buf);
278
279 return ret;
280}
281
282static int ath3k_get_version(struct usb_device *udev,
283 struct ath3k_version *version)
284{
285 int ret, pipe = 0;
286 struct ath3k_version *buf;
287 const int size = sizeof(*buf);
288
289 buf = kmalloc(size, GFP_KERNEL);
290 if (!buf)
291 return -ENOMEM;
292
293 pipe = usb_rcvctrlpipe(udev, 0);
294 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
295 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
296 buf, size, USB_CTRL_SET_TIMEOUT);
297
298 memcpy(version, buf, size);
299 kfree(buf);
300
301 return ret;
302}
303
304static int ath3k_load_fwfile(struct usb_device *udev,
305 const struct firmware *firmware)
306{
307 u8 *send_buf;
308 int len = 0;
309 int err, pipe, size, count, sent = 0;
310 int ret;
311
312 count = firmware->size;
313
314 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
315 if (!send_buf) {
316 BT_ERR("Can't allocate memory chunk for firmware");
317 return -ENOMEM;
318 }
319
320 size = min_t(uint, count, FW_HDR_SIZE);
321 memcpy(send_buf, firmware->data, size);
322
323 pipe = usb_sndctrlpipe(udev, 0);
324 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
325 USB_TYPE_VENDOR, 0, 0, send_buf,
326 size, USB_CTRL_SET_TIMEOUT);
327 if (ret < 0) {
328 BT_ERR("Can't change to loading configuration err");
329 kfree(send_buf);
330 return ret;
331 }
332
333 sent += size;
334 count -= size;
335
336 pipe = usb_sndbulkpipe(udev, 0x02);
337
338 while (count) {
339
340 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
341
342 size = min_t(uint, count, BULK_SIZE);
343 memcpy(send_buf, firmware->data + sent, size);
344
345 err = usb_bulk_msg(udev, pipe, send_buf, size,
346 &len, 3000);
347 if (err || (len != size)) {
348 BT_ERR("Error in firmware loading err = %d,"
349 "len = %d, size = %d", err, len, size);
350 kfree(send_buf);
351 return err;
352 }
353 sent += size;
354 count -= size;
355 }
356
357 kfree(send_buf);
358 return 0;
359}
360
361static int ath3k_switch_pid(struct usb_device *udev)
362{
363 int pipe = 0;
364
365 pipe = usb_sndctrlpipe(udev, 0);
366 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
367 USB_TYPE_VENDOR, 0, 0,
368 NULL, 0, USB_CTRL_SET_TIMEOUT);
369}
370
371static int ath3k_set_normal_mode(struct usb_device *udev)
372{
373 unsigned char fw_state;
374 int pipe = 0, ret;
375
376 ret = ath3k_get_state(udev, &fw_state);
377 if (ret < 0) {
378 BT_ERR("Can't get state to change to normal mode err");
379 return ret;
380 }
381
382 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
383 BT_DBG("firmware was already in normal mode");
384 return 0;
385 }
386
387 pipe = usb_sndctrlpipe(udev, 0);
388 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
389 USB_TYPE_VENDOR, 0, 0,
390 NULL, 0, USB_CTRL_SET_TIMEOUT);
391}
392
393static int ath3k_load_patch(struct usb_device *udev)
394{
395 unsigned char fw_state;
396 char filename[ATH3K_NAME_LEN] = {0};
397 const struct firmware *firmware;
398 struct ath3k_version fw_version;
399 __u32 pt_rom_version, pt_build_version;
400 int ret;
401
402 ret = ath3k_get_state(udev, &fw_state);
403 if (ret < 0) {
404 BT_ERR("Can't get state to change to load ram patch err");
405 return ret;
406 }
407
408 if (fw_state & ATH3K_PATCH_UPDATE) {
409 BT_DBG("Patch was already downloaded");
410 return 0;
411 }
412
413 ret = ath3k_get_version(udev, &fw_version);
414 if (ret < 0) {
415 BT_ERR("Can't get version to change to load ram patch err");
416 return ret;
417 }
418
419 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
420 le32_to_cpu(fw_version.rom_version));
421
422 ret = request_firmware(&firmware, filename, &udev->dev);
423 if (ret < 0) {
424 BT_ERR("Patch file not found %s", filename);
425 return ret;
426 }
427
428 pt_rom_version = get_unaligned_le32(firmware->data +
429 firmware->size - 8);
430 pt_build_version = get_unaligned_le32(firmware->data +
431 firmware->size - 4);
432
433 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
434 pt_build_version <= le32_to_cpu(fw_version.build_version)) {
435 BT_ERR("Patch file version did not match with firmware");
436 release_firmware(firmware);
437 return -EINVAL;
438 }
439
440 ret = ath3k_load_fwfile(udev, firmware);
441 release_firmware(firmware);
442
443 return ret;
444}
445
446static int ath3k_load_syscfg(struct usb_device *udev)
447{
448 unsigned char fw_state;
449 char filename[ATH3K_NAME_LEN] = {0};
450 const struct firmware *firmware;
451 struct ath3k_version fw_version;
452 int clk_value, ret;
453
454 ret = ath3k_get_state(udev, &fw_state);
455 if (ret < 0) {
456 BT_ERR("Can't get state to change to load configuration err");
457 return -EBUSY;
458 }
459
460 ret = ath3k_get_version(udev, &fw_version);
461 if (ret < 0) {
462 BT_ERR("Can't get version to change to load ram patch err");
463 return ret;
464 }
465
466 switch (fw_version.ref_clock) {
467
468 case ATH3K_XTAL_FREQ_26M:
469 clk_value = 26;
470 break;
471 case ATH3K_XTAL_FREQ_40M:
472 clk_value = 40;
473 break;
474 case ATH3K_XTAL_FREQ_19P2:
475 clk_value = 19;
476 break;
477 default:
478 clk_value = 0;
479 break;
480 }
481
482 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
483 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
484
485 ret = request_firmware(&firmware, filename, &udev->dev);
486 if (ret < 0) {
487 BT_ERR("Configuration file not found %s", filename);
488 return ret;
489 }
490
491 ret = ath3k_load_fwfile(udev, firmware);
492 release_firmware(firmware);
493
494 return ret;
495}
496
497static int ath3k_probe(struct usb_interface *intf,
498 const struct usb_device_id *id)
499{
500 const struct firmware *firmware;
501 struct usb_device *udev = interface_to_usbdev(intf);
502 int ret;
503
504 BT_DBG("intf %p id %p", intf, id);
505
506 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
507 return -ENODEV;
508
509
510 if (!id->driver_info) {
511 const struct usb_device_id *match;
512
513 match = usb_match_id(intf, ath3k_blist_tbl);
514 if (match)
515 id = match;
516 }
517
518
519 if (id->driver_info & BTUSB_ATH3012) {
520
521
522 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
523 return -ENODEV;
524
525 ret = ath3k_load_patch(udev);
526 if (ret < 0) {
527 BT_ERR("Loading patch file failed");
528 return ret;
529 }
530 ret = ath3k_load_syscfg(udev);
531 if (ret < 0) {
532 BT_ERR("Loading sysconfig file failed");
533 return ret;
534 }
535 ret = ath3k_set_normal_mode(udev);
536 if (ret < 0) {
537 BT_ERR("Set normal mode failed");
538 return ret;
539 }
540 ath3k_switch_pid(udev);
541 return 0;
542 }
543
544 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
545 if (ret < 0) {
546 if (ret == -ENOENT)
547 BT_ERR("Firmware file \"%s\" not found",
548 ATH3K_FIRMWARE);
549 else
550 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
551 ATH3K_FIRMWARE, ret);
552 return ret;
553 }
554
555 ret = ath3k_load_firmware(udev, firmware);
556 release_firmware(firmware);
557
558 return ret;
559}
560
561static void ath3k_disconnect(struct usb_interface *intf)
562{
563 BT_DBG("ath3k_disconnect intf %p", intf);
564}
565
566static struct usb_driver ath3k_driver = {
567 .name = "ath3k",
568 .probe = ath3k_probe,
569 .disconnect = ath3k_disconnect,
570 .id_table = ath3k_table,
571 .disable_hub_initiated_lpm = 1,
572};
573
574module_usb_driver(ath3k_driver);
575
576MODULE_AUTHOR("Atheros Communications");
577MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
578MODULE_VERSION(VERSION);
579MODULE_LICENSE("GPL");
580MODULE_FIRMWARE(ATH3K_FIRMWARE);
581
