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