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