[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 <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 {
	unsigned int	rom_version;
	unsigned int	build_version;
	unsigned int	ram_version;
	unsigned char	ref_clock;
	unsigned char	reserved[0x07];
};

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

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

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

	/* Atheros AR3012 with sflash firmware*/
	{ USB_DEVICE(0x0CF3, 0x0036) },
	{ USB_DEVICE(0x0CF3, 0x3004) },
	{ USB_DEVICE(0x0CF3, 0x3008) },
	{ USB_DEVICE(0x0CF3, 0x311D) },
	{ USB_DEVICE(0x0CF3, 0x817a) },
	{ USB_DEVICE(0x13d3, 0x3375) },
	{ USB_DEVICE(0x04CA, 0x3004) },
	{ USB_DEVICE(0x04CA, 0x3005) },
	{ USB_DEVICE(0x04CA, 0x3006) },
	{ USB_DEVICE(0x04CA, 0x3008) },
	{ USB_DEVICE(0x13d3, 0x3362) },
	{ USB_DEVICE(0x0CF3, 0xE004) },
	{ USB_DEVICE(0x0930, 0x0219) },
	{ USB_DEVICE(0x0489, 0xe057) },
	{ USB_DEVICE(0x13d3, 0x3393) },
	{ USB_DEVICE(0x0489, 0xe04e) },
	{ USB_DEVICE(0x0489, 0xe056) },
	{ USB_DEVICE(0x0489, 0xe04d) },
	{ USB_DEVICE(0x04c5, 0x1330) },
	{ USB_DEVICE(0x13d3, 0x3402) },
	{ USB_DEVICE(0x0cf3, 0x3121) },
	{ USB_DEVICE(0x0cf3, 0xe003) },

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

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

	{ }	/* Terminating entry */
};

MODULE_DEVICE_TABLE(usb, ath3k_table);

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

	/* Atheros AR3012 with sflash firmware*/
	{ 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, 0x817a), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3375), .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, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },

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

	{ }	/* Terminating entry */
};

#define USB_REQ_DFU_DNLOAD	1
#define BULK_SIZE		4096
#define FW_HDR_SIZE		20

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

	while (count) {
		size = min_t(uint, count, BULK_SIZE);
		pipe = usb_sndbulkpipe(udev, 0x02);
		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;

	while (count) {
		size = min_t(uint, count, BULK_SIZE);
		pipe = usb_sndbulkpipe(udev, 0x02);

		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, pt_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",
		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_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
	pt_version.build_version = *(int *)
		(firmware->data + firmware->size - 4);

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