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>
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
{
61 static const struct usb_device_id ath3k_table
[] = {
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(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) },
125 /* Atheros AR5BBU12 with sflash firmware */
126 { USB_DEVICE(0x0489, 0xE02C) },
128 /* Atheros AR5BBU22 with sflash firmware */
129 { USB_DEVICE(0x0489, 0xE036) },
130 { USB_DEVICE(0x0489, 0xE03C) },
132 { } /* Terminating entry */
135 MODULE_DEVICE_TABLE(usb
, ath3k_table
);
137 #define BTUSB_ATH3012 0x80
138 /* This table is to load patch and sysconfig files
140 static const struct usb_device_id ath3k_blist_tbl
[] = {
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
},
190 /* Atheros AR5BBU22 with sflash firmware */
191 { USB_DEVICE(0x0489, 0xE036), .driver_info
= BTUSB_ATH3012
},
192 { USB_DEVICE(0x0489, 0xE03C), .driver_info
= BTUSB_ATH3012
},
194 { } /* Terminating entry */
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
203 static int ath3k_load_firmware(struct usb_device
*udev
,
204 const struct firmware
*firmware
)
207 int err
, pipe
, len
, size
, sent
= 0;
208 int count
= firmware
->size
;
210 BT_DBG("udev %p", udev
);
212 pipe
= usb_sndctrlpipe(udev
, 0);
214 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
216 BT_ERR("Can't allocate memory chunk for firmware");
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
);
224 BT_ERR("Can't change to loading configuration err");
230 pipe
= usb_sndbulkpipe(udev
, 0x02);
233 /* workaround the compatibility issue with xHCI controller*/
234 usleep_range(TIMEGAP_USEC_MIN
, TIMEGAP_USEC_MAX
);
236 size
= min_t(uint
, count
, BULK_SIZE
);
237 memcpy(send_buf
, firmware
->data
+ sent
, size
);
239 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
242 if (err
|| (len
!= size
)) {
243 BT_ERR("Error in firmware loading err = %d,"
244 "len = %d, size = %d", err
, len
, size
);
257 static int ath3k_get_state(struct usb_device
*udev
, unsigned char *state
)
262 buf
= kmalloc(sizeof(*buf
), GFP_KERNEL
);
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
);
277 static int ath3k_get_version(struct usb_device
*udev
,
278 struct ath3k_version
*version
)
281 struct ath3k_version
*buf
;
282 const int size
= sizeof(*buf
);
284 buf
= kmalloc(size
, GFP_KERNEL
);
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
);
293 memcpy(version
, buf
, size
);
299 static int ath3k_load_fwfile(struct usb_device
*udev
,
300 const struct firmware
*firmware
)
303 int err
, pipe
, len
, size
, count
, sent
= 0;
306 count
= firmware
->size
;
308 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
310 BT_ERR("Can't allocate memory chunk for firmware");
314 size
= min_t(uint
, count
, FW_HDR_SIZE
);
315 memcpy(send_buf
, firmware
->data
, size
);
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
);
322 BT_ERR("Can't change to loading configuration err");
330 pipe
= usb_sndbulkpipe(udev
, 0x02);
333 /* workaround the compatibility issue with xHCI controller*/
334 usleep_range(TIMEGAP_USEC_MIN
, TIMEGAP_USEC_MAX
);
336 size
= min_t(uint
, count
, BULK_SIZE
);
337 memcpy(send_buf
, firmware
->data
+ sent
, size
);
339 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
341 if (err
|| (len
!= size
)) {
342 BT_ERR("Error in firmware loading err = %d,"
343 "len = %d, size = %d", err
, len
, size
);
355 static int ath3k_switch_pid(struct usb_device
*udev
)
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
);
365 static int ath3k_set_normal_mode(struct usb_device
*udev
)
367 unsigned char fw_state
;
370 ret
= ath3k_get_state(udev
, &fw_state
);
372 BT_ERR("Can't get state to change to normal mode err");
376 if ((fw_state
& ATH3K_MODE_MASK
) == ATH3K_NORMAL_MODE
) {
377 BT_DBG("firmware was already in normal mode");
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
);
387 static int ath3k_load_patch(struct usb_device
*udev
)
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
;
396 ret
= ath3k_get_state(udev
, &fw_state
);
398 BT_ERR("Can't get state to change to load ram patch err");
402 if (fw_state
& ATH3K_PATCH_UPDATE
) {
403 BT_DBG("Patch was already downloaded");
407 ret
= ath3k_get_version(udev
, &fw_version
);
409 BT_ERR("Can't get version to change to load ram patch err");
413 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/AthrBT_0x%08x.dfu",
414 le32_to_cpu(fw_version
.rom_version
));
416 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
418 BT_ERR("Patch file not found %s", filename
);
422 pt_rom_version
= get_unaligned_le32(firmware
->data
+
424 pt_build_version
= get_unaligned_le32(firmware
->data
+
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
);
434 ret
= ath3k_load_fwfile(udev
, firmware
);
435 release_firmware(firmware
);
440 static int ath3k_load_syscfg(struct usb_device
*udev
)
442 unsigned char fw_state
;
443 char filename
[ATH3K_NAME_LEN
] = {0};
444 const struct firmware
*firmware
;
445 struct ath3k_version fw_version
;
448 ret
= ath3k_get_state(udev
, &fw_state
);
450 BT_ERR("Can't get state to change to load configuration err");
454 ret
= ath3k_get_version(udev
, &fw_version
);
456 BT_ERR("Can't get version to change to load ram patch err");
460 switch (fw_version
.ref_clock
) {
462 case ATH3K_XTAL_FREQ_26M
:
465 case ATH3K_XTAL_FREQ_40M
:
468 case ATH3K_XTAL_FREQ_19P2
:
476 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/ramps_0x%08x_%d%s",
477 le32_to_cpu(fw_version
.rom_version
), clk_value
, ".dfu");
479 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
481 BT_ERR("Configuration file not found %s", filename
);
485 ret
= ath3k_load_fwfile(udev
, firmware
);
486 release_firmware(firmware
);
491 static int ath3k_probe(struct usb_interface
*intf
,
492 const struct usb_device_id
*id
)
494 const struct firmware
*firmware
;
495 struct usb_device
*udev
= interface_to_usbdev(intf
);
498 BT_DBG("intf %p id %p", intf
, id
);
500 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 0)
503 /* match device ID in ath3k blacklist table */
504 if (!id
->driver_info
) {
505 const struct usb_device_id
*match
;
507 match
= usb_match_id(intf
, ath3k_blist_tbl
);
512 /* load patch and sysconfig files for AR3012 */
513 if (id
->driver_info
& BTUSB_ATH3012
) {
515 /* New firmware with patch and sysconfig files already loaded */
516 if (le16_to_cpu(udev
->descriptor
.bcdDevice
) > 0x0001)
519 ret
= ath3k_load_patch(udev
);
521 BT_ERR("Loading patch file failed");
524 ret
= ath3k_load_syscfg(udev
);
526 BT_ERR("Loading sysconfig file failed");
529 ret
= ath3k_set_normal_mode(udev
);
531 BT_ERR("Set normal mode failed");
534 ath3k_switch_pid(udev
);
538 ret
= request_firmware(&firmware
, ATH3K_FIRMWARE
, &udev
->dev
);
541 BT_ERR("Firmware file \"%s\" not found",
544 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
545 ATH3K_FIRMWARE
, ret
);
549 ret
= ath3k_load_firmware(udev
, firmware
);
550 release_firmware(firmware
);
555 static void ath3k_disconnect(struct usb_interface
*intf
)
557 BT_DBG("ath3k_disconnect intf %p", intf
);
560 static struct usb_driver ath3k_driver
= {
562 .probe
= ath3k_probe
,
563 .disconnect
= ath3k_disconnect
,
564 .id_table
= ath3k_table
,
565 .disable_hub_initiated_lpm
= 1,
568 module_usb_driver(ath3k_driver
);
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
);