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