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) },
66 /* Atheros AR9285 Malbec with sflash firmware */
67 { USB_DEVICE(0x03F0, 0x311D) },
69 /* Atheros AR3012 with sflash firmware*/
70 { USB_DEVICE(0x0CF3, 0x3004) },
72 { } /* Terminating entry */
75 MODULE_DEVICE_TABLE(usb, ath3k_table);
77 #define BTUSB_ATH3012 0x80
78 /* This table is to load patch and sysconfig files
80 static struct usb_device_id ath3k_blist_tbl[] = {
82 /* Atheros AR3012 with sflash firmware*/
83 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
85 { } /* Terminating entry */
88 #define USB_REQ_DFU_DNLOAD 1
89 #define BULK_SIZE 4096
90 #define FW_HDR_SIZE 20
92 static int ath3k_load_firmware(struct usb_device *udev,
93 const struct firmware *firmware)
96 int err, pipe, len, size, sent = 0;
97 int count = firmware->size;
99 BT_DBG("udev %p", udev);
101 pipe = usb_sndctrlpipe(udev, 0);
103 send_buf = kmalloc(BULK_SIZE, GFP_ATOMIC);
105 BT_ERR("Can't allocate memory chunk for firmware");
109 memcpy(send_buf, firmware->data, 20);
110 if ((err = usb_control_msg(udev, pipe,
112 USB_TYPE_VENDOR, 0, 0,
113 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
114 BT_ERR("Can't change to loading configuration err");
121 size = min_t(uint, count, BULK_SIZE);
122 pipe = usb_sndbulkpipe(udev, 0x02);
123 memcpy(send_buf, firmware->data + sent, size);
125 err = usb_bulk_msg(udev, pipe, send_buf, size,
128 if (err || (len != size)) {
129 BT_ERR("Error in firmware loading err = %d,"
130 "len = %d, size = %d", err, len, size);
146 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
150 pipe = usb_rcvctrlpipe(udev, 0);
151 return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
152 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
153 state, 0x01, USB_CTRL_SET_TIMEOUT);
156 static int ath3k_get_version(struct usb_device *udev,
157 struct ath3k_version *version)
161 pipe = usb_rcvctrlpipe(udev, 0);
162 return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
163 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
164 sizeof(struct ath3k_version),
165 USB_CTRL_SET_TIMEOUT);
168 static int ath3k_load_fwfile(struct usb_device *udev,
169 const struct firmware *firmware)
172 int err, pipe, len, size, count, sent = 0;
175 count = firmware->size;
177 send_buf = kmalloc(BULK_SIZE, GFP_ATOMIC);
179 BT_ERR("Can't allocate memory chunk for firmware");
183 size = min_t(uint, count, FW_HDR_SIZE);
184 memcpy(send_buf, firmware->data, size);
186 pipe = usb_sndctrlpipe(udev, 0);
187 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
188 USB_TYPE_VENDOR, 0, 0, send_buf,
189 size, USB_CTRL_SET_TIMEOUT);
191 BT_ERR("Can't change to loading configuration err");
200 size = min_t(uint, count, BULK_SIZE);
201 pipe = usb_sndbulkpipe(udev, 0x02);
203 memcpy(send_buf, firmware->data + sent, size);
205 err = usb_bulk_msg(udev, pipe, send_buf, size,
207 if (err || (len != size)) {
208 BT_ERR("Error in firmware loading err = %d,"
209 "len = %d, size = %d", err, len, size);
221 static int ath3k_switch_pid(struct usb_device *udev)
225 pipe = usb_sndctrlpipe(udev, 0);
226 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
227 USB_TYPE_VENDOR, 0, 0,
228 NULL, 0, USB_CTRL_SET_TIMEOUT);
231 static int ath3k_set_normal_mode(struct usb_device *udev)
233 unsigned char fw_state;
236 ret = ath3k_get_state(udev, &fw_state);
238 BT_ERR("Can't get state to change to normal mode err");
242 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
243 BT_DBG("firmware was already in normal mode");
247 pipe = usb_sndctrlpipe(udev, 0);
248 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
249 USB_TYPE_VENDOR, 0, 0,
250 NULL, 0, USB_CTRL_SET_TIMEOUT);
253 static int ath3k_load_patch(struct usb_device *udev)
255 unsigned char fw_state;
256 char filename[ATH3K_NAME_LEN] = {0};
257 const struct firmware *firmware;
258 struct ath3k_version fw_version, pt_version;
261 ret = ath3k_get_state(udev, &fw_state);
263 BT_ERR("Can't get state to change to load ram patch err");
267 if (fw_state & ATH3K_PATCH_UPDATE) {
268 BT_DBG("Patch was already downloaded");
272 ret = ath3k_get_version(udev, &fw_version);
274 BT_ERR("Can't get version to change to load ram patch err");
278 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
279 fw_version.rom_version);
281 ret = request_firmware(&firmware, filename, &udev->dev);
283 BT_ERR("Patch file not found %s", filename);
287 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
288 pt_version.build_version = *(int *)
289 (firmware->data + firmware->size - 4);
291 if ((pt_version.rom_version != fw_version.rom_version) ||
292 (pt_version.build_version <= fw_version.build_version)) {
293 BT_ERR("Patch file version did not match with firmware");
294 release_firmware(firmware);
298 ret = ath3k_load_fwfile(udev, firmware);
299 release_firmware(firmware);
304 static int ath3k_load_syscfg(struct usb_device *udev)
306 unsigned char fw_state;
307 char filename[ATH3K_NAME_LEN] = {0};
308 const struct firmware *firmware;
309 struct ath3k_version fw_version;
312 ret = ath3k_get_state(udev, &fw_state);
314 BT_ERR("Can't get state to change to load configration err");
318 ret = ath3k_get_version(udev, &fw_version);
320 BT_ERR("Can't get version to change to load ram patch err");
324 switch (fw_version.ref_clock) {
326 case ATH3K_XTAL_FREQ_26M:
329 case ATH3K_XTAL_FREQ_40M:
332 case ATH3K_XTAL_FREQ_19P2:
340 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
341 fw_version.rom_version, clk_value, ".dfu");
343 ret = request_firmware(&firmware, filename, &udev->dev);
345 BT_ERR("Configuration file not found %s", filename);
349 ret = ath3k_load_fwfile(udev, firmware);
350 release_firmware(firmware);
355 static int ath3k_probe(struct usb_interface *intf,
356 const struct usb_device_id *id)
358 const struct firmware *firmware;
359 struct usb_device *udev = interface_to_usbdev(intf);
362 BT_DBG("intf %p id %p", intf, id);
364 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
367 /* match device ID in ath3k blacklist table */
368 if (!id->driver_info) {
369 const struct usb_device_id *match;
370 match = usb_match_id(intf, ath3k_blist_tbl);
375 /* load patch and sysconfig files for AR3012 */
376 if (id->driver_info & BTUSB_ATH3012) {
377 ret = ath3k_load_patch(udev);
379 BT_ERR("Loading patch file failed");
382 ret = ath3k_load_syscfg(udev);
384 BT_ERR("Loading sysconfig file failed");
387 ret = ath3k_set_normal_mode(udev);
389 BT_ERR("Set normal mode failed");
392 ath3k_switch_pid(udev);
396 if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
397 BT_ERR("Error loading firmware");
401 ret = ath3k_load_firmware(udev, firmware);
402 release_firmware(firmware);
407 static void ath3k_disconnect(struct usb_interface *intf)
409 BT_DBG("ath3k_disconnect intf %p", intf);
412 static struct usb_driver ath3k_driver = {
414 .probe = ath3k_probe,
415 .disconnect = ath3k_disconnect,
416 .id_table = ath3k_table,
419 static int __init ath3k_init(void)
421 BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
422 return usb_register(&ath3k_driver);
425 static void __exit ath3k_exit(void)
427 usb_deregister(&ath3k_driver);
430 module_init(ath3k_init);
431 module_exit(ath3k_exit);
433 MODULE_AUTHOR("Atheros Communications");
434 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
435 MODULE_VERSION(VERSION);
436 MODULE_LICENSE("GPL");
437 MODULE_FIRMWARE("ath3k-1.fw");