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(0x0CF3, 0xE019) },
66 { USB_DEVICE(0x13d3, 0x3304) },
67 { USB_DEVICE(0x0930, 0x0215) },
68 { USB_DEVICE(0x0489, 0xE03D) },
69 { USB_DEVICE(0x0489, 0xE027) },
71 /* Atheros AR9285 Malbec with sflash firmware */
72 { USB_DEVICE(0x03F0, 0x311D) },
74 /* Atheros AR3012 with sflash firmware*/
75 { USB_DEVICE(0x0CF3, 0x0036) },
76 { USB_DEVICE(0x0CF3, 0x3004) },
77 { USB_DEVICE(0x0CF3, 0x3008) },
78 { USB_DEVICE(0x0CF3, 0x311D) },
79 { USB_DEVICE(0x0CF3, 0x817a) },
80 { USB_DEVICE(0x13d3, 0x3375) },
81 { USB_DEVICE(0x04CA, 0x3004) },
82 { USB_DEVICE(0x04CA, 0x3005) },
83 { USB_DEVICE(0x04CA, 0x3006) },
84 { USB_DEVICE(0x04CA, 0x3008) },
85 { USB_DEVICE(0x13d3, 0x3362) },
86 { USB_DEVICE(0x0CF3, 0xE004) },
87 { USB_DEVICE(0x0CF3, 0xE005) },
88 { USB_DEVICE(0x0930, 0x0219) },
89 { USB_DEVICE(0x0489, 0xe057) },
90 { USB_DEVICE(0x13d3, 0x3393) },
91 { USB_DEVICE(0x0489, 0xe04e) },
92 { USB_DEVICE(0x0489, 0xe056) },
93 { USB_DEVICE(0x0489, 0xe04d) },
94 { USB_DEVICE(0x04c5, 0x1330) },
95 { USB_DEVICE(0x13d3, 0x3402) },
96 { USB_DEVICE(0x0cf3, 0x3121) },
97 { USB_DEVICE(0x0cf3, 0xe003) },
99 /* Atheros AR5BBU12 with sflash firmware */
100 { USB_DEVICE(0x0489, 0xE02C) },
102 /* Atheros AR5BBU22 with sflash firmware */
103 { USB_DEVICE(0x0489, 0xE03C) },
104 { USB_DEVICE(0x0489, 0xE036) },
106 { } /* Terminating entry */
109 MODULE_DEVICE_TABLE(usb, ath3k_table);
111 #define BTUSB_ATH3012 0x80
112 /* This table is to load patch and sysconfig files
114 static struct usb_device_id ath3k_blist_tbl[] = {
116 /* Atheros AR3012 with sflash firmware*/
117 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
118 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
119 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
120 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
121 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
122 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
123 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
124 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
125 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
126 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
127 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
128 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
129 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
130 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
131 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
132 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
133 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
134 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
135 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
136 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
137 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
138 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
139 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
141 /* Atheros AR5BBU22 with sflash firmware */
142 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
143 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
145 { } /* Terminating entry */
148 #define USB_REQ_DFU_DNLOAD 1
149 #define BULK_SIZE 4096
150 #define FW_HDR_SIZE 20
152 static int ath3k_load_firmware(struct usb_device *udev,
153 const struct firmware *firmware)
156 int err, pipe, len, size, sent = 0;
157 int count = firmware->size;
159 BT_DBG("udev %p", udev);
161 pipe = usb_sndctrlpipe(udev, 0);
163 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
165 BT_ERR("Can't allocate memory chunk for firmware");
169 memcpy(send_buf, firmware->data, 20);
170 if ((err = usb_control_msg(udev, pipe,
172 USB_TYPE_VENDOR, 0, 0,
173 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
174 BT_ERR("Can't change to loading configuration err");
181 size = min_t(uint, count, BULK_SIZE);
182 pipe = usb_sndbulkpipe(udev, 0x02);
183 memcpy(send_buf, firmware->data + sent, size);
185 err = usb_bulk_msg(udev, pipe, send_buf, size,
188 if (err || (len != size)) {
189 BT_ERR("Error in firmware loading err = %d,"
190 "len = %d, size = %d", err, len, size);
203 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
207 pipe = usb_rcvctrlpipe(udev, 0);
208 return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
209 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
210 state, 0x01, USB_CTRL_SET_TIMEOUT);
213 static int ath3k_get_version(struct usb_device *udev,
214 struct ath3k_version *version)
218 pipe = usb_rcvctrlpipe(udev, 0);
219 return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
220 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
221 sizeof(struct ath3k_version),
222 USB_CTRL_SET_TIMEOUT);
225 static int ath3k_load_fwfile(struct usb_device *udev,
226 const struct firmware *firmware)
229 int err, pipe, len, size, count, sent = 0;
232 count = firmware->size;
234 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
236 BT_ERR("Can't allocate memory chunk for firmware");
240 size = min_t(uint, count, FW_HDR_SIZE);
241 memcpy(send_buf, firmware->data, size);
243 pipe = usb_sndctrlpipe(udev, 0);
244 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
245 USB_TYPE_VENDOR, 0, 0, send_buf,
246 size, USB_CTRL_SET_TIMEOUT);
248 BT_ERR("Can't change to loading configuration err");
257 size = min_t(uint, count, BULK_SIZE);
258 pipe = usb_sndbulkpipe(udev, 0x02);
260 memcpy(send_buf, firmware->data + sent, size);
262 err = usb_bulk_msg(udev, pipe, send_buf, size,
264 if (err || (len != size)) {
265 BT_ERR("Error in firmware loading err = %d,"
266 "len = %d, size = %d", err, len, size);
278 static int ath3k_switch_pid(struct usb_device *udev)
282 pipe = usb_sndctrlpipe(udev, 0);
283 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
284 USB_TYPE_VENDOR, 0, 0,
285 NULL, 0, USB_CTRL_SET_TIMEOUT);
288 static int ath3k_set_normal_mode(struct usb_device *udev)
290 unsigned char fw_state;
293 ret = ath3k_get_state(udev, &fw_state);
295 BT_ERR("Can't get state to change to normal mode err");
299 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
300 BT_DBG("firmware was already in normal mode");
304 pipe = usb_sndctrlpipe(udev, 0);
305 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
306 USB_TYPE_VENDOR, 0, 0,
307 NULL, 0, USB_CTRL_SET_TIMEOUT);
310 static int ath3k_load_patch(struct usb_device *udev)
312 unsigned char fw_state;
313 char filename[ATH3K_NAME_LEN] = {0};
314 const struct firmware *firmware;
315 struct ath3k_version fw_version, pt_version;
318 ret = ath3k_get_state(udev, &fw_state);
320 BT_ERR("Can't get state to change to load ram patch err");
324 if (fw_state & ATH3K_PATCH_UPDATE) {
325 BT_DBG("Patch was already downloaded");
329 ret = ath3k_get_version(udev, &fw_version);
331 BT_ERR("Can't get version to change to load ram patch err");
335 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
336 fw_version.rom_version);
338 ret = request_firmware(&firmware, filename, &udev->dev);
340 BT_ERR("Patch file not found %s", filename);
344 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
345 pt_version.build_version = *(int *)
346 (firmware->data + firmware->size - 4);
348 if ((pt_version.rom_version != fw_version.rom_version) ||
349 (pt_version.build_version <= fw_version.build_version)) {
350 BT_ERR("Patch file version did not match with firmware");
351 release_firmware(firmware);
355 ret = ath3k_load_fwfile(udev, firmware);
356 release_firmware(firmware);
361 static int ath3k_load_syscfg(struct usb_device *udev)
363 unsigned char fw_state;
364 char filename[ATH3K_NAME_LEN] = {0};
365 const struct firmware *firmware;
366 struct ath3k_version fw_version;
369 ret = ath3k_get_state(udev, &fw_state);
371 BT_ERR("Can't get state to change to load configration err");
375 ret = ath3k_get_version(udev, &fw_version);
377 BT_ERR("Can't get version to change to load ram patch err");
381 switch (fw_version.ref_clock) {
383 case ATH3K_XTAL_FREQ_26M:
386 case ATH3K_XTAL_FREQ_40M:
389 case ATH3K_XTAL_FREQ_19P2:
397 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
398 fw_version.rom_version, clk_value, ".dfu");
400 ret = request_firmware(&firmware, filename, &udev->dev);
402 BT_ERR("Configuration file not found %s", filename);
406 ret = ath3k_load_fwfile(udev, firmware);
407 release_firmware(firmware);
412 static int ath3k_probe(struct usb_interface *intf,
413 const struct usb_device_id *id)
415 const struct firmware *firmware;
416 struct usb_device *udev = interface_to_usbdev(intf);
419 BT_DBG("intf %p id %p", intf, id);
421 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
424 /* match device ID in ath3k blacklist table */
425 if (!id->driver_info) {
426 const struct usb_device_id *match;
427 match = usb_match_id(intf, ath3k_blist_tbl);
432 /* load patch and sysconfig files for AR3012 */
433 if (id->driver_info & BTUSB_ATH3012) {
435 /* New firmware with patch and sysconfig files already loaded */
436 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
439 ret = ath3k_load_patch(udev);
441 BT_ERR("Loading patch file failed");
444 ret = ath3k_load_syscfg(udev);
446 BT_ERR("Loading sysconfig file failed");
449 ret = ath3k_set_normal_mode(udev);
451 BT_ERR("Set normal mode failed");
454 ath3k_switch_pid(udev);
458 if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
459 BT_ERR("Error loading firmware");
463 ret = ath3k_load_firmware(udev, firmware);
464 release_firmware(firmware);
469 static void ath3k_disconnect(struct usb_interface *intf)
471 BT_DBG("ath3k_disconnect intf %p", intf);
474 static struct usb_driver ath3k_driver = {
476 .probe = ath3k_probe,
477 .disconnect = ath3k_disconnect,
478 .id_table = ath3k_table,
481 static int __init ath3k_init(void)
483 BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
484 return usb_register(&ath3k_driver);
487 static void __exit ath3k_exit(void)
489 usb_deregister(&ath3k_driver);
492 module_init(ath3k_init);
493 module_exit(ath3k_exit);
495 MODULE_AUTHOR("Atheros Communications");
496 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
497 MODULE_VERSION(VERSION);
498 MODULE_LICENSE("GPL");
499 MODULE_FIRMWARE("ath3k-1.fw");