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