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