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