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