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