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