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