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 #define ATH3K_FIRMWARE  "ath3k-1.fw"
  34
  35 #define ATH3K_DNLOAD                            0x01
  36 #define ATH3K_GETSTATE                          0x05
  37 #define ATH3K_SET_NORMAL_MODE                   0x07
  38 #define ATH3K_GETVERSION                        0x09
  39 #define USB_REG_SWITCH_VID_PID                  0x0a
  40
  41 #define ATH3K_MODE_MASK                         0x3F
  42 #define ATH3K_NORMAL_MODE                       0x0E
  43
  44 #define ATH3K_PATCH_UPDATE                      0x80
  45 #define ATH3K_SYSCFG_UPDATE                     0x40
  46
  47 #define ATH3K_XTAL_FREQ_26M                     0x00
  48 #define ATH3K_XTAL_FREQ_40M                     0x01
  49 #define ATH3K_XTAL_FREQ_19P2                    0x02
  50 #define ATH3K_NAME_LEN                          0xFF
  51
  52 struct ath3k_version {
  53         unsigned int    rom_version;
  54         unsigned int    build_version;
  55         unsigned int    ram_version;
  56         unsigned char   ref_clock;
  57         unsigned char   reserved[0x07];
  58 };
  59
  60 static struct usb_device_id ath3k_table[] = {
  61         /* Atheros AR3011 */
  62         { USB_DEVICE(0x0CF3, 0x3000) },
  63
  64         /* Atheros AR3011 with sflash firmware*/
  65         { USB_DEVICE(0x0CF3, 0x3002) },
  66         { USB_DEVICE(0x0CF3, 0xE019) },
  67         { USB_DEVICE(0x13d3, 0x3304) },
  68         { USB_DEVICE(0x0930, 0x0215) },
  69         { USB_DEVICE(0x0489, 0xE03D) },
  70         { USB_DEVICE(0x0489, 0xE027) },
  71
  72         /* Atheros AR9285 Malbec with sflash firmware */
  73         { USB_DEVICE(0x03F0, 0x311D) },
  74
  75         /* Atheros AR3012 with sflash firmware*/
  76         { USB_DEVICE(0x0CF3, 0x0036) },
  77         { USB_DEVICE(0x0CF3, 0x3004) },
  78         { USB_DEVICE(0x0CF3, 0x3008) },
  79         { USB_DEVICE(0x0CF3, 0x311D) },
  80         { USB_DEVICE(0x0CF3, 0x817a) },
  81         { USB_DEVICE(0x13d3, 0x3375) },
  82         { USB_DEVICE(0x04CA, 0x3004) },
  83         { USB_DEVICE(0x04CA, 0x3005) },
  84         { USB_DEVICE(0x04CA, 0x3006) },
  85         { USB_DEVICE(0x04CA, 0x3007) },
  86         { USB_DEVICE(0x04CA, 0x3008) },
  87         { USB_DEVICE(0x13d3, 0x3362) },
  88         { USB_DEVICE(0x0CF3, 0xE004) },
  89         { USB_DEVICE(0x0CF3, 0xE005) },
  90         { USB_DEVICE(0x0930, 0x0219) },
  91         { USB_DEVICE(0x0489, 0xe057) },
  92         { USB_DEVICE(0x13d3, 0x3393) },
  93         { USB_DEVICE(0x0489, 0xe04e) },
  94         { USB_DEVICE(0x0489, 0xe056) },
  95         { USB_DEVICE(0x0489, 0xe04d) },
  96         { USB_DEVICE(0x04c5, 0x1330) },
  97         { USB_DEVICE(0x13d3, 0x3402) },
  98         { USB_DEVICE(0x0cf3, 0x3121) },
  99         { USB_DEVICE(0x0cf3, 0xe003) },
 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
 144         /* Atheros AR5BBU22 with sflash firmware */
 145         { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
 146         { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
 147
 148         { }     /* Terminating entry */
 149 };
 150
 151 #define USB_REQ_DFU_DNLOAD      1
 152 #define BULK_SIZE               4096
 153 #define FW_HDR_SIZE             20
 154 #define TIMEGAP_USEC_MIN        50
 155 #define TIMEGAP_USEC_MAX        100
 156
 157 static int ath3k_load_firmware(struct usb_device *udev,
 158                                 const struct firmware *firmware)
 159 {
 160         u8 *send_buf;
 161         int err, pipe, len, size, sent = 0;
 162         int count = firmware->size;
 163
 164         BT_DBG("udev %p", udev);
 165
 166         pipe = usb_sndctrlpipe(udev, 0);
 167
 168         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
 169         if (!send_buf) {
 170                 BT_ERR("Can't allocate memory chunk for firmware");
 171                 return -ENOMEM;
 172         }
 173
 174         memcpy(send_buf, firmware->data, 20);
 175         if ((err = usb_control_msg(udev, pipe,
 176                                 USB_REQ_DFU_DNLOAD,
 177                                 USB_TYPE_VENDOR, 0, 0,
 178                                 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
 179                 BT_ERR("Can't change to loading configuration err");
 180                 goto error;
 181         }
 182         sent += 20;
 183         count -= 20;
 184
 185         while (count) {
 186                 /* workaround the compatibility issue with xHCI controller*/
 187                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
 188
 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 ret, pipe = 0;
 214         char *buf;
 215
 216         buf = kmalloc(sizeof(*buf), GFP_KERNEL);
 217         if (!buf)
 218                 return -ENOMEM;
 219
 220         pipe = usb_rcvctrlpipe(udev, 0);
 221         ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
 222                               USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
 223                               buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);
 224
 225         *state = *buf;
 226         kfree(buf);
 227
 228         return ret;
 229 }
 230
 231 static int ath3k_get_version(struct usb_device *udev,
 232                         struct ath3k_version *version)
 233 {
 234         int ret, pipe = 0;
 235         struct ath3k_version *buf;
 236         const int size = sizeof(*buf);
 237
 238         buf = kmalloc(size, GFP_KERNEL);
 239         if (!buf)
 240                 return -ENOMEM;
 241
 242         pipe = usb_rcvctrlpipe(udev, 0);
 243         ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
 244                               USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
 245                               buf, size, USB_CTRL_SET_TIMEOUT);
 246
 247         memcpy(version, buf, size);
 248         kfree(buf);
 249
 250         return ret;
 251 }
 252
 253 static int ath3k_load_fwfile(struct usb_device *udev,
 254                 const struct firmware *firmware)
 255 {
 256         u8 *send_buf;
 257         int err, pipe, len, size, count, sent = 0;
 258         int ret;
 259
 260         count = firmware->size;
 261
 262         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
 263         if (!send_buf) {
 264                 BT_ERR("Can't allocate memory chunk for firmware");
 265                 return -ENOMEM;
 266         }
 267
 268         size = min_t(uint, count, FW_HDR_SIZE);
 269         memcpy(send_buf, firmware->data, size);
 270
 271         pipe = usb_sndctrlpipe(udev, 0);
 272         ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
 273                         USB_TYPE_VENDOR, 0, 0, send_buf,
 274                         size, USB_CTRL_SET_TIMEOUT);
 275         if (ret < 0) {
 276                 BT_ERR("Can't change to loading configuration err");
 277                 kfree(send_buf);
 278                 return ret;
 279         }
 280
 281         sent += size;
 282         count -= size;
 283
 284         while (count) {
 285                 /* workaround the compatibility issue with xHCI controller*/
 286                 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);
 287
 288                 size = min_t(uint, count, BULK_SIZE);
 289                 pipe = usb_sndbulkpipe(udev, 0x02);
 290
 291                 memcpy(send_buf, firmware->data + sent, size);
 292
 293                 err = usb_bulk_msg(udev, pipe, send_buf, size,
 294                                         &len, 3000);
 295                 if (err || (len != size)) {
 296                         BT_ERR("Error in firmware loading err = %d,"
 297                                 "len = %d, size = %d", err, len, size);
 298                         kfree(send_buf);
 299                         return err;
 300                 }
 301                 sent  += size;
 302                 count -= size;
 303         }
 304
 305         kfree(send_buf);
 306         return 0;
 307 }
 308
 309 static int ath3k_switch_pid(struct usb_device *udev)
 310 {
 311         int pipe = 0;
 312
 313         pipe = usb_sndctrlpipe(udev, 0);
 314         return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
 315                         USB_TYPE_VENDOR, 0, 0,
 316                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 317 }
 318
 319 static int ath3k_set_normal_mode(struct usb_device *udev)
 320 {
 321         unsigned char fw_state;
 322         int pipe = 0, ret;
 323
 324         ret = ath3k_get_state(udev, &fw_state);
 325         if (ret < 0) {
 326                 BT_ERR("Can't get state to change to normal mode err");
 327                 return ret;
 328         }
 329
 330         if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
 331                 BT_DBG("firmware was already in normal mode");
 332                 return 0;
 333         }
 334
 335         pipe = usb_sndctrlpipe(udev, 0);
 336         return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
 337                         USB_TYPE_VENDOR, 0, 0,
 338                         NULL, 0, USB_CTRL_SET_TIMEOUT);
 339 }
 340
 341 static int ath3k_load_patch(struct usb_device *udev)
 342 {
 343         unsigned char fw_state;
 344         char filename[ATH3K_NAME_LEN] = {0};
 345         const struct firmware *firmware;
 346         struct ath3k_version fw_version, pt_version;
 347         int ret;
 348
 349         ret = ath3k_get_state(udev, &fw_state);
 350         if (ret < 0) {
 351                 BT_ERR("Can't get state to change to load ram patch err");
 352                 return ret;
 353         }
 354
 355         if (fw_state & ATH3K_PATCH_UPDATE) {
 356                 BT_DBG("Patch was already downloaded");
 357                 return 0;
 358         }
 359
 360         ret = ath3k_get_version(udev, &fw_version);
 361         if (ret < 0) {
 362                 BT_ERR("Can't get version to change to load ram patch err");
 363                 return ret;
 364         }
 365
 366         snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
 367                 fw_version.rom_version);
 368
 369         ret = request_firmware(&firmware, filename, &udev->dev);
 370         if (ret < 0) {
 371                 BT_ERR("Patch file not found %s", filename);
 372                 return ret;
 373         }
 374
 375         pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
 376         pt_version.build_version = *(int *)
 377                 (firmware->data + firmware->size - 4);
 378
 379         if ((pt_version.rom_version != fw_version.rom_version) ||
 380                 (pt_version.build_version <= fw_version.build_version)) {
 381                 BT_ERR("Patch file version did not match with firmware");
 382                 release_firmware(firmware);
 383                 return -EINVAL;
 384         }
 385
 386         ret = ath3k_load_fwfile(udev, firmware);
 387         release_firmware(firmware);
 388
 389         return ret;
 390 }
 391
 392 static int ath3k_load_syscfg(struct usb_device *udev)
 393 {
 394         unsigned char fw_state;
 395         char filename[ATH3K_NAME_LEN] = {0};
 396         const struct firmware *firmware;
 397         struct ath3k_version fw_version;
 398         int clk_value, ret;
 399
 400         ret = ath3k_get_state(udev, &fw_state);
 401         if (ret < 0) {
 402                 BT_ERR("Can't get state to change to load configuration err");
 403                 return -EBUSY;
 404         }
 405
 406         ret = ath3k_get_version(udev, &fw_version);
 407         if (ret < 0) {
 408                 BT_ERR("Can't get version to change to load ram patch err");
 409                 return ret;
 410         }
 411
 412         switch (fw_version.ref_clock) {
 413
 414         case ATH3K_XTAL_FREQ_26M:
 415                 clk_value = 26;
 416                 break;
 417         case ATH3K_XTAL_FREQ_40M:
 418                 clk_value = 40;
 419                 break;
 420         case ATH3K_XTAL_FREQ_19P2:
 421                 clk_value = 19;
 422                 break;
 423         default:
 424                 clk_value = 0;
 425                 break;
 426         }
 427
 428         snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
 429                 fw_version.rom_version, clk_value, ".dfu");
 430
 431         ret = request_firmware(&firmware, filename, &udev->dev);
 432         if (ret < 0) {
 433                 BT_ERR("Configuration file not found %s", filename);
 434                 return ret;
 435         }
 436
 437         ret = ath3k_load_fwfile(udev, firmware);
 438         release_firmware(firmware);
 439
 440         return ret;
 441 }
 442
 443 static int ath3k_probe(struct usb_interface *intf,
 444                         const struct usb_device_id *id)
 445 {
 446         const struct firmware *firmware;
 447         struct usb_device *udev = interface_to_usbdev(intf);
 448         int ret;
 449
 450         BT_DBG("intf %p id %p", intf, id);
 451
 452         if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
 453                 return -ENODEV;
 454
 455         /* match device ID in ath3k blacklist table */
 456         if (!id->driver_info) {
 457                 const struct usb_device_id *match;
 458                 match = usb_match_id(intf, ath3k_blist_tbl);
 459                 if (match)
 460                         id = match;
 461         }
 462
 463         /* load patch and sysconfig files for AR3012 */
 464         if (id->driver_info & BTUSB_ATH3012) {
 465
 466                 /* New firmware with patch and sysconfig files already loaded */
 467                 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
 468                         return -ENODEV;
 469
 470                 ret = ath3k_load_patch(udev);
 471                 if (ret < 0) {
 472                         BT_ERR("Loading patch file failed");
 473                         return ret;
 474                 }
 475                 ret = ath3k_load_syscfg(udev);
 476                 if (ret < 0) {
 477                         BT_ERR("Loading sysconfig file failed");
 478                         return ret;
 479                 }
 480                 ret = ath3k_set_normal_mode(udev);
 481                 if (ret < 0) {
 482                         BT_ERR("Set normal mode failed");
 483                         return ret;
 484                 }
 485                 ath3k_switch_pid(udev);
 486                 return 0;
 487         }
 488
 489         ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
 490         if (ret < 0) {
 491                 if (ret == -ENOENT)
 492                         BT_ERR("Firmware file \"%s\" not found",
 493                                                         ATH3K_FIRMWARE);
 494                 else
 495                         BT_ERR("Firmware file \"%s\" request failed (err=%d)",
 496                                                         ATH3K_FIRMWARE, ret);
 497                 return ret;
 498         }
 499
 500         ret = ath3k_load_firmware(udev, firmware);
 501         release_firmware(firmware);
 502
 503         return ret;
 504 }
 505
 506 static void ath3k_disconnect(struct usb_interface *intf)
 507 {
 508         BT_DBG("ath3k_disconnect intf %p", intf);
 509 }
 510
 511 static struct usb_driver ath3k_driver = {
 512         .name           = "ath3k",
 513         .probe          = ath3k_probe,
 514         .disconnect     = ath3k_disconnect,
 515         .id_table       = ath3k_table,
 516         .disable_hub_initiated_lpm = 1,
 517 };
 518
 519 module_usb_driver(ath3k_driver);
 520
 521 MODULE_AUTHOR("Atheros Communications");
 522 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
 523 MODULE_VERSION(VERSION);
 524 MODULE_LICENSE("GPL");
 525 MODULE_FIRMWARE(ATH3K_FIRMWARE);