[deliverable/linux.git] / drivers / bluetooth / ath3k.c

/*
 * Copyright (c) 2008-2009 Atheros Communications Inc.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


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