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