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