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 <net/bluetooth/bluetooth.h>
  31
  32 #define VERSION "1.0"
  33
  34 #define ATH3K_DNLOAD                            0x01
  35 #define ATH3K_GETSTATE                          0x05
  36 #define ATH3K_SET_NORMAL_MODE                   0x07
  37 #define ATH3K_GETVERSION                        0x09
  38 #define USB_REG_SWITCH_VID_PID                  0x0a
  39
  40 #define ATH3K_MODE_MASK                         0x3F
  41 #define ATH3K_NORMAL_MODE                       0x0E
  42
  43 #define ATH3K_PATCH_UPDATE                      0x80
  44 #define ATH3K_SYSCFG_UPDATE                     0x40
  45
  46 #define ATH3K_XTAL_FREQ_26M                     0x00
  47 #define ATH3K_XTAL_FREQ_40M                     0x01
  48 #define ATH3K_XTAL_FREQ_19P2                    0x02
  49 #define ATH3K_NAME_LEN                          0xFF
  50
  51 struct ath3k_version {
  52         unsigned int    rom_version;
  53         unsigned int    build_version;
  54         unsigned int    ram_version;
  55         unsigned char   ref_clock;
  56         unsigned char   reserved[0x07];
  57 };
  58
  59 static struct usb_device_id ath3k_table[] = {
  60         /* Atheros AR3011 */
  61         { USB_DEVICE(0x0CF3, 0x3000) },
  62
  63         /* Atheros AR3011 with sflash firmware*/
  64         { USB_DEVICE(0x0489, 0xE027) },
  65         { USB_DEVICE(0x0489, 0xE03D) },
  66         { USB_DEVICE(0x0930, 0x0215) },
  67         { USB_DEVICE(0x0CF3, 0x3002) },
  68         { USB_DEVICE(0x0CF3, 0xE019) },
  69         { USB_DEVICE(0x13d3, 0x3304) },
  70
  71         /* Atheros AR9285 Malbec with sflash firmware */
  72         { USB_DEVICE(0x03F0, 0x311D) },
  73
  74         /* Atheros AR3012 with sflash firmware*/
  75         { USB_DEVICE(0x0489, 0xe04d) },
  76         { USB_DEVICE(0x0489, 0xe04e) },
  77         { USB_DEVICE(0x0489, 0xe057) },
  78         { USB_DEVICE(0x0489, 0xe056) },
  79         { USB_DEVICE(0x0489, 0xe05f) },
  80         { USB_DEVICE(0x0489, 0xe078) },
  81         { USB_DEVICE(0x04c5, 0x1330) },
  82         { USB_DEVICE(0x04CA, 0x3004) },
  83         { USB_DEVICE(0x04CA, 0x3005) },
  84         { USB_DEVICE(0x04CA, 0x3006) },
  85         { USB_DEVICE(0x04CA, 0x3007) },
  86         { USB_DEVICE(0x04CA, 0x3008) },
  87         { USB_DEVICE(0x04CA, 0x300b) },
  88         { USB_DEVICE(0x04CA, 0x3010) },
  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, 0x3408) },
 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 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(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
 143         { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
 144         { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
 145         { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
 146         { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
 147         { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
 148         { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
 149         { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
 150         { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
 151         { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
 152         { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
 153         { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
 154         { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
 155         { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
 156         { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
 157         { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
 158         { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
 159         { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
 160         { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
 161         { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
 162         { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
 163         { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },
 164
 165         /* Atheros AR5BBU22 with sflash firmware */
 166         { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
 167         { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
 168
 169         { }     /* Terminating entry */
 170 };
 171
 172 #define USB_REQ_DFU_DNLOAD      1
 173 #define BULK_SIZE               4096
 174 #define FW_HDR_SIZE             20
 175
 176 static int ath3k_load_firmware(struct usb_device *udev,
 177                                 const struct firmware *firmware)
 178 {
 179         u8 *send_buf;
 180         int err, pipe, len, size, sent = 0;
 181         int count = firmware->size;
 182
 183         BT_DBG("udev %p", udev);
 184
 185         pipe = usb_sndctrlpipe(udev, 0);
 186
 187         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
 188         if (!send_buf) {
 189                 BT_ERR("Can't allocate memory chunk for firmware");
 190                 return -ENOMEM;
 191         }
 192
 193         memcpy(send_buf, firmware->data, 20);
 194         if ((err = usb_control_msg(udev, pipe,
 195                                 USB_REQ_DFU_DNLOAD,
 196                                 USB_TYPE_VENDOR, 0, 0,
 197                                 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
 198                 BT_ERR("Can't change to loading configuration err");
 199                 goto error;
 200         }
 201         sent += 20;
 202         count -= 20;
 203
 204         while (count) {
 205                 size = min_t(uint, count, BULK_SIZE);
 206                 pipe = usb_sndbulkpipe(udev, 0x02);
 207                 memcpy(send_buf, firmware->data + sent, size);
 208
 209                 err = usb_bulk_msg(udev, pipe, send_buf, size,
 210                                         &len, 3000);
 211
 212                 if (err || (len != size)) {
 213                         BT_ERR("Error in firmware loading err = %d,"
 214                                 "len = %d, size = %d", err, len, size);
 215                         goto error;
 216                 }
 217
 218                 sent  += size;
 219                 count -= size;
 220         }
 221
 222 error:
 223         kfree(send_buf);
 224         return err;
 225 }
 226
 227 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
 228 {
 229         int pipe = 0;
 230
 231         pipe = usb_rcvctrlpipe(udev, 0);
 232         return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
 233                         USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
 234                         state, 0x01, USB_CTRL_SET_TIMEOUT);
 235 }
 236
 237 static int ath3k_get_version(struct usb_device *udev,
 238                         struct ath3k_version *version)
 239 {
 240         int pipe = 0;
 241
 242         pipe = usb_rcvctrlpipe(udev, 0);
 243         return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
 244                         USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
 245                         sizeof(struct ath3k_version),
 246                         USB_CTRL_SET_TIMEOUT);
 247 }
 248
 249 static int ath3k_load_fwfile(struct usb_device *udev,
 250                 const struct firmware *firmware)
 251 {
 252         u8 *send_buf;
 253         int err, pipe, len, size, count, sent = 0;
 254         int ret;
 255
 256         count = firmware->size;
 257
 258         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
 259         if (!send_buf) {
 260                 BT_ERR("Can't allocate memory chunk for firmware");
 261                 return -ENOMEM;
 262         }
 263
 264         size = min_t(uint, count, FW_HDR_SIZE);
 265         memcpy(send_buf, firmware->data, size);
 266
 267         pipe = usb_sndctrlpipe(udev, 0);
 268         ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
 269                         USB_TYPE_VENDOR, 0, 0, send_buf,
 270                         size, USB_CTRL_SET_TIMEOUT);
 271         if (ret < 0) {
 272                 BT_ERR("Can't change to loading configuration err");
 273                 kfree(send_buf);
 274                 return ret;
 275         }
 276
 277         sent += size;
 278         count -= size;
 279
 280         while (count) {
 281                 size = min_t(uint, count, BULK_SIZE);
 282                 pipe = usb_sndbulkpipe(udev, 0x02);
 283
 284                 memcpy(send_buf, firmware->data + sent, size);
 285
 286                 err = usb_bulk_msg(udev, pipe, send_buf, size,
 287                                         &len, 3000);
 288                 if (err || (len != size)) {
 289                         BT_ERR("Error in firmware loading err = %d,"
 290                                 "len = %d, size = %d", err, len, size);
 291                         kfree(send_buf);
 292                         return err;
 293                 }
 294                 sent  += size;
 295                 count -= size;
 296         }
 297
 298         kfree(send_buf);
 299         return 0;
 300 }
 301
 302 static int ath3k_switch_pid(struct usb_device *udev)
 303 {
 304         int pipe = 0;
 305
 306         pipe = usb_sndctrlpipe(udev, 0);
 307         return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
 308                         USB_TYPE_VENDOR, 0, 0,
 309                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 310 }
 311
 312 static int ath3k_set_normal_mode(struct usb_device *udev)
 313 {
 314         unsigned char fw_state;
 315         int pipe = 0, ret;
 316
 317         ret = ath3k_get_state(udev, &fw_state);
 318         if (ret < 0) {
 319                 BT_ERR("Can't get state to change to normal mode err");
 320                 return ret;
 321         }
 322
 323         if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
 324                 BT_DBG("firmware was already in normal mode");
 325                 return 0;
 326         }
 327
 328         pipe = usb_sndctrlpipe(udev, 0);
 329         return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
 330                         USB_TYPE_VENDOR, 0, 0,
 331                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 332 }
 333
 334 static int ath3k_load_patch(struct usb_device *udev)
 335 {
 336         unsigned char fw_state;
 337         char filename[ATH3K_NAME_LEN] = {0};
 338         const struct firmware *firmware;
 339         struct ath3k_version fw_version, pt_version;
 340         int ret;
 341
 342         ret = ath3k_get_state(udev, &fw_state);
 343         if (ret < 0) {
 344                 BT_ERR("Can't get state to change to load ram patch err");
 345                 return ret;
 346         }
 347
 348         if (fw_state & ATH3K_PATCH_UPDATE) {
 349                 BT_DBG("Patch was already downloaded");
 350                 return 0;
 351         }
 352
 353         ret = ath3k_get_version(udev, &fw_version);
 354         if (ret < 0) {
 355                 BT_ERR("Can't get version to change to load ram patch err");
 356                 return ret;
 357         }
 358
 359         snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
 360                 fw_version.rom_version);
 361
 362         ret = request_firmware(&firmware, filename, &udev->dev);
 363         if (ret < 0) {
 364                 BT_ERR("Patch file not found %s", filename);
 365                 return ret;
 366         }
 367
 368         pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
 369         pt_version.build_version = *(int *)
 370                 (firmware->data + firmware->size - 4);
 371
 372         if ((pt_version.rom_version != fw_version.rom_version) ||
 373                 (pt_version.build_version <= fw_version.build_version)) {
 374                 BT_ERR("Patch file version did not match with firmware");
 375                 release_firmware(firmware);
 376                 return -EINVAL;
 377         }
 378
 379         ret = ath3k_load_fwfile(udev, firmware);
 380         release_firmware(firmware);
 381
 382         return ret;
 383 }
 384
 385 static int ath3k_load_syscfg(struct usb_device *udev)
 386 {
 387         unsigned char fw_state;
 388         char filename[ATH3K_NAME_LEN] = {0};
 389         const struct firmware *firmware;
 390         struct ath3k_version fw_version;
 391         int clk_value, ret;
 392
 393         ret = ath3k_get_state(udev, &fw_state);
 394         if (ret < 0) {
 395                 BT_ERR("Can't get state to change to load configration err");
 396                 return -EBUSY;
 397         }
 398
 399         ret = ath3k_get_version(udev, &fw_version);
 400         if (ret < 0) {
 401                 BT_ERR("Can't get version to change to load ram patch err");
 402                 return ret;
 403         }
 404
 405         switch (fw_version.ref_clock) {
 406
 407         case ATH3K_XTAL_FREQ_26M:
 408                 clk_value = 26;
 409                 break;
 410         case ATH3K_XTAL_FREQ_40M:
 411                 clk_value = 40;
 412                 break;
 413         case ATH3K_XTAL_FREQ_19P2:
 414                 clk_value = 19;
 415                 break;
 416         default:
 417                 clk_value = 0;
 418                 break;
 419         }
 420
 421         snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
 422                 fw_version.rom_version, clk_value, ".dfu");
 423
 424         ret = request_firmware(&firmware, filename, &udev->dev);
 425         if (ret < 0) {
 426                 BT_ERR("Configuration file not found %s", filename);
 427                 return ret;
 428         }
 429
 430         ret = ath3k_load_fwfile(udev, firmware);
 431         release_firmware(firmware);
 432
 433         return ret;
 434 }
 435
 436 static int ath3k_probe(struct usb_interface *intf,
 437                         const struct usb_device_id *id)
 438 {
 439         const struct firmware *firmware;
 440         struct usb_device *udev = interface_to_usbdev(intf);
 441         int ret;
 442
 443         BT_DBG("intf %p id %p", intf, id);
 444
 445         if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
 446                 return -ENODEV;
 447
 448         /* match device ID in ath3k blacklist table */
 449         if (!id->driver_info) {
 450                 const struct usb_device_id *match;
 451                 match = usb_match_id(intf, ath3k_blist_tbl);
 452                 if (match)
 453                         id = match;
 454         }
 455
 456         /* load patch and sysconfig files for AR3012 */
 457         if (id->driver_info & BTUSB_ATH3012) {
 458
 459                 /* New firmware with patch and sysconfig files already loaded */
 460                 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
 461                         return -ENODEV;
 462
 463                 ret = ath3k_load_patch(udev);
 464                 if (ret < 0) {
 465                         BT_ERR("Loading patch file failed");
 466                         return ret;
 467                 }
 468                 ret = ath3k_load_syscfg(udev);
 469                 if (ret < 0) {
 470                         BT_ERR("Loading sysconfig file failed");
 471                         return ret;
 472                 }
 473                 ret = ath3k_set_normal_mode(udev);
 474                 if (ret < 0) {
 475                         BT_ERR("Set normal mode failed");
 476                         return ret;
 477                 }
 478                 ath3k_switch_pid(udev);
 479                 return 0;
 480         }
 481
 482         if (request_firmware(&firmware, "ath3k-1.fw", &udev->dev) < 0) {
 483                 BT_ERR("Error loading firmware");
 484                 return -EIO;
 485         }
 486
 487         ret = ath3k_load_firmware(udev, firmware);
 488         release_firmware(firmware);
 489
 490         return ret;
 491 }
 492
 493 static void ath3k_disconnect(struct usb_interface *intf)
 494 {
 495         BT_DBG("ath3k_disconnect intf %p", intf);
 496 }
 497
 498 static struct usb_driver ath3k_driver = {
 499         .name           = "ath3k",
 500         .probe          = ath3k_probe,
 501         .disconnect     = ath3k_disconnect,
 502         .id_table       = ath3k_table,
 503 };
 504
 505 static int __init ath3k_init(void)
 506 {
 507         BT_INFO("Atheros AR30xx firmware driver ver %s", VERSION);
 508         return usb_register(&ath3k_driver);
 509 }
 510
 511 static void __exit ath3k_exit(void)
 512 {
 513         usb_deregister(&ath3k_driver);
 514 }
 515
 516 module_init(ath3k_init);
 517 module_exit(ath3k_exit);
 518
 519 MODULE_AUTHOR("Atheros Communications");
 520 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
 521 MODULE_VERSION(VERSION);
 522 MODULE_LICENSE("GPL");
 523 MODULE_FIRMWARE("ath3k-1.fw");