[linux-2.6-block.git] / drivers / bluetooth / ath3k.c

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


#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/errno.h>
#include <linux/device.h>
#include <linux/firmware.h>
#include <linux/usb.h>
#include <net/bluetooth/bluetooth.h>

#define VERSION "1.0"
#define ATH3K_FIRMWARE	"ath3k-1.fw"

#define ATH3K_DNLOAD				0x01
#define ATH3K_GETSTATE				0x05
#define ATH3K_SET_NORMAL_MODE			0x07
#define ATH3K_GETVERSION			0x09
#define USB_REG_SWITCH_VID_PID			0x0a

#define ATH3K_MODE_MASK				0x3F
#define ATH3K_NORMAL_MODE			0x0E

#define ATH3K_PATCH_UPDATE			0x80
#define ATH3K_SYSCFG_UPDATE			0x40

#define ATH3K_XTAL_FREQ_26M			0x00
#define ATH3K_XTAL_FREQ_40M			0x01
#define ATH3K_XTAL_FREQ_19P2			0x02
#define ATH3K_NAME_LEN				0xFF

struct ath3k_version {
	unsigned int	rom_version;
	unsigned int	build_version;
	unsigned int	ram_version;
	unsigned char	ref_clock;
	unsigned char	reserved[0x07];
};

static const struct usb_device_id ath3k_table[] = {
	/* Atheros AR3011 */
	{ USB_DEVICE(0x0CF3, 0x3000) },

	/* Atheros AR3011 with sflash firmware*/
	{ USB_DEVICE(0x0489, 0xE027) },
	{ USB_DEVICE(0x0489, 0xE03D) },
	{ USB_DEVICE(0x0930, 0x0215) },
	{ USB_DEVICE(0x0CF3, 0x3002) },
	{ USB_DEVICE(0x0CF3, 0xE019) },
	{ USB_DEVICE(0x13d3, 0x3304) },

	/* Atheros AR9285 Malbec with sflash firmware */
	{ USB_DEVICE(0x03F0, 0x311D) },

	/* Atheros AR3012 with sflash firmware*/
	{ USB_DEVICE(0x0489, 0xe04d) },
	{ USB_DEVICE(0x0489, 0xe04e) },
	{ USB_DEVICE(0x0489, 0xe057) },
	{ USB_DEVICE(0x0489, 0xe056) },
	{ USB_DEVICE(0x0489, 0xe05f) },
	{ USB_DEVICE(0x04c5, 0x1330) },
	{ USB_DEVICE(0x04CA, 0x3004) },
	{ USB_DEVICE(0x04CA, 0x3005) },
	{ USB_DEVICE(0x04CA, 0x3006) },
	{ USB_DEVICE(0x04CA, 0x3008) },
	{ USB_DEVICE(0x04CA, 0x300b) },
	{ USB_DEVICE(0x0930, 0x0219) },
	{ USB_DEVICE(0x0930, 0x0220) },
	{ USB_DEVICE(0x0b05, 0x17d0) },
	{ USB_DEVICE(0x0CF3, 0x0036) },
	{ USB_DEVICE(0x0CF3, 0x3004) },
	{ USB_DEVICE(0x0CF3, 0x3005) },
	{ USB_DEVICE(0x0CF3, 0x3008) },
	{ USB_DEVICE(0x0CF3, 0x311D) },
	{ USB_DEVICE(0x0CF3, 0x311E) },
	{ USB_DEVICE(0x0CF3, 0x311F) },
	{ USB_DEVICE(0x0cf3, 0x3121) },
	{ USB_DEVICE(0x0CF3, 0x817a) },
	{ USB_DEVICE(0x0cf3, 0xe003) },
	{ USB_DEVICE(0x0CF3, 0xE004) },
	{ USB_DEVICE(0x0CF3, 0xE005) },
	{ USB_DEVICE(0x13d3, 0x3362) },
	{ USB_DEVICE(0x13d3, 0x3375) },
	{ USB_DEVICE(0x13d3, 0x3393) },
	{ USB_DEVICE(0x13d3, 0x3402) },

	/* Atheros AR5BBU12 with sflash firmware */
	{ USB_DEVICE(0x0489, 0xE02C) },

	/* Atheros AR5BBU22 with sflash firmware */
	{ USB_DEVICE(0x0489, 0xE036) },
	{ USB_DEVICE(0x0489, 0xE03C) },

	{ }	/* Terminating entry */
};

MODULE_DEVICE_TABLE(usb, ath3k_table);

#define BTUSB_ATH3012		0x80
/* This table is to load patch and sysconfig files
 * for AR3012 */
static const struct usb_device_id ath3k_blist_tbl[] = {

	/* Atheros AR3012 with sflash firmware*/
	{ USB_DEVICE(0x0489, 0xe04e), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe04d), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe056), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe057), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xe05f), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04c5, 0x1330), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3004), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3006), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x04ca, 0x300b), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0930, 0x0220), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(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, 0x3005), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x3008), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311E), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x311F), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0x3121), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0CF3, 0x817a), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe005), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0cf3, 0xe003), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3393), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x13d3, 0x3402), .driver_info = BTUSB_ATH3012 },

	/* Atheros AR5BBU22 with sflash firmware */
	{ USB_DEVICE(0x0489, 0xE036), .driver_info = BTUSB_ATH3012 },
	{ USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },

	{ }	/* Terminating entry */
};

#define USB_REQ_DFU_DNLOAD	1
#define BULK_SIZE		4096
#define FW_HDR_SIZE		20

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

	BT_DBG("udev %p", udev);

	pipe = usb_sndctrlpipe(udev, 0);

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

	memcpy(send_buf, firmware->data, 20);
	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;

	while (count) {
		size = min_t(uint, count, BULK_SIZE);
		pipe = usb_sndbulkpipe(udev, 0x02);
		memcpy(send_buf, firmware->data + sent, size);

		err = usb_bulk_msg(udev, pipe, send_buf, size,
					&len, 3000);

		if (err || (len != size)) {
			BT_ERR("Error in firmware loading err = %d,"
				"len = %d, size = %d", err, len, size);
			goto error;
		}

		sent  += size;
		count -= size;
	}

error:
	kfree(send_buf);
	return err;
}

static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
{
	int ret, pipe = 0;
	char *buf;

	buf = kmalloc(sizeof(*buf), GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	pipe = usb_rcvctrlpipe(udev, 0);
	ret = usb_control_msg(udev, pipe, ATH3K_GETSTATE,
			      USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
			      buf, sizeof(*buf), USB_CTRL_SET_TIMEOUT);

	*state = *buf;
	kfree(buf);

	return ret;
}

static int ath3k_get_version(struct usb_device *udev,
			struct ath3k_version *version)
{
	int ret, pipe = 0;
	struct ath3k_version *buf;
	const int size = sizeof(*buf);

	buf = kmalloc(size, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	pipe = usb_rcvctrlpipe(udev, 0);
	ret = usb_control_msg(udev, pipe, ATH3K_GETVERSION,
			      USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
			      buf, size, USB_CTRL_SET_TIMEOUT);

	memcpy(version, buf, size);
	kfree(buf);

	return ret;
}

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

	count = firmware->size;

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

	size = min_t(uint, count, FW_HDR_SIZE);
	memcpy(send_buf, firmware->data, size);

	pipe = usb_sndctrlpipe(udev, 0);
	ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
			USB_TYPE_VENDOR, 0, 0, send_buf,
			size, USB_CTRL_SET_TIMEOUT);
	if (ret < 0) {
		BT_ERR("Can't change to loading configuration err");
		kfree(send_buf);
		return ret;
	}

	sent += size;
	count -= size;

	while (count) {
		size = min_t(uint, count, BULK_SIZE);
		pipe = usb_sndbulkpipe(udev, 0x02);

		memcpy(send_buf, firmware->data + sent, size);

		err = usb_bulk_msg(udev, pipe, send_buf, size,
					&len, 3000);
		if (err || (len != size)) {
			BT_ERR("Error in firmware loading err = %d,"
				"len = %d, size = %d", err, len, size);
			kfree(send_buf);
			return err;
		}
		sent  += size;
		count -= size;
	}

	kfree(send_buf);
	return 0;
}

static int ath3k_switch_pid(struct usb_device *udev)
{
	int pipe = 0;

	pipe = usb_sndctrlpipe(udev, 0);
	return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
			USB_TYPE_VENDOR, 0, 0,
			NULL, 0, USB_CTRL_SET_TIMEOUT);
}

static int ath3k_set_normal_mode(struct usb_device *udev)
{
	unsigned char fw_state;
	int pipe = 0, ret;

	ret = ath3k_get_state(udev, &fw_state);
	if (ret < 0) {
		BT_ERR("Can't get state to change to normal mode err");
		return ret;
	}

	if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
		BT_DBG("firmware was already in normal mode");
		return 0;
	}

	pipe = usb_sndctrlpipe(udev, 0);
	return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
			USB_TYPE_VENDOR, 0, 0,
			NULL, 0, USB_CTRL_SET_TIMEOUT);
}

static int ath3k_load_patch(struct usb_device *udev)
{
	unsigned char fw_state;
	char filename[ATH3K_NAME_LEN] = {0};
	const struct firmware *firmware;
	struct ath3k_version fw_version, pt_version;
	int ret;

	ret = ath3k_get_state(udev, &fw_state);
	if (ret < 0) {
		BT_ERR("Can't get state to change to load ram patch err");
		return ret;
	}

	if (fw_state & ATH3K_PATCH_UPDATE) {
		BT_DBG("Patch was already downloaded");
		return 0;
	}

	ret = ath3k_get_version(udev, &fw_version);
	if (ret < 0) {
		BT_ERR("Can't get version to change to load ram patch err");
		return ret;
	}

	snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
		fw_version.rom_version);

	ret = request_firmware(&firmware, filename, &udev->dev);
	if (ret < 0) {
		BT_ERR("Patch file not found %s", filename);
		return ret;
	}

	pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
	pt_version.build_version = *(int *)
		(firmware->data + firmware->size - 4);

	if ((pt_version.rom_version != fw_version.rom_version) ||
		(pt_version.build_version <= fw_version.build_version)) {
		BT_ERR("Patch file version did not match with firmware");
		release_firmware(firmware);
		return -EINVAL;
	}

	ret = ath3k_load_fwfile(udev, firmware);
	release_firmware(firmware);

	return ret;
}

static int ath3k_load_syscfg(struct usb_device *udev)
{
	unsigned char fw_state;
	char filename[ATH3K_NAME_LEN] = {0};
	const struct firmware *firmware;
	struct ath3k_version fw_version;
	int clk_value, ret;

	ret = ath3k_get_state(udev, &fw_state);
	if (ret < 0) {
		BT_ERR("Can't get state to change to load configuration err");
		return -EBUSY;
	}

	ret = ath3k_get_version(udev, &fw_version);
	if (ret < 0) {
		BT_ERR("Can't get version to change to load ram patch err");
		return ret;
	}

	switch (fw_version.ref_clock) {

	case ATH3K_XTAL_FREQ_26M:
		clk_value = 26;
		break;
	case ATH3K_XTAL_FREQ_40M:
		clk_value = 40;
		break;
	case ATH3K_XTAL_FREQ_19P2:
		clk_value = 19;
		break;
	default:
		clk_value = 0;
		break;
	}

	snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
		fw_version.rom_version, clk_value, ".dfu");

	ret = request_firmware(&firmware, filename, &udev->dev);
	if (ret < 0) {
		BT_ERR("Configuration file not found %s", filename);
		return ret;
	}

	ret = ath3k_load_fwfile(udev, firmware);
	release_firmware(firmware);

	return ret;
}

static int ath3k_probe(struct usb_interface *intf,
			const struct usb_device_id *id)
{
	const struct firmware *firmware;
	struct usb_device *udev = interface_to_usbdev(intf);
	int ret;

	BT_DBG("intf %p id %p", intf, id);

	if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
		return -ENODEV;

	/* match device ID in ath3k blacklist table */
	if (!id->driver_info) {
		const struct usb_device_id *match;
		match = usb_match_id(intf, ath3k_blist_tbl);
		if (match)
			id = match;
	}

	/* load patch and sysconfig files for AR3012 */
	if (id->driver_info & BTUSB_ATH3012) {

		/* New firmware with patch and sysconfig files already loaded */
		if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
			return -ENODEV;

		ret = ath3k_load_patch(udev);
		if (ret < 0) {
			BT_ERR("Loading patch file failed");
			return ret;
		}
		ret = ath3k_load_syscfg(udev);
		if (ret < 0) {
			BT_ERR("Loading sysconfig file failed");
			return ret;
		}
		ret = ath3k_set_normal_mode(udev);
		if (ret < 0) {
			BT_ERR("Set normal mode failed");
			return ret;
		}
		ath3k_switch_pid(udev);
		return 0;
	}

	ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
	if (ret < 0) {
		if (ret == -ENOENT)
			BT_ERR("Firmware file \"%s\" not found",
							ATH3K_FIRMWARE);
		else
			BT_ERR("Firmware file \"%s\" request failed (err=%d)",
							ATH3K_FIRMWARE, ret);
		return ret;
	}

	ret = ath3k_load_firmware(udev, firmware);
	release_firmware(firmware);

	return ret;
}

static void ath3k_disconnect(struct usb_interface *intf)
{
	BT_DBG("ath3k_disconnect intf %p", intf);
}

static struct usb_driver ath3k_driver = {
	.name		= "ath3k",
	.probe		= ath3k_probe,
	.disconnect	= ath3k_disconnect,
	.id_table	= ath3k_table,
	.disable_hub_initiated_lpm = 1,
};

module_usb_driver(ath3k_driver);

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