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