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 <net/bluetooth/bluetooth.h>
33 #define ATH3K_FIRMWARE "ath3k-1.fw"
35 #define ATH3K_DNLOAD 0x01
36 #define ATH3K_GETSTATE 0x05
37 #define ATH3K_SET_NORMAL_MODE 0x07
38 #define ATH3K_GETVERSION 0x09
39 #define USB_REG_SWITCH_VID_PID 0x0a
41 #define ATH3K_MODE_MASK 0x3F
42 #define ATH3K_NORMAL_MODE 0x0E
44 #define ATH3K_PATCH_UPDATE 0x80
45 #define ATH3K_SYSCFG_UPDATE 0x40
47 #define ATH3K_XTAL_FREQ_26M 0x00
48 #define ATH3K_XTAL_FREQ_40M 0x01
49 #define ATH3K_XTAL_FREQ_19P2 0x02
50 #define ATH3K_NAME_LEN 0xFF
52 struct ath3k_version
{
53 unsigned int rom_version
;
54 unsigned int build_version
;
55 unsigned int ram_version
;
56 unsigned char ref_clock
;
57 unsigned char reserved
[0x07];
60 static struct usb_device_id ath3k_table
[] = {
62 { USB_DEVICE(0x0CF3, 0x3000) },
64 /* Atheros AR3011 with sflash firmware*/
65 { USB_DEVICE(0x0CF3, 0x3002) },
66 { USB_DEVICE(0x0CF3, 0xE019) },
67 { USB_DEVICE(0x13d3, 0x3304) },
68 { USB_DEVICE(0x0930, 0x0215) },
69 { USB_DEVICE(0x0489, 0xE03D) },
71 /* Atheros AR9285 Malbec with sflash firmware */
72 { USB_DEVICE(0x03F0, 0x311D) },
74 /* Atheros AR3012 with sflash firmware*/
75 { USB_DEVICE(0x0CF3, 0x3004) },
76 { USB_DEVICE(0x0CF3, 0x311D) },
77 { USB_DEVICE(0x13d3, 0x3375) },
78 { USB_DEVICE(0x04CA, 0x3005) },
79 { USB_DEVICE(0x13d3, 0x3362) },
80 { USB_DEVICE(0x0CF3, 0xE004) },
81 { USB_DEVICE(0x0930, 0x0219) },
83 /* Atheros AR5BBU12 with sflash firmware */
84 { USB_DEVICE(0x0489, 0xE02C) },
86 /* Atheros AR5BBU22 with sflash firmware */
87 { USB_DEVICE(0x0489, 0xE03C) },
89 { } /* Terminating entry */
92 MODULE_DEVICE_TABLE(usb
, ath3k_table
);
94 #define BTUSB_ATH3012 0x80
95 /* This table is to load patch and sysconfig files
97 static struct usb_device_id ath3k_blist_tbl
[] = {
99 /* Atheros AR3012 with sflash firmware*/
100 { USB_DEVICE(0x0cf3, 0x3004), .driver_info
= BTUSB_ATH3012
},
101 { USB_DEVICE(0x0cf3, 0x311D), .driver_info
= BTUSB_ATH3012
},
102 { USB_DEVICE(0x13d3, 0x3375), .driver_info
= BTUSB_ATH3012
},
103 { USB_DEVICE(0x04ca, 0x3005), .driver_info
= BTUSB_ATH3012
},
104 { USB_DEVICE(0x13d3, 0x3362), .driver_info
= BTUSB_ATH3012
},
105 { USB_DEVICE(0x0cf3, 0xe004), .driver_info
= BTUSB_ATH3012
},
106 { USB_DEVICE(0x0930, 0x0219), .driver_info
= BTUSB_ATH3012
},
108 /* Atheros AR5BBU22 with sflash firmware */
109 { USB_DEVICE(0x0489, 0xE03C), .driver_info
= BTUSB_ATH3012
},
111 { } /* Terminating entry */
114 #define USB_REQ_DFU_DNLOAD 1
115 #define BULK_SIZE 4096
116 #define FW_HDR_SIZE 20
118 static int ath3k_load_firmware(struct usb_device
*udev
,
119 const struct firmware
*firmware
)
122 int err
, pipe
, len
, size
, sent
= 0;
123 int count
= firmware
->size
;
125 BT_DBG("udev %p", udev
);
127 pipe
= usb_sndctrlpipe(udev
, 0);
129 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
131 BT_ERR("Can't allocate memory chunk for firmware");
135 memcpy(send_buf
, firmware
->data
, 20);
136 if ((err
= usb_control_msg(udev
, pipe
,
138 USB_TYPE_VENDOR
, 0, 0,
139 send_buf
, 20, USB_CTRL_SET_TIMEOUT
)) < 0) {
140 BT_ERR("Can't change to loading configuration err");
147 size
= min_t(uint
, count
, BULK_SIZE
);
148 pipe
= usb_sndbulkpipe(udev
, 0x02);
149 memcpy(send_buf
, firmware
->data
+ sent
, size
);
151 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
154 if (err
|| (len
!= size
)) {
155 BT_ERR("Error in firmware loading err = %d,"
156 "len = %d, size = %d", err
, len
, size
);
169 static int ath3k_get_state(struct usb_device
*udev
, unsigned char *state
)
173 pipe
= usb_rcvctrlpipe(udev
, 0);
174 return usb_control_msg(udev
, pipe
, ATH3K_GETSTATE
,
175 USB_TYPE_VENDOR
| USB_DIR_IN
, 0, 0,
176 state
, 0x01, USB_CTRL_SET_TIMEOUT
);
179 static int ath3k_get_version(struct usb_device
*udev
,
180 struct ath3k_version
*version
)
184 pipe
= usb_rcvctrlpipe(udev
, 0);
185 return usb_control_msg(udev
, pipe
, ATH3K_GETVERSION
,
186 USB_TYPE_VENDOR
| USB_DIR_IN
, 0, 0, version
,
187 sizeof(struct ath3k_version
),
188 USB_CTRL_SET_TIMEOUT
);
191 static int ath3k_load_fwfile(struct usb_device
*udev
,
192 const struct firmware
*firmware
)
195 int err
, pipe
, len
, size
, count
, sent
= 0;
198 count
= firmware
->size
;
200 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
202 BT_ERR("Can't allocate memory chunk for firmware");
206 size
= min_t(uint
, count
, FW_HDR_SIZE
);
207 memcpy(send_buf
, firmware
->data
, size
);
209 pipe
= usb_sndctrlpipe(udev
, 0);
210 ret
= usb_control_msg(udev
, pipe
, ATH3K_DNLOAD
,
211 USB_TYPE_VENDOR
, 0, 0, send_buf
,
212 size
, USB_CTRL_SET_TIMEOUT
);
214 BT_ERR("Can't change to loading configuration err");
223 size
= min_t(uint
, count
, BULK_SIZE
);
224 pipe
= usb_sndbulkpipe(udev
, 0x02);
226 memcpy(send_buf
, firmware
->data
+ sent
, size
);
228 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
230 if (err
|| (len
!= size
)) {
231 BT_ERR("Error in firmware loading err = %d,"
232 "len = %d, size = %d", err
, len
, size
);
244 static int ath3k_switch_pid(struct usb_device
*udev
)
248 pipe
= usb_sndctrlpipe(udev
, 0);
249 return usb_control_msg(udev
, pipe
, USB_REG_SWITCH_VID_PID
,
250 USB_TYPE_VENDOR
, 0, 0,
251 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
254 static int ath3k_set_normal_mode(struct usb_device
*udev
)
256 unsigned char fw_state
;
259 ret
= ath3k_get_state(udev
, &fw_state
);
261 BT_ERR("Can't get state to change to normal mode err");
265 if ((fw_state
& ATH3K_MODE_MASK
) == ATH3K_NORMAL_MODE
) {
266 BT_DBG("firmware was already in normal mode");
270 pipe
= usb_sndctrlpipe(udev
, 0);
271 return usb_control_msg(udev
, pipe
, ATH3K_SET_NORMAL_MODE
,
272 USB_TYPE_VENDOR
, 0, 0,
273 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
276 static int ath3k_load_patch(struct usb_device
*udev
)
278 unsigned char fw_state
;
279 char filename
[ATH3K_NAME_LEN
] = {0};
280 const struct firmware
*firmware
;
281 struct ath3k_version fw_version
, pt_version
;
284 ret
= ath3k_get_state(udev
, &fw_state
);
286 BT_ERR("Can't get state to change to load ram patch err");
290 if (fw_state
& ATH3K_PATCH_UPDATE
) {
291 BT_DBG("Patch was already downloaded");
295 ret
= ath3k_get_version(udev
, &fw_version
);
297 BT_ERR("Can't get version to change to load ram patch err");
301 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/AthrBT_0x%08x.dfu",
302 fw_version
.rom_version
);
304 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
306 BT_ERR("Patch file not found %s", filename
);
310 pt_version
.rom_version
= *(int *)(firmware
->data
+ firmware
->size
- 8);
311 pt_version
.build_version
= *(int *)
312 (firmware
->data
+ firmware
->size
- 4);
314 if ((pt_version
.rom_version
!= fw_version
.rom_version
) ||
315 (pt_version
.build_version
<= fw_version
.build_version
)) {
316 BT_ERR("Patch file version did not match with firmware");
317 release_firmware(firmware
);
321 ret
= ath3k_load_fwfile(udev
, firmware
);
322 release_firmware(firmware
);
327 static int ath3k_load_syscfg(struct usb_device
*udev
)
329 unsigned char fw_state
;
330 char filename
[ATH3K_NAME_LEN
] = {0};
331 const struct firmware
*firmware
;
332 struct ath3k_version fw_version
;
335 ret
= ath3k_get_state(udev
, &fw_state
);
337 BT_ERR("Can't get state to change to load configration err");
341 ret
= ath3k_get_version(udev
, &fw_version
);
343 BT_ERR("Can't get version to change to load ram patch err");
347 switch (fw_version
.ref_clock
) {
349 case ATH3K_XTAL_FREQ_26M
:
352 case ATH3K_XTAL_FREQ_40M
:
355 case ATH3K_XTAL_FREQ_19P2
:
363 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/ramps_0x%08x_%d%s",
364 fw_version
.rom_version
, clk_value
, ".dfu");
366 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
368 BT_ERR("Configuration file not found %s", filename
);
372 ret
= ath3k_load_fwfile(udev
, firmware
);
373 release_firmware(firmware
);
378 static int ath3k_probe(struct usb_interface
*intf
,
379 const struct usb_device_id
*id
)
381 const struct firmware
*firmware
;
382 struct usb_device
*udev
= interface_to_usbdev(intf
);
385 BT_DBG("intf %p id %p", intf
, id
);
387 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 0)
390 /* match device ID in ath3k blacklist table */
391 if (!id
->driver_info
) {
392 const struct usb_device_id
*match
;
393 match
= usb_match_id(intf
, ath3k_blist_tbl
);
398 /* load patch and sysconfig files for AR3012 */
399 if (id
->driver_info
& BTUSB_ATH3012
) {
401 /* New firmware with patch and sysconfig files already loaded */
402 if (le16_to_cpu(udev
->descriptor
.bcdDevice
) > 0x0001)
405 ret
= ath3k_load_patch(udev
);
407 BT_ERR("Loading patch file failed");
410 ret
= ath3k_load_syscfg(udev
);
412 BT_ERR("Loading sysconfig file failed");
415 ret
= ath3k_set_normal_mode(udev
);
417 BT_ERR("Set normal mode failed");
420 ath3k_switch_pid(udev
);
424 ret
= request_firmware(&firmware
, ATH3K_FIRMWARE
, &udev
->dev
);
427 BT_ERR("Firmware file \"%s\" not found",
430 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
431 ATH3K_FIRMWARE
, ret
);
435 ret
= ath3k_load_firmware(udev
, firmware
);
436 release_firmware(firmware
);
441 static void ath3k_disconnect(struct usb_interface
*intf
)
443 BT_DBG("ath3k_disconnect intf %p", intf
);
446 static struct usb_driver ath3k_driver
= {
448 .probe
= ath3k_probe
,
449 .disconnect
= ath3k_disconnect
,
450 .id_table
= ath3k_table
,
451 .disable_hub_initiated_lpm
= 1,
454 module_usb_driver(ath3k_driver
);
456 MODULE_AUTHOR("Atheros Communications");
457 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
458 MODULE_VERSION(VERSION
);
459 MODULE_LICENSE("GPL");
460 MODULE_FIRMWARE(ATH3K_FIRMWARE
);