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(0x13d3, 0x3304) },
67 { USB_DEVICE(0x0930, 0x0215) },
68 { USB_DEVICE(0x0489, 0xE03D) },
70 /* Atheros AR9285 Malbec with sflash firmware */
71 { USB_DEVICE(0x03F0, 0x311D) },
73 /* Atheros AR3012 with sflash firmware*/
74 { USB_DEVICE(0x0CF3, 0x3004) },
75 { USB_DEVICE(0x0CF3, 0x311D) },
76 { USB_DEVICE(0x13d3, 0x3375) },
77 { USB_DEVICE(0x04CA, 0x3005) },
78 { USB_DEVICE(0x13d3, 0x3362) },
79 { USB_DEVICE(0x0CF3, 0xE004) },
81 /* Atheros AR5BBU12 with sflash firmware */
82 { USB_DEVICE(0x0489, 0xE02C) },
84 { } /* Terminating entry */
87 MODULE_DEVICE_TABLE(usb, ath3k_table);
89 #define BTUSB_ATH3012 0x80
90 /* This table is to load patch and sysconfig files
92 static struct usb_device_id ath3k_blist_tbl[] = {
94 /* Atheros AR3012 with sflash firmware*/
95 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
96 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
97 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
98 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
99 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
100 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
102 { } /* Terminating entry */
105 #define USB_REQ_DFU_DNLOAD 1
106 #define BULK_SIZE 4096
107 #define FW_HDR_SIZE 20
109 static int ath3k_load_firmware(struct usb_device *udev,
110 const struct firmware *firmware)
113 int err, pipe, len, size, sent = 0;
114 int count = firmware->size;
116 BT_DBG("udev %p", udev);
118 pipe = usb_sndctrlpipe(udev, 0);
120 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
122 BT_ERR("Can't allocate memory chunk for firmware");
126 memcpy(send_buf, firmware->data, 20);
127 if ((err = usb_control_msg(udev, pipe,
129 USB_TYPE_VENDOR, 0, 0,
130 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
131 BT_ERR("Can't change to loading configuration err");
138 size = min_t(uint, count, BULK_SIZE);
139 pipe = usb_sndbulkpipe(udev, 0x02);
140 memcpy(send_buf, firmware->data + sent, size);
142 err = usb_bulk_msg(udev, pipe, send_buf, size,
145 if (err || (len != size)) {
146 BT_ERR("Error in firmware loading err = %d,"
147 "len = %d, size = %d", err, len, size);
160 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
164 pipe = usb_rcvctrlpipe(udev, 0);
165 return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
166 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
167 state, 0x01, USB_CTRL_SET_TIMEOUT);
170 static int ath3k_get_version(struct usb_device *udev,
171 struct ath3k_version *version)
175 pipe = usb_rcvctrlpipe(udev, 0);
176 return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
177 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
178 sizeof(struct ath3k_version),
179 USB_CTRL_SET_TIMEOUT);
182 static int ath3k_load_fwfile(struct usb_device *udev,
183 const struct firmware *firmware)
186 int err, pipe, len, size, count, sent = 0;
189 count = firmware->size;
191 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
193 BT_ERR("Can't allocate memory chunk for firmware");
197 size = min_t(uint, count, FW_HDR_SIZE);
198 memcpy(send_buf, firmware->data, size);
200 pipe = usb_sndctrlpipe(udev, 0);
201 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
202 USB_TYPE_VENDOR, 0, 0, send_buf,
203 size, USB_CTRL_SET_TIMEOUT);
205 BT_ERR("Can't change to loading configuration err");
214 size = min_t(uint, count, BULK_SIZE);
215 pipe = usb_sndbulkpipe(udev, 0x02);
217 memcpy(send_buf, firmware->data + sent, size);
219 err = usb_bulk_msg(udev, pipe, send_buf, size,
221 if (err || (len != size)) {
222 BT_ERR("Error in firmware loading err = %d,"
223 "len = %d, size = %d", err, len, size);
235 static int ath3k_switch_pid(struct usb_device *udev)
239 pipe = usb_sndctrlpipe(udev, 0);
240 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
241 USB_TYPE_VENDOR, 0, 0,
242 NULL, 0, USB_CTRL_SET_TIMEOUT);
245 static int ath3k_set_normal_mode(struct usb_device *udev)
247 unsigned char fw_state;
250 ret = ath3k_get_state(udev, &fw_state);
252 BT_ERR("Can't get state to change to normal mode err");
256 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
257 BT_DBG("firmware was already in normal mode");
261 pipe = usb_sndctrlpipe(udev, 0);
262 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
263 USB_TYPE_VENDOR, 0, 0,
264 NULL, 0, USB_CTRL_SET_TIMEOUT);
267 static int ath3k_load_patch(struct usb_device *udev)
269 unsigned char fw_state;
270 char filename[ATH3K_NAME_LEN] = {0};
271 const struct firmware *firmware;
272 struct ath3k_version fw_version, pt_version;
275 ret = ath3k_get_state(udev, &fw_state);
277 BT_ERR("Can't get state to change to load ram patch err");
281 if (fw_state & ATH3K_PATCH_UPDATE) {
282 BT_DBG("Patch was already downloaded");
286 ret = ath3k_get_version(udev, &fw_version);
288 BT_ERR("Can't get version to change to load ram patch err");
292 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
293 fw_version.rom_version);
295 ret = request_firmware(&firmware, filename, &udev->dev);
297 BT_ERR("Patch file not found %s", filename);
301 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
302 pt_version.build_version = *(int *)
303 (firmware->data + firmware->size - 4);
305 if ((pt_version.rom_version != fw_version.rom_version) ||
306 (pt_version.build_version <= fw_version.build_version)) {
307 BT_ERR("Patch file version did not match with firmware");
308 release_firmware(firmware);
312 ret = ath3k_load_fwfile(udev, firmware);
313 release_firmware(firmware);
318 static int ath3k_load_syscfg(struct usb_device *udev)
320 unsigned char fw_state;
321 char filename[ATH3K_NAME_LEN] = {0};
322 const struct firmware *firmware;
323 struct ath3k_version fw_version;
326 ret = ath3k_get_state(udev, &fw_state);
328 BT_ERR("Can't get state to change to load configration err");
332 ret = ath3k_get_version(udev, &fw_version);
334 BT_ERR("Can't get version to change to load ram patch err");
338 switch (fw_version.ref_clock) {
340 case ATH3K_XTAL_FREQ_26M:
343 case ATH3K_XTAL_FREQ_40M:
346 case ATH3K_XTAL_FREQ_19P2:
354 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
355 fw_version.rom_version, clk_value, ".dfu");
357 ret = request_firmware(&firmware, filename, &udev->dev);
359 BT_ERR("Configuration file not found %s", filename);
363 ret = ath3k_load_fwfile(udev, firmware);
364 release_firmware(firmware);
369 static int ath3k_probe(struct usb_interface *intf,
370 const struct usb_device_id *id)
372 const struct firmware *firmware;
373 struct usb_device *udev = interface_to_usbdev(intf);
376 BT_DBG("intf %p id %p", intf, id);
378 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
381 /* match device ID in ath3k blacklist table */
382 if (!id->driver_info) {
383 const struct usb_device_id *match;
384 match = usb_match_id(intf, ath3k_blist_tbl);
389 /* load patch and sysconfig files for AR3012 */
390 if (id->driver_info & BTUSB_ATH3012) {
392 /* New firmware with patch and sysconfig files already loaded */
393 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
396 ret = ath3k_load_patch(udev);
398 BT_ERR("Loading patch file failed");
401 ret = ath3k_load_syscfg(udev);
403 BT_ERR("Loading sysconfig file failed");
406 ret = ath3k_set_normal_mode(udev);
408 BT_ERR("Set normal mode failed");
411 ath3k_switch_pid(udev);
415 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
418 BT_ERR("Firmware file \"%s\" not found",
421 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
422 ATH3K_FIRMWARE, ret);
426 ret = ath3k_load_firmware(udev, firmware);
427 release_firmware(firmware);
432 static void ath3k_disconnect(struct usb_interface *intf)
434 BT_DBG("ath3k_disconnect intf %p", intf);
437 static struct usb_driver ath3k_driver = {
439 .probe = ath3k_probe,
440 .disconnect = ath3k_disconnect,
441 .id_table = ath3k_table,
444 module_usb_driver(ath3k_driver);
446 MODULE_AUTHOR("Atheros Communications");
447 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
448 MODULE_VERSION(VERSION);
449 MODULE_LICENSE("GPL");
450 MODULE_FIRMWARE(ATH3K_FIRMWARE);