[mirror_ubuntu-bionic-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 <asm/unaligned.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 {
	__le32	rom_version;
	__le32	build_version;
	__le32	ram_version;
	__u8	ref_clock;
	__u8	reserved[7];
} __packed;

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(0x0489, 0xe078) },
	{ USB_DEVICE(0x04c5, 0x1330) },
	{ USB_DEVICE(0x04CA, 0x3004) },
	{ USB_DEVICE(0x04CA, 0x3005) },
	{ USB_DEVICE(0x04CA, 0x3006) },
	{ USB_DEVICE(0x04CA, 0x3007) },
	{ USB_DEVICE(0x04CA, 0x3008) },
	{ USB_DEVICE(0x04CA, 0x300b) },
	{ USB_DEVICE(0x04CA, 0x3010) },
	{ USB_DEVICE(0x0930, 0x0219) },
	{ USB_DEVICE(0x0930, 0x0220) },
	{ USB_DEVICE(0x0930, 0x0227) },
	{ USB_DEVICE(0x0b05, 0x17d0) },
	{ 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) },
	{ USB_DEVICE(0x13d3, 0x3408) },
	{ USB_DEVICE(0x13d3, 0x3423) },
	{ USB_DEVICE(0x13d3, 0x3432) },

	/* 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(0x0489, 0xe078), .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, 0x3007), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3010), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0227), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0b05, 0x17d0), .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 },
	{ USB_DEVICE(0x13d3, 0x3408), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3423), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3432), .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);
	err = usb_control_msg(udev, pipe, USB_REQ_DFU_DNLOAD, USB_TYPE_VENDOR,
			      0, 0, send_buf, 20, USB_CTRL_SET_TIMEOUT);
	if (err < 0) {
		BT_ERR("Can't change to loading configuration err");
		goto error;
	}
	sent += 20;
	count -= 20;

	pipe = usb_sndbulkpipe(udev, 0x02);

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

	pipe = usb_sndbulkpipe(udev, 0x02);

	while (count) {
		size = min_t(uint, count, BULK_SIZE);
		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;
	__u32 pt_rom_version, pt_build_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",
		 le32_to_cpu(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_rom_version = get_unaligned_le32(firmware->data +
					    firmware->size - 8);
	pt_build_version = get_unaligned_le32(firmware->data +
					      firmware->size - 4);

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