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(0x13d3, 0x3304) },
66
{ USB_DEVICE(0x0930, 0x0215) },
68
/* Atheros AR9285 Malbec with sflash firmware */
69
{ USB_DEVICE(0x03F0, 0x311D) },
71
/* Atheros AR3012 with sflash firmware*/
72
{ USB_DEVICE(0x0CF3, 0x3004) },
74
/* Atheros AR5BBU12 with sflash firmware */
75
{ USB_DEVICE(0x0489, 0xE02C) },
77
{ } /* Terminating entry */
80
MODULE_DEVICE_TABLE(usb, ath3k_table);
82
#define BTUSB_ATH3012 0x80
83
/* This table is to load patch and sysconfig files
85
static struct usb_device_id ath3k_blist_tbl[] = {
87
/* Atheros AR3012 with sflash firmware*/
88
{ USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
90
{ } /* Terminating entry */
93
#define USB_REQ_DFU_DNLOAD 1
94
#define BULK_SIZE 4096
95
#define FW_HDR_SIZE 20
97
static int ath3k_load_firmware(struct usb_device *udev,
98
const struct firmware *firmware)
101
int err, pipe, len, size, sent = 0;
102
int count = firmware->size;
104
BT_DBG("udev %p", udev);
106
pipe = usb_sndctrlpipe(udev, 0);
108
send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
110
BT_ERR("Can't allocate memory chunk for firmware");
114
memcpy(send_buf, firmware->data, 20);
115
if ((err = usb_control_msg(udev, pipe,
117
USB_TYPE_VENDOR, 0, 0,
118
send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
119
BT_ERR("Can't change to loading configuration err");
126
size = min_t(uint, count, BULK_SIZE);
127
pipe = usb_sndbulkpipe(udev, 0x02);
128
memcpy(send_buf, firmware->data + sent, size);
130
err = usb_bulk_msg(udev, pipe, send_buf, size,
133
if (err || (len != size)) {
134
BT_ERR("Error in firmware loading err = %d,"
135
"len = %d, size = %d", err, len, size);
148
static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
152
pipe = usb_rcvctrlpipe(udev, 0);
153
return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
154
USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
155
state, 0x01, USB_CTRL_SET_TIMEOUT);
158
static int ath3k_get_version(struct usb_device *udev,
159
struct ath3k_version *version)
163
pipe = usb_rcvctrlpipe(udev, 0);
164
return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
165
USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
166
sizeof(struct ath3k_version),
167
USB_CTRL_SET_TIMEOUT);
170
static int ath3k_load_fwfile(struct usb_device *udev,
171
const struct firmware *firmware)
174
int err, pipe, len, size, count, sent = 0;
177
count = firmware->size;
179
send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
181
BT_ERR("Can't allocate memory chunk for firmware");
185
size = min_t(uint, count, FW_HDR_SIZE);
186
memcpy(send_buf, firmware->data, size);
188
pipe = usb_sndctrlpipe(udev, 0);
189
ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
190
USB_TYPE_VENDOR, 0, 0, send_buf,
191
size, USB_CTRL_SET_TIMEOUT);
193
BT_ERR("Can't change to loading configuration err");
202
size = min_t(uint, count, BULK_SIZE);
203
pipe = usb_sndbulkpipe(udev, 0x02);
205
memcpy(send_buf, firmware->data + sent, size);
207
err = usb_bulk_msg(udev, pipe, send_buf, size,
209
if (err || (len != size)) {
210
BT_ERR("Error in firmware loading err = %d,"
211
"len = %d, size = %d", err, len, size);
223
static int ath3k_switch_pid(struct usb_device *udev)
227
pipe = usb_sndctrlpipe(udev, 0);
228
return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
229
USB_TYPE_VENDOR, 0, 0,
230
NULL, 0, USB_CTRL_SET_TIMEOUT);
233
static int ath3k_set_normal_mode(struct usb_device *udev)
235
unsigned char fw_state;
238
ret = ath3k_get_state(udev, &fw_state);
240
BT_ERR("Can't get state to change to normal mode err");
244
if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
245
BT_DBG("firmware was already in normal mode");
249
pipe = usb_sndctrlpipe(udev, 0);
250
return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
251
USB_TYPE_VENDOR, 0, 0,
252
NULL, 0, USB_CTRL_SET_TIMEOUT);
255
static int ath3k_load_patch(struct usb_device *udev)
257
unsigned char fw_state;
258
char filename[ATH3K_NAME_LEN] = {0};
259
const struct firmware *firmware;
260
struct ath3k_version fw_version, pt_version;
263
ret = ath3k_get_state(udev, &fw_state);
265
BT_ERR("Can't get state to change to load ram patch err");
269
if (fw_state & ATH3K_PATCH_UPDATE) {
270
BT_DBG("Patch was already downloaded");
274
ret = ath3k_get_version(udev, &fw_version);
276
BT_ERR("Can't get version to change to load ram patch err");
280
snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
281
fw_version.rom_version);
283
ret = request_firmware(&firmware, filename, &udev->dev);
285
BT_ERR("Patch file not found %s", filename);
289
pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
290
pt_version.build_version = *(int *)
291
(firmware->data + firmware->size - 4);
293
if ((pt_version.rom_version != fw_version.rom_version) ||
294
(pt_version.build_version <= fw_version.build_version)) {
295
BT_ERR("Patch file version did not match with firmware");
296
release_firmware(firmware);
300
ret = ath3k_load_fwfile(udev, firmware);
301
release_firmware(firmware);
306
static int ath3k_load_syscfg(struct usb_device *udev)
308
unsigned char fw_state;
309
char filename[ATH3K_NAME_LEN] = {0};
310
const struct firmware *firmware;
311
struct ath3k_version fw_version;
314
ret = ath3k_get_state(udev, &fw_state);
316
BT_ERR("Can't get state to change to load configration err");
320
ret = ath3k_get_version(udev, &fw_version);
322
BT_ERR("Can't get version to change to load ram patch err");
326
switch (fw_version.ref_clock) {
328
case ATH3K_XTAL_FREQ_26M:
331
case ATH3K_XTAL_FREQ_40M:
334
case ATH3K_XTAL_FREQ_19P2:
342
snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
343
fw_version.rom_version, clk_value, ".dfu");
345
ret = request_firmware(&firmware, filename, &udev->dev);
347
BT_ERR("Configuration file not found %s", filename);
351
ret = ath3k_load_fwfile(udev, firmware);
352
release_firmware(firmware);
357
static int ath3k_probe(struct usb_interface *intf,
358
const struct usb_device_id *id)
360
const struct firmware *firmware;
361
struct usb_device *udev = interface_to_usbdev(intf);
364
BT_DBG("intf %p id %p", intf, id);
366
if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
369
/* match device ID in ath3k blacklist table */
370
if (!id->driver_info) {
371
const struct usb_device_id *match;
372
match = usb_match_id(intf, ath3k_blist_tbl);
377
/* load patch and sysconfig files for AR3012 */
378
if (id->driver_info & BTUSB_ATH3012) {
380
/* New firmware with patch and sysconfig files already loaded */
381
if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
384
ret = ath3k_load_patch(udev);
386
BT_ERR("Loading patch file failed");
389
ret = ath3k_load_syscfg(udev);
391
BT_ERR("Loading sysconfig file failed");
394
ret = ath3k_set_normal_mode(udev);
396
BT_ERR("Set normal mode failed");
399
ath3k_switch_pid(udev);
403
if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
404
BT_ERR("Error loading firmware");
408
ret = ath3k_load_firmware(udev, firmware);
409
release_firmware(firmware);
414
static void ath3k_disconnect(struct usb_interface *intf)
416
BT_DBG("ath3k_disconnect intf %p", intf);
419
static struct usb_driver ath3k_driver = {
421
.probe = ath3k_probe,
422
.disconnect = ath3k_disconnect,
423
.id_table = ath3k_table,
426
static int __init ath3k_init(void)
428
BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
429
return usb_register(&ath3k_driver);
432
static void __exit ath3k_exit(void)
434
usb_deregister(&ath3k_driver);
437
module_init(ath3k_init);
438
module_exit(ath3k_exit);
440
MODULE_AUTHOR("Atheros Communications");
441
MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
442
MODULE_VERSION(VERSION);
443
MODULE_LICENSE("GPL");
444
MODULE_FIRMWARE("ath3k-1.fw");