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