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