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