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