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