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