Commit | Line | Data |
---|---|---|
9670d80a VK |
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" | |
c3eae82a | 33 | #define ATH3K_FIRMWARE "ath3k-1.fw" |
9670d80a | 34 | |
d9f51b51 BS |
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 | |
40 | ||
41 | #define ATH3K_MODE_MASK 0x3F | |
42 | #define ATH3K_NORMAL_MODE 0x0E | |
43 | ||
44 | #define ATH3K_PATCH_UPDATE 0x80 | |
45 | #define ATH3K_SYSCFG_UPDATE 0x40 | |
46 | ||
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 | |
51 | ||
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]; | |
58 | }; | |
9670d80a VK |
59 | |
60 | static struct usb_device_id ath3k_table[] = { | |
61 | /* Atheros AR3011 */ | |
62 | { USB_DEVICE(0x0CF3, 0x3000) }, | |
be93112a BS |
63 | |
64 | /* Atheros AR3011 with sflash firmware*/ | |
65 | { USB_DEVICE(0x0CF3, 0x3002) }, | |
6eda541d | 66 | { USB_DEVICE(0x0CF3, 0xE019) }, |
2a7bcccc | 67 | { USB_DEVICE(0x13d3, 0x3304) }, |
8e7c3d2e | 68 | { USB_DEVICE(0x0930, 0x0215) }, |
6b6ba88b | 69 | { USB_DEVICE(0x0489, 0xE03D) }, |
acd94544 | 70 | { USB_DEVICE(0x0489, 0xE027) }, |
be93112a | 71 | |
509e7861 CYC |
72 | /* Atheros AR9285 Malbec with sflash firmware */ |
73 | { USB_DEVICE(0x03F0, 0x311D) }, | |
d9f51b51 BS |
74 | |
75 | /* Atheros AR3012 with sflash firmware*/ | |
d66629c1 | 76 | { USB_DEVICE(0x0CF3, 0x0036) }, |
d9f51b51 | 77 | { USB_DEVICE(0x0CF3, 0x3004) }, |
94a32d10 | 78 | { USB_DEVICE(0x0CF3, 0x3008) }, |
07c0ea87 | 79 | { USB_DEVICE(0x0CF3, 0x311D) }, |
9498ba7a | 80 | { USB_DEVICE(0x13d3, 0x3375) }, |
3f63c340 | 81 | { USB_DEVICE(0x04CA, 0x3004) }, |
55ed7d4d | 82 | { USB_DEVICE(0x04CA, 0x3005) }, |
2c262b2a | 83 | { USB_DEVICE(0x04CA, 0x3006) }, |
f4d6f7dc | 84 | { USB_DEVICE(0x04CA, 0x3008) }, |
87522a43 | 85 | { USB_DEVICE(0x13d3, 0x3362) }, |
ac71311e | 86 | { USB_DEVICE(0x0CF3, 0xE004) }, |
6c4ae5c2 | 87 | { USB_DEVICE(0x0930, 0x0219) }, |
2096ae6c | 88 | { USB_DEVICE(0x0489, 0xe057) }, |
eed307e2 | 89 | { USB_DEVICE(0x13d3, 0x3393) }, |
3a61eda8 | 90 | { USB_DEVICE(0x0489, 0xe04e) }, |
2582d529 | 91 | { USB_DEVICE(0x0489, 0xe056) }, |
d9f51b51 | 92 | |
e9036e33 CYC |
93 | /* Atheros AR5BBU12 with sflash firmware */ |
94 | { USB_DEVICE(0x0489, 0xE02C) }, | |
b67afe7f | 95 | |
85d59726 MG |
96 | /* Atheros AR5BBU22 with sflash firmware */ |
97 | { USB_DEVICE(0x0489, 0xE03C) }, | |
bc21fde2 | 98 | { USB_DEVICE(0x0489, 0xE036) }, |
85d59726 | 99 | |
9670d80a VK |
100 | { } /* Terminating entry */ |
101 | }; | |
102 | ||
103 | MODULE_DEVICE_TABLE(usb, ath3k_table); | |
104 | ||
d9f51b51 BS |
105 | #define BTUSB_ATH3012 0x80 |
106 | /* This table is to load patch and sysconfig files | |
107 | * for AR3012 */ | |
108 | static struct usb_device_id ath3k_blist_tbl[] = { | |
109 | ||
110 | /* Atheros AR3012 with sflash firmware*/ | |
d66629c1 | 111 | { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 }, |
d9f51b51 | 112 | { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 }, |
94a32d10 | 113 | { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 }, |
07c0ea87 | 114 | { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 }, |
9498ba7a | 115 | { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 }, |
3f63c340 | 116 | { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 }, |
55ed7d4d | 117 | { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 }, |
2c262b2a | 118 | { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 }, |
f4d6f7dc | 119 | { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 }, |
87522a43 | 120 | { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 }, |
ac71311e | 121 | { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 }, |
6c4ae5c2 | 122 | { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 }, |
2096ae6c | 123 | { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 }, |
eed307e2 | 124 | { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 }, |
3a61eda8 | 125 | { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 }, |
2582d529 | 126 | { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 }, |
d9f51b51 | 127 | |
85d59726 MG |
128 | /* Atheros AR5BBU22 with sflash firmware */ |
129 | { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 }, | |
bc21fde2 | 130 | { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 }, |
85d59726 | 131 | |
d9f51b51 BS |
132 | { } /* Terminating entry */ |
133 | }; | |
134 | ||
9670d80a VK |
135 | #define USB_REQ_DFU_DNLOAD 1 |
136 | #define BULK_SIZE 4096 | |
d9f51b51 | 137 | #define FW_HDR_SIZE 20 |
9670d80a | 138 | |
86e09287 AH |
139 | static int ath3k_load_firmware(struct usb_device *udev, |
140 | const struct firmware *firmware) | |
9670d80a VK |
141 | { |
142 | u8 *send_buf; | |
143 | int err, pipe, len, size, sent = 0; | |
86e09287 | 144 | int count = firmware->size; |
9670d80a | 145 | |
86e09287 | 146 | BT_DBG("udev %p", udev); |
9670d80a | 147 | |
86e09287 | 148 | pipe = usb_sndctrlpipe(udev, 0); |
9670d80a | 149 | |
52a1020e | 150 | send_buf = kmalloc(BULK_SIZE, GFP_KERNEL); |
86e09287 AH |
151 | if (!send_buf) { |
152 | BT_ERR("Can't allocate memory chunk for firmware"); | |
153 | return -ENOMEM; | |
154 | } | |
155 | ||
156 | memcpy(send_buf, firmware->data, 20); | |
157 | if ((err = usb_control_msg(udev, pipe, | |
9670d80a VK |
158 | USB_REQ_DFU_DNLOAD, |
159 | USB_TYPE_VENDOR, 0, 0, | |
86e09287 | 160 | send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) { |
9670d80a | 161 | BT_ERR("Can't change to loading configuration err"); |
86e09287 | 162 | goto error; |
9670d80a VK |
163 | } |
164 | sent += 20; | |
165 | count -= 20; | |
166 | ||
9670d80a VK |
167 | while (count) { |
168 | size = min_t(uint, count, BULK_SIZE); | |
86e09287 AH |
169 | pipe = usb_sndbulkpipe(udev, 0x02); |
170 | memcpy(send_buf, firmware->data + sent, size); | |
9670d80a | 171 | |
86e09287 | 172 | err = usb_bulk_msg(udev, pipe, send_buf, size, |
9670d80a VK |
173 | &len, 3000); |
174 | ||
175 | if (err || (len != size)) { | |
176 | BT_ERR("Error in firmware loading err = %d," | |
177 | "len = %d, size = %d", err, len, size); | |
178 | goto error; | |
179 | } | |
180 | ||
181 | sent += size; | |
182 | count -= size; | |
183 | } | |
184 | ||
9670d80a VK |
185 | error: |
186 | kfree(send_buf); | |
187 | return err; | |
188 | } | |
189 | ||
d9f51b51 BS |
190 | static int ath3k_get_state(struct usb_device *udev, unsigned char *state) |
191 | { | |
192 | int pipe = 0; | |
193 | ||
194 | pipe = usb_rcvctrlpipe(udev, 0); | |
195 | return usb_control_msg(udev, pipe, ATH3K_GETSTATE, | |
196 | USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, | |
197 | state, 0x01, USB_CTRL_SET_TIMEOUT); | |
198 | } | |
199 | ||
200 | static int ath3k_get_version(struct usb_device *udev, | |
201 | struct ath3k_version *version) | |
202 | { | |
203 | int pipe = 0; | |
204 | ||
205 | pipe = usb_rcvctrlpipe(udev, 0); | |
206 | return usb_control_msg(udev, pipe, ATH3K_GETVERSION, | |
207 | USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version, | |
208 | sizeof(struct ath3k_version), | |
209 | USB_CTRL_SET_TIMEOUT); | |
210 | } | |
211 | ||
212 | static int ath3k_load_fwfile(struct usb_device *udev, | |
213 | const struct firmware *firmware) | |
214 | { | |
215 | u8 *send_buf; | |
216 | int err, pipe, len, size, count, sent = 0; | |
217 | int ret; | |
218 | ||
219 | count = firmware->size; | |
220 | ||
52a1020e | 221 | send_buf = kmalloc(BULK_SIZE, GFP_KERNEL); |
d9f51b51 BS |
222 | if (!send_buf) { |
223 | BT_ERR("Can't allocate memory chunk for firmware"); | |
224 | return -ENOMEM; | |
225 | } | |
226 | ||
227 | size = min_t(uint, count, FW_HDR_SIZE); | |
228 | memcpy(send_buf, firmware->data, size); | |
229 | ||
230 | pipe = usb_sndctrlpipe(udev, 0); | |
231 | ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD, | |
232 | USB_TYPE_VENDOR, 0, 0, send_buf, | |
233 | size, USB_CTRL_SET_TIMEOUT); | |
234 | if (ret < 0) { | |
235 | BT_ERR("Can't change to loading configuration err"); | |
236 | kfree(send_buf); | |
237 | return ret; | |
238 | } | |
239 | ||
240 | sent += size; | |
241 | count -= size; | |
242 | ||
243 | while (count) { | |
244 | size = min_t(uint, count, BULK_SIZE); | |
245 | pipe = usb_sndbulkpipe(udev, 0x02); | |
246 | ||
247 | memcpy(send_buf, firmware->data + sent, size); | |
248 | ||
249 | err = usb_bulk_msg(udev, pipe, send_buf, size, | |
250 | &len, 3000); | |
251 | if (err || (len != size)) { | |
252 | BT_ERR("Error in firmware loading err = %d," | |
253 | "len = %d, size = %d", err, len, size); | |
254 | kfree(send_buf); | |
255 | return err; | |
256 | } | |
257 | sent += size; | |
258 | count -= size; | |
259 | } | |
260 | ||
261 | kfree(send_buf); | |
262 | return 0; | |
263 | } | |
264 | ||
265 | static int ath3k_switch_pid(struct usb_device *udev) | |
266 | { | |
267 | int pipe = 0; | |
268 | ||
269 | pipe = usb_sndctrlpipe(udev, 0); | |
270 | return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID, | |
271 | USB_TYPE_VENDOR, 0, 0, | |
272 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
273 | } | |
274 | ||
275 | static int ath3k_set_normal_mode(struct usb_device *udev) | |
276 | { | |
277 | unsigned char fw_state; | |
278 | int pipe = 0, ret; | |
279 | ||
280 | ret = ath3k_get_state(udev, &fw_state); | |
281 | if (ret < 0) { | |
282 | BT_ERR("Can't get state to change to normal mode err"); | |
283 | return ret; | |
284 | } | |
285 | ||
286 | if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) { | |
287 | BT_DBG("firmware was already in normal mode"); | |
288 | return 0; | |
289 | } | |
290 | ||
291 | pipe = usb_sndctrlpipe(udev, 0); | |
292 | return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE, | |
293 | USB_TYPE_VENDOR, 0, 0, | |
294 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
295 | } | |
296 | ||
297 | static int ath3k_load_patch(struct usb_device *udev) | |
298 | { | |
299 | unsigned char fw_state; | |
300 | char filename[ATH3K_NAME_LEN] = {0}; | |
301 | const struct firmware *firmware; | |
302 | struct ath3k_version fw_version, pt_version; | |
303 | int ret; | |
304 | ||
305 | ret = ath3k_get_state(udev, &fw_state); | |
306 | if (ret < 0) { | |
307 | BT_ERR("Can't get state to change to load ram patch err"); | |
308 | return ret; | |
309 | } | |
310 | ||
311 | if (fw_state & ATH3K_PATCH_UPDATE) { | |
312 | BT_DBG("Patch was already downloaded"); | |
313 | return 0; | |
314 | } | |
315 | ||
316 | ret = ath3k_get_version(udev, &fw_version); | |
317 | if (ret < 0) { | |
318 | BT_ERR("Can't get version to change to load ram patch err"); | |
319 | return ret; | |
320 | } | |
321 | ||
322 | snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu", | |
323 | fw_version.rom_version); | |
324 | ||
325 | ret = request_firmware(&firmware, filename, &udev->dev); | |
326 | if (ret < 0) { | |
327 | BT_ERR("Patch file not found %s", filename); | |
328 | return ret; | |
329 | } | |
330 | ||
331 | pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8); | |
332 | pt_version.build_version = *(int *) | |
333 | (firmware->data + firmware->size - 4); | |
334 | ||
335 | if ((pt_version.rom_version != fw_version.rom_version) || | |
336 | (pt_version.build_version <= fw_version.build_version)) { | |
337 | BT_ERR("Patch file version did not match with firmware"); | |
338 | release_firmware(firmware); | |
339 | return -EINVAL; | |
340 | } | |
341 | ||
342 | ret = ath3k_load_fwfile(udev, firmware); | |
343 | release_firmware(firmware); | |
344 | ||
345 | return ret; | |
346 | } | |
347 | ||
348 | static int ath3k_load_syscfg(struct usb_device *udev) | |
349 | { | |
350 | unsigned char fw_state; | |
351 | char filename[ATH3K_NAME_LEN] = {0}; | |
352 | const struct firmware *firmware; | |
353 | struct ath3k_version fw_version; | |
354 | int clk_value, ret; | |
355 | ||
356 | ret = ath3k_get_state(udev, &fw_state); | |
357 | if (ret < 0) { | |
358 | BT_ERR("Can't get state to change to load configration err"); | |
359 | return -EBUSY; | |
360 | } | |
361 | ||
362 | ret = ath3k_get_version(udev, &fw_version); | |
363 | if (ret < 0) { | |
364 | BT_ERR("Can't get version to change to load ram patch err"); | |
365 | return ret; | |
366 | } | |
367 | ||
368 | switch (fw_version.ref_clock) { | |
369 | ||
370 | case ATH3K_XTAL_FREQ_26M: | |
371 | clk_value = 26; | |
372 | break; | |
373 | case ATH3K_XTAL_FREQ_40M: | |
374 | clk_value = 40; | |
375 | break; | |
376 | case ATH3K_XTAL_FREQ_19P2: | |
377 | clk_value = 19; | |
378 | break; | |
379 | default: | |
380 | clk_value = 0; | |
381 | break; | |
382 | } | |
383 | ||
384 | snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s", | |
385 | fw_version.rom_version, clk_value, ".dfu"); | |
386 | ||
387 | ret = request_firmware(&firmware, filename, &udev->dev); | |
388 | if (ret < 0) { | |
389 | BT_ERR("Configuration file not found %s", filename); | |
390 | return ret; | |
391 | } | |
392 | ||
393 | ret = ath3k_load_fwfile(udev, firmware); | |
394 | release_firmware(firmware); | |
395 | ||
396 | return ret; | |
397 | } | |
398 | ||
9670d80a VK |
399 | static int ath3k_probe(struct usb_interface *intf, |
400 | const struct usb_device_id *id) | |
401 | { | |
402 | const struct firmware *firmware; | |
403 | struct usb_device *udev = interface_to_usbdev(intf); | |
84f0e17f | 404 | int ret; |
9670d80a VK |
405 | |
406 | BT_DBG("intf %p id %p", intf, id); | |
407 | ||
408 | if (intf->cur_altsetting->desc.bInterfaceNumber != 0) | |
409 | return -ENODEV; | |
410 | ||
d9f51b51 BS |
411 | /* match device ID in ath3k blacklist table */ |
412 | if (!id->driver_info) { | |
413 | const struct usb_device_id *match; | |
414 | match = usb_match_id(intf, ath3k_blist_tbl); | |
415 | if (match) | |
416 | id = match; | |
417 | } | |
418 | ||
419 | /* load patch and sysconfig files for AR3012 */ | |
420 | if (id->driver_info & BTUSB_ATH3012) { | |
2d25f8b4 SL |
421 | |
422 | /* New firmware with patch and sysconfig files already loaded */ | |
423 | if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001) | |
424 | return -ENODEV; | |
425 | ||
d9f51b51 BS |
426 | ret = ath3k_load_patch(udev); |
427 | if (ret < 0) { | |
428 | BT_ERR("Loading patch file failed"); | |
429 | return ret; | |
430 | } | |
431 | ret = ath3k_load_syscfg(udev); | |
432 | if (ret < 0) { | |
433 | BT_ERR("Loading sysconfig file failed"); | |
434 | return ret; | |
435 | } | |
436 | ret = ath3k_set_normal_mode(udev); | |
437 | if (ret < 0) { | |
438 | BT_ERR("Set normal mode failed"); | |
439 | return ret; | |
440 | } | |
441 | ath3k_switch_pid(udev); | |
442 | return 0; | |
443 | } | |
444 | ||
c3eae82a PF |
445 | ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev); |
446 | if (ret < 0) { | |
447 | if (ret == -ENOENT) | |
448 | BT_ERR("Firmware file \"%s\" not found", | |
449 | ATH3K_FIRMWARE); | |
450 | else | |
451 | BT_ERR("Firmware file \"%s\" request failed (err=%d)", | |
452 | ATH3K_FIRMWARE, ret); | |
453 | return ret; | |
9670d80a VK |
454 | } |
455 | ||
84f0e17f | 456 | ret = ath3k_load_firmware(udev, firmware); |
86e09287 | 457 | release_firmware(firmware); |
9670d80a | 458 | |
84f0e17f | 459 | return ret; |
9670d80a VK |
460 | } |
461 | ||
462 | static void ath3k_disconnect(struct usb_interface *intf) | |
463 | { | |
9670d80a | 464 | BT_DBG("ath3k_disconnect intf %p", intf); |
9670d80a VK |
465 | } |
466 | ||
467 | static struct usb_driver ath3k_driver = { | |
468 | .name = "ath3k", | |
469 | .probe = ath3k_probe, | |
470 | .disconnect = ath3k_disconnect, | |
471 | .id_table = ath3k_table, | |
e1f12eb6 | 472 | .disable_hub_initiated_lpm = 1, |
9670d80a VK |
473 | }; |
474 | ||
93f1508c | 475 | module_usb_driver(ath3k_driver); |
9670d80a VK |
476 | |
477 | MODULE_AUTHOR("Atheros Communications"); | |
478 | MODULE_DESCRIPTION("Atheros AR30xx firmware driver"); | |
479 | MODULE_VERSION(VERSION); | |
480 | MODULE_LICENSE("GPL"); | |
c3eae82a | 481 | MODULE_FIRMWARE(ATH3K_FIRMWARE); |