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