[mirror_ubuntu-artful-kernel.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(0x0489, 0xE027) },
	{ USB_DEVICE(0x0489, 0xE03D) },
	{ 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(0x04c5, 0x1330) },
	{ USB_DEVICE(0x04CA, 0x3004) },
	{ USB_DEVICE(0x04CA, 0x3005) },
	{ USB_DEVICE(0x04CA, 0x3006) },
	{ USB_DEVICE(0x04CA, 0x3008) },
	{ USB_DEVICE(0x04CA, 0x300b) },
	{ USB_DEVICE(0x0930, 0x0219) },
	{ USB_DEVICE(0x0930, 0x0220) },
	{ 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) },

	/* 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(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, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0220), .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 },

	/* 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

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