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