[GitHub/LineageOS/android_kernel_samsung_universal7580.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, 0x311E) },
	{ USB_DEVICE(0x0CF3, 0x311F) },
	{ USB_DEVICE(0x0CF3, 0x817a) },
	{ USB_DEVICE(0x13d3, 0x3375) },
	{ USB_DEVICE(0x04CA, 0x3004) },
	{ USB_DEVICE(0x04CA, 0x3005) },
	{ USB_DEVICE(0x04CA, 0x3006) },
	{ USB_DEVICE(0x04CA, 0x3007) },
	{ USB_DEVICE(0x04CA, 0x3008) },
	{ USB_DEVICE(0x13d3, 0x3362) },
	{ USB_DEVICE(0x0CF3, 0xE004) },
	{ USB_DEVICE(0x0CF3, 0xE005) },
	{ 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, 0x311E), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311F), .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, 0x3007), .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(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
#define TIMEGAP_USEC_MIN	50
#define TIMEGAP_USEC_MAX	100

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

	BT_DBG("udev %p", udev);

	pipe = usb_sndctrlpipe(udev, 0);

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

	memcpy(send_buf, firmware->data, 20);
	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) {
		/* workaround the compatibility issue with xHCI controller*/
		usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);

		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) {
		/* workaround the compatibility issue with xHCI controller*/
		usleep_range(TIMEGAP_USEC_MIN, TIMEGAP_USEC_MAX);

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