Merge tag 'sched-core-2021-08-30' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / drivers / bluetooth / ath3k.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (c) 2008-2009 Atheros Communications Inc.
4  */
5
6
7 #include <linux/module.h>
8 #include <linux/kernel.h>
9 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/types.h>
12 #include <linux/errno.h>
13 #include <linux/device.h>
14 #include <linux/firmware.h>
15 #include <linux/usb.h>
16 #include <asm/unaligned.h>
17 #include <net/bluetooth/bluetooth.h>
18
19 #define VERSION "1.0"
20 #define ATH3K_FIRMWARE  "ath3k-1.fw"
21
22 #define ATH3K_DNLOAD                            0x01
23 #define ATH3K_GETSTATE                          0x05
24 #define ATH3K_SET_NORMAL_MODE                   0x07
25 #define ATH3K_GETVERSION                        0x09
26 #define USB_REG_SWITCH_VID_PID                  0x0a
27
28 #define ATH3K_MODE_MASK                         0x3F
29 #define ATH3K_NORMAL_MODE                       0x0E
30
31 #define ATH3K_PATCH_UPDATE                      0x80
32 #define ATH3K_SYSCFG_UPDATE                     0x40
33
34 #define ATH3K_XTAL_FREQ_26M                     0x00
35 #define ATH3K_XTAL_FREQ_40M                     0x01
36 #define ATH3K_XTAL_FREQ_19P2                    0x02
37 #define ATH3K_NAME_LEN                          0xFF
38
39 struct ath3k_version {
40         __le32  rom_version;
41         __le32  build_version;
42         __le32  ram_version;
43         __u8    ref_clock;
44         __u8    reserved[7];
45 } __packed;
46
47 static const struct usb_device_id ath3k_table[] = {
48         /* Atheros AR3011 */
49         { USB_DEVICE(0x0CF3, 0x3000) },
50
51         /* Atheros AR3011 with sflash firmware*/
52         { USB_DEVICE(0x0489, 0xE027) },
53         { USB_DEVICE(0x0489, 0xE03D) },
54         { USB_DEVICE(0x04F2, 0xAFF1) },
55         { USB_DEVICE(0x0930, 0x0215) },
56         { USB_DEVICE(0x0CF3, 0x3002) },
57         { USB_DEVICE(0x0CF3, 0xE019) },
58         { USB_DEVICE(0x13d3, 0x3304) },
59
60         /* Atheros AR9285 Malbec with sflash firmware */
61         { USB_DEVICE(0x03F0, 0x311D) },
62
63         /* Atheros AR3012 with sflash firmware*/
64         { USB_DEVICE(0x0489, 0xe04d) },
65         { USB_DEVICE(0x0489, 0xe04e) },
66         { USB_DEVICE(0x0489, 0xe057) },
67         { USB_DEVICE(0x0489, 0xe056) },
68         { USB_DEVICE(0x0489, 0xe05f) },
69         { USB_DEVICE(0x0489, 0xe076) },
70         { USB_DEVICE(0x0489, 0xe078) },
71         { USB_DEVICE(0x0489, 0xe095) },
72         { USB_DEVICE(0x04c5, 0x1330) },
73         { USB_DEVICE(0x04CA, 0x3004) },
74         { USB_DEVICE(0x04CA, 0x3005) },
75         { USB_DEVICE(0x04CA, 0x3006) },
76         { USB_DEVICE(0x04CA, 0x3007) },
77         { USB_DEVICE(0x04CA, 0x3008) },
78         { USB_DEVICE(0x04CA, 0x300b) },
79         { USB_DEVICE(0x04CA, 0x300d) },
80         { USB_DEVICE(0x04CA, 0x300f) },
81         { USB_DEVICE(0x04CA, 0x3010) },
82         { USB_DEVICE(0x04CA, 0x3014) },
83         { USB_DEVICE(0x04CA, 0x3018) },
84         { USB_DEVICE(0x0930, 0x0219) },
85         { USB_DEVICE(0x0930, 0x021c) },
86         { USB_DEVICE(0x0930, 0x0220) },
87         { USB_DEVICE(0x0930, 0x0227) },
88         { USB_DEVICE(0x0b05, 0x17d0) },
89         { USB_DEVICE(0x0CF3, 0x0036) },
90         { USB_DEVICE(0x0CF3, 0x3004) },
91         { USB_DEVICE(0x0CF3, 0x3008) },
92         { USB_DEVICE(0x0CF3, 0x311D) },
93         { USB_DEVICE(0x0CF3, 0x311E) },
94         { USB_DEVICE(0x0CF3, 0x311F) },
95         { USB_DEVICE(0x0cf3, 0x3121) },
96         { USB_DEVICE(0x0CF3, 0x817a) },
97         { USB_DEVICE(0x0CF3, 0x817b) },
98         { USB_DEVICE(0x0cf3, 0xe003) },
99         { USB_DEVICE(0x0CF3, 0xE004) },
100         { USB_DEVICE(0x0CF3, 0xE005) },
101         { USB_DEVICE(0x0CF3, 0xE006) },
102         { USB_DEVICE(0x13d3, 0x3362) },
103         { USB_DEVICE(0x13d3, 0x3375) },
104         { USB_DEVICE(0x13d3, 0x3393) },
105         { USB_DEVICE(0x13d3, 0x3395) },
106         { USB_DEVICE(0x13d3, 0x3402) },
107         { USB_DEVICE(0x13d3, 0x3408) },
108         { USB_DEVICE(0x13d3, 0x3423) },
109         { USB_DEVICE(0x13d3, 0x3432) },
110         { USB_DEVICE(0x13d3, 0x3472) },
111         { USB_DEVICE(0x13d3, 0x3474) },
112         { USB_DEVICE(0x13d3, 0x3487) },
113         { USB_DEVICE(0x13d3, 0x3490) },
114
115         /* Atheros AR5BBU12 with sflash firmware */
116         { USB_DEVICE(0x0489, 0xE02C) },
117
118         /* Atheros AR5BBU22 with sflash firmware */
119         { USB_DEVICE(0x0489, 0xE036) },
120         { USB_DEVICE(0x0489, 0xE03C) },
121
122         { }     /* Terminating entry */
123 };
124
125 MODULE_DEVICE_TABLE(usb, ath3k_table);
126
127 #define BTUSB_ATH3012           0x80
128 /* This table is to load patch and sysconfig files
129  * for AR3012
130  */
131 static const struct usb_device_id ath3k_blist_tbl[] = {
132
133         /* Atheros AR3012 with sflash firmware*/
134         { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
135         { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
136         { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
137         { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
138         { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
139         { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
140         { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
141         { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
142         { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
143         { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
144         { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
145         { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
146         { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
147         { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
148         { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
149         { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
150         { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
151         { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
152         { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
153         { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
154         { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
155         { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
156         { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
157         { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
158         { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
159         { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
160         { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
161         { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
162         { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
163         { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
164         { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
165         { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
166         { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
167         { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
168         { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
169         { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
170         { USB_DEVICE(0x0cf3, 0xe006), .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, 0x3472), .driver_info = BTUSB_ATH3012 },
181         { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
182         { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
183         { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
184
185         /* Atheros AR5BBU22 with sflash firmware */
186         { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
187         { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
188
189         { }     /* Terminating entry */
190 };
191
192 static inline void ath3k_log_failed_loading(int err, int len, int size,
193                                             int count)
194 {
195         BT_ERR("Firmware loading err = %d, len = %d, size = %d, count = %d",
196                err, len, size, count);
197 }
198
199 #define USB_REQ_DFU_DNLOAD      1
200 #define BULK_SIZE               4096
201 #define FW_HDR_SIZE             20
202 #define TIMEGAP_USEC_MIN        50
203 #define TIMEGAP_USEC_MAX        100
204
205 static int ath3k_load_firmware(struct usb_device *udev,
206                                 const struct firmware *firmware)
207 {
208         u8 *send_buf;
209         int len = 0;
210         int err, pipe, size, sent = 0;
211         int count = firmware->size;
212
213         BT_DBG("udev %p", udev);
214
215         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
216         if (!send_buf) {
217                 BT_ERR("Can't allocate memory chunk for firmware");
218                 return -ENOMEM;
219         }
220
221         err = usb_control_msg_send(udev, 0, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
222                                    0, 0, firmware->data, FW_HDR_SIZE,
223                                    USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
224         if (err) {
225                 BT_ERR("Can't change to loading configuration err");
226                 goto error;
227         }
228         sent += FW_HDR_SIZE;
229         count -= FW_HDR_SIZE;
230
231         pipe = usb_sndbulkpipe(udev, 0x02);
232
233         while (count) {
234                 /* workaround the compatibility issue with xHCI controller*/
235                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
236
237                 size = min_t(uint, count, BULK_SIZE);
238                 memcpy(send_buf, firmware->data + sent, size);
239
240                 err = usb_bulk_msg(udev, pipe, send_buf, size,
241                                         &len, 3000);
242
243                 if (err || (len != size)) {
244                         ath3k_log_failed_loading(err, len, size, count);
245                         goto error;
246                 }
247
248                 sent  += size;
249                 count -= size;
250         }
251
252 error:
253         kfree(send_buf);
254         return err;
255 }
256
257 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
258 {
259         return usb_control_msg_recv(udev, 0, ATH3K_GETSTATE,
260                                     USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
261                                     state, 1, USB_CTRL_SET_TIMEOUT,
262                                     GFP_KERNEL);
263 }
264
265 static int ath3k_get_version(struct usb_device *udev,
266                         struct ath3k_version *version)
267 {
268         return usb_control_msg_recv(udev, 0, ATH3K_GETVERSION,
269                                     USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
270                                     version, sizeof(*version), USB_CTRL_SET_TIMEOUT,
271                                     GFP_KERNEL);
272 }
273
274 static int ath3k_load_fwfile(struct usb_device *udev,
275                 const struct firmware *firmware)
276 {
277         u8 *send_buf;
278         int len = 0;
279         int err, pipe, size, count, sent = 0;
280         int ret;
281
282         count = firmware->size;
283
284         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
285         if (!send_buf) {
286                 BT_ERR("Can't allocate memory chunk for firmware");
287                 return -ENOMEM;
288         }
289
290         size = min_t(uint, count, FW_HDR_SIZE);
291
292         ret = usb_control_msg_send(udev, 0, ATH3K_DNLOAD, USB_TYPE_VENDOR, 0, 0,
293                                    firmware->data, size, USB_CTRL_SET_TIMEOUT,
294                                    GFP_KERNEL);
295         if (ret) {
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         pipe = usb_sndbulkpipe(udev, 0x02);
305
306         while (count) {
307                 /* workaround the compatibility issue with xHCI controller*/
308                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
309
310                 size = min_t(uint, count, BULK_SIZE);
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                         ath3k_log_failed_loading(err, len, size, count);
317                         kfree(send_buf);
318                         return err;
319                 }
320                 sent  += size;
321                 count -= size;
322         }
323
324         kfree(send_buf);
325         return 0;
326 }
327
328 static void ath3k_switch_pid(struct usb_device *udev)
329 {
330         usb_control_msg_send(udev, 0, USB_REG_SWITCH_VID_PID, USB_TYPE_VENDOR,
331                              0, 0, NULL, 0, USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
332 }
333
334 static int ath3k_set_normal_mode(struct usb_device *udev)
335 {
336         unsigned char fw_state;
337         int ret;
338
339         ret = ath3k_get_state(udev, &fw_state);
340         if (ret) {
341                 BT_ERR("Can't get state to change to normal mode err");
342                 return ret;
343         }
344
345         if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
346                 BT_DBG("firmware was already in normal mode");
347                 return 0;
348         }
349
350         return usb_control_msg_send(udev, 0, ATH3K_SET_NORMAL_MODE,
351                                     USB_TYPE_VENDOR, 0, 0, NULL, 0,
352                                     USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
353 }
354
355 static int ath3k_load_patch(struct usb_device *udev)
356 {
357         unsigned char fw_state;
358         char filename[ATH3K_NAME_LEN];
359         const struct firmware *firmware;
360         struct ath3k_version fw_version;
361         __u32 pt_rom_version, pt_build_version;
362         int ret;
363
364         ret = ath3k_get_state(udev, &fw_state);
365         if (ret) {
366                 BT_ERR("Can't get state to change to load ram patch err");
367                 return ret;
368         }
369
370         if (fw_state & ATH3K_PATCH_UPDATE) {
371                 BT_DBG("Patch was already downloaded");
372                 return 0;
373         }
374
375         ret = ath3k_get_version(udev, &fw_version);
376         if (ret) {
377                 BT_ERR("Can't get version to change to load ram patch err");
378                 return ret;
379         }
380
381         snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
382                  le32_to_cpu(fw_version.rom_version));
383
384         ret = request_firmware(&firmware, filename, &udev->dev);
385         if (ret < 0) {
386                 BT_ERR("Patch file not found %s", filename);
387                 return ret;
388         }
389
390         pt_rom_version = get_unaligned_le32(firmware->data +
391                                             firmware->size - 8);
392         pt_build_version = get_unaligned_le32(firmware->data +
393                                               firmware->size - 4);
394
395         if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
396             pt_build_version <= le32_to_cpu(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];
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) {
418                 BT_ERR("Can't get state to change to load configuration err");
419                 return -EBUSY;
420         }
421
422         ret = ath3k_get_version(udev, &fw_version);
423         if (ret) {
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                 le32_to_cpu(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
475                 match = usb_match_id(intf, ath3k_blist_tbl);
476                 if (match)
477                         id = match;
478         }
479
480         /* load patch and sysconfig files for AR3012 */
481         if (id->driver_info & BTUSB_ATH3012) {
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) {
498                         BT_ERR("Set normal mode failed");
499                         return ret;
500                 }
501                 ath3k_switch_pid(udev);
502                 return 0;
503         }
504
505         ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
506         if (ret < 0) {
507                 if (ret == -ENOENT)
508                         BT_ERR("Firmware file \"%s\" not found",
509                                                         ATH3K_FIRMWARE);
510                 else
511                         BT_ERR("Firmware file \"%s\" request failed (err=%d)",
512                                                         ATH3K_FIRMWARE, ret);
513                 return ret;
514         }
515
516         ret = ath3k_load_firmware(udev, firmware);
517         release_firmware(firmware);
518
519         return ret;
520 }
521
522 static void ath3k_disconnect(struct usb_interface *intf)
523 {
524         BT_DBG("%s intf %p", __func__, intf);
525 }
526
527 static struct usb_driver ath3k_driver = {
528         .name           = "ath3k",
529         .probe          = ath3k_probe,
530         .disconnect     = ath3k_disconnect,
531         .id_table       = ath3k_table,
532         .disable_hub_initiated_lpm = 1,
533 };
534
535 module_usb_driver(ath3k_driver);
536
537 MODULE_AUTHOR("Atheros Communications");
538 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
539 MODULE_VERSION(VERSION);
540 MODULE_LICENSE("GPL");
541 MODULE_FIRMWARE(ATH3K_FIRMWARE);