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