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