[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 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, 0x311E) },
	{ 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(0x04CA, 0x300b) },
	{ 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) },
	{ USB_DEVICE(0x0489, 0xe05f) },

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