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