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