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