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