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