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