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