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