Loading...
1/*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
3 *
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.
8 *
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.
13 *
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
17 *
18 */
19
20
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>
31
32#define VERSION "1.0"
33
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
39
40#define ATH3K_MODE_MASK 0x3F
41#define ATH3K_NORMAL_MODE 0x0E
42
43#define ATH3K_PATCH_UPDATE 0x80
44#define ATH3K_SYSCFG_UPDATE 0x40
45
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
50
51struct 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];
57};
58
59static struct usb_device_id ath3k_table[] = {
60 /* Atheros AR3011 */
61 { USB_DEVICE(0x0CF3, 0x3000) },
62
63 /* Atheros AR3011 with sflash firmware*/
64 { USB_DEVICE(0x0CF3, 0x3002) },
65 { USB_DEVICE(0x13d3, 0x3304) },
66 { USB_DEVICE(0x0930, 0x0215) },
67
68 /* Atheros AR9285 Malbec with sflash firmware */
69 { USB_DEVICE(0x03F0, 0x311D) },
70
71 /* Atheros AR3012 with sflash firmware*/
72 { USB_DEVICE(0x0CF3, 0x3004) },
73
74 /* Atheros AR5BBU12 with sflash firmware */
75 { USB_DEVICE(0x0489, 0xE02C) },
76
77 { } /* Terminating entry */
78};
79
80MODULE_DEVICE_TABLE(usb, ath3k_table);
81
82#define BTUSB_ATH3012 0x80
83/* This table is to load patch and sysconfig files
84 * for AR3012 */
85static struct usb_device_id ath3k_blist_tbl[] = {
86
87 /* Atheros AR3012 with sflash firmware*/
88 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
89
90 { } /* Terminating entry */
91};
92
93#define USB_REQ_DFU_DNLOAD 1
94#define BULK_SIZE 4096
95#define FW_HDR_SIZE 20
96
97static int ath3k_load_firmware(struct usb_device *udev,
98 const struct firmware *firmware)
99{
100 u8 *send_buf;
101 int err, pipe, len, size, sent = 0;
102 int count = firmware->size;
103
104 BT_DBG("udev %p", udev);
105
106 pipe = usb_sndctrlpipe(udev, 0);
107
108 send_buf = kmalloc(BULK_SIZE, GFP_ATOMIC);
109 if (!send_buf) {
110 BT_ERR("Can't allocate memory chunk for firmware");
111 return -ENOMEM;
112 }
113
114 memcpy(send_buf, firmware->data, 20);
115 if ((err = usb_control_msg(udev, pipe,
116 USB_REQ_DFU_DNLOAD,
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");
120 goto error;
121 }
122 sent += 20;
123 count -= 20;
124
125 while (count) {
126 size = min_t(uint, count, BULK_SIZE);
127 pipe = usb_sndbulkpipe(udev, 0x02);
128 memcpy(send_buf, firmware->data + sent, size);
129
130 err = usb_bulk_msg(udev, pipe, send_buf, size,
131 &len, 3000);
132
133 if (err || (len != size)) {
134 BT_ERR("Error in firmware loading err = %d,"
135 "len = %d, size = %d", err, len, size);
136 goto error;
137 }
138
139 sent += size;
140 count -= size;
141 }
142
143error:
144 kfree(send_buf);
145 return err;
146}
147
148static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
149{
150 int pipe = 0;
151
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);
156}
157
158static int ath3k_get_version(struct usb_device *udev,
159 struct ath3k_version *version)
160{
161 int pipe = 0;
162
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);
168}
169
170static int ath3k_load_fwfile(struct usb_device *udev,
171 const struct firmware *firmware)
172{
173 u8 *send_buf;
174 int err, pipe, len, size, count, sent = 0;
175 int ret;
176
177 count = firmware->size;
178
179 send_buf = kmalloc(BULK_SIZE, GFP_ATOMIC);
180 if (!send_buf) {
181 BT_ERR("Can't allocate memory chunk for firmware");
182 return -ENOMEM;
183 }
184
185 size = min_t(uint, count, FW_HDR_SIZE);
186 memcpy(send_buf, firmware->data, size);
187
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);
192 if (ret < 0) {
193 BT_ERR("Can't change to loading configuration err");
194 kfree(send_buf);
195 return ret;
196 }
197
198 sent += size;
199 count -= size;
200
201 while (count) {
202 size = min_t(uint, count, BULK_SIZE);
203 pipe = usb_sndbulkpipe(udev, 0x02);
204
205 memcpy(send_buf, firmware->data + sent, size);
206
207 err = usb_bulk_msg(udev, pipe, send_buf, size,
208 &len, 3000);
209 if (err || (len != size)) {
210 BT_ERR("Error in firmware loading err = %d,"
211 "len = %d, size = %d", err, len, size);
212 kfree(send_buf);
213 return err;
214 }
215 sent += size;
216 count -= size;
217 }
218
219 kfree(send_buf);
220 return 0;
221}
222
223static int ath3k_switch_pid(struct usb_device *udev)
224{
225 int pipe = 0;
226
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);
231}
232
233static int ath3k_set_normal_mode(struct usb_device *udev)
234{
235 unsigned char fw_state;
236 int pipe = 0, ret;
237
238 ret = ath3k_get_state(udev, &fw_state);
239 if (ret < 0) {
240 BT_ERR("Can't get state to change to normal mode err");
241 return ret;
242 }
243
244 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
245 BT_DBG("firmware was already in normal mode");
246 return 0;
247 }
248
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);
253}
254
255static int ath3k_load_patch(struct usb_device *udev)
256{
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;
261 int ret;
262
263 ret = ath3k_get_state(udev, &fw_state);
264 if (ret < 0) {
265 BT_ERR("Can't get state to change to load ram patch err");
266 return ret;
267 }
268
269 if (fw_state & ATH3K_PATCH_UPDATE) {
270 BT_DBG("Patch was already downloaded");
271 return 0;
272 }
273
274 ret = ath3k_get_version(udev, &fw_version);
275 if (ret < 0) {
276 BT_ERR("Can't get version to change to load ram patch err");
277 return ret;
278 }
279
280 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
281 fw_version.rom_version);
282
283 ret = request_firmware(&firmware, filename, &udev->dev);
284 if (ret < 0) {
285 BT_ERR("Patch file not found %s", filename);
286 return ret;
287 }
288
289 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
290 pt_version.build_version = *(int *)
291 (firmware->data + firmware->size - 4);
292
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);
297 return -EINVAL;
298 }
299
300 ret = ath3k_load_fwfile(udev, firmware);
301 release_firmware(firmware);
302
303 return ret;
304}
305
306static int ath3k_load_syscfg(struct usb_device *udev)
307{
308 unsigned char fw_state;
309 char filename[ATH3K_NAME_LEN] = {0};
310 const struct firmware *firmware;
311 struct ath3k_version fw_version;
312 int clk_value, ret;
313
314 ret = ath3k_get_state(udev, &fw_state);
315 if (ret < 0) {
316 BT_ERR("Can't get state to change to load configration err");
317 return -EBUSY;
318 }
319
320 ret = ath3k_get_version(udev, &fw_version);
321 if (ret < 0) {
322 BT_ERR("Can't get version to change to load ram patch err");
323 return ret;
324 }
325
326 switch (fw_version.ref_clock) {
327
328 case ATH3K_XTAL_FREQ_26M:
329 clk_value = 26;
330 break;
331 case ATH3K_XTAL_FREQ_40M:
332 clk_value = 40;
333 break;
334 case ATH3K_XTAL_FREQ_19P2:
335 clk_value = 19;
336 break;
337 default:
338 clk_value = 0;
339 break;
340 }
341
342 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
343 fw_version.rom_version, clk_value, ".dfu");
344
345 ret = request_firmware(&firmware, filename, &udev->dev);
346 if (ret < 0) {
347 BT_ERR("Configuration file not found %s", filename);
348 return ret;
349 }
350
351 ret = ath3k_load_fwfile(udev, firmware);
352 release_firmware(firmware);
353
354 return ret;
355}
356
357static int ath3k_probe(struct usb_interface *intf,
358 const struct usb_device_id *id)
359{
360 const struct firmware *firmware;
361 struct usb_device *udev = interface_to_usbdev(intf);
362 int ret;
363
364 BT_DBG("intf %p id %p", intf, id);
365
366 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
367 return -ENODEV;
368
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);
373 if (match)
374 id = match;
375 }
376
377 /* load patch and sysconfig files for AR3012 */
378 if (id->driver_info & BTUSB_ATH3012) {
379
380 /* New firmware with patch and sysconfig files already loaded */
381 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
382 return -ENODEV;
383
384 ret = ath3k_load_patch(udev);
385 if (ret < 0) {
386 BT_ERR("Loading patch file failed");
387 return ret;
388 }
389 ret = ath3k_load_syscfg(udev);
390 if (ret < 0) {
391 BT_ERR("Loading sysconfig file failed");
392 return ret;
393 }
394 ret = ath3k_set_normal_mode(udev);
395 if (ret < 0) {
396 BT_ERR("Set normal mode failed");
397 return ret;
398 }
399 ath3k_switch_pid(udev);
400 return 0;
401 }
402
403 if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
404 BT_ERR("Error loading firmware");
405 return -EIO;
406 }
407
408 ret = ath3k_load_firmware(udev, firmware);
409 release_firmware(firmware);
410
411 return ret;
412}
413
414static void ath3k_disconnect(struct usb_interface *intf)
415{
416 BT_DBG("ath3k_disconnect intf %p", intf);
417}
418
419static struct usb_driver ath3k_driver = {
420 .name = "ath3k",
421 .probe = ath3k_probe,
422 .disconnect = ath3k_disconnect,
423 .id_table = ath3k_table,
424};
425
426static int __init ath3k_init(void)
427{
428 BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
429 return usb_register(&ath3k_driver);
430}
431
432static void __exit ath3k_exit(void)
433{
434 usb_deregister(&ath3k_driver);
435}
436
437module_init(ath3k_init);
438module_exit(ath3k_exit);
439
440MODULE_AUTHOR("Atheros Communications");
441MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
442MODULE_VERSION(VERSION);
443MODULE_LICENSE("GPL");
444MODULE_FIRMWARE("ath3k-1.fw");
1/*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
3 *
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.
8 *
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.
13 *
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
17 *
18 */
19
20
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>
32
33#define VERSION "1.0"
34#define ATH3K_FIRMWARE "ath3k-1.fw"
35
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
41
42#define ATH3K_MODE_MASK 0x3F
43#define ATH3K_NORMAL_MODE 0x0E
44
45#define ATH3K_PATCH_UPDATE 0x80
46#define ATH3K_SYSCFG_UPDATE 0x40
47
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
52
53struct ath3k_version {
54 __le32 rom_version;
55 __le32 build_version;
56 __le32 ram_version;
57 __u8 ref_clock;
58 __u8 reserved[7];
59} __packed;
60
61static const struct usb_device_id ath3k_table[] = {
62 /* Atheros AR3011 */
63 { USB_DEVICE(0x0CF3, 0x3000) },
64
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) },
73
74 /* Atheros AR9285 Malbec with sflash firmware */
75 { USB_DEVICE(0x03F0, 0x311D) },
76
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, 0xe076) },
84 { USB_DEVICE(0x0489, 0xe078) },
85 { USB_DEVICE(0x0489, 0xe095) },
86 { USB_DEVICE(0x04c5, 0x1330) },
87 { USB_DEVICE(0x04CA, 0x3004) },
88 { USB_DEVICE(0x04CA, 0x3005) },
89 { USB_DEVICE(0x04CA, 0x3006) },
90 { USB_DEVICE(0x04CA, 0x3007) },
91 { USB_DEVICE(0x04CA, 0x3008) },
92 { USB_DEVICE(0x04CA, 0x300b) },
93 { USB_DEVICE(0x04CA, 0x300d) },
94 { USB_DEVICE(0x04CA, 0x300f) },
95 { USB_DEVICE(0x04CA, 0x3010) },
96 { USB_DEVICE(0x04CA, 0x3014) },
97 { USB_DEVICE(0x04CA, 0x3018) },
98 { USB_DEVICE(0x0930, 0x0219) },
99 { USB_DEVICE(0x0930, 0x021c) },
100 { USB_DEVICE(0x0930, 0x0220) },
101 { USB_DEVICE(0x0930, 0x0227) },
102 { USB_DEVICE(0x0b05, 0x17d0) },
103 { USB_DEVICE(0x0CF3, 0x0036) },
104 { USB_DEVICE(0x0CF3, 0x3004) },
105 { USB_DEVICE(0x0CF3, 0x3008) },
106 { USB_DEVICE(0x0CF3, 0x311D) },
107 { USB_DEVICE(0x0CF3, 0x311E) },
108 { USB_DEVICE(0x0CF3, 0x311F) },
109 { USB_DEVICE(0x0cf3, 0x3121) },
110 { USB_DEVICE(0x0CF3, 0x817a) },
111 { USB_DEVICE(0x0CF3, 0x817b) },
112 { USB_DEVICE(0x0cf3, 0xe003) },
113 { USB_DEVICE(0x0CF3, 0xE004) },
114 { USB_DEVICE(0x0CF3, 0xE005) },
115 { USB_DEVICE(0x0CF3, 0xE006) },
116 { USB_DEVICE(0x13d3, 0x3362) },
117 { USB_DEVICE(0x13d3, 0x3375) },
118 { USB_DEVICE(0x13d3, 0x3393) },
119 { USB_DEVICE(0x13d3, 0x3395) },
120 { USB_DEVICE(0x13d3, 0x3402) },
121 { USB_DEVICE(0x13d3, 0x3408) },
122 { USB_DEVICE(0x13d3, 0x3423) },
123 { USB_DEVICE(0x13d3, 0x3432) },
124 { USB_DEVICE(0x13d3, 0x3472) },
125 { USB_DEVICE(0x13d3, 0x3474) },
126 { USB_DEVICE(0x13d3, 0x3487) },
127 { USB_DEVICE(0x13d3, 0x3490) },
128
129 /* Atheros AR5BBU12 with sflash firmware */
130 { USB_DEVICE(0x0489, 0xE02C) },
131
132 /* Atheros AR5BBU22 with sflash firmware */
133 { USB_DEVICE(0x0489, 0xE036) },
134 { USB_DEVICE(0x0489, 0xE03C) },
135
136 { } /* Terminating entry */
137};
138
139MODULE_DEVICE_TABLE(usb, ath3k_table);
140
141#define BTUSB_ATH3012 0x80
142/* This table is to load patch and sysconfig files
143 * for AR3012 */
144static const struct usb_device_id ath3k_blist_tbl[] = {
145
146 /* Atheros AR3012 with sflash firmware*/
147 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
148 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
169 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
170 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
171 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
173 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
174 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
175 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
176 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
177 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
191 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
193 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
194 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
195 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
196 { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
197
198 /* Atheros AR5BBU22 with sflash firmware */
199 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
200 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
201
202 { } /* Terminating entry */
203};
204
205#define USB_REQ_DFU_DNLOAD 1
206#define BULK_SIZE 4096
207#define FW_HDR_SIZE 20
208#define TIMEGAP_USEC_MIN 50
209#define TIMEGAP_USEC_MAX 100
210
211static int ath3k_load_firmware(struct usb_device *udev,
212 const struct firmware *firmware)
213{
214 u8 *send_buf;
215 int len = 0;
216 int err, pipe, size, sent = 0;
217 int count = firmware->size;
218
219 BT_DBG("udev %p", udev);
220
221 pipe = usb_sndctrlpipe(udev, 0);
222
223 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
224 if (!send_buf) {
225 BT_ERR("Can't allocate memory chunk for firmware");
226 return -ENOMEM;
227 }
228
229 memcpy(send_buf, firmware->data, 20);
230 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
231 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
232 if (err < 0) {
233 BT_ERR("Can't change to loading configuration err");
234 goto error;
235 }
236 sent += 20;
237 count -= 20;
238
239 pipe = usb_sndbulkpipe(udev, 0x02);
240
241 while (count) {
242 /* workaround the compatibility issue with xHCI controller*/
243 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
244
245 size = min_t(uint, count, BULK_SIZE);
246 memcpy(send_buf, firmware->data + sent, size);
247
248 err = usb_bulk_msg(udev, pipe, send_buf, size,
249 &len, 3000);
250
251 if (err || (len != size)) {
252 BT_ERR("Error in firmware loading err = %d,"
253 "len = %d, size = %d", err, len, size);
254 goto error;
255 }
256
257 sent += size;
258 count -= size;
259 }
260
261error:
262 kfree(send_buf);
263 return err;
264}
265
266static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
267{
268 int ret, pipe = 0;
269 char *buf;
270
271 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
272 if (!buf)
273 return -ENOMEM;
274
275 pipe = usb_rcvctrlpipe(udev, 0);
276 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
277 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
278 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
279
280 *state = *buf;
281 kfree(buf);
282
283 return ret;
284}
285
286static int ath3k_get_version(struct usb_device *udev,
287 struct ath3k_version *version)
288{
289 int ret, pipe = 0;
290 struct ath3k_version *buf;
291 const int size = sizeof(*buf);
292
293 buf = kmalloc(size, GFP_KERNEL);
294 if (!buf)
295 return -ENOMEM;
296
297 pipe = usb_rcvctrlpipe(udev, 0);
298 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
299 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
300 buf, size, USB_CTRL_SET_TIMEOUT);
301
302 memcpy(version, buf, size);
303 kfree(buf);
304
305 return ret;
306}
307
308static int ath3k_load_fwfile(struct usb_device *udev,
309 const struct firmware *firmware)
310{
311 u8 *send_buf;
312 int len = 0;
313 int err, pipe, size, count, sent = 0;
314 int ret;
315
316 count = firmware->size;
317
318 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
319 if (!send_buf) {
320 BT_ERR("Can't allocate memory chunk for firmware");
321 return -ENOMEM;
322 }
323
324 size = min_t(uint, count, FW_HDR_SIZE);
325 memcpy(send_buf, firmware->data, size);
326
327 pipe = usb_sndctrlpipe(udev, 0);
328 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
329 USB_TYPE_VENDOR, 0, 0, send_buf,
330 size, USB_CTRL_SET_TIMEOUT);
331 if (ret < 0) {
332 BT_ERR("Can't change to loading configuration err");
333 kfree(send_buf);
334 return ret;
335 }
336
337 sent += size;
338 count -= size;
339
340 pipe = usb_sndbulkpipe(udev, 0x02);
341
342 while (count) {
343 /* workaround the compatibility issue with xHCI controller*/
344 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
345
346 size = min_t(uint, count, BULK_SIZE);
347 memcpy(send_buf, firmware->data + sent, size);
348
349 err = usb_bulk_msg(udev, pipe, send_buf, size,
350 &len, 3000);
351 if (err || (len != size)) {
352 BT_ERR("Error in firmware loading err = %d,"
353 "len = %d, size = %d", err, len, size);
354 kfree(send_buf);
355 return err;
356 }
357 sent += size;
358 count -= size;
359 }
360
361 kfree(send_buf);
362 return 0;
363}
364
365static int ath3k_switch_pid(struct usb_device *udev)
366{
367 int pipe = 0;
368
369 pipe = usb_sndctrlpipe(udev, 0);
370 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
371 USB_TYPE_VENDOR, 0, 0,
372 NULL, 0, USB_CTRL_SET_TIMEOUT);
373}
374
375static int ath3k_set_normal_mode(struct usb_device *udev)
376{
377 unsigned char fw_state;
378 int pipe = 0, ret;
379
380 ret = ath3k_get_state(udev, &fw_state);
381 if (ret < 0) {
382 BT_ERR("Can't get state to change to normal mode err");
383 return ret;
384 }
385
386 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
387 BT_DBG("firmware was already in normal mode");
388 return 0;
389 }
390
391 pipe = usb_sndctrlpipe(udev, 0);
392 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
393 USB_TYPE_VENDOR, 0, 0,
394 NULL, 0, USB_CTRL_SET_TIMEOUT);
395}
396
397static int ath3k_load_patch(struct usb_device *udev)
398{
399 unsigned char fw_state;
400 char filename[ATH3K_NAME_LEN] = {0};
401 const struct firmware *firmware;
402 struct ath3k_version fw_version;
403 __u32 pt_rom_version, pt_build_version;
404 int ret;
405
406 ret = ath3k_get_state(udev, &fw_state);
407 if (ret < 0) {
408 BT_ERR("Can't get state to change to load ram patch err");
409 return ret;
410 }
411
412 if (fw_state & ATH3K_PATCH_UPDATE) {
413 BT_DBG("Patch was already downloaded");
414 return 0;
415 }
416
417 ret = ath3k_get_version(udev, &fw_version);
418 if (ret < 0) {
419 BT_ERR("Can't get version to change to load ram patch err");
420 return ret;
421 }
422
423 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
424 le32_to_cpu(fw_version.rom_version));
425
426 ret = request_firmware(&firmware, filename, &udev->dev);
427 if (ret < 0) {
428 BT_ERR("Patch file not found %s", filename);
429 return ret;
430 }
431
432 pt_rom_version = get_unaligned_le32(firmware->data +
433 firmware->size - 8);
434 pt_build_version = get_unaligned_le32(firmware->data +
435 firmware->size - 4);
436
437 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
438 pt_build_version <= le32_to_cpu(fw_version.build_version)) {
439 BT_ERR("Patch file version did not match with firmware");
440 release_firmware(firmware);
441 return -EINVAL;
442 }
443
444 ret = ath3k_load_fwfile(udev, firmware);
445 release_firmware(firmware);
446
447 return ret;
448}
449
450static int ath3k_load_syscfg(struct usb_device *udev)
451{
452 unsigned char fw_state;
453 char filename[ATH3K_NAME_LEN] = {0};
454 const struct firmware *firmware;
455 struct ath3k_version fw_version;
456 int clk_value, ret;
457
458 ret = ath3k_get_state(udev, &fw_state);
459 if (ret < 0) {
460 BT_ERR("Can't get state to change to load configuration err");
461 return -EBUSY;
462 }
463
464 ret = ath3k_get_version(udev, &fw_version);
465 if (ret < 0) {
466 BT_ERR("Can't get version to change to load ram patch err");
467 return ret;
468 }
469
470 switch (fw_version.ref_clock) {
471
472 case ATH3K_XTAL_FREQ_26M:
473 clk_value = 26;
474 break;
475 case ATH3K_XTAL_FREQ_40M:
476 clk_value = 40;
477 break;
478 case ATH3K_XTAL_FREQ_19P2:
479 clk_value = 19;
480 break;
481 default:
482 clk_value = 0;
483 break;
484 }
485
486 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
487 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
488
489 ret = request_firmware(&firmware, filename, &udev->dev);
490 if (ret < 0) {
491 BT_ERR("Configuration file not found %s", filename);
492 return ret;
493 }
494
495 ret = ath3k_load_fwfile(udev, firmware);
496 release_firmware(firmware);
497
498 return ret;
499}
500
501static int ath3k_probe(struct usb_interface *intf,
502 const struct usb_device_id *id)
503{
504 const struct firmware *firmware;
505 struct usb_device *udev = interface_to_usbdev(intf);
506 int ret;
507
508 BT_DBG("intf %p id %p", intf, id);
509
510 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
511 return -ENODEV;
512
513 /* match device ID in ath3k blacklist table */
514 if (!id->driver_info) {
515 const struct usb_device_id *match;
516
517 match = usb_match_id(intf, ath3k_blist_tbl);
518 if (match)
519 id = match;
520 }
521
522 /* load patch and sysconfig files for AR3012 */
523 if (id->driver_info & BTUSB_ATH3012) {
524
525 /* New firmware with patch and sysconfig files already loaded */
526 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
527 return -ENODEV;
528
529 ret = ath3k_load_patch(udev);
530 if (ret < 0) {
531 BT_ERR("Loading patch file failed");
532 return ret;
533 }
534 ret = ath3k_load_syscfg(udev);
535 if (ret < 0) {
536 BT_ERR("Loading sysconfig file failed");
537 return ret;
538 }
539 ret = ath3k_set_normal_mode(udev);
540 if (ret < 0) {
541 BT_ERR("Set normal mode failed");
542 return ret;
543 }
544 ath3k_switch_pid(udev);
545 return 0;
546 }
547
548 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
549 if (ret < 0) {
550 if (ret == -ENOENT)
551 BT_ERR("Firmware file \"%s\" not found",
552 ATH3K_FIRMWARE);
553 else
554 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
555 ATH3K_FIRMWARE, ret);
556 return ret;
557 }
558
559 ret = ath3k_load_firmware(udev, firmware);
560 release_firmware(firmware);
561
562 return ret;
563}
564
565static void ath3k_disconnect(struct usb_interface *intf)
566{
567 BT_DBG("ath3k_disconnect intf %p", intf);
568}
569
570static struct usb_driver ath3k_driver = {
571 .name = "ath3k",
572 .probe = ath3k_probe,
573 .disconnect = ath3k_disconnect,
574 .id_table = ath3k_table,
575 .disable_hub_initiated_lpm = 1,
576};
577
578module_usb_driver(ath3k_driver);
579
580MODULE_AUTHOR("Atheros Communications");
581MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
582MODULE_VERSION(VERSION);
583MODULE_LICENSE("GPL");
584MODULE_FIRMWARE(ATH3K_FIRMWARE);