1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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 <net/bluetooth/bluetooth.h>
31
32#define VERSION "1.0"
33#define ATH3K_FIRMWARE "ath3k-1.fw"
34
35#define ATH3K_DNLOAD 0x01
36#define ATH3K_GETSTATE 0x05
37#define ATH3K_SET_NORMAL_MODE 0x07
38#define ATH3K_GETVERSION 0x09
39#define USB_REG_SWITCH_VID_PID 0x0a
40
41#define ATH3K_MODE_MASK 0x3F
42#define ATH3K_NORMAL_MODE 0x0E
43
44#define ATH3K_PATCH_UPDATE 0x80
45#define ATH3K_SYSCFG_UPDATE 0x40
46
47#define ATH3K_XTAL_FREQ_26M 0x00
48#define ATH3K_XTAL_FREQ_40M 0x01
49#define ATH3K_XTAL_FREQ_19P2 0x02
50#define ATH3K_NAME_LEN 0xFF
51
52struct ath3k_version {
53 unsigned int rom_version;
54 unsigned int build_version;
55 unsigned int ram_version;
56 unsigned char ref_clock;
57 unsigned char reserved[0x07];
58};
59
60static struct usb_device_id ath3k_table[] = {
61
62 { USB_DEVICE(0x0CF3, 0x3000) },
63
64
65 { USB_DEVICE(0x0CF3, 0x3002) },
66 { USB_DEVICE(0x0CF3, 0xE019) },
67 { USB_DEVICE(0x13d3, 0x3304) },
68 { USB_DEVICE(0x0930, 0x0215) },
69 { USB_DEVICE(0x0489, 0xE03D) },
70 { USB_DEVICE(0x0489, 0xE027) },
71
72
73 { USB_DEVICE(0x03F0, 0x311D) },
74
75
76 { USB_DEVICE(0x0CF3, 0x3004) },
77 { USB_DEVICE(0x0CF3, 0x311D) },
78 { USB_DEVICE(0x13d3, 0x3375) },
79 { USB_DEVICE(0x04CA, 0x3005) },
80 { USB_DEVICE(0x04CA, 0x3006) },
81 { USB_DEVICE(0x04CA, 0x3008) },
82 { USB_DEVICE(0x13d3, 0x3362) },
83 { USB_DEVICE(0x0CF3, 0xE004) },
84 { USB_DEVICE(0x0930, 0x0219) },
85 { USB_DEVICE(0x0489, 0xe057) },
86 { USB_DEVICE(0x13d3, 0x3393) },
87 { USB_DEVICE(0x0489, 0xe04e) },
88 { USB_DEVICE(0x0489, 0xe056) },
89
90
91 { USB_DEVICE(0x0489, 0xE02C) },
92
93
94 { USB_DEVICE(0x0489, 0xE03C) },
95 { USB_DEVICE(0x0489, 0xE036) },
96
97 { }
98};
99
100MODULE_DEVICE_TABLE(usb, ath3k_table);
101
102#define BTUSB_ATH3012 0x80
103
104
105static struct usb_device_id ath3k_blist_tbl[] = {
106
107
108 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
109 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
110 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
111 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
112 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
113 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
114 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
115 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
116 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
117 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
118 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
119 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
120 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
121
122
123 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
124 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
125
126 { }
127};
128
129#define USB_REQ_DFU_DNLOAD 1
130#define BULK_SIZE 4096
131#define FW_HDR_SIZE 20
132
133static int ath3k_load_firmware(struct usb_device *udev,
134 const struct firmware *firmware)
135{
136 u8 *send_buf;
137 int err, pipe, len, size, sent = 0;
138 int count = firmware->size;
139
140 BT_DBG("udev %p", udev);
141
142 pipe = usb_sndctrlpipe(udev, 0);
143
144 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
145 if (!send_buf) {
146 BT_ERR("Can't allocate memory chunk for firmware");
147 return -ENOMEM;
148 }
149
150 memcpy(send_buf, firmware->data, 20);
151 if ((err = usb_control_msg(udev, pipe,
152 USB_REQ_DFU_DNLOAD,
153 USB_TYPE_VENDOR, 0, 0,
154 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
155 BT_ERR("Can't change to loading configuration err");
156 goto error;
157 }
158 sent += 20;
159 count -= 20;
160
161 while (count) {
162 size = min_t(uint, count, BULK_SIZE);
163 pipe = usb_sndbulkpipe(udev, 0x02);
164 memcpy(send_buf, firmware->data + sent, size);
165
166 err = usb_bulk_msg(udev, pipe, send_buf, size,
167 &len, 3000);
168
169 if (err || (len != size)) {
170 BT_ERR("Error in firmware loading err = %d,"
171 "len = %d, size = %d", err, len, size);
172 goto error;
173 }
174
175 sent += size;
176 count -= size;
177 }
178
179error:
180 kfree(send_buf);
181 return err;
182}
183
184static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
185{
186 int pipe = 0;
187
188 pipe = usb_rcvctrlpipe(udev, 0);
189 return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
190 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
191 state, 0x01, USB_CTRL_SET_TIMEOUT);
192}
193
194static int ath3k_get_version(struct usb_device *udev,
195 struct ath3k_version *version)
196{
197 int pipe = 0;
198
199 pipe = usb_rcvctrlpipe(udev, 0);
200 return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
201 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
202 sizeof(struct ath3k_version),
203 USB_CTRL_SET_TIMEOUT);
204}
205
206static int ath3k_load_fwfile(struct usb_device *udev,
207 const struct firmware *firmware)
208{
209 u8 *send_buf;
210 int err, pipe, len, size, count, sent = 0;
211 int ret;
212
213 count = firmware->size;
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 size = min_t(uint, count, FW_HDR_SIZE);
222 memcpy(send_buf, firmware->data, size);
223
224 pipe = usb_sndctrlpipe(udev, 0);
225 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
226 USB_TYPE_VENDOR, 0, 0, send_buf,
227 size, USB_CTRL_SET_TIMEOUT);
228 if (ret < 0) {
229 BT_ERR("Can't change to loading configuration err");
230 kfree(send_buf);
231 return ret;
232 }
233
234 sent += size;
235 count -= size;
236
237 while (count) {
238 size = min_t(uint, count, BULK_SIZE);
239 pipe = usb_sndbulkpipe(udev, 0x02);
240
241 memcpy(send_buf, firmware->data + sent, size);
242
243 err = usb_bulk_msg(udev, pipe, send_buf, size,
244 &len, 3000);
245 if (err || (len != size)) {
246 BT_ERR("Error in firmware loading err = %d,"
247 "len = %d, size = %d", err, len, size);
248 kfree(send_buf);
249 return err;
250 }
251 sent += size;
252 count -= size;
253 }
254
255 kfree(send_buf);
256 return 0;
257}
258
259static int ath3k_switch_pid(struct usb_device *udev)
260{
261 int pipe = 0;
262
263 pipe = usb_sndctrlpipe(udev, 0);
264 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
265 USB_TYPE_VENDOR, 0, 0,
266 NULL, 0, USB_CTRL_SET_TIMEOUT);
267}
268
269static int ath3k_set_normal_mode(struct usb_device *udev)
270{
271 unsigned char fw_state;
272 int pipe = 0, ret;
273
274 ret = ath3k_get_state(udev, &fw_state);
275 if (ret < 0) {
276 BT_ERR("Can't get state to change to normal mode err");
277 return ret;
278 }
279
280 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
281 BT_DBG("firmware was already in normal mode");
282 return 0;
283 }
284
285 pipe = usb_sndctrlpipe(udev, 0);
286 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
287 USB_TYPE_VENDOR, 0, 0,
288 NULL, 0, USB_CTRL_SET_TIMEOUT);
289}
290
291static int ath3k_load_patch(struct usb_device *udev)
292{
293 unsigned char fw_state;
294 char filename[ATH3K_NAME_LEN] = {0};
295 const struct firmware *firmware;
296 struct ath3k_version fw_version, pt_version;
297 int ret;
298
299 ret = ath3k_get_state(udev, &fw_state);
300 if (ret < 0) {
301 BT_ERR("Can't get state to change to load ram patch err");
302 return ret;
303 }
304
305 if (fw_state & ATH3K_PATCH_UPDATE) {
306 BT_DBG("Patch was already downloaded");
307 return 0;
308 }
309
310 ret = ath3k_get_version(udev, &fw_version);
311 if (ret < 0) {
312 BT_ERR("Can't get version to change to load ram patch err");
313 return ret;
314 }
315
316 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
317 fw_version.rom_version);
318
319 ret = request_firmware(&firmware, filename, &udev->dev);
320 if (ret < 0) {
321 BT_ERR("Patch file not found %s", filename);
322 return ret;
323 }
324
325 pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
326 pt_version.build_version = *(int *)
327 (firmware->data + firmware->size - 4);
328
329 if ((pt_version.rom_version != fw_version.rom_version) ||
330 (pt_version.build_version <= fw_version.build_version)) {
331 BT_ERR("Patch file version did not match with firmware");
332 release_firmware(firmware);
333 return -EINVAL;
334 }
335
336 ret = ath3k_load_fwfile(udev, firmware);
337 release_firmware(firmware);
338
339 return ret;
340}
341
342static int ath3k_load_syscfg(struct usb_device *udev)
343{
344 unsigned char fw_state;
345 char filename[ATH3K_NAME_LEN] = {0};
346 const struct firmware *firmware;
347 struct ath3k_version fw_version;
348 int clk_value, ret;
349
350 ret = ath3k_get_state(udev, &fw_state);
351 if (ret < 0) {
352 BT_ERR("Can't get state to change to load configration err");
353 return -EBUSY;
354 }
355
356 ret = ath3k_get_version(udev, &fw_version);
357 if (ret < 0) {
358 BT_ERR("Can't get version to change to load ram patch err");
359 return ret;
360 }
361
362 switch (fw_version.ref_clock) {
363
364 case ATH3K_XTAL_FREQ_26M:
365 clk_value = 26;
366 break;
367 case ATH3K_XTAL_FREQ_40M:
368 clk_value = 40;
369 break;
370 case ATH3K_XTAL_FREQ_19P2:
371 clk_value = 19;
372 break;
373 default:
374 clk_value = 0;
375 break;
376 }
377
378 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
379 fw_version.rom_version, clk_value, ".dfu");
380
381 ret = request_firmware(&firmware, filename, &udev->dev);
382 if (ret < 0) {
383 BT_ERR("Configuration file not found %s", filename);
384 return ret;
385 }
386
387 ret = ath3k_load_fwfile(udev, firmware);
388 release_firmware(firmware);
389
390 return ret;
391}
392
393static int ath3k_probe(struct usb_interface *intf,
394 const struct usb_device_id *id)
395{
396 const struct firmware *firmware;
397 struct usb_device *udev = interface_to_usbdev(intf);
398 int ret;
399
400 BT_DBG("intf %p id %p", intf, id);
401
402 if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
403 return -ENODEV;
404
405
406 if (!id->driver_info) {
407 const struct usb_device_id *match;
408 match = usb_match_id(intf, ath3k_blist_tbl);
409 if (match)
410 id = match;
411 }
412
413
414 if (id->driver_info & BTUSB_ATH3012) {
415
416
417 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
418 return -ENODEV;
419
420 ret = ath3k_load_patch(udev);
421 if (ret < 0) {
422 BT_ERR("Loading patch file failed");
423 return ret;
424 }
425 ret = ath3k_load_syscfg(udev);
426 if (ret < 0) {
427 BT_ERR("Loading sysconfig file failed");
428 return ret;
429 }
430 ret = ath3k_set_normal_mode(udev);
431 if (ret < 0) {
432 BT_ERR("Set normal mode failed");
433 return ret;
434 }
435 ath3k_switch_pid(udev);
436 return 0;
437 }
438
439 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
440 if (ret < 0) {
441 if (ret == -ENOENT)
442 BT_ERR("Firmware file \"%s\" not found",
443 ATH3K_FIRMWARE);
444 else
445 BT_ERR("Firmware file \"%s\" request failed (err=%d)",
446 ATH3K_FIRMWARE, ret);
447 return ret;
448 }
449
450 ret = ath3k_load_firmware(udev, firmware);
451 release_firmware(firmware);
452
453 return ret;
454}
455
456static void ath3k_disconnect(struct usb_interface *intf)
457{
458 BT_DBG("ath3k_disconnect intf %p", intf);
459}
460
461static struct usb_driver ath3k_driver = {
462 .name = "ath3k",
463 .probe = ath3k_probe,
464 .disconnect = ath3k_disconnect,
465 .id_table = ath3k_table,
466 .disable_hub_initiated_lpm = 1,
467};
468
469module_usb_driver(ath3k_driver);
470
471MODULE_AUTHOR("Atheros Communications");
472MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
473MODULE_VERSION(VERSION);
474MODULE_LICENSE("GPL");
475MODULE_FIRMWARE(ATH3K_FIRMWARE);
476
