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