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