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 <asm/unaligned.h>
31 #include <net/bluetooth/bluetooth.h>
34 #define ATH3K_FIRMWARE "ath3k-1.fw"
36 #define ATH3K_DNLOAD 0x01
37 #define ATH3K_GETSTATE 0x05
38 #define ATH3K_SET_NORMAL_MODE 0x07
39 #define ATH3K_GETVERSION 0x09
40 #define USB_REG_SWITCH_VID_PID 0x0a
42 #define ATH3K_MODE_MASK 0x3F
43 #define ATH3K_NORMAL_MODE 0x0E
45 #define ATH3K_PATCH_UPDATE 0x80
46 #define ATH3K_SYSCFG_UPDATE 0x40
48 #define ATH3K_XTAL_FREQ_26M 0x00
49 #define ATH3K_XTAL_FREQ_40M 0x01
50 #define ATH3K_XTAL_FREQ_19P2 0x02
51 #define ATH3K_NAME_LEN 0xFF
53 struct ath3k_version {
61 static const struct usb_device_id ath3k_table[] = {
63 { USB_DEVICE(0x0CF3, 0x3000) },
65 /* Atheros AR3011 with sflash firmware*/
66 { USB_DEVICE(0x0489, 0xE027) },
67 { USB_DEVICE(0x0489, 0xE03D) },
68 { USB_DEVICE(0x04F2, 0xAFF1) },
69 { USB_DEVICE(0x0930, 0x0215) },
70 { USB_DEVICE(0x0CF3, 0x3002) },
71 { USB_DEVICE(0x0CF3, 0xE019) },
72 { USB_DEVICE(0x13d3, 0x3304) },
74 /* Atheros AR9285 Malbec with sflash firmware */
75 { USB_DEVICE(0x03F0, 0x311D) },
77 /* Atheros AR3012 with sflash firmware*/
78 { USB_DEVICE(0x0489, 0xe04d) },
79 { USB_DEVICE(0x0489, 0xe04e) },
80 { USB_DEVICE(0x0489, 0xe057) },
81 { USB_DEVICE(0x0489, 0xe056) },
82 { USB_DEVICE(0x0489, 0xe05f) },
83 { USB_DEVICE(0x0489, 0xe078) },
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, 0x3010) },
92 { USB_DEVICE(0x0930, 0x0219) },
93 { USB_DEVICE(0x0930, 0x0220) },
94 { USB_DEVICE(0x0930, 0x0227) },
95 { USB_DEVICE(0x0b05, 0x17d0) },
96 { USB_DEVICE(0x0CF3, 0x0036) },
97 { USB_DEVICE(0x0CF3, 0x3004) },
98 { USB_DEVICE(0x0CF3, 0x3008) },
99 { USB_DEVICE(0x0CF3, 0x311D) },
100 { USB_DEVICE(0x0CF3, 0x311E) },
101 { USB_DEVICE(0x0CF3, 0x311F) },
102 { USB_DEVICE(0x0cf3, 0x3121) },
103 { USB_DEVICE(0x0CF3, 0x817a) },
104 { USB_DEVICE(0x0cf3, 0xe003) },
105 { USB_DEVICE(0x0CF3, 0xE004) },
106 { USB_DEVICE(0x0CF3, 0xE005) },
107 { USB_DEVICE(0x13d3, 0x3362) },
108 { USB_DEVICE(0x13d3, 0x3375) },
109 { USB_DEVICE(0x13d3, 0x3393) },
110 { USB_DEVICE(0x13d3, 0x3402) },
111 { USB_DEVICE(0x13d3, 0x3408) },
112 { USB_DEVICE(0x13d3, 0x3423) },
113 { USB_DEVICE(0x13d3, 0x3432) },
115 /* Atheros AR5BBU12 with sflash firmware */
116 { USB_DEVICE(0x0489, 0xE02C) },
118 /* Atheros AR5BBU22 with sflash firmware */
119 { USB_DEVICE(0x0489, 0xE036) },
120 { USB_DEVICE(0x0489, 0xE03C) },
122 { } /* Terminating entry */
125 MODULE_DEVICE_TABLE(usb, ath3k_table);
127 #define BTUSB_ATH3012 0x80
128 /* This table is to load patch and sysconfig files
130 static const struct usb_device_id ath3k_blist_tbl[] = {
132 /* Atheros AR3012 with sflash firmware*/
133 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
134 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
135 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
136 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
137 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
138 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
139 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
140 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
141 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
142 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
143 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
144 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
145 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
146 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
147 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
170 /* Atheros AR5BBU22 with sflash firmware */
171 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
174 { } /* Terminating entry */
177 #define USB_REQ_DFU_DNLOAD 1
178 #define BULK_SIZE 4096
179 #define FW_HDR_SIZE 20
180 #define TIMEGAP_USEC_MIN 50
181 #define TIMEGAP_USEC_MAX 100
183 static int ath3k_load_firmware(struct usb_device *udev,
184 const struct firmware *firmware)
187 int err, pipe, len, size, sent = 0;
188 int count = firmware->size;
190 BT_DBG("udev %p", udev);
192 pipe = usb_sndctrlpipe(udev, 0);
194 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
196 BT_ERR("Can't allocate memory chunk for firmware");
200 memcpy(send_buf, firmware->data, 20);
201 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
202 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
204 BT_ERR("Can't change to loading configuration err");
210 pipe = usb_sndbulkpipe(udev, 0x02);
213 /* workaround the compatibility issue with xHCI controller*/
214 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
216 size = min_t(uint, count, BULK_SIZE);
217 memcpy(send_buf, firmware->data + sent, size);
219 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);
237 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
242 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
246 pipe = usb_rcvctrlpipe(udev, 0);
247 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
248 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
249 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
257 static int ath3k_get_version(struct usb_device *udev,
258 struct ath3k_version *version)
261 struct ath3k_version *buf;
262 const int size = sizeof(*buf);
264 buf = kmalloc(size, GFP_KERNEL);
268 pipe = usb_rcvctrlpipe(udev, 0);
269 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
270 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
271 buf, size, USB_CTRL_SET_TIMEOUT);
273 memcpy(version, buf, size);
279 static int ath3k_load_fwfile(struct usb_device *udev,
280 const struct firmware *firmware)
283 int err, pipe, len, size, count, sent = 0;
286 count = firmware->size;
288 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
290 BT_ERR("Can't allocate memory chunk for firmware");
294 size = min_t(uint, count, FW_HDR_SIZE);
295 memcpy(send_buf, firmware->data, size);
297 pipe = usb_sndctrlpipe(udev, 0);
298 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
299 USB_TYPE_VENDOR, 0, 0, send_buf,
300 size, USB_CTRL_SET_TIMEOUT);
302 BT_ERR("Can't change to loading configuration err");
310 pipe = usb_sndbulkpipe(udev, 0x02);
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 memcpy(send_buf, firmware->data + sent, size);
319 err = usb_bulk_msg(udev, pipe, send_buf, size,
321 if (err || (len != size)) {
322 BT_ERR("Error in firmware loading err = %d,"
323 "len = %d, size = %d", err, len, size);
335 static int ath3k_switch_pid(struct usb_device *udev)
339 pipe = usb_sndctrlpipe(udev, 0);
340 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
341 USB_TYPE_VENDOR, 0, 0,
342 NULL, 0, USB_CTRL_SET_TIMEOUT);
345 static int ath3k_set_normal_mode(struct usb_device *udev)
347 unsigned char fw_state;
350 ret = ath3k_get_state(udev, &fw_state);
352 BT_ERR("Can't get state to change to normal mode err");
356 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
357 BT_DBG("firmware was already in normal mode");
361 pipe = usb_sndctrlpipe(udev, 0);
362 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
363 USB_TYPE_VENDOR, 0, 0,
364 NULL, 0, USB_CTRL_SET_TIMEOUT);
367 static int ath3k_load_patch(struct usb_device *udev)
369 unsigned char fw_state;
370 char filename[ATH3K_NAME_LEN] = {0};
371 const struct firmware *firmware;
372 struct ath3k_version fw_version;
373 __u32 pt_rom_version, pt_build_version;
376 ret = ath3k_get_state(udev, &fw_state);
378 BT_ERR("Can't get state to change to load ram patch err");
382 if (fw_state & ATH3K_PATCH_UPDATE) {
383 BT_DBG("Patch was already downloaded");
387 ret = ath3k_get_version(udev, &fw_version);
389 BT_ERR("Can't get version to change to load ram patch err");
393 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
394 le32_to_cpu(fw_version.rom_version));
396 ret = request_firmware(&firmware, filename, &udev->dev);
398 BT_ERR("Patch file not found %s", filename);
402 pt_rom_version = get_unaligned_le32(firmware->data +
404 pt_build_version = get_unaligned_le32(firmware->data +
407 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
408 pt_build_version <= le32_to_cpu(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 configuration 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 le32_to_cpu(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 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
520 BT_ERR("Firmware file \"%s\" not found",
523 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
524 ATH3K_FIRMWARE, ret);
528 ret = ath3k_load_firmware(udev, firmware);
529 release_firmware(firmware);
534 static void ath3k_disconnect(struct usb_interface *intf)
536 BT_DBG("ath3k_disconnect intf %p", intf);
539 static struct usb_driver ath3k_driver = {
541 .probe = ath3k_probe,
542 .disconnect = ath3k_disconnect,
543 .id_table = ath3k_table,
544 .disable_hub_initiated_lpm = 1,
547 module_usb_driver(ath3k_driver);
549 MODULE_AUTHOR("Atheros Communications");
550 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
551 MODULE_VERSION(VERSION);
552 MODULE_LICENSE("GPL");
553 MODULE_FIRMWARE(ATH3K_FIRMWARE);