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