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