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