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