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