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(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
145 static const struct usb_device_id ath3k_blist_tbl
[] = {
147 /* Atheros AR3012 with sflash firmware*/
148 { USB_DEVICE(0x0489, 0xe04e), .driver_info
= BTUSB_ATH3012
},
149 { USB_DEVICE(0x0489, 0xe04d), .driver_info
= BTUSB_ATH3012
},
150 { USB_DEVICE(0x0489, 0xe056), .driver_info
= BTUSB_ATH3012
},
151 { USB_DEVICE(0x0489, 0xe057), .driver_info
= BTUSB_ATH3012
},
152 { USB_DEVICE(0x0489, 0xe05f), .driver_info
= BTUSB_ATH3012
},
153 { USB_DEVICE(0x0489, 0xe076), .driver_info
= BTUSB_ATH3012
},
154 { USB_DEVICE(0x0489, 0xe078), .driver_info
= BTUSB_ATH3012
},
155 { USB_DEVICE(0x0489, 0xe095), .driver_info
= BTUSB_ATH3012
},
156 { USB_DEVICE(0x04c5, 0x1330), .driver_info
= BTUSB_ATH3012
},
157 { USB_DEVICE(0x04ca, 0x3004), .driver_info
= BTUSB_ATH3012
},
158 { USB_DEVICE(0x04ca, 0x3005), .driver_info
= BTUSB_ATH3012
},
159 { USB_DEVICE(0x04ca, 0x3006), .driver_info
= BTUSB_ATH3012
},
160 { USB_DEVICE(0x04ca, 0x3007), .driver_info
= BTUSB_ATH3012
},
161 { USB_DEVICE(0x04ca, 0x3008), .driver_info
= BTUSB_ATH3012
},
162 { USB_DEVICE(0x04ca, 0x300b), .driver_info
= BTUSB_ATH3012
},
163 { USB_DEVICE(0x04ca, 0x300d), .driver_info
= BTUSB_ATH3012
},
164 { USB_DEVICE(0x04ca, 0x300f), .driver_info
= BTUSB_ATH3012
},
165 { USB_DEVICE(0x04ca, 0x3010), .driver_info
= BTUSB_ATH3012
},
166 { USB_DEVICE(0x04ca, 0x3014), .driver_info
= BTUSB_ATH3012
},
167 { USB_DEVICE(0x04ca, 0x3018), .driver_info
= BTUSB_ATH3012
},
168 { USB_DEVICE(0x0930, 0x0219), .driver_info
= BTUSB_ATH3012
},
169 { USB_DEVICE(0x0930, 0x021c), .driver_info
= BTUSB_ATH3012
},
170 { USB_DEVICE(0x0930, 0x0220), .driver_info
= BTUSB_ATH3012
},
171 { USB_DEVICE(0x0930, 0x0227), .driver_info
= BTUSB_ATH3012
},
172 { USB_DEVICE(0x0b05, 0x17d0), .driver_info
= BTUSB_ATH3012
},
173 { USB_DEVICE(0x0CF3, 0x0036), .driver_info
= BTUSB_ATH3012
},
174 { USB_DEVICE(0x0cf3, 0x3004), .driver_info
= BTUSB_ATH3012
},
175 { USB_DEVICE(0x0cf3, 0x3008), .driver_info
= BTUSB_ATH3012
},
176 { USB_DEVICE(0x0cf3, 0x311D), .driver_info
= BTUSB_ATH3012
},
177 { USB_DEVICE(0x0cf3, 0x311E), .driver_info
= BTUSB_ATH3012
},
178 { USB_DEVICE(0x0cf3, 0x311F), .driver_info
= BTUSB_ATH3012
},
179 { USB_DEVICE(0x0cf3, 0x3121), .driver_info
= BTUSB_ATH3012
},
180 { USB_DEVICE(0x0CF3, 0x817a), .driver_info
= BTUSB_ATH3012
},
181 { USB_DEVICE(0x0CF3, 0x817b), .driver_info
= BTUSB_ATH3012
},
182 { USB_DEVICE(0x0cf3, 0xe004), .driver_info
= BTUSB_ATH3012
},
183 { USB_DEVICE(0x0cf3, 0xe005), .driver_info
= BTUSB_ATH3012
},
184 { USB_DEVICE(0x0cf3, 0xe006), .driver_info
= BTUSB_ATH3012
},
185 { USB_DEVICE(0x0cf3, 0xe003), .driver_info
= BTUSB_ATH3012
},
186 { USB_DEVICE(0x13d3, 0x3362), .driver_info
= BTUSB_ATH3012
},
187 { USB_DEVICE(0x13d3, 0x3375), .driver_info
= BTUSB_ATH3012
},
188 { USB_DEVICE(0x13d3, 0x3393), .driver_info
= BTUSB_ATH3012
},
189 { USB_DEVICE(0x13d3, 0x3395), .driver_info
= BTUSB_ATH3012
},
190 { USB_DEVICE(0x13d3, 0x3402), .driver_info
= BTUSB_ATH3012
},
191 { USB_DEVICE(0x13d3, 0x3408), .driver_info
= BTUSB_ATH3012
},
192 { USB_DEVICE(0x13d3, 0x3423), .driver_info
= BTUSB_ATH3012
},
193 { USB_DEVICE(0x13d3, 0x3432), .driver_info
= BTUSB_ATH3012
},
194 { USB_DEVICE(0x13d3, 0x3472), .driver_info
= BTUSB_ATH3012
},
195 { USB_DEVICE(0x13d3, 0x3474), .driver_info
= BTUSB_ATH3012
},
196 { USB_DEVICE(0x13d3, 0x3487), .driver_info
= BTUSB_ATH3012
},
197 { USB_DEVICE(0x13d3, 0x3490), .driver_info
= BTUSB_ATH3012
},
199 /* Atheros AR5BBU22 with sflash firmware */
200 { USB_DEVICE(0x0489, 0xE036), .driver_info
= BTUSB_ATH3012
},
201 { USB_DEVICE(0x0489, 0xE03C), .driver_info
= BTUSB_ATH3012
},
203 { } /* Terminating entry */
206 static inline void ath3k_log_failed_loading(int err
, int len
, int size
)
208 BT_ERR("Error in firmware loading err = %d, len = %d, size = %d",
212 #define USB_REQ_DFU_DNLOAD 1
213 #define BULK_SIZE 4096
214 #define FW_HDR_SIZE 20
215 #define TIMEGAP_USEC_MIN 50
216 #define TIMEGAP_USEC_MAX 100
218 static int ath3k_load_firmware(struct usb_device
*udev
,
219 const struct firmware
*firmware
)
223 int err
, pipe
, size
, sent
= 0;
224 int count
= firmware
->size
;
226 BT_DBG("udev %p", udev
);
228 pipe
= usb_sndctrlpipe(udev
, 0);
230 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
232 BT_ERR("Can't allocate memory chunk for firmware");
236 memcpy(send_buf
, firmware
->data
, FW_HDR_SIZE
);
237 err
= usb_control_msg(udev
, pipe
, USB_REQ_DFU_DNLOAD
, USB_TYPE_VENDOR
,
238 0, 0, send_buf
, FW_HDR_SIZE
,
239 USB_CTRL_SET_TIMEOUT
);
241 BT_ERR("Can't change to loading configuration err");
245 count
-= FW_HDR_SIZE
;
247 pipe
= usb_sndbulkpipe(udev
, 0x02);
250 /* workaround the compatibility issue with xHCI controller*/
251 usleep_range(TIMEGAP_USEC_MIN
, TIMEGAP_USEC_MAX
);
253 size
= min_t(uint
, count
, BULK_SIZE
);
254 memcpy(send_buf
, firmware
->data
+ sent
, size
);
256 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
259 if (err
|| (len
!= size
)) {
260 ath3k_log_failed_loading(err
, len
, size
);
273 static int ath3k_get_state(struct usb_device
*udev
, unsigned char *state
)
278 buf
= kmalloc(sizeof(*buf
), GFP_KERNEL
);
282 pipe
= usb_rcvctrlpipe(udev
, 0);
283 ret
= usb_control_msg(udev
, pipe
, ATH3K_GETSTATE
,
284 USB_TYPE_VENDOR
| USB_DIR_IN
, 0, 0,
285 buf
, sizeof(*buf
), USB_CTRL_SET_TIMEOUT
);
293 static int ath3k_get_version(struct usb_device
*udev
,
294 struct ath3k_version
*version
)
297 struct ath3k_version
*buf
;
298 const int size
= sizeof(*buf
);
300 buf
= kmalloc(size
, GFP_KERNEL
);
304 pipe
= usb_rcvctrlpipe(udev
, 0);
305 ret
= usb_control_msg(udev
, pipe
, ATH3K_GETVERSION
,
306 USB_TYPE_VENDOR
| USB_DIR_IN
, 0, 0,
307 buf
, size
, USB_CTRL_SET_TIMEOUT
);
309 memcpy(version
, buf
, size
);
315 static int ath3k_load_fwfile(struct usb_device
*udev
,
316 const struct firmware
*firmware
)
320 int err
, pipe
, size
, count
, sent
= 0;
323 count
= firmware
->size
;
325 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
327 BT_ERR("Can't allocate memory chunk for firmware");
331 size
= min_t(uint
, count
, FW_HDR_SIZE
);
332 memcpy(send_buf
, firmware
->data
, size
);
334 pipe
= usb_sndctrlpipe(udev
, 0);
335 ret
= usb_control_msg(udev
, pipe
, ATH3K_DNLOAD
,
336 USB_TYPE_VENDOR
, 0, 0, send_buf
,
337 size
, USB_CTRL_SET_TIMEOUT
);
339 BT_ERR("Can't change to loading configuration err");
347 pipe
= usb_sndbulkpipe(udev
, 0x02);
350 /* workaround the compatibility issue with xHCI controller*/
351 usleep_range(TIMEGAP_USEC_MIN
, TIMEGAP_USEC_MAX
);
353 size
= min_t(uint
, count
, BULK_SIZE
);
354 memcpy(send_buf
, firmware
->data
+ sent
, size
);
356 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
358 if (err
|| (len
!= size
)) {
359 ath3k_log_failed_loading(err
, len
, size
);
371 static int ath3k_switch_pid(struct usb_device
*udev
)
375 pipe
= usb_sndctrlpipe(udev
, 0);
376 return usb_control_msg(udev
, pipe
, USB_REG_SWITCH_VID_PID
,
377 USB_TYPE_VENDOR
, 0, 0,
378 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
381 static int ath3k_set_normal_mode(struct usb_device
*udev
)
383 unsigned char fw_state
;
386 ret
= ath3k_get_state(udev
, &fw_state
);
388 BT_ERR("Can't get state to change to normal mode err");
392 if ((fw_state
& ATH3K_MODE_MASK
) == ATH3K_NORMAL_MODE
) {
393 BT_DBG("firmware was already in normal mode");
397 pipe
= usb_sndctrlpipe(udev
, 0);
398 return usb_control_msg(udev
, pipe
, ATH3K_SET_NORMAL_MODE
,
399 USB_TYPE_VENDOR
, 0, 0,
400 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
403 static int ath3k_load_patch(struct usb_device
*udev
)
405 unsigned char fw_state
;
406 char filename
[ATH3K_NAME_LEN
];
407 const struct firmware
*firmware
;
408 struct ath3k_version fw_version
;
409 __u32 pt_rom_version
, pt_build_version
;
412 ret
= ath3k_get_state(udev
, &fw_state
);
414 BT_ERR("Can't get state to change to load ram patch err");
418 if (fw_state
& ATH3K_PATCH_UPDATE
) {
419 BT_DBG("Patch was already downloaded");
423 ret
= ath3k_get_version(udev
, &fw_version
);
425 BT_ERR("Can't get version to change to load ram patch err");
429 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/AthrBT_0x%08x.dfu",
430 le32_to_cpu(fw_version
.rom_version
));
432 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
434 BT_ERR("Patch file not found %s", filename
);
438 pt_rom_version
= get_unaligned_le32(firmware
->data
+
440 pt_build_version
= get_unaligned_le32(firmware
->data
+
443 if (pt_rom_version
!= le32_to_cpu(fw_version
.rom_version
) ||
444 pt_build_version
<= le32_to_cpu(fw_version
.build_version
)) {
445 BT_ERR("Patch file version did not match with firmware");
446 release_firmware(firmware
);
450 ret
= ath3k_load_fwfile(udev
, firmware
);
451 release_firmware(firmware
);
456 static int ath3k_load_syscfg(struct usb_device
*udev
)
458 unsigned char fw_state
;
459 char filename
[ATH3K_NAME_LEN
];
460 const struct firmware
*firmware
;
461 struct ath3k_version fw_version
;
464 ret
= ath3k_get_state(udev
, &fw_state
);
466 BT_ERR("Can't get state to change to load configuration err");
470 ret
= ath3k_get_version(udev
, &fw_version
);
472 BT_ERR("Can't get version to change to load ram patch err");
476 switch (fw_version
.ref_clock
) {
478 case ATH3K_XTAL_FREQ_26M
:
481 case ATH3K_XTAL_FREQ_40M
:
484 case ATH3K_XTAL_FREQ_19P2
:
492 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/ramps_0x%08x_%d%s",
493 le32_to_cpu(fw_version
.rom_version
), clk_value
, ".dfu");
495 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
497 BT_ERR("Configuration file not found %s", filename
);
501 ret
= ath3k_load_fwfile(udev
, firmware
);
502 release_firmware(firmware
);
507 static int ath3k_probe(struct usb_interface
*intf
,
508 const struct usb_device_id
*id
)
510 const struct firmware
*firmware
;
511 struct usb_device
*udev
= interface_to_usbdev(intf
);
514 BT_DBG("intf %p id %p", intf
, id
);
516 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 0)
519 /* match device ID in ath3k blacklist table */
520 if (!id
->driver_info
) {
521 const struct usb_device_id
*match
;
523 match
= usb_match_id(intf
, ath3k_blist_tbl
);
528 /* load patch and sysconfig files for AR3012 */
529 if (id
->driver_info
& BTUSB_ATH3012
) {
530 /* New firmware with patch and sysconfig files already loaded */
531 if (le16_to_cpu(udev
->descriptor
.bcdDevice
) > 0x0001)
534 ret
= ath3k_load_patch(udev
);
536 BT_ERR("Loading patch file failed");
539 ret
= ath3k_load_syscfg(udev
);
541 BT_ERR("Loading sysconfig file failed");
544 ret
= ath3k_set_normal_mode(udev
);
546 BT_ERR("Set normal mode failed");
549 ath3k_switch_pid(udev
);
553 ret
= request_firmware(&firmware
, ATH3K_FIRMWARE
, &udev
->dev
);
556 BT_ERR("Firmware file \"%s\" not found",
559 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
560 ATH3K_FIRMWARE
, ret
);
564 ret
= ath3k_load_firmware(udev
, firmware
);
565 release_firmware(firmware
);
570 static void ath3k_disconnect(struct usb_interface
*intf
)
572 BT_DBG("%s intf %p", __func__
, intf
);
575 static struct usb_driver ath3k_driver
= {
577 .probe
= ath3k_probe
,
578 .disconnect
= ath3k_disconnect
,
579 .id_table
= ath3k_table
,
580 .disable_hub_initiated_lpm
= 1,
583 module_usb_driver(ath3k_driver
);
585 MODULE_AUTHOR("Atheros Communications");
586 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
587 MODULE_VERSION(VERSION
);
588 MODULE_LICENSE("GPL");
589 MODULE_FIRMWARE(ATH3K_FIRMWARE
);