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>
33 #define ATH3K_FIRMWARE "ath3k-1.fw"
35 #define ATH3K_DNLOAD 0x01
36 #define ATH3K_GETSTATE 0x05
37 #define ATH3K_SET_NORMAL_MODE 0x07
38 #define ATH3K_GETVERSION 0x09
39 #define USB_REG_SWITCH_VID_PID 0x0a
41 #define ATH3K_MODE_MASK 0x3F
42 #define ATH3K_NORMAL_MODE 0x0E
44 #define ATH3K_PATCH_UPDATE 0x80
45 #define ATH3K_SYSCFG_UPDATE 0x40
47 #define ATH3K_XTAL_FREQ_26M 0x00
48 #define ATH3K_XTAL_FREQ_40M 0x01
49 #define ATH3K_XTAL_FREQ_19P2 0x02
50 #define ATH3K_NAME_LEN 0xFF
52 struct ath3k_version {
53 unsigned int rom_version;
54 unsigned int build_version;
55 unsigned int ram_version;
56 unsigned char ref_clock;
57 unsigned char reserved[0x07];
60 static const struct usb_device_id ath3k_table[] = {
62 { USB_DEVICE(0x0CF3, 0x3000) },
64 /* Atheros AR3011 with sflash firmware*/
65 { USB_DEVICE(0x0489, 0xE027) },
66 { USB_DEVICE(0x0489, 0xE03D) },
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(0x04c5, 0x1330) },
82 { USB_DEVICE(0x04CA, 0x3004) },
83 { USB_DEVICE(0x04CA, 0x3005) },
84 { USB_DEVICE(0x04CA, 0x3006) },
85 { USB_DEVICE(0x04CA, 0x3007) },
86 { USB_DEVICE(0x04CA, 0x3008) },
87 { USB_DEVICE(0x04CA, 0x300b) },
88 { USB_DEVICE(0x0930, 0x0219) },
89 { USB_DEVICE(0x0930, 0x0220) },
90 { USB_DEVICE(0x0b05, 0x17d0) },
91 { USB_DEVICE(0x0CF3, 0x0036) },
92 { USB_DEVICE(0x0CF3, 0x3004) },
93 { USB_DEVICE(0x0CF3, 0x3005) },
94 { USB_DEVICE(0x0CF3, 0x3008) },
95 { USB_DEVICE(0x0CF3, 0x311D) },
96 { USB_DEVICE(0x0CF3, 0x311E) },
97 { USB_DEVICE(0x0CF3, 0x311F) },
98 { USB_DEVICE(0x0cf3, 0x3121) },
99 { USB_DEVICE(0x0CF3, 0x817a) },
100 { USB_DEVICE(0x0cf3, 0xe003) },
101 { USB_DEVICE(0x0CF3, 0xE004) },
102 { USB_DEVICE(0x0CF3, 0xE005) },
103 { USB_DEVICE(0x13d3, 0x3362) },
104 { USB_DEVICE(0x13d3, 0x3375) },
105 { USB_DEVICE(0x13d3, 0x3393) },
106 { USB_DEVICE(0x13d3, 0x3402) },
108 /* Atheros AR5BBU12 with sflash firmware */
109 { USB_DEVICE(0x0489, 0xE02C) },
111 /* Atheros AR5BBU22 with sflash firmware */
112 { USB_DEVICE(0x0489, 0xE036) },
113 { USB_DEVICE(0x0489, 0xE03C) },
115 { } /* Terminating entry */
118 MODULE_DEVICE_TABLE(usb, ath3k_table);
120 #define BTUSB_ATH3012 0x80
121 /* This table is to load patch and sysconfig files
123 static const struct usb_device_id ath3k_blist_tbl[] = {
125 /* Atheros AR3012 with sflash firmware*/
126 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
127 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
128 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
129 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
130 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
131 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
132 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
133 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
134 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
135 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
136 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
137 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
138 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
139 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
140 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
141 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
142 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
143 { USB_DEVICE(0x0cf3, 0x3005), .driver_info = BTUSB_ATH3012 },
144 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
145 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
146 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
147 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
158 /* Atheros AR5BBU22 with sflash firmware */
159 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
162 { } /* Terminating entry */
165 #define USB_REQ_DFU_DNLOAD 1
166 #define BULK_SIZE 4096
167 #define FW_HDR_SIZE 20
169 static int ath3k_load_firmware(struct usb_device *udev,
170 const struct firmware *firmware)
173 int err, pipe, len, size, sent = 0;
174 int count = firmware->size;
176 BT_DBG("udev %p", udev);
178 pipe = usb_sndctrlpipe(udev, 0);
180 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
182 BT_ERR("Can't allocate memory chunk for firmware");
186 memcpy(send_buf, firmware->data, 20);
187 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
188 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
190 BT_ERR("Can't change to loading configuration err");
197 size = min_t(uint, count, BULK_SIZE);
198 pipe = usb_sndbulkpipe(udev, 0x02);
199 memcpy(send_buf, firmware->data + sent, size);
201 err = usb_bulk_msg(udev, pipe, send_buf, size,
204 if (err || (len != size)) {
205 BT_ERR("Error in firmware loading err = %d,"
206 "len = %d, size = %d", err, len, size);
219 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
224 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
228 pipe = usb_rcvctrlpipe(udev, 0);
229 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
230 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
231 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
239 static int ath3k_get_version(struct usb_device *udev,
240 struct ath3k_version *version)
243 struct ath3k_version *buf;
244 const int size = sizeof(*buf);
246 buf = kmalloc(size, GFP_KERNEL);
250 pipe = usb_rcvctrlpipe(udev, 0);
251 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
252 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
253 buf, size, USB_CTRL_SET_TIMEOUT);
255 memcpy(version, buf, size);
261 static int ath3k_load_fwfile(struct usb_device *udev,
262 const struct firmware *firmware)
265 int err, pipe, len, size, count, sent = 0;
268 count = firmware->size;
270 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
272 BT_ERR("Can't allocate memory chunk for firmware");
276 size = min_t(uint, count, FW_HDR_SIZE);
277 memcpy(send_buf, firmware->data, size);
279 pipe = usb_sndctrlpipe(udev, 0);
280 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
281 USB_TYPE_VENDOR, 0, 0, send_buf,
282 size, USB_CTRL_SET_TIMEOUT);
284 BT_ERR("Can't change to loading configuration err");
293 size = min_t(uint, count, BULK_SIZE);
294 pipe = usb_sndbulkpipe(udev, 0x02);
296 memcpy(send_buf, firmware->data + sent, size);
298 err = usb_bulk_msg(udev, pipe, send_buf, size,
300 if (err || (len != size)) {
301 BT_ERR("Error in firmware loading err = %d,"
302 "len = %d, size = %d", err, len, size);
314 static int ath3k_switch_pid(struct usb_device *udev)
318 pipe = usb_sndctrlpipe(udev, 0);
319 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
320 USB_TYPE_VENDOR, 0, 0,
321 NULL, 0, USB_CTRL_SET_TIMEOUT);
324 static int ath3k_set_normal_mode(struct usb_device *udev)
326 unsigned char fw_state;
329 ret = ath3k_get_state(udev, &fw_state);
331 BT_ERR("Can't get state to change to normal mode err");
335 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
336 BT_DBG("firmware was already in normal mode");
340 pipe = usb_sndctrlpipe(udev, 0);
341 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
342 USB_TYPE_VENDOR, 0, 0,
343 NULL, 0, USB_CTRL_SET_TIMEOUT);
346 static int ath3k_load_patch(struct usb_device *udev)
348 unsigned char fw_state;
349 char filename[ATH3K_NAME_LEN] = {0};
350 const struct firmware *firmware;
351 struct ath3k_version fw_version, pt_version;
354 ret = ath3k_get_state(udev, &fw_state);
356 BT_ERR("Can't get state to change to load ram patch err");
360 if (fw_state & ATH3K_PATCH_UPDATE) {
361 BT_DBG("Patch was already downloaded");
365 ret = ath3k_get_version(udev, &fw_version);
367 BT_ERR("Can't get version to change to load ram patch err");
371 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
372 le32_to_cpu(fw_version.rom_version));
374 ret = request_firmware(&firmware, filename, &udev->dev);
376 BT_ERR("Patch file not found %s", filename);
380 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
381 pt_version.build_version = *(int *)
382 (firmware->data + firmware->size - 4);
384 if ((pt_version.rom_version != fw_version.rom_version) ||
385 (pt_version.build_version <= fw_version.build_version)) {
386 BT_ERR("Patch file version did not match with firmware");
387 release_firmware(firmware);
391 ret = ath3k_load_fwfile(udev, firmware);
392 release_firmware(firmware);
397 static int ath3k_load_syscfg(struct usb_device *udev)
399 unsigned char fw_state;
400 char filename[ATH3K_NAME_LEN] = {0};
401 const struct firmware *firmware;
402 struct ath3k_version fw_version;
405 ret = ath3k_get_state(udev, &fw_state);
407 BT_ERR("Can't get state to change to load configuration err");
411 ret = ath3k_get_version(udev, &fw_version);
413 BT_ERR("Can't get version to change to load ram patch err");
417 switch (fw_version.ref_clock) {
419 case ATH3K_XTAL_FREQ_26M:
422 case ATH3K_XTAL_FREQ_40M:
425 case ATH3K_XTAL_FREQ_19P2:
433 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
434 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
436 ret = request_firmware(&firmware, filename, &udev->dev);
438 BT_ERR("Configuration file not found %s", filename);
442 ret = ath3k_load_fwfile(udev, firmware);
443 release_firmware(firmware);
448 static int ath3k_probe(struct usb_interface *intf,
449 const struct usb_device_id *id)
451 const struct firmware *firmware;
452 struct usb_device *udev = interface_to_usbdev(intf);
455 BT_DBG("intf %p id %p", intf, id);
457 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
460 /* match device ID in ath3k blacklist table */
461 if (!id->driver_info) {
462 const struct usb_device_id *match;
463 match = usb_match_id(intf, ath3k_blist_tbl);
468 /* load patch and sysconfig files for AR3012 */
469 if (id->driver_info & BTUSB_ATH3012) {
471 /* New firmware with patch and sysconfig files already loaded */
472 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
475 ret = ath3k_load_patch(udev);
477 BT_ERR("Loading patch file failed");
480 ret = ath3k_load_syscfg(udev);
482 BT_ERR("Loading sysconfig file failed");
485 ret = ath3k_set_normal_mode(udev);
487 BT_ERR("Set normal mode failed");
490 ath3k_switch_pid(udev);
494 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
497 BT_ERR("Firmware file \"%s\" not found",
500 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
501 ATH3K_FIRMWARE, ret);
505 ret = ath3k_load_firmware(udev, firmware);
506 release_firmware(firmware);
511 static void ath3k_disconnect(struct usb_interface *intf)
513 BT_DBG("ath3k_disconnect intf %p", intf);
516 static struct usb_driver ath3k_driver = {
518 .probe = ath3k_probe,
519 .disconnect = ath3k_disconnect,
520 .id_table = ath3k_table,
521 .disable_hub_initiated_lpm = 1,
524 module_usb_driver(ath3k_driver);
526 MODULE_AUTHOR("Atheros Communications");
527 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
528 MODULE_VERSION(VERSION);
529 MODULE_LICENSE("GPL");
530 MODULE_FIRMWARE(ATH3K_FIRMWARE);