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