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