[deliverable/linux.git] / drivers / bluetooth / ath3k.c

/*
 * Copyright (c) 2008-2009 Atheros Communications Inc.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/errno.h>
#include <linux/device.h>
#include <linux/firmware.h>
#include <linux/usb.h>
#include <asm/unaligned.h>
#include <net/bluetooth/bluetooth.h>

#define VERSION "1.0"
#define ATH3K_FIRMWARE	"ath3k-1.fw"

#define ATH3K_DNLOAD				0x01
#define ATH3K_GETSTATE				0x05
#define ATH3K_SET_NORMAL_MODE			0x07
#define ATH3K_GETVERSION			0x09
#define USB_REG_SWITCH_VID_PID			0x0a

#define ATH3K_MODE_MASK				0x3F
#define ATH3K_NORMAL_MODE			0x0E

#define ATH3K_PATCH_UPDATE			0x80
#define ATH3K_SYSCFG_UPDATE			0x40

#define ATH3K_XTAL_FREQ_26M			0x00
#define ATH3K_XTAL_FREQ_40M			0x01
#define ATH3K_XTAL_FREQ_19P2			0x02
#define ATH3K_NAME_LEN				0xFF

struct ath3k_version {
	__le32	rom_version;
	__le32	build_version;
	__le32	ram_version;
	__u8	ref_clock;
	__u8	reserved[7];
} __packed;

static const struct usb_device_id ath3k_table[] = {
	/* Atheros AR3011 */
	{ USB_DEVICE(0x0CF3, 0x3000) },

	/* Atheros AR3011 with sflash firmware*/
	{ USB_DEVICE(0x0489, 0xE027) },
	{ USB_DEVICE(0x0489, 0xE03D) },
	{ USB_DEVICE(0x04F2, 0xAFF1) },
	{ USB_DEVICE(0x0930, 0x0215) },
	{ USB_DEVICE(0x0CF3, 0x3002) },
	{ USB_DEVICE(0x0CF3, 0xE019) },
	{ USB_DEVICE(0x13d3, 0x3304) },

	/* Atheros AR9285 Malbec with sflash firmware */
	{ USB_DEVICE(0x03F0, 0x311D) },

	/* Atheros AR3012 with sflash firmware*/
	{ USB_DEVICE(0x0489, 0xe04d) },
	{ USB_DEVICE(0x0489, 0xe04e) },
	{ USB_DEVICE(0x0489, 0xe057) },
	{ USB_DEVICE(0x0489, 0xe056) },
	{ USB_DEVICE(0x0489, 0xe05f) },
	{ USB_DEVICE(0x0489, 0xe078) },
	{ USB_DEVICE(0x04c5, 0x1330) },
	{ USB_DEVICE(0x04CA, 0x3004) },
	{ USB_DEVICE(0x04CA, 0x3005) },
	{ USB_DEVICE(0x04CA, 0x3006) },
	{ USB_DEVICE(0x04CA, 0x3007) },
	{ USB_DEVICE(0x04CA, 0x3008) },
	{ USB_DEVICE(0x04CA, 0x300b) },
	{ USB_DEVICE(0x04CA, 0x3010) },
	{ USB_DEVICE(0x0930, 0x0219) },
	{ USB_DEVICE(0x0930, 0x0220) },
	{ USB_DEVICE(0x0930, 0x0227) },
	{ USB_DEVICE(0x0b05, 0x17d0) },
	{ USB_DEVICE(0x0CF3, 0x0036) },
	{ USB_DEVICE(0x0CF3, 0x3004) },
	{ USB_DEVICE(0x0CF3, 0x3008) },
	{ USB_DEVICE(0x0CF3, 0x311D) },
	{ USB_DEVICE(0x0CF3, 0x311E) },
	{ USB_DEVICE(0x0CF3, 0x311F) },
	{ USB_DEVICE(0x0cf3, 0x3121) },
	{ USB_DEVICE(0x0CF3, 0x817a) },
	{ USB_DEVICE(0x0cf3, 0xe003) },
	{ USB_DEVICE(0x0CF3, 0xE004) },
	{ USB_DEVICE(0x0CF3, 0xE005) },
	{ USB_DEVICE(0x13d3, 0x3362) },
	{ USB_DEVICE(0x13d3, 0x3375) },
	{ USB_DEVICE(0x13d3, 0x3393) },
	{ USB_DEVICE(0x13d3, 0x3402) },
	{ USB_DEVICE(0x13d3, 0x3408) },
	{ USB_DEVICE(0x13d3, 0x3423) },
	{ USB_DEVICE(0x13d3, 0x3432) },

	/* Atheros AR5BBU12 with sflash firmware */
	{ USB_DEVICE(0x0489, 0xE02C) },

	/* Atheros AR5BBU22 with sflash firmware */
	{ USB_DEVICE(0x0489, 0xE036) },
	{ USB_DEVICE(0x0489, 0xE03C) },

	{ }	/* Terminating entry */
};

MODULE_DEVICE_TABLE(usb, ath3k_table);

#define BTUSB_ATH3012		0x80
/* This table is to load patch and sysconfig files
 * for AR3012 */
static const struct usb_device_id ath3k_blist_tbl[] = {

	/* Atheros AR3012 with sflash firmware*/
	{ USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe078), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3007), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0b05, 0x17d0), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3432), .driver_info = BTUSB_ATH3012 },

	/* Atheros AR5BBU22 with sflash firmware */
	{ USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },

	{ }	/* Terminating entry */
};

#define USB_REQ_DFU_DNLOAD	1
#define BULK_SIZE		4096
#define FW_HDR_SIZE		20
#define TIMEGAP_USEC_MIN	50
#define TIMEGAP_USEC_MAX	100

static int ath3k_load_firmware(struct usb_device *udev,
				const struct firmware *firmware)
{
	u8 *send_buf;
	int err, pipe, len, size, sent = 0;
	int count = firmware->size;

	BT_DBG("udev %p", udev);

	pipe = usb_sndctrlpipe(udev, 0);

	send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
	if (!send_buf) {
		BT_ERR("Can't allocate memory chunk for firmware");
		return -ENOMEM;
	}

	memcpy(send_buf, firmware->data, 20);
	err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
			      0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
	if (err < 0) {
		BT_ERR("Can't change to loading configuration err");
		goto error;
	}
	sent += 20;
	count -= 20;

	pipe = usb_sndbulkpipe(udev, 0x02);

	while (count) {
		/* workaround the compatibility issue with xHCI controller*/
		usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);

		size = min_t(uint, count, BULK_SIZE);
		memcpy(send_buf, firmware->data + sent, size);

		err = usb_bulk_msg(udev, pipe, send_buf, size,
					&len, 3000);

		if (err || (len != size)) {
			BT_ERR("Error in firmware loading err = %d,"
				"len = %d, size = %d", err, len, size);
			goto error;
		}

		sent  += size;
		count -= size;
	}

error:
	kfree(send_buf);
	return err;
}

static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
{
	int ret, pipe = 0;
	char *buf;

	buf = kmalloc(sizeof(*buf), GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	pipe = usb_rcvctrlpipe(udev, 0);
	ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
			      USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
			      buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);

	*state = *buf;
	kfree(buf);

	return ret;
}

static int ath3k_get_version(struct usb_device *udev,
			struct ath3k_version *version)
{
	int ret, pipe = 0;
	struct ath3k_version *buf;
	const int size = sizeof(*buf);

	buf = kmalloc(size, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	pipe = usb_rcvctrlpipe(udev, 0);
	ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
			      USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
			      buf, size, USB_CTRL_SET_TIMEOUT);

	memcpy(version, buf, size);
	kfree(buf);

	return ret;
}

static int ath3k_load_fwfile(struct usb_device *udev,
		const struct firmware *firmware)
{
	u8 *send_buf;
	int err, pipe, len, size, count, sent = 0;
	int ret;

	count = firmware->size;

	send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
	if (!send_buf) {
		BT_ERR("Can't allocate memory chunk for firmware");
		return -ENOMEM;
	}

	size = min_t(uint, count, FW_HDR_SIZE);
	memcpy(send_buf, firmware->data, size);

	pipe = usb_sndctrlpipe(udev, 0);
	ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
			USB_TYPE_VENDOR, 0, 0, send_buf,
			size, USB_CTRL_SET_TIMEOUT);
	if (ret < 0) {
		BT_ERR("Can't change to loading configuration err");
		kfree(send_buf);
		return ret;
	}

	sent += size;
	count -= size;

	pipe = usb_sndbulkpipe(udev, 0x02);

	while (count) {
		/* workaround the compatibility issue with xHCI controller*/
		usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);

		size = min_t(uint, count, BULK_SIZE);
		memcpy(send_buf, firmware->data + sent, size);

		err = usb_bulk_msg(udev, pipe, send_buf, size,
					&len, 3000);
		if (err || (len != size)) {
			BT_ERR("Error in firmware loading err = %d,"
				"len = %d, size = %d", err, len, size);
			kfree(send_buf);
			return err;
		}
		sent  += size;
		count -= size;
	}

	kfree(send_buf);
	return 0;
}

static int ath3k_switch_pid(struct usb_device *udev)
{
	int pipe = 0;

	pipe = usb_sndctrlpipe(udev, 0);
	return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
			USB_TYPE_VENDOR, 0, 0,
			NULL, 0, USB_CTRL_SET_TIMEOUT);
}

static int ath3k_set_normal_mode(struct usb_device *udev)
{
	unsigned char fw_state;
	int pipe = 0, ret;

	ret = ath3k_get_state(udev, &fw_state);
	if (ret < 0) {
		BT_ERR("Can't get state to change to normal mode err");
		return ret;
	}

	if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
		BT_DBG("firmware was already in normal mode");
		return 0;
	}

	pipe = usb_sndctrlpipe(udev, 0);
	return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
			USB_TYPE_VENDOR, 0, 0,
			NULL, 0, USB_CTRL_SET_TIMEOUT);
}

static int ath3k_load_patch(struct usb_device *udev)
{
	unsigned char fw_state;
	char filename[ATH3K_NAME_LEN] = {0};
	const struct firmware *firmware;
	struct ath3k_version fw_version;
	__u32 pt_rom_version, pt_build_version;
	int ret;

	ret = ath3k_get_state(udev, &fw_state);
	if (ret < 0) {
		BT_ERR("Can't get state to change to load ram patch err");
		return ret;
	}

	if (fw_state & ATH3K_PATCH_UPDATE) {
		BT_DBG("Patch was already downloaded");
		return 0;
	}

	ret = ath3k_get_version(udev, &fw_version);
	if (ret < 0) {
		BT_ERR("Can't get version to change to load ram patch err");
		return ret;
	}

	snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
		 le32_to_cpu(fw_version.rom_version));

	ret = request_firmware(&firmware, filename, &udev->dev);
	if (ret < 0) {
		BT_ERR("Patch file not found %s", filename);
		return ret;
	}

	pt_rom_version = get_unaligned_le32(firmware->data +
					    firmware->size - 8);
	pt_build_version = get_unaligned_le32(firmware->data +
					      firmware->size - 4);

	if (pt_rom_version != le32_to_cpu(fw_version.rom_version) ||
	    pt_build_version <= le32_to_cpu(fw_version.build_version)) {
		BT_ERR("Patch file version did not match with firmware");
		release_firmware(firmware);
		return -EINVAL;
	}

	ret = ath3k_load_fwfile(udev, firmware);
	release_firmware(firmware);

	return ret;
}

static int ath3k_load_syscfg(struct usb_device *udev)
{
	unsigned char fw_state;
	char filename[ATH3K_NAME_LEN] = {0};
	const struct firmware *firmware;
	struct ath3k_version fw_version;
	int clk_value, ret;

	ret = ath3k_get_state(udev, &fw_state);
	if (ret < 0) {
		BT_ERR("Can't get state to change to load configuration err");
		return -EBUSY;
	}

	ret = ath3k_get_version(udev, &fw_version);
	if (ret < 0) {
		BT_ERR("Can't get version to change to load ram patch err");
		return ret;
	}

	switch (fw_version.ref_clock) {

	case ATH3K_XTAL_FREQ_26M:
		clk_value = 26;
		break;
	case ATH3K_XTAL_FREQ_40M:
		clk_value = 40;
		break;
	case ATH3K_XTAL_FREQ_19P2:
		clk_value = 19;
		break;
	default:
		clk_value = 0;
		break;
	}

	snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
		le32_to_cpu(fw_version.rom_version), clk_value, ".dfu");

	ret = request_firmware(&firmware, filename, &udev->dev);
	if (ret < 0) {
		BT_ERR("Configuration file not found %s", filename);
		return ret;
	}

	ret = ath3k_load_fwfile(udev, firmware);
	release_firmware(firmware);

	return ret;
}

static int ath3k_probe(struct usb_interface *intf,
			const struct usb_device_id *id)
{
	const struct firmware *firmware;
	struct usb_device *udev = interface_to_usbdev(intf);
	int ret;

	BT_DBG("intf %p id %p", intf, id);

	if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
		return -ENODEV;

	/* match device ID in ath3k blacklist table */
	if (!id->driver_info) {
		const struct usb_device_id *match;
		match = usb_match_id(intf, ath3k_blist_tbl);
		if (match)
			id = match;
	}

	/* load patch and sysconfig files for AR3012 */
	if (id->driver_info & BTUSB_ATH3012) {

		/* New firmware with patch and sysconfig files already loaded */
		if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
			return -ENODEV;

		ret = ath3k_load_patch(udev);
		if (ret < 0) {
			BT_ERR("Loading patch file failed");
			return ret;
		}
		ret = ath3k_load_syscfg(udev);
		if (ret < 0) {
			BT_ERR("Loading sysconfig file failed");
			return ret;
		}
		ret = ath3k_set_normal_mode(udev);
		if (ret < 0) {
			BT_ERR("Set normal mode failed");
			return ret;
		}
		ath3k_switch_pid(udev);
		return 0;
	}

	ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
	if (ret < 0) {
		if (ret == -ENOENT)
			BT_ERR("Firmware file \"%s\" not found",
							ATH3K_FIRMWARE);
		else
			BT_ERR("Firmware file \"%s\" request failed (err=%d)",
							ATH3K_FIRMWARE, ret);
		return ret;
	}

	ret = ath3k_load_firmware(udev, firmware);
	release_firmware(firmware);

	return ret;
}

static void ath3k_disconnect(struct usb_interface *intf)
{
	BT_DBG("ath3k_disconnect intf %p", intf);
}

static struct usb_driver ath3k_driver = {
	.name		= "ath3k",
	.probe		= ath3k_probe,
	.disconnect	= ath3k_disconnect,
	.id_table	= ath3k_table,
	.disable_hub_initiated_lpm = 1,
};

module_usb_driver(ath3k_driver);

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