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