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