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