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