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