1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2008-2009 Atheros Communications Inc.
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>
20 #define ATH3K_FIRMWARE "ath3k-1.fw"
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
28 #define ATH3K_MODE_MASK 0x3F
29 #define ATH3K_NORMAL_MODE 0x0E
31 #define ATH3K_PATCH_UPDATE 0x80
32 #define ATH3K_SYSCFG_UPDATE 0x40
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
39 struct ath3k_version
{
47 static const struct usb_device_id ath3k_table
[] = {
49 { USB_DEVICE(0x0CF3, 0x3000) },
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) },
60 /* Atheros AR9285 Malbec with sflash firmware */
61 { USB_DEVICE(0x03F0, 0x311D) },
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) },
115 /* Atheros AR5BBU12 with sflash firmware */
116 { USB_DEVICE(0x0489, 0xE02C) },
118 /* Atheros AR5BBU22 with sflash firmware */
119 { USB_DEVICE(0x0489, 0xE036) },
120 { USB_DEVICE(0x0489, 0xE03C) },
122 { } /* Terminating entry */
125 MODULE_DEVICE_TABLE(usb
, ath3k_table
);
127 #define BTUSB_ATH3012 0x80
128 /* This table is to load patch and sysconfig files
131 static const struct usb_device_id ath3k_blist_tbl
[] = {
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
},
185 /* Atheros AR5BBU22 with sflash firmware */
186 { USB_DEVICE(0x0489, 0xE036), .driver_info
= BTUSB_ATH3012
},
187 { USB_DEVICE(0x0489, 0xE03C), .driver_info
= BTUSB_ATH3012
},
189 { } /* Terminating entry */
192 static inline void ath3k_log_failed_loading(int err
, int len
, int size
,
195 BT_ERR("Firmware loading err = %d, len = %d, size = %d, count = %d",
196 err
, len
, size
, count
);
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
205 static int ath3k_load_firmware(struct usb_device
*udev
,
206 const struct firmware
*firmware
)
210 int err
, pipe
, size
, sent
= 0;
211 int count
= firmware
->size
;
213 BT_DBG("udev %p", udev
);
215 pipe
= usb_sndctrlpipe(udev
, 0);
217 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
219 BT_ERR("Can't allocate memory chunk for firmware");
223 memcpy(send_buf
, firmware
->data
, FW_HDR_SIZE
);
224 err
= usb_control_msg(udev
, pipe
, USB_REQ_DFU_DNLOAD
, USB_TYPE_VENDOR
,
225 0, 0, send_buf
, FW_HDR_SIZE
,
226 USB_CTRL_SET_TIMEOUT
);
228 BT_ERR("Can't change to loading configuration err");
232 count
-= FW_HDR_SIZE
;
234 pipe
= usb_sndbulkpipe(udev
, 0x02);
237 /* workaround the compatibility issue with xHCI controller*/
238 usleep_range(TIMEGAP_USEC_MIN
, TIMEGAP_USEC_MAX
);
240 size
= min_t(uint
, count
, BULK_SIZE
);
241 memcpy(send_buf
, firmware
->data
+ sent
, size
);
243 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
246 if (err
|| (len
!= size
)) {
247 ath3k_log_failed_loading(err
, len
, size
, count
);
260 static int ath3k_get_state(struct usb_device
*udev
, unsigned char *state
)
265 buf
= kmalloc(sizeof(*buf
), GFP_KERNEL
);
269 pipe
= usb_rcvctrlpipe(udev
, 0);
270 ret
= usb_control_msg(udev
, pipe
, ATH3K_GETSTATE
,
271 USB_TYPE_VENDOR
| USB_DIR_IN
, 0, 0,
272 buf
, sizeof(*buf
), USB_CTRL_SET_TIMEOUT
);
280 static int ath3k_get_version(struct usb_device
*udev
,
281 struct ath3k_version
*version
)
284 struct ath3k_version
*buf
;
285 const int size
= sizeof(*buf
);
287 buf
= kmalloc(size
, GFP_KERNEL
);
291 pipe
= usb_rcvctrlpipe(udev
, 0);
292 ret
= usb_control_msg(udev
, pipe
, ATH3K_GETVERSION
,
293 USB_TYPE_VENDOR
| USB_DIR_IN
, 0, 0,
294 buf
, size
, USB_CTRL_SET_TIMEOUT
);
296 memcpy(version
, buf
, size
);
302 static int ath3k_load_fwfile(struct usb_device
*udev
,
303 const struct firmware
*firmware
)
307 int err
, pipe
, size
, count
, sent
= 0;
310 count
= firmware
->size
;
312 send_buf
= kmalloc(BULK_SIZE
, GFP_KERNEL
);
314 BT_ERR("Can't allocate memory chunk for firmware");
318 size
= min_t(uint
, count
, FW_HDR_SIZE
);
319 memcpy(send_buf
, firmware
->data
, size
);
321 pipe
= usb_sndctrlpipe(udev
, 0);
322 ret
= usb_control_msg(udev
, pipe
, ATH3K_DNLOAD
,
323 USB_TYPE_VENDOR
, 0, 0, send_buf
,
324 size
, USB_CTRL_SET_TIMEOUT
);
326 BT_ERR("Can't change to loading configuration err");
334 pipe
= usb_sndbulkpipe(udev
, 0x02);
337 /* workaround the compatibility issue with xHCI controller*/
338 usleep_range(TIMEGAP_USEC_MIN
, TIMEGAP_USEC_MAX
);
340 size
= min_t(uint
, count
, BULK_SIZE
);
341 memcpy(send_buf
, firmware
->data
+ sent
, size
);
343 err
= usb_bulk_msg(udev
, pipe
, send_buf
, size
,
345 if (err
|| (len
!= size
)) {
346 ath3k_log_failed_loading(err
, len
, size
, count
);
358 static int ath3k_switch_pid(struct usb_device
*udev
)
362 pipe
= usb_sndctrlpipe(udev
, 0);
363 return usb_control_msg(udev
, pipe
, USB_REG_SWITCH_VID_PID
,
364 USB_TYPE_VENDOR
, 0, 0,
365 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
368 static int ath3k_set_normal_mode(struct usb_device
*udev
)
370 unsigned char fw_state
;
373 ret
= ath3k_get_state(udev
, &fw_state
);
375 BT_ERR("Can't get state to change to normal mode err");
379 if ((fw_state
& ATH3K_MODE_MASK
) == ATH3K_NORMAL_MODE
) {
380 BT_DBG("firmware was already in normal mode");
384 pipe
= usb_sndctrlpipe(udev
, 0);
385 return usb_control_msg(udev
, pipe
, ATH3K_SET_NORMAL_MODE
,
386 USB_TYPE_VENDOR
, 0, 0,
387 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
390 static int ath3k_load_patch(struct usb_device
*udev
)
392 unsigned char fw_state
;
393 char filename
[ATH3K_NAME_LEN
];
394 const struct firmware
*firmware
;
395 struct ath3k_version fw_version
;
396 __u32 pt_rom_version
, pt_build_version
;
399 ret
= ath3k_get_state(udev
, &fw_state
);
401 BT_ERR("Can't get state to change to load ram patch err");
405 if (fw_state
& ATH3K_PATCH_UPDATE
) {
406 BT_DBG("Patch was already downloaded");
410 ret
= ath3k_get_version(udev
, &fw_version
);
412 BT_ERR("Can't get version to change to load ram patch err");
416 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/AthrBT_0x%08x.dfu",
417 le32_to_cpu(fw_version
.rom_version
));
419 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
421 BT_ERR("Patch file not found %s", filename
);
425 pt_rom_version
= get_unaligned_le32(firmware
->data
+
427 pt_build_version
= get_unaligned_le32(firmware
->data
+
430 if (pt_rom_version
!= le32_to_cpu(fw_version
.rom_version
) ||
431 pt_build_version
<= le32_to_cpu(fw_version
.build_version
)) {
432 BT_ERR("Patch file version did not match with firmware");
433 release_firmware(firmware
);
437 ret
= ath3k_load_fwfile(udev
, firmware
);
438 release_firmware(firmware
);
443 static int ath3k_load_syscfg(struct usb_device
*udev
)
445 unsigned char fw_state
;
446 char filename
[ATH3K_NAME_LEN
];
447 const struct firmware
*firmware
;
448 struct ath3k_version fw_version
;
451 ret
= ath3k_get_state(udev
, &fw_state
);
453 BT_ERR("Can't get state to change to load configuration err");
457 ret
= ath3k_get_version(udev
, &fw_version
);
459 BT_ERR("Can't get version to change to load ram patch err");
463 switch (fw_version
.ref_clock
) {
465 case ATH3K_XTAL_FREQ_26M
:
468 case ATH3K_XTAL_FREQ_40M
:
471 case ATH3K_XTAL_FREQ_19P2
:
479 snprintf(filename
, ATH3K_NAME_LEN
, "ar3k/ramps_0x%08x_%d%s",
480 le32_to_cpu(fw_version
.rom_version
), clk_value
, ".dfu");
482 ret
= request_firmware(&firmware
, filename
, &udev
->dev
);
484 BT_ERR("Configuration file not found %s", filename
);
488 ret
= ath3k_load_fwfile(udev
, firmware
);
489 release_firmware(firmware
);
494 static int ath3k_probe(struct usb_interface
*intf
,
495 const struct usb_device_id
*id
)
497 const struct firmware
*firmware
;
498 struct usb_device
*udev
= interface_to_usbdev(intf
);
501 BT_DBG("intf %p id %p", intf
, id
);
503 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 0)
506 /* match device ID in ath3k blacklist table */
507 if (!id
->driver_info
) {
508 const struct usb_device_id
*match
;
510 match
= usb_match_id(intf
, ath3k_blist_tbl
);
515 /* load patch and sysconfig files for AR3012 */
516 if (id
->driver_info
& BTUSB_ATH3012
) {
517 /* New firmware with patch and sysconfig files already loaded */
518 if (le16_to_cpu(udev
->descriptor
.bcdDevice
) > 0x0001)
521 ret
= ath3k_load_patch(udev
);
523 BT_ERR("Loading patch file failed");
526 ret
= ath3k_load_syscfg(udev
);
528 BT_ERR("Loading sysconfig file failed");
531 ret
= ath3k_set_normal_mode(udev
);
533 BT_ERR("Set normal mode failed");
536 ath3k_switch_pid(udev
);
540 ret
= request_firmware(&firmware
, ATH3K_FIRMWARE
, &udev
->dev
);
543 BT_ERR("Firmware file \"%s\" not found",
546 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
547 ATH3K_FIRMWARE
, ret
);
551 ret
= ath3k_load_firmware(udev
, firmware
);
552 release_firmware(firmware
);
557 static void ath3k_disconnect(struct usb_interface
*intf
)
559 BT_DBG("%s intf %p", __func__
, intf
);
562 static struct usb_driver ath3k_driver
= {
564 .probe
= ath3k_probe
,
565 .disconnect
= ath3k_disconnect
,
566 .id_table
= ath3k_table
,
567 .disable_hub_initiated_lpm
= 1,
570 module_usb_driver(ath3k_driver
);
572 MODULE_AUTHOR("Atheros Communications");
573 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
574 MODULE_VERSION(VERSION
);
575 MODULE_LICENSE("GPL");
576 MODULE_FIRMWARE(ATH3K_FIRMWARE
);