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