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