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