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>
34 #define ATH3K_DNLOAD 0x01
35 #define ATH3K_GETSTATE 0x05
36 #define ATH3K_SET_NORMAL_MODE 0x07
37 #define ATH3K_GETVERSION 0x09
38 #define USB_REG_SWITCH_VID_PID 0x0a
40 #define ATH3K_MODE_MASK 0x3F
41 #define ATH3K_NORMAL_MODE 0x0E
43 #define ATH3K_PATCH_UPDATE 0x80
44 #define ATH3K_SYSCFG_UPDATE 0x40
46 #define ATH3K_XTAL_FREQ_26M 0x00
47 #define ATH3K_XTAL_FREQ_40M 0x01
48 #define ATH3K_XTAL_FREQ_19P2 0x02
49 #define ATH3K_NAME_LEN 0xFF
51 struct ath3k_version {
52 unsigned int rom_version;
53 unsigned int build_version;
54 unsigned int ram_version;
55 unsigned char ref_clock;
56 unsigned char reserved[0x07];
59 static struct usb_device_id ath3k_table[] = {
61 { USB_DEVICE(0x0CF3, 0x3000) },
63 /* Atheros AR3011 with sflash firmware*/
64 { USB_DEVICE(0x0CF3, 0x3002) },
65 { USB_DEVICE(0x13d3, 0x3304) },
66 { USB_DEVICE(0x0930, 0x0215) },
67 { USB_DEVICE(0x0489, 0xE03D) },
69 /* Atheros AR9285 Malbec with sflash firmware */
70 { USB_DEVICE(0x03F0, 0x311D) },
72 /* Atheros AR3012 with sflash firmware*/
73 { USB_DEVICE(0x0CF3, 0x3004) },
74 { USB_DEVICE(0x0CF3, 0x311D) },
75 { USB_DEVICE(0x13d3, 0x3375) },
76 { USB_DEVICE(0x04CA, 0x3005) },
78 /* Atheros AR5BBU12 with sflash firmware */
79 { USB_DEVICE(0x0489, 0xE02C) },
81 /* Atheros AR5BBU22 with sflash firmware */
82 { USB_DEVICE(0x0489, 0xE03C) },
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 },
100 /* Atheros AR5BBU22 with sflash firmware */
101 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
103 { } /* Terminating entry */
106 #define USB_REQ_DFU_DNLOAD 1
107 #define BULK_SIZE 4096
108 #define FW_HDR_SIZE 20
110 static int ath3k_load_firmware(struct usb_device *udev,
111 const struct firmware *firmware)
114 int err, pipe, len, size, sent = 0;
115 int count = firmware->size;
117 BT_DBG("udev %p", udev);
119 pipe = usb_sndctrlpipe(udev, 0);
121 send_buf = kmalloc(BULK_SIZE, GFP_ATOMIC);
123 BT_ERR("Can't allocate memory chunk for firmware");
127 memcpy(send_buf, firmware->data, 20);
128 if ((err = usb_control_msg(udev, pipe,
130 USB_TYPE_VENDOR, 0, 0,
131 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
132 BT_ERR("Can't change to loading configuration err");
139 size = min_t(uint, count, BULK_SIZE);
140 pipe = usb_sndbulkpipe(udev, 0x02);
141 memcpy(send_buf, firmware->data + sent, size);
143 err = usb_bulk_msg(udev, pipe, send_buf, size,
146 if (err || (len != size)) {
147 BT_ERR("Error in firmware loading err = %d,"
148 "len = %d, size = %d", err, len, size);
161 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
165 pipe = usb_rcvctrlpipe(udev, 0);
166 return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
167 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
168 state, 0x01, USB_CTRL_SET_TIMEOUT);
171 static int ath3k_get_version(struct usb_device *udev,
172 struct ath3k_version *version)
176 pipe = usb_rcvctrlpipe(udev, 0);
177 return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
178 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
179 sizeof(struct ath3k_version),
180 USB_CTRL_SET_TIMEOUT);
183 static int ath3k_load_fwfile(struct usb_device *udev,
184 const struct firmware *firmware)
187 int err, pipe, len, size, count, sent = 0;
190 count = firmware->size;
192 send_buf = kmalloc(BULK_SIZE, GFP_ATOMIC);
194 BT_ERR("Can't allocate memory chunk for firmware");
198 size = min_t(uint, count, FW_HDR_SIZE);
199 memcpy(send_buf, firmware->data, size);
201 pipe = usb_sndctrlpipe(udev, 0);
202 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
203 USB_TYPE_VENDOR, 0, 0, send_buf,
204 size, USB_CTRL_SET_TIMEOUT);
206 BT_ERR("Can't change to loading configuration err");
215 size = min_t(uint, count, BULK_SIZE);
216 pipe = usb_sndbulkpipe(udev, 0x02);
218 memcpy(send_buf, firmware->data + sent, size);
220 err = usb_bulk_msg(udev, pipe, send_buf, size,
222 if (err || (len != size)) {
223 BT_ERR("Error in firmware loading err = %d,"
224 "len = %d, size = %d", err, len, size);
236 static int ath3k_switch_pid(struct usb_device *udev)
240 pipe = usb_sndctrlpipe(udev, 0);
241 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
242 USB_TYPE_VENDOR, 0, 0,
243 NULL, 0, USB_CTRL_SET_TIMEOUT);
246 static int ath3k_set_normal_mode(struct usb_device *udev)
248 unsigned char fw_state;
251 ret = ath3k_get_state(udev, &fw_state);
253 BT_ERR("Can't get state to change to normal mode err");
257 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
258 BT_DBG("firmware was already in normal mode");
262 pipe = usb_sndctrlpipe(udev, 0);
263 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
264 USB_TYPE_VENDOR, 0, 0,
265 NULL, 0, USB_CTRL_SET_TIMEOUT);
268 static int ath3k_load_patch(struct usb_device *udev)
270 unsigned char fw_state;
271 char filename[ATH3K_NAME_LEN] = {0};
272 const struct firmware *firmware;
273 struct ath3k_version fw_version, pt_version;
276 ret = ath3k_get_state(udev, &fw_state);
278 BT_ERR("Can't get state to change to load ram patch err");
282 if (fw_state & ATH3K_PATCH_UPDATE) {
283 BT_DBG("Patch was already downloaded");
287 ret = ath3k_get_version(udev, &fw_version);
289 BT_ERR("Can't get version to change to load ram patch err");
293 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
294 fw_version.rom_version);
296 ret = request_firmware(&firmware, filename, &udev->dev);
298 BT_ERR("Patch file not found %s", filename);
302 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
303 pt_version.build_version = *(int *)
304 (firmware->data + firmware->size - 4);
306 if ((pt_version.rom_version != fw_version.rom_version) ||
307 (pt_version.build_version <= fw_version.build_version)) {
308 BT_ERR("Patch file version did not match with firmware");
309 release_firmware(firmware);
313 ret = ath3k_load_fwfile(udev, firmware);
314 release_firmware(firmware);
319 static int ath3k_load_syscfg(struct usb_device *udev)
321 unsigned char fw_state;
322 char filename[ATH3K_NAME_LEN] = {0};
323 const struct firmware *firmware;
324 struct ath3k_version fw_version;
327 ret = ath3k_get_state(udev, &fw_state);
329 BT_ERR("Can't get state to change to load configration err");
333 ret = ath3k_get_version(udev, &fw_version);
335 BT_ERR("Can't get version to change to load ram patch err");
339 switch (fw_version.ref_clock) {
341 case ATH3K_XTAL_FREQ_26M:
344 case ATH3K_XTAL_FREQ_40M:
347 case ATH3K_XTAL_FREQ_19P2:
355 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
356 fw_version.rom_version, clk_value, ".dfu");
358 ret = request_firmware(&firmware, filename, &udev->dev);
360 BT_ERR("Configuration file not found %s", filename);
364 ret = ath3k_load_fwfile(udev, firmware);
365 release_firmware(firmware);
370 static int ath3k_probe(struct usb_interface *intf,
371 const struct usb_device_id *id)
373 const struct firmware *firmware;
374 struct usb_device *udev = interface_to_usbdev(intf);
377 BT_DBG("intf %p id %p", intf, id);
379 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
382 /* match device ID in ath3k blacklist table */
383 if (!id->driver_info) {
384 const struct usb_device_id *match;
385 match = usb_match_id(intf, ath3k_blist_tbl);
390 /* load patch and sysconfig files for AR3012 */
391 if (id->driver_info & BTUSB_ATH3012) {
393 /* New firmware with patch and sysconfig files already loaded */
394 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
397 ret = ath3k_load_patch(udev);
399 BT_ERR("Loading patch file failed");
402 ret = ath3k_load_syscfg(udev);
404 BT_ERR("Loading sysconfig file failed");
407 ret = ath3k_set_normal_mode(udev);
409 BT_ERR("Set normal mode failed");
412 ath3k_switch_pid(udev);
416 if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
417 BT_ERR("Error loading firmware");
421 ret = ath3k_load_firmware(udev, firmware);
422 release_firmware(firmware);
427 static void ath3k_disconnect(struct usb_interface *intf)
429 BT_DBG("ath3k_disconnect intf %p", intf);
432 static struct usb_driver ath3k_driver = {
434 .probe = ath3k_probe,
435 .disconnect = ath3k_disconnect,
436 .id_table = ath3k_table,
439 static int __init ath3k_init(void)
441 BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
442 return usb_register(&ath3k_driver);
445 static void __exit ath3k_exit(void)
447 usb_deregister(&ath3k_driver);
450 module_init(ath3k_init);
451 module_exit(ath3k_exit);
453 MODULE_AUTHOR("Atheros Communications");
454 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
455 MODULE_VERSION(VERSION);
456 MODULE_LICENSE("GPL");
457 MODULE_FIRMWARE("ath3k-1.fw");