Linux 5.1.15
[linux/fpc-iii.git] / drivers / bluetooth / ath3k.c
blob1ad4991753bb6c8f213f6cb77cfe9f7f56e03a4c
1 /*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
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.
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.
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
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>
33 #define VERSION "1.0"
34 #define ATH3K_FIRMWARE "ath3k-1.fw"
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
42 #define ATH3K_MODE_MASK 0x3F
43 #define ATH3K_NORMAL_MODE 0x0E
45 #define ATH3K_PATCH_UPDATE 0x80
46 #define ATH3K_SYSCFG_UPDATE 0x40
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
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;
61 static const struct usb_device_id ath3k_table[] = {
62 /* Atheros AR3011 */
63 { USB_DEVICE(0x0CF3, 0x3000) },
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) },
74 /* Atheros AR9285 Malbec with sflash firmware */
75 { USB_DEVICE(0x03F0, 0x311D) },
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(0x0489, 0xe095) },
86 { USB_DEVICE(0x04c5, 0x1330) },
87 { USB_DEVICE(0x04CA, 0x3004) },
88 { USB_DEVICE(0x04CA, 0x3005) },
89 { USB_DEVICE(0x04CA, 0x3006) },
90 { USB_DEVICE(0x04CA, 0x3007) },
91 { USB_DEVICE(0x04CA, 0x3008) },
92 { USB_DEVICE(0x04CA, 0x300b) },
93 { USB_DEVICE(0x04CA, 0x300d) },
94 { USB_DEVICE(0x04CA, 0x300f) },
95 { USB_DEVICE(0x04CA, 0x3010) },
96 { USB_DEVICE(0x04CA, 0x3014) },
97 { USB_DEVICE(0x04CA, 0x3018) },
98 { USB_DEVICE(0x0930, 0x0219) },
99 { USB_DEVICE(0x0930, 0x021c) },
100 { USB_DEVICE(0x0930, 0x0220) },
101 { USB_DEVICE(0x0930, 0x0227) },
102 { USB_DEVICE(0x0b05, 0x17d0) },
103 { USB_DEVICE(0x0CF3, 0x0036) },
104 { USB_DEVICE(0x0CF3, 0x3004) },
105 { USB_DEVICE(0x0CF3, 0x3008) },
106 { USB_DEVICE(0x0CF3, 0x311D) },
107 { USB_DEVICE(0x0CF3, 0x311E) },
108 { USB_DEVICE(0x0CF3, 0x311F) },
109 { USB_DEVICE(0x0cf3, 0x3121) },
110 { USB_DEVICE(0x0CF3, 0x817a) },
111 { USB_DEVICE(0x0CF3, 0x817b) },
112 { USB_DEVICE(0x0cf3, 0xe003) },
113 { USB_DEVICE(0x0CF3, 0xE004) },
114 { USB_DEVICE(0x0CF3, 0xE005) },
115 { USB_DEVICE(0x0CF3, 0xE006) },
116 { USB_DEVICE(0x13d3, 0x3362) },
117 { USB_DEVICE(0x13d3, 0x3375) },
118 { USB_DEVICE(0x13d3, 0x3393) },
119 { USB_DEVICE(0x13d3, 0x3395) },
120 { USB_DEVICE(0x13d3, 0x3402) },
121 { USB_DEVICE(0x13d3, 0x3408) },
122 { USB_DEVICE(0x13d3, 0x3423) },
123 { USB_DEVICE(0x13d3, 0x3432) },
124 { USB_DEVICE(0x13d3, 0x3472) },
125 { USB_DEVICE(0x13d3, 0x3474) },
126 { USB_DEVICE(0x13d3, 0x3487) },
127 { USB_DEVICE(0x13d3, 0x3490) },
129 /* Atheros AR5BBU12 with sflash firmware */
130 { USB_DEVICE(0x0489, 0xE02C) },
132 /* Atheros AR5BBU22 with sflash firmware */
133 { USB_DEVICE(0x0489, 0xE036) },
134 { USB_DEVICE(0x0489, 0xE03C) },
136 { } /* Terminating entry */
139 MODULE_DEVICE_TABLE(usb, ath3k_table);
141 #define BTUSB_ATH3012 0x80
142 /* This table is to load patch and sysconfig files
143 * for AR3012
145 static const struct usb_device_id ath3k_blist_tbl[] = {
147 /* Atheros AR3012 with sflash firmware*/
148 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
149 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
150 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
151 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
152 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
153 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 },
154 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
155 { USB_DEVICE(0x0489, 0xe095), .driver_info = BTUSB_ATH3012 },
156 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
157 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
158 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
159 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
160 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
161 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
162 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
163 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 },
164 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 },
165 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
166 { USB_DEVICE(0x04ca, 0x3014), .driver_info = BTUSB_ATH3012 },
167 { USB_DEVICE(0x04ca, 0x3018), .driver_info = BTUSB_ATH3012 },
168 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
169 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 },
170 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
171 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
172 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
173 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
174 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
175 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
176 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
177 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
178 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
179 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
180 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
181 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 },
182 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
183 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
184 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 },
185 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
186 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
187 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
188 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
189 { USB_DEVICE(0x13d3, 0x3395), .driver_info = BTUSB_ATH3012 },
190 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
191 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
192 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
193 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
194 { USB_DEVICE(0x13d3, 0x3472), .driver_info = BTUSB_ATH3012 },
195 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 },
196 { USB_DEVICE(0x13d3, 0x3487), .driver_info = BTUSB_ATH3012 },
197 { USB_DEVICE(0x13d3, 0x3490), .driver_info = BTUSB_ATH3012 },
199 /* Atheros AR5BBU22 with sflash firmware */
200 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
201 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
203 { } /* Terminating entry */
206 static inline void ath3k_log_failed_loading(int err, int len, int size,
207 int count)
209 BT_ERR("Firmware loading err = %d, len = %d, size = %d, count = %d",
210 err, len, size, count);
213 #define USB_REQ_DFU_DNLOAD 1
214 #define BULK_SIZE 4096
215 #define FW_HDR_SIZE 20
216 #define TIMEGAP_USEC_MIN 50
217 #define TIMEGAP_USEC_MAX 100
219 static int ath3k_load_firmware(struct usb_device *udev,
220 const struct firmware *firmware)
222 u8 *send_buf;
223 int len = 0;
224 int err, pipe, size, sent = 0;
225 int count = firmware->size;
227 BT_DBG("udev %p", udev);
229 pipe = usb_sndctrlpipe(udev, 0);
231 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
232 if (!send_buf) {
233 BT_ERR("Can't allocate memory chunk for firmware");
234 return -ENOMEM;
237 memcpy(send_buf, firmware->data, FW_HDR_SIZE);
238 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
239 0, 0, send_buf, FW_HDR_SIZE,
240 USB_CTRL_SET_TIMEOUT);
241 if (err < 0) {
242 BT_ERR("Can't change to loading configuration err");
243 goto error;
245 sent += FW_HDR_SIZE;
246 count -= FW_HDR_SIZE;
248 pipe = usb_sndbulkpipe(udev, 0x02);
250 while (count) {
251 /* workaround the compatibility issue with xHCI controller*/
252 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
254 size = min_t(uint, count, BULK_SIZE);
255 memcpy(send_buf, firmware->data + sent, size);
257 err = usb_bulk_msg(udev, pipe, send_buf, size,
258 &len, 3000);
260 if (err || (len != size)) {
261 ath3k_log_failed_loading(err, len, size, count);
262 goto error;
265 sent += size;
266 count -= size;
269 error:
270 kfree(send_buf);
271 return err;
274 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
276 int ret, pipe = 0;
277 char *buf;
279 buf = kmalloc(sizeof(*buf), GFP_KERNEL);
280 if (!buf)
281 return -ENOMEM;
283 pipe = usb_rcvctrlpipe(udev, 0);
284 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
285 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
286 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
288 *state = *buf;
289 kfree(buf);
291 return ret;
294 static int ath3k_get_version(struct usb_device *udev,
295 struct ath3k_version *version)
297 int ret, pipe = 0;
298 struct ath3k_version *buf;
299 const int size = sizeof(*buf);
301 buf = kmalloc(size, GFP_KERNEL);
302 if (!buf)
303 return -ENOMEM;
305 pipe = usb_rcvctrlpipe(udev, 0);
306 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
307 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
308 buf, size, USB_CTRL_SET_TIMEOUT);
310 memcpy(version, buf, size);
311 kfree(buf);
313 return ret;
316 static int ath3k_load_fwfile(struct usb_device *udev,
317 const struct firmware *firmware)
319 u8 *send_buf;
320 int len = 0;
321 int err, pipe, size, count, sent = 0;
322 int ret;
324 count = firmware->size;
326 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
327 if (!send_buf) {
328 BT_ERR("Can't allocate memory chunk for firmware");
329 return -ENOMEM;
332 size = min_t(uint, count, FW_HDR_SIZE);
333 memcpy(send_buf, firmware->data, size);
335 pipe = usb_sndctrlpipe(udev, 0);
336 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
337 USB_TYPE_VENDOR, 0, 0, send_buf,
338 size, USB_CTRL_SET_TIMEOUT);
339 if (ret < 0) {
340 BT_ERR("Can't change to loading configuration err");
341 kfree(send_buf);
342 return ret;
345 sent += size;
346 count -= size;
348 pipe = usb_sndbulkpipe(udev, 0x02);
350 while (count) {
351 /* workaround the compatibility issue with xHCI controller*/
352 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
354 size = min_t(uint, count, BULK_SIZE);
355 memcpy(send_buf, firmware->data + sent, size);
357 err = usb_bulk_msg(udev, pipe, send_buf, size,
358 &len, 3000);
359 if (err || (len != size)) {
360 ath3k_log_failed_loading(err, len, size, count);
361 kfree(send_buf);
362 return err;
364 sent += size;
365 count -= size;
368 kfree(send_buf);
369 return 0;
372 static int ath3k_switch_pid(struct usb_device *udev)
374 int pipe = 0;
376 pipe = usb_sndctrlpipe(udev, 0);
377 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
378 USB_TYPE_VENDOR, 0, 0,
379 NULL, 0, USB_CTRL_SET_TIMEOUT);
382 static int ath3k_set_normal_mode(struct usb_device *udev)
384 unsigned char fw_state;
385 int pipe = 0, ret;
387 ret = ath3k_get_state(udev, &fw_state);
388 if (ret < 0) {
389 BT_ERR("Can't get state to change to normal mode err");
390 return ret;
393 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
394 BT_DBG("firmware was already in normal mode");
395 return 0;
398 pipe = usb_sndctrlpipe(udev, 0);
399 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
400 USB_TYPE_VENDOR, 0, 0,
401 NULL, 0, USB_CTRL_SET_TIMEOUT);
404 static int ath3k_load_patch(struct usb_device *udev)
406 unsigned char fw_state;
407 char filename[ATH3K_NAME_LEN];
408 const struct firmware *firmware;
409 struct ath3k_version fw_version;
410 __u32 pt_rom_version, pt_build_version;
411 int ret;
413 ret = ath3k_get_state(udev, &fw_state);
414 if (ret < 0) {
415 BT_ERR("Can't get state to change to load ram patch err");
416 return ret;
419 if (fw_state & ATH3K_PATCH_UPDATE) {
420 BT_DBG("Patch was already downloaded");
421 return 0;
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;
430 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
431 le32_to_cpu(fw_version.rom_version));
433 ret = request_firmware(&firmware, filename, &udev->dev);
434 if (ret < 0) {
435 BT_ERR("Patch file not found %s", filename);
436 return ret;
439 pt_rom_version = get_unaligned_le32(firmware->data +
440 firmware->size - 8);
441 pt_build_version = get_unaligned_le32(firmware->data +
442 firmware->size - 4);
444 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
445 pt_build_version <= le32_to_cpu(fw_version.build_version)) {
446 BT_ERR("Patch file version did not match with firmware");
447 release_firmware(firmware);
448 return -EINVAL;
451 ret = ath3k_load_fwfile(udev, firmware);
452 release_firmware(firmware);
454 return ret;
457 static int ath3k_load_syscfg(struct usb_device *udev)
459 unsigned char fw_state;
460 char filename[ATH3K_NAME_LEN];
461 const struct firmware *firmware;
462 struct ath3k_version fw_version;
463 int clk_value, ret;
465 ret = ath3k_get_state(udev, &fw_state);
466 if (ret < 0) {
467 BT_ERR("Can't get state to change to load configuration err");
468 return -EBUSY;
471 ret = ath3k_get_version(udev, &fw_version);
472 if (ret < 0) {
473 BT_ERR("Can't get version to change to load ram patch err");
474 return ret;
477 switch (fw_version.ref_clock) {
479 case ATH3K_XTAL_FREQ_26M:
480 clk_value = 26;
481 break;
482 case ATH3K_XTAL_FREQ_40M:
483 clk_value = 40;
484 break;
485 case ATH3K_XTAL_FREQ_19P2:
486 clk_value = 19;
487 break;
488 default:
489 clk_value = 0;
490 break;
493 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
494 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
496 ret = request_firmware(&firmware, filename, &udev->dev);
497 if (ret < 0) {
498 BT_ERR("Configuration file not found %s", filename);
499 return ret;
502 ret = ath3k_load_fwfile(udev, firmware);
503 release_firmware(firmware);
505 return ret;
508 static int ath3k_probe(struct usb_interface *intf,
509 const struct usb_device_id *id)
511 const struct firmware *firmware;
512 struct usb_device *udev = interface_to_usbdev(intf);
513 int ret;
515 BT_DBG("intf %p id %p", intf, id);
517 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
518 return -ENODEV;
520 /* match device ID in ath3k blacklist table */
521 if (!id->driver_info) {
522 const struct usb_device_id *match;
524 match = usb_match_id(intf, ath3k_blist_tbl);
525 if (match)
526 id = match;
529 /* load patch and sysconfig files for AR3012 */
530 if (id->driver_info & BTUSB_ATH3012) {
531 /* New firmware with patch and sysconfig files already loaded */
532 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
533 return -ENODEV;
535 ret = ath3k_load_patch(udev);
536 if (ret < 0) {
537 BT_ERR("Loading patch file failed");
538 return ret;
540 ret = ath3k_load_syscfg(udev);
541 if (ret < 0) {
542 BT_ERR("Loading sysconfig file failed");
543 return ret;
545 ret = ath3k_set_normal_mode(udev);
546 if (ret < 0) {
547 BT_ERR("Set normal mode failed");
548 return ret;
550 ath3k_switch_pid(udev);
551 return 0;
554 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
555 if (ret < 0) {
556 if (ret == -ENOENT)
557 BT_ERR("Firmware file \"%s\" not found",
558 ATH3K_FIRMWARE);
559 else
560 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
561 ATH3K_FIRMWARE, ret);
562 return ret;
565 ret = ath3k_load_firmware(udev, firmware);
566 release_firmware(firmware);
568 return ret;
571 static void ath3k_disconnect(struct usb_interface *intf)
573 BT_DBG("%s intf %p", __func__, intf);
576 static struct usb_driver ath3k_driver = {
577 .name = "ath3k",
578 .probe = ath3k_probe,
579 .disconnect = ath3k_disconnect,
580 .id_table = ath3k_table,
581 .disable_hub_initiated_lpm = 1,
584 module_usb_driver(ath3k_driver);
586 MODULE_AUTHOR("Atheros Communications");
587 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
588 MODULE_VERSION(VERSION);
589 MODULE_LICENSE("GPL");
590 MODULE_FIRMWARE(ATH3K_FIRMWARE);