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