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