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