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