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