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