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