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