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 <asm/unaligned.h> 31 #include <net/bluetooth/bluetooth.h> 32 33 #define VERSION "1.0" 34 #define ATH3K_FIRMWARE "ath3k-1.fw" 35 36 #define ATH3K_DNLOAD 0x01 37 #define ATH3K_GETSTATE 0x05 38 #define ATH3K_SET_NORMAL_MODE 0x07 39 #define ATH3K_GETVERSION 0x09 40 #define USB_REG_SWITCH_VID_PID 0x0a 41 42 #define ATH3K_MODE_MASK 0x3F 43 #define ATH3K_NORMAL_MODE 0x0E 44 45 #define ATH3K_PATCH_UPDATE 0x80 46 #define ATH3K_SYSCFG_UPDATE 0x40 47 48 #define ATH3K_XTAL_FREQ_26M 0x00 49 #define ATH3K_XTAL_FREQ_40M 0x01 50 #define ATH3K_XTAL_FREQ_19P2 0x02 51 #define ATH3K_NAME_LEN 0xFF 52 53 struct ath3k_version { 54 __le32 rom_version; 55 __le32 build_version; 56 __le32 ram_version; 57 __u8 ref_clock; 58 __u8 reserved[7]; 59 } __packed; 60 61 static const struct usb_device_id ath3k_table[] = { 62 /* Atheros AR3011 */ 63 { USB_DEVICE(0x0CF3, 0x3000) }, 64 65 /* Atheros AR3011 with sflash firmware*/ 66 { USB_DEVICE(0x0489, 0xE027) }, 67 { USB_DEVICE(0x0489, 0xE03D) }, 68 { USB_DEVICE(0x04F2, 0xAFF1) }, 69 { USB_DEVICE(0x0930, 0x0215) }, 70 { USB_DEVICE(0x0CF3, 0x3002) }, 71 { USB_DEVICE(0x0CF3, 0xE019) }, 72 { USB_DEVICE(0x13d3, 0x3304) }, 73 74 /* Atheros AR9285 Malbec with sflash firmware */ 75 { USB_DEVICE(0x03F0, 0x311D) }, 76 77 /* Atheros AR3012 with sflash firmware*/ 78 { USB_DEVICE(0x0489, 0xe04d) }, 79 { USB_DEVICE(0x0489, 0xe04e) }, 80 { USB_DEVICE(0x0489, 0xe057) }, 81 { USB_DEVICE(0x0489, 0xe056) }, 82 { USB_DEVICE(0x0489, 0xe05f) }, 83 { USB_DEVICE(0x0489, 0xe076) }, 84 { USB_DEVICE(0x0489, 0xe078) }, 85 { USB_DEVICE(0x04c5, 0x1330) }, 86 { USB_DEVICE(0x04CA, 0x3004) }, 87 { USB_DEVICE(0x04CA, 0x3005) }, 88 { USB_DEVICE(0x04CA, 0x3006) }, 89 { USB_DEVICE(0x04CA, 0x3007) }, 90 { USB_DEVICE(0x04CA, 0x3008) }, 91 { USB_DEVICE(0x04CA, 0x300b) }, 92 { USB_DEVICE(0x04CA, 0x300d) }, 93 { USB_DEVICE(0x04CA, 0x300f) }, 94 { USB_DEVICE(0x04CA, 0x3010) }, 95 { USB_DEVICE(0x0930, 0x0219) }, 96 { USB_DEVICE(0x0930, 0x021c) }, 97 { USB_DEVICE(0x0930, 0x0220) }, 98 { USB_DEVICE(0x0930, 0x0227) }, 99 { USB_DEVICE(0x0b05, 0x17d0) }, 100 { USB_DEVICE(0x0CF3, 0x0036) }, 101 { USB_DEVICE(0x0CF3, 0x3004) }, 102 { USB_DEVICE(0x0CF3, 0x3008) }, 103 { USB_DEVICE(0x0CF3, 0x311D) }, 104 { USB_DEVICE(0x0CF3, 0x311E) }, 105 { USB_DEVICE(0x0CF3, 0x311F) }, 106 { USB_DEVICE(0x0cf3, 0x3121) }, 107 { USB_DEVICE(0x0CF3, 0x817a) }, 108 { USB_DEVICE(0x0CF3, 0x817b) }, 109 { USB_DEVICE(0x0cf3, 0xe003) }, 110 { USB_DEVICE(0x0CF3, 0xE004) }, 111 { USB_DEVICE(0x0CF3, 0xE005) }, 112 { USB_DEVICE(0x0CF3, 0xE006) }, 113 { USB_DEVICE(0x13d3, 0x3362) }, 114 { USB_DEVICE(0x13d3, 0x3375) }, 115 { USB_DEVICE(0x13d3, 0x3393) }, 116 { USB_DEVICE(0x13d3, 0x3402) }, 117 { USB_DEVICE(0x13d3, 0x3408) }, 118 { USB_DEVICE(0x13d3, 0x3423) }, 119 { USB_DEVICE(0x13d3, 0x3432) }, 120 { USB_DEVICE(0x13d3, 0x3474) }, 121 122 /* Atheros AR5BBU12 with sflash firmware */ 123 { USB_DEVICE(0x0489, 0xE02C) }, 124 125 /* Atheros AR5BBU22 with sflash firmware */ 126 { USB_DEVICE(0x0489, 0xE036) }, 127 { USB_DEVICE(0x0489, 0xE03C) }, 128 129 { } /* Terminating entry */ 130 }; 131 132 MODULE_DEVICE_TABLE(usb, ath3k_table); 133 134 #define BTUSB_ATH3012 0x80 135 /* This table is to load patch and sysconfig files 136 * for AR3012 */ 137 static const struct usb_device_id ath3k_blist_tbl[] = { 138 139 /* Atheros AR3012 with sflash firmware*/ 140 { USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 }, 141 { USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 }, 142 { USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 }, 143 { USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 }, 144 { USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 }, 145 { USB_DEVICE(0x0489, 0xe076), .driver_info = BTUSB_ATH3012 }, 146 { USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 }, 147 { USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 }, 148 { USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 }, 149 { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 }, 150 { USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 }, 151 { USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 }, 152 { USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 }, 153 { USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 }, 154 { USB_DEVICE(0x04ca, 0x300d), .driver_info = BTUSB_ATH3012 }, 155 { USB_DEVICE(0x04ca, 0x300f), .driver_info = BTUSB_ATH3012 }, 156 { USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 }, 157 { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 }, 158 { USB_DEVICE(0x0930, 0x021c), .driver_info = BTUSB_ATH3012 }, 159 { USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 }, 160 { USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 }, 161 { USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 }, 162 { USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 }, 163 { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 }, 164 { USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 }, 165 { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 }, 166 { USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 }, 167 { USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 }, 168 { USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 }, 169 { USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 }, 170 { USB_DEVICE(0x0CF3, 0x817b), .driver_info = BTUSB_ATH3012 }, 171 { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 }, 172 { USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 }, 173 { USB_DEVICE(0x0cf3, 0xe006), .driver_info = BTUSB_ATH3012 }, 174 { USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 }, 175 { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 }, 176 { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 }, 177 { USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 }, 178 { USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 }, 179 { USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 }, 180 { USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 }, 181 { USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 }, 182 { USB_DEVICE(0x13d3, 0x3474), .driver_info = BTUSB_ATH3012 }, 183 184 /* Atheros AR5BBU22 with sflash firmware */ 185 { USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 }, 186 { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 }, 187 188 { } /* Terminating entry */ 189 }; 190 191 #define USB_REQ_DFU_DNLOAD 1 192 #define BULK_SIZE 4096 193 #define FW_HDR_SIZE 20 194 #define TIMEGAP_USEC_MIN 50 195 #define TIMEGAP_USEC_MAX 100 196 197 static int ath3k_load_firmware(struct usb_device *udev, 198 const struct firmware *firmware) 199 { 200 u8 *send_buf; 201 int err, pipe, len, size, sent = 0; 202 int count = firmware->size; 203 204 BT_DBG("udev %p", udev); 205 206 pipe = usb_sndctrlpipe(udev, 0); 207 208 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL); 209 if (!send_buf) { 210 BT_ERR("Can't allocate memory chunk for firmware"); 211 return -ENOMEM; 212 } 213 214 memcpy(send_buf, firmware->data, 20); 215 err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR, 216 0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT); 217 if (err < 0) { 218 BT_ERR("Can't change to loading configuration err"); 219 goto error; 220 } 221 sent += 20; 222 count -= 20; 223 224 pipe = usb_sndbulkpipe(udev, 0x02); 225 226 while (count) { 227 /* workaround the compatibility issue with xHCI controller*/ 228 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX); 229 230 size = min_t(uint, count, BULK_SIZE); 231 memcpy(send_buf, firmware->data + sent, size); 232 233 err = usb_bulk_msg(udev, pipe, send_buf, size, 234 &len, 3000); 235 236 if (err || (len != size)) { 237 BT_ERR("Error in firmware loading err = %d," 238 "len = %d, size = %d", err, len, size); 239 goto error; 240 } 241 242 sent += size; 243 count -= size; 244 } 245 246 error: 247 kfree(send_buf); 248 return err; 249 } 250 251 static int ath3k_get_state(struct usb_device *udev, unsigned char *state) 252 { 253 int ret, pipe = 0; 254 char *buf; 255 256 buf = kmalloc(sizeof(*buf), GFP_KERNEL); 257 if (!buf) 258 return -ENOMEM; 259 260 pipe = usb_rcvctrlpipe(udev, 0); 261 ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE, 262 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, 263 buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT); 264 265 *state = *buf; 266 kfree(buf); 267 268 return ret; 269 } 270 271 static int ath3k_get_version(struct usb_device *udev, 272 struct ath3k_version *version) 273 { 274 int ret, pipe = 0; 275 struct ath3k_version *buf; 276 const int size = sizeof(*buf); 277 278 buf = kmalloc(size, GFP_KERNEL); 279 if (!buf) 280 return -ENOMEM; 281 282 pipe = usb_rcvctrlpipe(udev, 0); 283 ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION, 284 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, 285 buf, size, USB_CTRL_SET_TIMEOUT); 286 287 memcpy(version, buf, size); 288 kfree(buf); 289 290 return ret; 291 } 292 293 static int ath3k_load_fwfile(struct usb_device *udev, 294 const struct firmware *firmware) 295 { 296 u8 *send_buf; 297 int err, pipe, len, size, count, sent = 0; 298 int ret; 299 300 count = firmware->size; 301 302 send_buf = kmalloc(BULK_SIZE, GFP_KERNEL); 303 if (!send_buf) { 304 BT_ERR("Can't allocate memory chunk for firmware"); 305 return -ENOMEM; 306 } 307 308 size = min_t(uint, count, FW_HDR_SIZE); 309 memcpy(send_buf, firmware->data, size); 310 311 pipe = usb_sndctrlpipe(udev, 0); 312 ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD, 313 USB_TYPE_VENDOR, 0, 0, send_buf, 314 size, USB_CTRL_SET_TIMEOUT); 315 if (ret < 0) { 316 BT_ERR("Can't change to loading configuration err"); 317 kfree(send_buf); 318 return ret; 319 } 320 321 sent += size; 322 count -= size; 323 324 pipe = usb_sndbulkpipe(udev, 0x02); 325 326 while (count) { 327 /* workaround the compatibility issue with xHCI controller*/ 328 usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX); 329 330 size = min_t(uint, count, BULK_SIZE); 331 memcpy(send_buf, firmware->data + sent, size); 332 333 err = usb_bulk_msg(udev, pipe, send_buf, size, 334 &len, 3000); 335 if (err || (len != size)) { 336 BT_ERR("Error in firmware loading err = %d," 337 "len = %d, size = %d", err, len, size); 338 kfree(send_buf); 339 return err; 340 } 341 sent += size; 342 count -= size; 343 } 344 345 kfree(send_buf); 346 return 0; 347 } 348 349 static int ath3k_switch_pid(struct usb_device *udev) 350 { 351 int pipe = 0; 352 353 pipe = usb_sndctrlpipe(udev, 0); 354 return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID, 355 USB_TYPE_VENDOR, 0, 0, 356 NULL, 0, USB_CTRL_SET_TIMEOUT); 357 } 358 359 static int ath3k_set_normal_mode(struct usb_device *udev) 360 { 361 unsigned char fw_state; 362 int pipe = 0, ret; 363 364 ret = ath3k_get_state(udev, &fw_state); 365 if (ret < 0) { 366 BT_ERR("Can't get state to change to normal mode err"); 367 return ret; 368 } 369 370 if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) { 371 BT_DBG("firmware was already in normal mode"); 372 return 0; 373 } 374 375 pipe = usb_sndctrlpipe(udev, 0); 376 return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE, 377 USB_TYPE_VENDOR, 0, 0, 378 NULL, 0, USB_CTRL_SET_TIMEOUT); 379 } 380 381 static int ath3k_load_patch(struct usb_device *udev) 382 { 383 unsigned char fw_state; 384 char filename[ATH3K_NAME_LEN] = {0}; 385 const struct firmware *firmware; 386 struct ath3k_version fw_version; 387 __u32 pt_rom_version, pt_build_version; 388 int ret; 389 390 ret = ath3k_get_state(udev, &fw_state); 391 if (ret < 0) { 392 BT_ERR("Can't get state to change to load ram patch err"); 393 return ret; 394 } 395 396 if (fw_state & ATH3K_PATCH_UPDATE) { 397 BT_DBG("Patch was already downloaded"); 398 return 0; 399 } 400 401 ret = ath3k_get_version(udev, &fw_version); 402 if (ret < 0) { 403 BT_ERR("Can't get version to change to load ram patch err"); 404 return ret; 405 } 406 407 snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu", 408 le32_to_cpu(fw_version.rom_version)); 409 410 ret = request_firmware(&firmware, filename, &udev->dev); 411 if (ret < 0) { 412 BT_ERR("Patch file not found %s", filename); 413 return ret; 414 } 415 416 pt_rom_version = get_unaligned_le32(firmware->data + 417 firmware->size - 8); 418 pt_build_version = get_unaligned_le32(firmware->data + 419 firmware->size - 4); 420 421 if (pt_rom_version != le32_to_cpu(fw_version.rom_version) || 422 pt_build_version <= le32_to_cpu(fw_version.build_version)) { 423 BT_ERR("Patch file version did not match with firmware"); 424 release_firmware(firmware); 425 return -EINVAL; 426 } 427 428 ret = ath3k_load_fwfile(udev, firmware); 429 release_firmware(firmware); 430 431 return ret; 432 } 433 434 static int ath3k_load_syscfg(struct usb_device *udev) 435 { 436 unsigned char fw_state; 437 char filename[ATH3K_NAME_LEN] = {0}; 438 const struct firmware *firmware; 439 struct ath3k_version fw_version; 440 int clk_value, ret; 441 442 ret = ath3k_get_state(udev, &fw_state); 443 if (ret < 0) { 444 BT_ERR("Can't get state to change to load configuration err"); 445 return -EBUSY; 446 } 447 448 ret = ath3k_get_version(udev, &fw_version); 449 if (ret < 0) { 450 BT_ERR("Can't get version to change to load ram patch err"); 451 return ret; 452 } 453 454 switch (fw_version.ref_clock) { 455 456 case ATH3K_XTAL_FREQ_26M: 457 clk_value = 26; 458 break; 459 case ATH3K_XTAL_FREQ_40M: 460 clk_value = 40; 461 break; 462 case ATH3K_XTAL_FREQ_19P2: 463 clk_value = 19; 464 break; 465 default: 466 clk_value = 0; 467 break; 468 } 469 470 snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s", 471 le32_to_cpu(fw_version.rom_version), clk_value, ".dfu"); 472 473 ret = request_firmware(&firmware, filename, &udev->dev); 474 if (ret < 0) { 475 BT_ERR("Configuration file not found %s", filename); 476 return ret; 477 } 478 479 ret = ath3k_load_fwfile(udev, firmware); 480 release_firmware(firmware); 481 482 return ret; 483 } 484 485 static int ath3k_probe(struct usb_interface *intf, 486 const struct usb_device_id *id) 487 { 488 const struct firmware *firmware; 489 struct usb_device *udev = interface_to_usbdev(intf); 490 int ret; 491 492 BT_DBG("intf %p id %p", intf, id); 493 494 if (intf->cur_altsetting->desc.bInterfaceNumber != 0) 495 return -ENODEV; 496 497 /* match device ID in ath3k blacklist table */ 498 if (!id->driver_info) { 499 const struct usb_device_id *match; 500 match = usb_match_id(intf, ath3k_blist_tbl); 501 if (match) 502 id = match; 503 } 504 505 /* load patch and sysconfig files for AR3012 */ 506 if (id->driver_info & BTUSB_ATH3012) { 507 508 /* New firmware with patch and sysconfig files already loaded */ 509 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001) 510 return -ENODEV; 511 512 ret = ath3k_load_patch(udev); 513 if (ret < 0) { 514 BT_ERR("Loading patch file failed"); 515 return ret; 516 } 517 ret = ath3k_load_syscfg(udev); 518 if (ret < 0) { 519 BT_ERR("Loading sysconfig file failed"); 520 return ret; 521 } 522 ret = ath3k_set_normal_mode(udev); 523 if (ret < 0) { 524 BT_ERR("Set normal mode failed"); 525 return ret; 526 } 527 ath3k_switch_pid(udev); 528 return 0; 529 } 530 531 ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev); 532 if (ret < 0) { 533 if (ret == -ENOENT) 534 BT_ERR("Firmware file \"%s\" not found", 535 ATH3K_FIRMWARE); 536 else 537 BT_ERR("Firmware file \"%s\" request failed (err=%d)", 538 ATH3K_FIRMWARE, ret); 539 return ret; 540 } 541 542 ret = ath3k_load_firmware(udev, firmware); 543 release_firmware(firmware); 544 545 return ret; 546 } 547 548 static void ath3k_disconnect(struct usb_interface *intf) 549 { 550 BT_DBG("ath3k_disconnect intf %p", intf); 551 } 552 553 static struct usb_driver ath3k_driver = { 554 .name = "ath3k", 555 .probe = ath3k_probe, 556 .disconnect = ath3k_disconnect, 557 .id_table = ath3k_table, 558 .disable_hub_initiated_lpm = 1, 559 }; 560 561 module_usb_driver(ath3k_driver); 562 563 MODULE_AUTHOR("Atheros Communications"); 564 MODULE_DESCRIPTION("Atheros AR30xx firmware driver"); 565 MODULE_VERSION(VERSION); 566 MODULE_LICENSE("GPL"); 567 MODULE_FIRMWARE(ATH3K_FIRMWARE); 568