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