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