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