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