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