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