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