[linux-2.6-block.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 const 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(0x0CF3, 0xE005) },
	{ USB_DEVICE(0x0930, 0x0219) },
	{ USB_DEVICE(0x0930, 0x0220) },
	{ 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 const 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(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0220), .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	59
3932eb33	60	static const struct usb_device_id ath3k_table[] = {
9670d80a VK	61	/* Atheros AR3011 */
9670d80a VK	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) },
0a3658cc	88	{ USB_DEVICE(0x0CF3, 0xE005) },
6c4ae5c2	89	{ USB_DEVICE(0x0930, 0x0219) },
bd0976dd	90	{ USB_DEVICE(0x0930, 0x0220) },
2096ae6c	91	{ USB_DEVICE(0x0489, 0xe057) },
eed307e2	92	{ USB_DEVICE(0x13d3, 0x3393) },
3a61eda8	93	{ USB_DEVICE(0x0489, 0xe04e) },
2582d529	94	{ USB_DEVICE(0x0489, 0xe056) },
0fc110f4	95	{ USB_DEVICE(0x0489, 0xe04d) },
84eb2ae1	96	{ USB_DEVICE(0x04c5, 0x1330) },
5b77a1f3	97	{ USB_DEVICE(0x13d3, 0x3402) },
1ebd0b21	98	{ USB_DEVICE(0x0cf3, 0x3121) },
1d5b569e	99	{ USB_DEVICE(0x0cf3, 0xe003) },
d9f51b51	100
e9036e33 CYC	101	/* Atheros AR5BBU12 with sflash firmware */
e9036e33 CYC	102	{ USB_DEVICE(0x0489, 0xE02C) },
b67afe7f	103
85d59726 MG	104	/* Atheros AR5BBU22 with sflash firmware */
85d59726 MG	105	{ USB_DEVICE(0x0489, 0xE03C) },
bc21fde2	106	{ USB_DEVICE(0x0489, 0xE036) },
85d59726	107
9670d80a VK	108	{ } /* Terminating entry */
	109	};
	110
	111	MODULE_DEVICE_TABLE(usb, ath3k_table);
	112
d9f51b51 BS	113	#define BTUSB_ATH3012 0x80
	114	/* This table is to load patch and sysconfig files
	115	* for AR3012 */
3932eb33	116	static const struct usb_device_id ath3k_blist_tbl[] = {
d9f51b51 BS	117
d9f51b51 BS	118	/* Atheros AR3012 with sflash firmware*/
d66629c1	119	{ USB_DEVICE(0x0CF3, 0x0036), .driver_info = BTUSB_ATH3012 },
d9f51b51	120	{ USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
94a32d10	121	{ USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
07c0ea87	122	{ USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
ebaf5795	123	{ USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
9498ba7a	124	{ USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
3f63c340	125	{ USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
55ed7d4d	126	{ USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
2c262b2a	127	{ USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
f4d6f7dc	128	{ USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
87522a43	129	{ USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
ac71311e	130	{ USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
0a3658cc	131	{ USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
6c4ae5c2	132	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
bd0976dd	133	{ USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
2096ae6c	134	{ USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
eed307e2	135	{ USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
3a61eda8	136	{ USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
2582d529	137	{ USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
0fc110f4	138	{ USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
84eb2ae1	139	{ USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
5b77a1f3	140	{ USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },
1ebd0b21	141	{ USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
1d5b569e	142	{ USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
d9f51b51	143
85d59726 MG	144	/* Atheros AR5BBU22 with sflash firmware */
85d59726 MG	145	{ USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
bc21fde2	146	{ USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
85d59726	147
d9f51b51 BS	148	{ } /* Terminating entry */
	149	};
	150
9670d80a VK	151	#define USB_REQ_DFU_DNLOAD 1
9670d80a VK	152	#define BULK_SIZE 4096
d9f51b51	153	#define FW_HDR_SIZE 20
9670d80a	154
86e09287 AH	155	static int ath3k_load_firmware(struct usb_device *udev,
86e09287 AH	156	const struct firmware *firmware)
9670d80a VK	157	{
	158	u8 *send_buf;
	159	int err, pipe, len, size, sent = 0;
86e09287	160	int count = firmware->size;
9670d80a	161
86e09287	162	BT_DBG("udev %p", udev);
9670d80a	163
86e09287	164	pipe = usb_sndctrlpipe(udev, 0);
9670d80a	165
52a1020e	166	send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
86e09287 AH	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,
9670d80a VK	174	USB_REQ_DFU_DNLOAD,
9670d80a VK	175	USB_TYPE_VENDOR, 0, 0,
86e09287	176	send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
9670d80a	177	BT_ERR("Can't change to loading configuration err");
86e09287	178	goto error;
9670d80a VK	179	}
	180	sent += 20;
	181	count -= 20;
	182
9670d80a VK	183	while (count) {
9670d80a VK	184	size = min_t(uint, count, BULK_SIZE);
86e09287 AH	185	pipe = usb_sndbulkpipe(udev, 0x02);
86e09287 AH	186	memcpy(send_buf, firmware->data + sent, size);
9670d80a	187
86e09287	188	err = usb_bulk_msg(udev, pipe, send_buf, size,
9670d80a VK	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
9670d80a VK	201	error:
	202	kfree(send_buf);
	203	return err;
	204	}
	205
d9f51b51 BS	206	static int ath3k_get_state(struct usb_device udev, unsigned char state)
d9f51b51 BS	207	{
517828a8 SG	208	int ret, pipe = 0;
	209	char *buf;
	210
	211	buf = kmalloc(sizeof(*buf), GFP_KERNEL);
	212	if (!buf)
	213	return -ENOMEM;
d9f51b51 BS	214
d9f51b51 BS	215	pipe = usb_rcvctrlpipe(udev, 0);
517828a8 SG	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;
d9f51b51 BS	224	}
	225
	226	static int ath3k_get_version(struct usb_device *udev,
	227	struct ath3k_version *version)
	228	{
517828a8 SG	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;
d9f51b51 BS	236
d9f51b51 BS	237	pipe = usb_rcvctrlpipe(udev, 0);
517828a8 SG	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;
d9f51b51 BS	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
52a1020e	257	send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
d9f51b51 BS	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) {
8a168ca7	394	BT_ERR("Can't get state to change to load configuration err");
d9f51b51 BS	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
9670d80a VK	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);
84f0e17f	440	int ret;
9670d80a VK	441
	442	BT_DBG("intf %p id %p", intf, id);
	443
	444	if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
	445	return -ENODEV;
	446
d9f51b51 BS	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) {
2d25f8b4 SL	457
	458	/* New firmware with patch and sysconfig files already loaded */
	459	if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
	460	return -ENODEV;
	461
d9f51b51 BS	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
c3eae82a PF	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;
9670d80a VK	490	}
9670d80a VK	491
84f0e17f	492	ret = ath3k_load_firmware(udev, firmware);
86e09287	493	release_firmware(firmware);
9670d80a	494
84f0e17f	495	return ret;
9670d80a VK	496	}
	497
	498	static void ath3k_disconnect(struct usb_interface *intf)
	499	{
9670d80a	500	BT_DBG("ath3k_disconnect intf %p", intf);
9670d80a VK	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,
e1f12eb6	508	.disable_hub_initiated_lpm = 1,
9670d80a VK	509	};
9670d80a VK	510
93f1508c	511	module_usb_driver(ath3k_driver);
9670d80a VK	512
	513	MODULE_AUTHOR("Atheros Communications");
	514	MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
	515	MODULE_VERSION(VERSION);
	516	MODULE_LICENSE("GPL");
c3eae82a	517	MODULE_FIRMWARE(ATH3K_FIRMWARE);