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