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 const 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(0x04F2, 0xAFF1) },
  69         { USB_DEVICE(0x0930, 0x0215) },
  70         { USB_DEVICE(0x0CF3, 0x3002) },
  71         { USB_DEVICE(0x0CF3, 0xE019) },
  72         { USB_DEVICE(0x13d3, 0x3304) },
  73
  74         /* Atheros AR9285 Malbec with sflash firmware */
  75         { USB_DEVICE(0x03F0, 0x311D) },
  76
  77         /* Atheros AR3012 with sflash firmware*/
  78         { USB_DEVICE(0x0489, 0xe04d) },
  79         { USB_DEVICE(0x0489, 0xe04e) },
  80         { USB_DEVICE(0x0489, 0xe057) },
  81         { USB_DEVICE(0x0489, 0xe056) },
  82         { USB_DEVICE(0x0489, 0xe05f) },
  83         { USB_DEVICE(0x0489, 0xe078) },
  84         { USB_DEVICE(0x04c5, 0x1330) },
  85         { USB_DEVICE(0x04CA, 0x3004) },
  86         { USB_DEVICE(0x04CA, 0x3005) },
  87         { USB_DEVICE(0x04CA, 0x3006) },
  88         { USB_DEVICE(0x04CA, 0x3007) },
  89         { USB_DEVICE(0x04CA, 0x3008) },
  90         { USB_DEVICE(0x04CA, 0x300b) },
  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
 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 const 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, 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         err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
 202                               0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
 203         if (err < 0) {
 204                 BT_ERR("Can't change to loading configuration err");
 205                 goto error;
 206         }
 207         sent += 20;
 208         count -= 20;
 209
 210         pipe = usb_sndbulkpipe(udev, 0x02);
 211
 212         while (count) {
 213                 /* workaround the compatibility issue with xHCI controller*/
 214                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
 215
 216                 size = min_t(uint, count, BULK_SIZE);
 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 ret, pipe = 0;
 240         char *buf;
 241
 242         buf = kmalloc(sizeof(*buf), GFP_KERNEL);
 243         if (!buf)
 244                 return -ENOMEM;
 245
 246         pipe = usb_rcvctrlpipe(udev, 0);
 247         ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
 248                               USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
 249                               buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
 250
 251         *state = *buf;
 252         kfree(buf);
 253
 254         return ret;
 255 }
 256
 257 static int ath3k_get_version(struct usb_device *udev,
 258                         struct ath3k_version *version)
 259 {
 260         int ret, pipe = 0;
 261         struct ath3k_version *buf;
 262         const int size = sizeof(*buf);
 263
 264         buf = kmalloc(size, GFP_KERNEL);
 265         if (!buf)
 266                 return -ENOMEM;
 267
 268         pipe = usb_rcvctrlpipe(udev, 0);
 269         ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
 270                               USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
 271                               buf, size, USB_CTRL_SET_TIMEOUT);
 272
 273         memcpy(version, buf, size);
 274         kfree(buf);
 275
 276         return ret;
 277 }
 278
 279 static int ath3k_load_fwfile(struct usb_device *udev,
 280                 const struct firmware *firmware)
 281 {
 282         u8 *send_buf;
 283         int err, pipe, len, size, count, sent = 0;
 284         int ret;
 285
 286         count = firmware->size;
 287
 288         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
 289         if (!send_buf) {
 290                 BT_ERR("Can't allocate memory chunk for firmware");
 291                 return -ENOMEM;
 292         }
 293
 294         size = min_t(uint, count, FW_HDR_SIZE);
 295         memcpy(send_buf, firmware->data, size);
 296
 297         pipe = usb_sndctrlpipe(udev, 0);
 298         ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
 299                         USB_TYPE_VENDOR, 0, 0, send_buf,
 300                         size, USB_CTRL_SET_TIMEOUT);
 301         if (ret < 0) {
 302                 BT_ERR("Can't change to loading configuration err");
 303                 kfree(send_buf);
 304                 return ret;
 305         }
 306
 307         sent += size;
 308         count -= size;
 309
 310         pipe = usb_sndbulkpipe(udev, 0x02);
 311
 312         while (count) {
 313                 /* workaround the compatibility issue with xHCI controller*/
 314                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
 315
 316                 size = min_t(uint, count, BULK_SIZE);
 317                 memcpy(send_buf, firmware->data + sent, size);
 318
 319                 err = usb_bulk_msg(udev, pipe, send_buf, size,
 320                                         &len, 3000);
 321                 if (err || (len != size)) {
 322                         BT_ERR("Error in firmware loading err = %d,"
 323                                 "len = %d, size = %d", err, len, size);
 324                         kfree(send_buf);
 325                         return err;
 326                 }
 327                 sent  += size;
 328                 count -= size;
 329         }
 330
 331         kfree(send_buf);
 332         return 0;
 333 }
 334
 335 static int ath3k_switch_pid(struct usb_device *udev)
 336 {
 337         int pipe = 0;
 338
 339         pipe = usb_sndctrlpipe(udev, 0);
 340         return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
 341                         USB_TYPE_VENDOR, 0, 0,
 342                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 343 }
 344
 345 static int ath3k_set_normal_mode(struct usb_device *udev)
 346 {
 347         unsigned char fw_state;
 348         int pipe = 0, ret;
 349
 350         ret = ath3k_get_state(udev, &fw_state);
 351         if (ret < 0) {
 352                 BT_ERR("Can't get state to change to normal mode err");
 353                 return ret;
 354         }
 355
 356         if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
 357                 BT_DBG("firmware was already in normal mode");
 358                 return 0;
 359         }
 360
 361         pipe = usb_sndctrlpipe(udev, 0);
 362         return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
 363                         USB_TYPE_VENDOR, 0, 0,
 364                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 365 }
 366
 367 static int ath3k_load_patch(struct usb_device *udev)
 368 {
 369         unsigned char fw_state;
 370         char filename[ATH3K_NAME_LEN] = {0};
 371         const struct firmware *firmware;
 372         struct ath3k_version fw_version;
 373         __u32 pt_rom_version, pt_build_version;
 374         int ret;
 375
 376         ret = ath3k_get_state(udev, &fw_state);
 377         if (ret < 0) {
 378                 BT_ERR("Can't get state to change to load ram patch err");
 379                 return ret;
 380         }
 381
 382         if (fw_state & ATH3K_PATCH_UPDATE) {
 383                 BT_DBG("Patch was already downloaded");
 384                 return 0;
 385         }
 386
 387         ret = ath3k_get_version(udev, &fw_version);
 388         if (ret < 0) {
 389                 BT_ERR("Can't get version to change to load ram patch err");
 390                 return ret;
 391         }
 392
 393         snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
 394                  le32_to_cpu(fw_version.rom_version));
 395
 396         ret = request_firmware(&firmware, filename, &udev->dev);
 397         if (ret < 0) {
 398                 BT_ERR("Patch file not found %s", filename);
 399                 return ret;
 400         }
 401
 402         pt_rom_version = get_unaligned_le32(firmware->data +
 403                                             firmware->size - 8);
 404         pt_build_version = get_unaligned_le32(firmware->data +
 405                                               firmware->size - 4);
 406
 407         if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
 408             pt_build_version <= le32_to_cpu(fw_version.build_version)) {
 409                 BT_ERR("Patch file version did not match with firmware");
 410                 release_firmware(firmware);
 411                 return -EINVAL;
 412         }
 413
 414         ret = ath3k_load_fwfile(udev, firmware);
 415         release_firmware(firmware);
 416
 417         return ret;
 418 }
 419
 420 static int ath3k_load_syscfg(struct usb_device *udev)
 421 {
 422         unsigned char fw_state;
 423         char filename[ATH3K_NAME_LEN] = {0};
 424         const struct firmware *firmware;
 425         struct ath3k_version fw_version;
 426         int clk_value, ret;
 427
 428         ret = ath3k_get_state(udev, &fw_state);
 429         if (ret < 0) {
 430                 BT_ERR("Can't get state to change to load configuration err");
 431                 return -EBUSY;
 432         }
 433
 434         ret = ath3k_get_version(udev, &fw_version);
 435         if (ret < 0) {
 436                 BT_ERR("Can't get version to change to load ram patch err");
 437                 return ret;
 438         }
 439
 440         switch (fw_version.ref_clock) {
 441
 442         case ATH3K_XTAL_FREQ_26M:
 443                 clk_value = 26;
 444                 break;
 445         case ATH3K_XTAL_FREQ_40M:
 446                 clk_value = 40;
 447                 break;
 448         case ATH3K_XTAL_FREQ_19P2:
 449                 clk_value = 19;
 450                 break;
 451         default:
 452                 clk_value = 0;
 453                 break;
 454         }
 455
 456         snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
 457                 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");
 458
 459         ret = request_firmware(&firmware, filename, &udev->dev);
 460         if (ret < 0) {
 461                 BT_ERR("Configuration file not found %s", filename);
 462                 return ret;
 463         }
 464
 465         ret = ath3k_load_fwfile(udev, firmware);
 466         release_firmware(firmware);
 467
 468         return ret;
 469 }
 470
 471 static int ath3k_probe(struct usb_interface *intf,
 472                         const struct usb_device_id *id)
 473 {
 474         const struct firmware *firmware;
 475         struct usb_device *udev = interface_to_usbdev(intf);
 476         int ret;
 477
 478         BT_DBG("intf %p id %p", intf, id);
 479
 480         if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
 481                 return -ENODEV;
 482
 483         /* match device ID in ath3k blacklist table */
 484         if (!id->driver_info) {
 485                 const struct usb_device_id *match;
 486                 match = usb_match_id(intf, ath3k_blist_tbl);
 487                 if (match)
 488                         id = match;
 489         }
 490
 491         /* load patch and sysconfig files for AR3012 */
 492         if (id->driver_info & BTUSB_ATH3012) {
 493
 494                 /* New firmware with patch and sysconfig files already loaded */
 495                 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
 496                         return -ENODEV;
 497
 498                 ret = ath3k_load_patch(udev);
 499                 if (ret < 0) {
 500                         BT_ERR("Loading patch file failed");
 501                         return ret;
 502                 }
 503                 ret = ath3k_load_syscfg(udev);
 504                 if (ret < 0) {
 505                         BT_ERR("Loading sysconfig file failed");
 506                         return ret;
 507                 }
 508                 ret = ath3k_set_normal_mode(udev);
 509                 if (ret < 0) {
 510                         BT_ERR("Set normal mode failed");
 511                         return ret;
 512                 }
 513                 ath3k_switch_pid(udev);
 514                 return 0;
 515         }
 516
 517         ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
 518         if (ret < 0) {
 519                 if (ret == -ENOENT)
 520                         BT_ERR("Firmware file \"%s\" not found",
 521                                                         ATH3K_FIRMWARE);
 522                 else
 523                         BT_ERR("Firmware file \"%s\" request failed (err=%d)",
 524                                                         ATH3K_FIRMWARE, ret);
 525                 return ret;
 526         }
 527
 528         ret = ath3k_load_firmware(udev, firmware);
 529         release_firmware(firmware);
 530
 531         return ret;
 532 }
 533
 534 static void ath3k_disconnect(struct usb_interface *intf)
 535 {
 536         BT_DBG("ath3k_disconnect intf %p", intf);
 537 }
 538
 539 static struct usb_driver ath3k_driver = {
 540         .name           = "ath3k",
 541         .probe          = ath3k_probe,
 542         .disconnect     = ath3k_disconnect,
 543         .id_table       = ath3k_table,
 544         .disable_hub_initiated_lpm = 1,
 545 };
 546
 547 module_usb_driver(ath3k_driver);
 548
 549 MODULE_AUTHOR("Atheros Communications");
 550 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
 551 MODULE_VERSION(VERSION);
 552 MODULE_LICENSE("GPL");
 553 MODULE_FIRMWARE(ATH3K_FIRMWARE);