r8152: fix tx packets accounting
[linux/fpc-iii.git] / drivers / bluetooth / ath3k.c
blobb793853ff05fa827a33340ddd4766d2694422cd5
1 /*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
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.
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.
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
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>
33 #define VERSION "1.0"
34 #define ATH3K_FIRMWARE "ath3k-1.fw"
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
42 #define ATH3K_MODE_MASK 0x3F
43 #define ATH3K_NORMAL_MODE 0x0E
45 #define ATH3K_PATCH_UPDATE 0x80
46 #define ATH3K_SYSCFG_UPDATE 0x40
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
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;
61 static const struct usb_device_id ath3k_table[] = {
62 /* Atheros AR3011 */
63 { USB_DEVICE(0x0CF3, 0x3000) },
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) },
74 /* Atheros AR9285 Malbec with sflash firmware */
75 { USB_DEVICE(0x03F0, 0x311D) },
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(0x04CA, 0x3018) },
98 { USB_DEVICE(0x0930, 0x0219) },
99 { USB_DEVICE(0x0930, 0x021c) },
100 { USB_DEVICE(0x0930, 0x0220) },
101 { USB_DEVICE(0x0930, 0x0227) },
102 { USB_DEVICE(0x0b05, 0x17d0) },
103 { USB_DEVICE(0x0CF3, 0x0036) },
104 { USB_DEVICE(0x0CF3, 0x3004) },
105 { USB_DEVICE(0x0CF3, 0x3008) },
106 { USB_DEVICE(0x0CF3, 0x311D) },
107 { USB_DEVICE(0x0CF3, 0x311E) },
108 { USB_DEVICE(0x0CF3, 0x311F) },
109 { USB_DEVICE(0x0cf3, 0x3121) },
110 { USB_DEVICE(0x0CF3, 0x817a) },
111 { USB_DEVICE(0x0CF3, 0x817b) },
112 { USB_DEVICE(0x0cf3, 0xe003) },
113 { USB_DEVICE(0x0CF3, 0xE004) },
114 { USB_DEVICE(0x0CF3, 0xE005) },
115 { USB_DEVICE(0x0CF3, 0xE006) },
116 { USB_DEVICE(0x13d3, 0x3362) },
117 { USB_DEVICE(0x13d3, 0x3375) },
118 { USB_DEVICE(0x13d3, 0x3393) },
119 { USB_DEVICE(0x13d3, 0x3395) },
120 { USB_DEVICE(0x13d3, 0x3402) },
121 { USB_DEVICE(0x13d3, 0x3408) },
122 { USB_DEVICE(0x13d3, 0x3423) },
123 { USB_DEVICE(0x13d3, 0x3432) },
124 { USB_DEVICE(0x13d3, 0x3472) },
125 { USB_DEVICE(0x13d3, 0x3474) },
126 { USB_DEVICE(0x13d3, 0x3487) },
127 { USB_DEVICE(0x13d3, 0x3490) },
129 /* Atheros AR5BBU12 with sflash firmware */
130 { USB_DEVICE(0x0489, 0xE02C) },
132 /* Atheros AR5BBU22 with sflash firmware */
133 { USB_DEVICE(0x0489, 0xE036) },
134 { USB_DEVICE(0x0489, 0xE03C) },
136 { } /* Terminating entry */
139 MODULE_DEVICE_TABLE(usb, ath3k_table);
141 #define BTUSB_ATH3012 0x80
142 /* This table is to load patch and sysconfig files
143 * for AR3012 */
144 static const struct usb_device_id ath3k_blist_tbl[] = {
146 /* Atheros AR3012 with sflash firmware*/
147 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
169 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
170 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
171 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
173 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
174 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
175 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
176 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
177 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
191 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
193 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
194 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
195 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
196 { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
198 /* Atheros AR5BBU22 with sflash firmware */
199 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
200 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
202 { } /* Terminating entry */
205 #define USB_REQ_DFU_DNLOAD 1
206 #define BULK_SIZE 4096
207 #define FW_HDR_SIZE 20
208 #define TIMEGAP_USEC_MIN 50
209 #define TIMEGAP_USEC_MAX 100
211 static int ath3k_load_firmware(struct usb_device *udev,
212 const struct firmware *firmware)
214 u8 *send_buf;
215 int len = 0;
216 int err, pipe, size, sent = 0;
217 int count = firmware->size;
219 BT_DBG("udev %p", udev);
221 pipe = usb_sndctrlpipe(udev, 0);
223 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
224 if (!send_buf) {
225 BT_ERR("Can't allocate memory chunk for firmware");
226 return -ENOMEM;
229 memcpy(send_buf, firmware->data, 20);
230 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
231 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
232 if (err < 0) {
233 BT_ERR("Can't change to loading configuration err");
234 goto error;
236 sent += 20;
237 count -= 20;
239 pipe = usb_sndbulkpipe(udev, 0x02);
241 while (count) {
242 /* workaround the compatibility issue with xHCI controller*/
243 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
245 size = min_t(uint, count, BULK_SIZE);
246 memcpy(send_buf, firmware->data + sent, size);
248 err = usb_bulk_msg(udev, pipe, send_buf, size,
249 &len, 3000);
251 if (err || (len != size)) {
252 BT_ERR("Error in firmware loading err = %d,"
253 "len = %d, size = %d", err, len, size);
254 goto error;
257 sent += size;
258 count -= size;
261 error:
262 kfree(send_buf);
263 return err;
266 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
268 int ret, pipe = 0;
269 char *buf;
271 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
272 if (!buf)
273 return -ENOMEM;
275 pipe = usb_rcvctrlpipe(udev, 0);
276 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
277 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
278 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
280 *state = *buf;
281 kfree(buf);
283 return ret;
286 static int ath3k_get_version(struct usb_device *udev,
287 struct ath3k_version *version)
289 int ret, pipe = 0;
290 struct ath3k_version *buf;
291 const int size = sizeof(*buf);
293 buf = kmalloc(size, GFP_KERNEL);
294 if (!buf)
295 return -ENOMEM;
297 pipe = usb_rcvctrlpipe(udev, 0);
298 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
299 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
300 buf, size, USB_CTRL_SET_TIMEOUT);
302 memcpy(version, buf, size);
303 kfree(buf);
305 return ret;
308 static int ath3k_load_fwfile(struct usb_device *udev,
309 const struct firmware *firmware)
311 u8 *send_buf;
312 int len = 0;
313 int err, pipe, size, count, sent = 0;
314 int ret;
316 count = firmware->size;
318 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
319 if (!send_buf) {
320 BT_ERR("Can't allocate memory chunk for firmware");
321 return -ENOMEM;
324 size = min_t(uint, count, FW_HDR_SIZE);
325 memcpy(send_buf, firmware->data, size);
327 pipe = usb_sndctrlpipe(udev, 0);
328 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
329 USB_TYPE_VENDOR, 0, 0, send_buf,
330 size, USB_CTRL_SET_TIMEOUT);
331 if (ret < 0) {
332 BT_ERR("Can't change to loading configuration err");
333 kfree(send_buf);
334 return ret;
337 sent += size;
338 count -= size;
340 pipe = usb_sndbulkpipe(udev, 0x02);
342 while (count) {
343 /* workaround the compatibility issue with xHCI controller*/
344 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
346 size = min_t(uint, count, BULK_SIZE);
347 memcpy(send_buf, firmware->data + sent, size);
349 err = usb_bulk_msg(udev, pipe, send_buf, size,
350 &len, 3000);
351 if (err || (len != size)) {
352 BT_ERR("Error in firmware loading err = %d,"
353 "len = %d, size = %d", err, len, size);
354 kfree(send_buf);
355 return err;
357 sent += size;
358 count -= size;
361 kfree(send_buf);
362 return 0;
365 static int ath3k_switch_pid(struct usb_device *udev)
367 int pipe = 0;
369 pipe = usb_sndctrlpipe(udev, 0);
370 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
371 USB_TYPE_VENDOR, 0, 0,
372 NULL, 0, USB_CTRL_SET_TIMEOUT);
375 static int ath3k_set_normal_mode(struct usb_device *udev)
377 unsigned char fw_state;
378 int pipe = 0, ret;
380 ret = ath3k_get_state(udev, &fw_state);
381 if (ret < 0) {
382 BT_ERR("Can't get state to change to normal mode err");
383 return ret;
386 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
387 BT_DBG("firmware was already in normal mode");
388 return 0;
391 pipe = usb_sndctrlpipe(udev, 0);
392 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
393 USB_TYPE_VENDOR, 0, 0,
394 NULL, 0, USB_CTRL_SET_TIMEOUT);
397 static int ath3k_load_patch(struct usb_device *udev)
399 unsigned char fw_state;
400 char filename[ATH3K_NAME_LEN] = {0};
401 const struct firmware *firmware;
402 struct ath3k_version fw_version;
403 __u32 pt_rom_version, pt_build_version;
404 int ret;
406 ret = ath3k_get_state(udev, &fw_state);
407 if (ret < 0) {
408 BT_ERR("Can't get state to change to load ram patch err");
409 return ret;
412 if (fw_state & ATH3K_PATCH_UPDATE) {
413 BT_DBG("Patch was already downloaded");
414 return 0;
417 ret = ath3k_get_version(udev, &fw_version);
418 if (ret < 0) {
419 BT_ERR("Can't get version to change to load ram patch err");
420 return ret;
423 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
424 le32_to_cpu(fw_version.rom_version));
426 ret = request_firmware(&firmware, filename, &udev->dev);
427 if (ret < 0) {
428 BT_ERR("Patch file not found %s", filename);
429 return ret;
432 pt_rom_version = get_unaligned_le32(firmware->data +
433 firmware->size - 8);
434 pt_build_version = get_unaligned_le32(firmware->data +
435 firmware->size - 4);
437 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
438 pt_build_version <= le32_to_cpu(fw_version.build_version)) {
439 BT_ERR("Patch file version did not match with firmware");
440 release_firmware(firmware);
441 return -EINVAL;
444 ret = ath3k_load_fwfile(udev, firmware);
445 release_firmware(firmware);
447 return ret;
450 static int ath3k_load_syscfg(struct usb_device *udev)
452 unsigned char fw_state;
453 char filename[ATH3K_NAME_LEN] = {0};
454 const struct firmware *firmware;
455 struct ath3k_version fw_version;
456 int clk_value, ret;
458 ret = ath3k_get_state(udev, &fw_state);
459 if (ret < 0) {
460 BT_ERR("Can't get state to change to load configuration err");
461 return -EBUSY;
464 ret = ath3k_get_version(udev, &fw_version);
465 if (ret < 0) {
466 BT_ERR("Can't get version to change to load ram patch err");
467 return ret;
470 switch (fw_version.ref_clock) {
472 case ATH3K_XTAL_FREQ_26M:
473 clk_value = 26;
474 break;
475 case ATH3K_XTAL_FREQ_40M:
476 clk_value = 40;
477 break;
478 case ATH3K_XTAL_FREQ_19P2:
479 clk_value = 19;
480 break;
481 default:
482 clk_value = 0;
483 break;
486 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
487 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
489 ret = request_firmware(&firmware, filename, &udev->dev);
490 if (ret < 0) {
491 BT_ERR("Configuration file not found %s", filename);
492 return ret;
495 ret = ath3k_load_fwfile(udev, firmware);
496 release_firmware(firmware);
498 return ret;
501 static int ath3k_probe(struct usb_interface *intf,
502 const struct usb_device_id *id)
504 const struct firmware *firmware;
505 struct usb_device *udev = interface_to_usbdev(intf);
506 int ret;
508 BT_DBG("intf %p id %p", intf, id);
510 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
511 return -ENODEV;
513 /* match device ID in ath3k blacklist table */
514 if (!id->driver_info) {
515 const struct usb_device_id *match;
517 match = usb_match_id(intf, ath3k_blist_tbl);
518 if (match)
519 id = match;
522 /* load patch and sysconfig files for AR3012 */
523 if (id->driver_info & BTUSB_ATH3012) {
525 /* New firmware with patch and sysconfig files already loaded */
526 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
527 return -ENODEV;
529 ret = ath3k_load_patch(udev);
530 if (ret < 0) {
531 BT_ERR("Loading patch file failed");
532 return ret;
534 ret = ath3k_load_syscfg(udev);
535 if (ret < 0) {
536 BT_ERR("Loading sysconfig file failed");
537 return ret;
539 ret = ath3k_set_normal_mode(udev);
540 if (ret < 0) {
541 BT_ERR("Set normal mode failed");
542 return ret;
544 ath3k_switch_pid(udev);
545 return 0;
548 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
549 if (ret < 0) {
550 if (ret == -ENOENT)
551 BT_ERR("Firmware file \"%s\" not found",
552 ATH3K_FIRMWARE);
553 else
554 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
555 ATH3K_FIRMWARE, ret);
556 return ret;
559 ret = ath3k_load_firmware(udev, firmware);
560 release_firmware(firmware);
562 return ret;
565 static void ath3k_disconnect(struct usb_interface *intf)
567 BT_DBG("ath3k_disconnect intf %p", intf);
570 static struct usb_driver ath3k_driver = {
571 .name = "ath3k",
572 .probe = ath3k_probe,
573 .disconnect = ath3k_disconnect,
574 .id_table = ath3k_table,
575 .disable_hub_initiated_lpm = 1,
578 module_usb_driver(ath3k_driver);
580 MODULE_AUTHOR("Atheros Communications");
581 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
582 MODULE_VERSION(VERSION);
583 MODULE_LICENSE("GPL");
584 MODULE_FIRMWARE(ATH3K_FIRMWARE);