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(0x0489, 0xE027) },
65 { USB_DEVICE(0x0489, 0xE03D) },
66 { USB_DEVICE(0x04F2, 0xAFF1) },
67 { USB_DEVICE(0x0930, 0x0215) },
68 { USB_DEVICE(0x0CF3, 0x3002) },
69 { USB_DEVICE(0x0CF3, 0xE019) },
70 { USB_DEVICE(0x13d3, 0x3304) },
72 /* Atheros AR9285 Malbec with sflash firmware */
73 { USB_DEVICE(0x03F0, 0x311D) },
75 /* Atheros AR3012 with sflash firmware*/
76 { USB_DEVICE(0x0489, 0xe04d) },
77 { USB_DEVICE(0x0489, 0xe04e) },
78 { USB_DEVICE(0x0489, 0xe057) },
79 { USB_DEVICE(0x0489, 0xe056) },
80 { USB_DEVICE(0x0489, 0xe05f) },
81 { USB_DEVICE(0x0489, 0xe076) },
82 { USB_DEVICE(0x0489, 0xe078) },
83 { USB_DEVICE(0x0489, 0xe095) },
84 { USB_DEVICE(0x04c5, 0x1330) },
85 { USB_DEVICE(0x04CA, 0x3004) },
86 { USB_DEVICE(0x04CA, 0x3005) },
87 { USB_DEVICE(0x04CA, 0x3006) },
88 { USB_DEVICE(0x04CA, 0x3007) },
89 { USB_DEVICE(0x04CA, 0x3008) },
90 { USB_DEVICE(0x04CA, 0x300b) },
91 { USB_DEVICE(0x04CA, 0x300f) },
92 { USB_DEVICE(0x04CA, 0x3010) },
93 { USB_DEVICE(0x04CA, 0x3014) },
94 { USB_DEVICE(0x04CA, 0x3018) },
95 { USB_DEVICE(0x0930, 0x0219) },
96 { USB_DEVICE(0x0930, 0x021c) },
97 { USB_DEVICE(0x0930, 0x0220) },
98 { USB_DEVICE(0x0930, 0x0227) },
99 { USB_DEVICE(0x0b05, 0x17d0) },
100 { USB_DEVICE(0x0CF3, 0x0036) },
101 { USB_DEVICE(0x0CF3, 0x3004) },
102 { USB_DEVICE(0x0CF3, 0x3008) },
103 { USB_DEVICE(0x0CF3, 0x311D) },
104 { USB_DEVICE(0x0CF3, 0x311E) },
105 { USB_DEVICE(0x0CF3, 0x311F) },
106 { USB_DEVICE(0x0cf3, 0x3121) },
107 { USB_DEVICE(0x0CF3, 0x817a) },
108 { USB_DEVICE(0x0CF3, 0x817b) },
109 { USB_DEVICE(0x0cf3, 0xe003) },
110 { USB_DEVICE(0x0CF3, 0xE004) },
111 { USB_DEVICE(0x0CF3, 0xE005) },
112 { USB_DEVICE(0x13d3, 0x3362) },
113 { USB_DEVICE(0x13d3, 0x3375) },
114 { USB_DEVICE(0x13d3, 0x3393) },
115 { USB_DEVICE(0x13d3, 0x3395) },
116 { USB_DEVICE(0x13d3, 0x3402) },
117 { USB_DEVICE(0x13d3, 0x3408) },
118 { USB_DEVICE(0x13d3, 0x3423) },
119 { USB_DEVICE(0x13d3, 0x3432) },
120 { USB_DEVICE(0x13d3, 0x3472) },
121 { USB_DEVICE(0x13d3, 0x3474) },
122 { USB_DEVICE(0x13d3, 0x3487) },
123 { USB_DEVICE(0x13d3, 0x3490) },
125 /* Atheros AR5BBU12 with sflash firmware */
126 { USB_DEVICE(0x0489, 0xE02C) },
128 /* Atheros AR5BBU22 with sflash firmware */
129 { USB_DEVICE(0x0489, 0xE036) },
130 { USB_DEVICE(0x0489, 0xE03C) },
132 { } /* Terminating entry */
135 MODULE_DEVICE_TABLE(usb, ath3k_table);
137 #define BTUSB_ATH3012 0x80
138 /* This table is to load patch and sysconfig files
140 static struct usb_device_id ath3k_blist_tbl[] = {
142 /* Atheros AR3012 with sflash firmware*/
143 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
144 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
145 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
146 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
147 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
169 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
170 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
171 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
173 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
174 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
175 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
176 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
177 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
192 /* Atheros AR5BBU22 with sflash firmware */
193 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
194 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
196 { } /* Terminating entry */
199 #define USB_REQ_DFU_DNLOAD 1
200 #define BULK_SIZE 4096
201 #define FW_HDR_SIZE 20
202 #define TIMEGAP_USEC_MIN 50
203 #define TIMEGAP_USEC_MAX 100
205 static int ath3k_load_firmware(struct usb_device *udev,
206 const struct firmware *firmware)
209 int err, pipe, len, size, sent = 0;
210 int count = firmware->size;
212 BT_DBG("udev %p", udev);
214 pipe = usb_sndctrlpipe(udev, 0);
216 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
218 BT_ERR("Can't allocate memory chunk for firmware");
222 memcpy(send_buf, firmware->data, 20);
223 if ((err = usb_control_msg(udev, pipe,
225 USB_TYPE_VENDOR, 0, 0,
226 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
227 BT_ERR("Can't change to loading configuration err");
234 /* workaround the compatibility issue with xHCI controller*/
235 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
237 size = min_t(uint, count, BULK_SIZE);
238 pipe = usb_sndbulkpipe(udev, 0x02);
239 memcpy(send_buf, firmware->data + sent, size);
241 err = usb_bulk_msg(udev, pipe, send_buf, size,
244 if (err || (len != size)) {
245 BT_ERR("Error in firmware loading err = %d,"
246 "len = %d, size = %d", err, len, size);
259 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
263 pipe = usb_rcvctrlpipe(udev, 0);
264 return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
265 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
266 state, 0x01, USB_CTRL_SET_TIMEOUT);
269 static int ath3k_get_version(struct usb_device *udev,
270 struct ath3k_version *version)
274 pipe = usb_rcvctrlpipe(udev, 0);
275 return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
276 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
277 sizeof(struct ath3k_version),
278 USB_CTRL_SET_TIMEOUT);
281 static int ath3k_load_fwfile(struct usb_device *udev,
282 const struct firmware *firmware)
285 int err, pipe, len, size, count, sent = 0;
288 count = firmware->size;
290 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
292 BT_ERR("Can't allocate memory chunk for firmware");
296 size = min_t(uint, count, FW_HDR_SIZE);
297 memcpy(send_buf, firmware->data, size);
299 pipe = usb_sndctrlpipe(udev, 0);
300 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
301 USB_TYPE_VENDOR, 0, 0, send_buf,
302 size, USB_CTRL_SET_TIMEOUT);
304 BT_ERR("Can't change to loading configuration err");
313 /* workaround the compatibility issue with xHCI controller*/
314 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
316 size = min_t(uint, count, BULK_SIZE);
317 pipe = usb_sndbulkpipe(udev, 0x02);
319 memcpy(send_buf, firmware->data + sent, size);
321 err = usb_bulk_msg(udev, pipe, send_buf, size,
323 if (err || (len != size)) {
324 BT_ERR("Error in firmware loading err = %d,"
325 "len = %d, size = %d", err, len, size);
337 static int ath3k_switch_pid(struct usb_device *udev)
341 pipe = usb_sndctrlpipe(udev, 0);
342 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
343 USB_TYPE_VENDOR, 0, 0,
344 NULL, 0, USB_CTRL_SET_TIMEOUT);
347 static int ath3k_set_normal_mode(struct usb_device *udev)
349 unsigned char fw_state;
352 ret = ath3k_get_state(udev, &fw_state);
354 BT_ERR("Can't get state to change to normal mode err");
358 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
359 BT_DBG("firmware was already in normal mode");
363 pipe = usb_sndctrlpipe(udev, 0);
364 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
365 USB_TYPE_VENDOR, 0, 0,
366 NULL, 0, USB_CTRL_SET_TIMEOUT);
369 static int ath3k_load_patch(struct usb_device *udev)
371 unsigned char fw_state;
372 char filename[ATH3K_NAME_LEN] = {0};
373 const struct firmware *firmware;
374 struct ath3k_version fw_version, pt_version;
377 ret = ath3k_get_state(udev, &fw_state);
379 BT_ERR("Can't get state to change to load ram patch err");
383 if (fw_state & ATH3K_PATCH_UPDATE) {
384 BT_DBG("Patch was already downloaded");
388 ret = ath3k_get_version(udev, &fw_version);
390 BT_ERR("Can't get version to change to load ram patch err");
394 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
395 fw_version.rom_version);
397 ret = request_firmware(&firmware, filename, &udev->dev);
399 BT_ERR("Patch file not found %s", filename);
403 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
404 pt_version.build_version = *(int *)
405 (firmware->data + firmware->size - 4);
407 if ((pt_version.rom_version != fw_version.rom_version) ||
408 (pt_version.build_version <= fw_version.build_version)) {
409 BT_ERR("Patch file version did not match with firmware");
410 release_firmware(firmware);
414 ret = ath3k_load_fwfile(udev, firmware);
415 release_firmware(firmware);
420 static int ath3k_load_syscfg(struct usb_device *udev)
422 unsigned char fw_state;
423 char filename[ATH3K_NAME_LEN] = {0};
424 const struct firmware *firmware;
425 struct ath3k_version fw_version;
428 ret = ath3k_get_state(udev, &fw_state);
430 BT_ERR("Can't get state to change to load configration err");
434 ret = ath3k_get_version(udev, &fw_version);
436 BT_ERR("Can't get version to change to load ram patch err");
440 switch (fw_version.ref_clock) {
442 case ATH3K_XTAL_FREQ_26M:
445 case ATH3K_XTAL_FREQ_40M:
448 case ATH3K_XTAL_FREQ_19P2:
456 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
457 fw_version.rom_version, clk_value, ".dfu");
459 ret = request_firmware(&firmware, filename, &udev->dev);
461 BT_ERR("Configuration file not found %s", filename);
465 ret = ath3k_load_fwfile(udev, firmware);
466 release_firmware(firmware);
471 static int ath3k_probe(struct usb_interface *intf,
472 const struct usb_device_id *id)
474 const struct firmware *firmware;
475 struct usb_device *udev = interface_to_usbdev(intf);
478 BT_DBG("intf %p id %p", intf, id);
480 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
483 /* match device ID in ath3k blacklist table */
484 if (!id->driver_info) {
485 const struct usb_device_id *match;
486 match = usb_match_id(intf, ath3k_blist_tbl);
491 /* load patch and sysconfig files for AR3012 */
492 if (id->driver_info & BTUSB_ATH3012) {
494 /* New firmware with patch and sysconfig files already loaded */
495 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
498 ret = ath3k_load_patch(udev);
500 BT_ERR("Loading patch file failed");
503 ret = ath3k_load_syscfg(udev);
505 BT_ERR("Loading sysconfig file failed");
508 ret = ath3k_set_normal_mode(udev);
510 BT_ERR("Set normal mode failed");
513 ath3k_switch_pid(udev);
517 if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
518 BT_ERR("Error loading firmware");
522 ret = ath3k_load_firmware(udev, firmware);
523 release_firmware(firmware);
528 static void ath3k_disconnect(struct usb_interface *intf)
530 BT_DBG("ath3k_disconnect intf %p", intf);
533 static struct usb_driver ath3k_driver = {
535 .probe = ath3k_probe,
536 .disconnect = ath3k_disconnect,
537 .id_table = ath3k_table,
540 static int __init ath3k_init(void)
542 BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
543 return usb_register(&ath3k_driver);
546 static void __exit ath3k_exit(void)
548 usb_deregister(&ath3k_driver);
551 module_init(ath3k_init);
552 module_exit(ath3k_exit);
554 MODULE_AUTHOR("Atheros Communications");
555 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
556 MODULE_VERSION(VERSION);
557 MODULE_LICENSE("GPL");
558 MODULE_FIRMWARE("ath3k-1.fw");