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