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