5554a5b713a9f649ed44b0d999094ef8f0fded70
[pandora-kernel.git] / drivers / bluetooth / ath3k.c
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"
33
34 #define ATH3K_DNLOAD                            0x01
35 #define ATH3K_GETSTATE                          0x05
36 #define ATH3K_SET_NORMAL_MODE                   0x07
37 #define ATH3K_GETVERSION                        0x09
38 #define USB_REG_SWITCH_VID_PID                  0x0a
39
40 #define ATH3K_MODE_MASK                         0x3F
41 #define ATH3K_NORMAL_MODE                       0x0E
42
43 #define ATH3K_PATCH_UPDATE                      0x80
44 #define ATH3K_SYSCFG_UPDATE                     0x40
45
46 #define ATH3K_XTAL_FREQ_26M                     0x00
47 #define ATH3K_XTAL_FREQ_40M                     0x01
48 #define ATH3K_XTAL_FREQ_19P2                    0x02
49 #define ATH3K_NAME_LEN                          0xFF
50
51 struct ath3k_version {
52         unsigned int    rom_version;
53         unsigned int    build_version;
54         unsigned int    ram_version;
55         unsigned char   ref_clock;
56         unsigned char   reserved[0x07];
57 };
58
59 static struct usb_device_id ath3k_table[] = {
60         /* Atheros AR3011 */
61         { USB_DEVICE(0x0CF3, 0x3000) },
62
63         /* Atheros AR3011 with sflash firmware*/
64         { USB_DEVICE(0x0489, 0xE027) },
65         { USB_DEVICE(0x0489, 0xE03D) },
66         { USB_DEVICE(0x04F2, 0xAFF1) },
67         { USB_DEVICE(0x0930, 0x0215) },
68         { USB_DEVICE(0x0CF3, 0x3002) },
69         { USB_DEVICE(0x0CF3, 0xE019) },
70         { USB_DEVICE(0x13d3, 0x3304) },
71
72         /* Atheros AR9285 Malbec with sflash firmware */
73         { USB_DEVICE(0x03F0, 0x311D) },
74
75         /* Atheros AR3012 with sflash firmware*/
76         { USB_DEVICE(0x0489, 0xe04d) },
77         { USB_DEVICE(0x0489, 0xe04e) },
78         { USB_DEVICE(0x0489, 0xe057) },
79         { USB_DEVICE(0x0489, 0xe056) },
80         { USB_DEVICE(0x0489, 0xe05f) },
81         { USB_DEVICE(0x0489, 0xe076) },
82         { USB_DEVICE(0x0489, 0xe078) },
83         { USB_DEVICE(0x0489, 0xe095) },
84         { USB_DEVICE(0x04c5, 0x1330) },
85         { USB_DEVICE(0x04CA, 0x3004) },
86         { USB_DEVICE(0x04CA, 0x3005) },
87         { USB_DEVICE(0x04CA, 0x3006) },
88         { USB_DEVICE(0x04CA, 0x3007) },
89         { USB_DEVICE(0x04CA, 0x3008) },
90         { USB_DEVICE(0x04CA, 0x300b) },
91         { USB_DEVICE(0x04CA, 0x300f) },
92         { USB_DEVICE(0x04CA, 0x3010) },
93         { USB_DEVICE(0x04CA, 0x3014) },
94         { USB_DEVICE(0x0930, 0x0219) },
95         { USB_DEVICE(0x0930, 0x021c) },
96         { USB_DEVICE(0x0930, 0x0220) },
97         { USB_DEVICE(0x0930, 0x0227) },
98         { USB_DEVICE(0x0b05, 0x17d0) },
99         { USB_DEVICE(0x0CF3, 0x0036) },
100         { USB_DEVICE(0x0CF3, 0x3004) },
101         { USB_DEVICE(0x0CF3, 0x3008) },
102         { USB_DEVICE(0x0CF3, 0x311D) },
103         { USB_DEVICE(0x0CF3, 0x311E) },
104         { USB_DEVICE(0x0CF3, 0x311F) },
105         { USB_DEVICE(0x0cf3, 0x3121) },
106         { USB_DEVICE(0x0CF3, 0x817a) },
107         { USB_DEVICE(0x0CF3, 0x817b) },
108         { USB_DEVICE(0x0cf3, 0xe003) },
109         { USB_DEVICE(0x0CF3, 0xE004) },
110         { USB_DEVICE(0x0CF3, 0xE005) },
111         { USB_DEVICE(0x13d3, 0x3362) },
112         { USB_DEVICE(0x13d3, 0x3375) },
113         { USB_DEVICE(0x13d3, 0x3393) },
114         { USB_DEVICE(0x13d3, 0x3395) },
115         { USB_DEVICE(0x13d3, 0x3402) },
116         { USB_DEVICE(0x13d3, 0x3408) },
117         { USB_DEVICE(0x13d3, 0x3423) },
118         { USB_DEVICE(0x13d3, 0x3432) },
119         { USB_DEVICE(0x13d3, 0x3472) },
120         { USB_DEVICE(0x13d3, 0x3474) },
121         { USB_DEVICE(0x13d3, 0x3487) },
122         { USB_DEVICE(0x13d3, 0x3490) },
123
124         /* Atheros AR5BBU12 with sflash firmware */
125         { USB_DEVICE(0x0489, 0xE02C) },
126
127         /* Atheros AR5BBU22 with sflash firmware */
128         { USB_DEVICE(0x0489, 0xE036) },
129         { USB_DEVICE(0x0489, 0xE03C) },
130
131         { }     /* Terminating entry */
132 };
133
134 MODULE_DEVICE_TABLE(usb, ath3k_table);
135
136 #define BTUSB_ATH3012           0x80
137 /* This table is to load patch and sysconfig files
138  * for AR3012 */
139 static struct usb_device_id ath3k_blist_tbl[] = {
140
141         /* Atheros AR3012 with sflash firmware*/
142         { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
143         { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
144         { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
145         { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
146         { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
147         { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
148         { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
149         { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
150         { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
151         { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
152         { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
153         { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
154         { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
155         { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
156         { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
157         { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
158         { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
159         { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
160         { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
161         { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
162         { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
163         { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
164         { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
165         { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
166         { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
167         { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
168         { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
169         { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
170         { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
171         { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
172         { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
173         { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
174         { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
175         { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
176         { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
177         { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
178         { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
179         { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
180         { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
181         { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
182         { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
183         { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
184         { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
185         { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
186         { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
187         { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
188         { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
189
190         /* Atheros AR5BBU22 with sflash firmware */
191         { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
192         { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
193
194         { }     /* Terminating entry */
195 };
196
197 #define USB_REQ_DFU_DNLOAD      1
198 #define BULK_SIZE               4096
199 #define FW_HDR_SIZE             20
200 #define TIMEGAP_USEC_MIN        50
201 #define TIMEGAP_USEC_MAX        100
202
203 static int ath3k_load_firmware(struct usb_device *udev,
204                                 const struct firmware *firmware)
205 {
206         u8 *send_buf;
207         int err, pipe, len, size, sent = 0;
208         int count = firmware->size;
209
210         BT_DBG("udev %p", udev);
211
212         pipe = usb_sndctrlpipe(udev, 0);
213
214         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
215         if (!send_buf) {
216                 BT_ERR("Can't allocate memory chunk for firmware");
217                 return -ENOMEM;
218         }
219
220         memcpy(send_buf, firmware->data, 20);
221         if ((err = usb_control_msg(udev, pipe,
222                                 USB_REQ_DFU_DNLOAD,
223                                 USB_TYPE_VENDOR, 0, 0,
224                                 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
225                 BT_ERR("Can't change to loading configuration err");
226                 goto error;
227         }
228         sent += 20;
229         count -= 20;
230
231         while (count) {
232                 /* workaround the compatibility issue with xHCI controller*/
233                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
234
235                 size = min_t(uint, count, BULK_SIZE);
236                 pipe = usb_sndbulkpipe(udev, 0x02);
237                 memcpy(send_buf, firmware->data + sent, size);
238
239                 err = usb_bulk_msg(udev, pipe, send_buf, size,
240                                         &len, 3000);
241
242                 if (err || (len != size)) {
243                         BT_ERR("Error in firmware loading err = %d,"
244                                 "len = %d, size = %d", err, len, size);
245                         goto error;
246                 }
247
248                 sent  += size;
249                 count -= size;
250         }
251
252 error:
253         kfree(send_buf);
254         return err;
255 }
256
257 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
258 {
259         int pipe = 0;
260
261         pipe = usb_rcvctrlpipe(udev, 0);
262         return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
263                         USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
264                         state, 0x01, USB_CTRL_SET_TIMEOUT);
265 }
266
267 static int ath3k_get_version(struct usb_device *udev,
268                         struct ath3k_version *version)
269 {
270         int pipe = 0;
271
272         pipe = usb_rcvctrlpipe(udev, 0);
273         return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
274                         USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
275                         sizeof(struct ath3k_version),
276                         USB_CTRL_SET_TIMEOUT);
277 }
278
279 static int ath3k_load_fwfile(struct usb_device *udev,
280                 const struct firmware *firmware)
281 {
282         u8 *send_buf;
283         int err, pipe, len, size, count, sent = 0;
284         int ret;
285
286         count = firmware->size;
287
288         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
289         if (!send_buf) {
290                 BT_ERR("Can't allocate memory chunk for firmware");
291                 return -ENOMEM;
292         }
293
294         size = min_t(uint, count, FW_HDR_SIZE);
295         memcpy(send_buf, firmware->data, size);
296
297         pipe = usb_sndctrlpipe(udev, 0);
298         ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
299                         USB_TYPE_VENDOR, 0, 0, send_buf,
300                         size, USB_CTRL_SET_TIMEOUT);
301         if (ret < 0) {
302                 BT_ERR("Can't change to loading configuration err");
303                 kfree(send_buf);
304                 return ret;
305         }
306
307         sent += size;
308         count -= size;
309
310         while (count) {
311                 /* workaround the compatibility issue with xHCI controller*/
312                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
313
314                 size = min_t(uint, count, BULK_SIZE);
315                 pipe = usb_sndbulkpipe(udev, 0x02);
316
317                 memcpy(send_buf, firmware->data + sent, size);
318
319                 err = usb_bulk_msg(udev, pipe, send_buf, size,
320                                         &len, 3000);
321                 if (err || (len != size)) {
322                         BT_ERR("Error in firmware loading err = %d,"
323                                 "len = %d, size = %d", err, len, size);
324                         kfree(send_buf);
325                         return err;
326                 }
327                 sent  += size;
328                 count -= size;
329         }
330
331         kfree(send_buf);
332         return 0;
333 }
334
335 static int ath3k_switch_pid(struct usb_device *udev)
336 {
337         int pipe = 0;
338
339         pipe = usb_sndctrlpipe(udev, 0);
340         return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
341                         USB_TYPE_VENDOR, 0, 0,
342                         NULL, 0, USB_CTRL_SET_TIMEOUT);
343 }
344
345 static int ath3k_set_normal_mode(struct usb_device *udev)
346 {
347         unsigned char fw_state;
348         int pipe = 0, ret;
349
350         ret = ath3k_get_state(udev, &fw_state);
351         if (ret < 0) {
352                 BT_ERR("Can't get state to change to normal mode err");
353                 return ret;
354         }
355
356         if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
357                 BT_DBG("firmware was already in normal mode");
358                 return 0;
359         }
360
361         pipe = usb_sndctrlpipe(udev, 0);
362         return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
363                         USB_TYPE_VENDOR, 0, 0,
364                         NULL, 0, USB_CTRL_SET_TIMEOUT);
365 }
366
367 static int ath3k_load_patch(struct usb_device *udev)
368 {
369         unsigned char fw_state;
370         char filename[ATH3K_NAME_LEN] = {0};
371         const struct firmware *firmware;
372         struct ath3k_version fw_version, pt_version;
373         int ret;
374
375         ret = ath3k_get_state(udev, &fw_state);
376         if (ret < 0) {
377                 BT_ERR("Can't get state to change to load ram patch err");
378                 return ret;
379         }
380
381         if (fw_state & ATH3K_PATCH_UPDATE) {
382                 BT_DBG("Patch was already downloaded");
383                 return 0;
384         }
385
386         ret = ath3k_get_version(udev, &fw_version);
387         if (ret < 0) {
388                 BT_ERR("Can't get version to change to load ram patch err");
389                 return ret;
390         }
391
392         snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
393                 fw_version.rom_version);
394
395         ret = request_firmware(&firmware, filename, &udev->dev);
396         if (ret < 0) {
397                 BT_ERR("Patch file not found %s", filename);
398                 return ret;
399         }
400
401         pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
402         pt_version.build_version = *(int *)
403                 (firmware->data + firmware->size - 4);
404
405         if ((pt_version.rom_version != fw_version.rom_version) ||
406                 (pt_version.build_version <= fw_version.build_version)) {
407                 BT_ERR("Patch file version did not match with firmware");
408                 release_firmware(firmware);
409                 return -EINVAL;
410         }
411
412         ret = ath3k_load_fwfile(udev, firmware);
413         release_firmware(firmware);
414
415         return ret;
416 }
417
418 static int ath3k_load_syscfg(struct usb_device *udev)
419 {
420         unsigned char fw_state;
421         char filename[ATH3K_NAME_LEN] = {0};
422         const struct firmware *firmware;
423         struct ath3k_version fw_version;
424         int clk_value, ret;
425
426         ret = ath3k_get_state(udev, &fw_state);
427         if (ret < 0) {
428                 BT_ERR("Can't get state to change to load configration err");
429                 return -EBUSY;
430         }
431
432         ret = ath3k_get_version(udev, &fw_version);
433         if (ret < 0) {
434                 BT_ERR("Can't get version to change to load ram patch err");
435                 return ret;
436         }
437
438         switch (fw_version.ref_clock) {
439
440         case ATH3K_XTAL_FREQ_26M:
441                 clk_value = 26;
442                 break;
443         case ATH3K_XTAL_FREQ_40M:
444                 clk_value = 40;
445                 break;
446         case ATH3K_XTAL_FREQ_19P2:
447                 clk_value = 19;
448                 break;
449         default:
450                 clk_value = 0;
451                 break;
452         }
453
454         snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
455                 fw_version.rom_version, clk_value, ".dfu");
456
457         ret = request_firmware(&firmware, filename, &udev->dev);
458         if (ret < 0) {
459                 BT_ERR("Configuration file not found %s", filename);
460                 return ret;
461         }
462
463         ret = ath3k_load_fwfile(udev, firmware);
464         release_firmware(firmware);
465
466         return ret;
467 }
468
469 static int ath3k_probe(struct usb_interface *intf,
470                         const struct usb_device_id *id)
471 {
472         const struct firmware *firmware;
473         struct usb_device *udev = interface_to_usbdev(intf);
474         int ret;
475
476         BT_DBG("intf %p id %p", intf, id);
477
478         if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
479                 return -ENODEV;
480
481         /* match device ID in ath3k blacklist table */
482         if (!id->driver_info) {
483                 const struct usb_device_id *match;
484                 match = usb_match_id(intf, ath3k_blist_tbl);
485                 if (match)
486                         id = match;
487         }
488
489         /* load patch and sysconfig files for AR3012 */
490         if (id->driver_info & BTUSB_ATH3012) {
491
492                 /* New firmware with patch and sysconfig files already loaded */
493                 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
494                         return -ENODEV;
495
496                 ret = ath3k_load_patch(udev);
497                 if (ret < 0) {
498                         BT_ERR("Loading patch file failed");
499                         return ret;
500                 }
501                 ret = ath3k_load_syscfg(udev);
502                 if (ret < 0) {
503                         BT_ERR("Loading sysconfig file failed");
504                         return ret;
505                 }
506                 ret = ath3k_set_normal_mode(udev);
507                 if (ret < 0) {
508                         BT_ERR("Set normal mode failed");
509                         return ret;
510                 }
511                 ath3k_switch_pid(udev);
512                 return 0;
513         }
514
515         if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
516                 BT_ERR("Error loading firmware");
517                 return -EIO;
518         }
519
520         ret = ath3k_load_firmware(udev, firmware);
521         release_firmware(firmware);
522
523         return ret;
524 }
525
526 static void ath3k_disconnect(struct usb_interface *intf)
527 {
528         BT_DBG("ath3k_disconnect intf %p", intf);
529 }
530
531 static struct usb_driver ath3k_driver = {
532         .name           = "ath3k",
533         .probe          = ath3k_probe,
534         .disconnect     = ath3k_disconnect,
535         .id_table       = ath3k_table,
536 };
537
538 static int __init ath3k_init(void)
539 {
540         BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
541         return usb_register(&ath3k_driver);
542 }
543
544 static void __exit ath3k_exit(void)
545 {
546         usb_deregister(&ath3k_driver);
547 }
548
549 module_init(ath3k_init);
550 module_exit(ath3k_exit);
551
552 MODULE_AUTHOR("Atheros Communications");
553 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
554 MODULE_VERSION(VERSION);
555 MODULE_LICENSE("GPL");
556 MODULE_FIRMWARE("ath3k-1.fw");