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