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