Version:  2.0.40 2.2.26 2.4.37 2.6.39 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15

Linux/drivers/bluetooth/ath3k.c

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

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us