[mirror_ubuntu-focal-kernel.git] / drivers / bluetooth / btbcm.c

/*
 *
 *  Bluetooth support for Broadcom devices
 *
 *  Copyright (C) 2015  Intel Corporation
 *
 *
 *  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/firmware.h>
#include <asm/unaligned.h>

#include <net/bluetooth/bluetooth.h>
#include <net/bluetooth/hci_core.h>

#include "btbcm.h"

#define VERSION "0.1"

#define BDADDR_BCM20702A0 (&(bdaddr_t) {{0x00, 0xa0, 0x02, 0x70, 0x20, 0x00}})
#define BDADDR_BCM4324B3 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb3, 0x24, 0x43}})
#define BDADDR_BCM4330B1 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb1, 0x30, 0x43}})

int btbcm_check_bdaddr(struct hci_dev *hdev)
{
	struct hci_rp_read_bd_addr *bda;
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, HCI_OP_READ_BD_ADDR, 0, NULL,
			     HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		int err = PTR_ERR(skb);
		bt_dev_err(hdev, "BCM: Reading device address failed (%d)", err);
		return err;
	}

	if (skb->len != sizeof(*bda)) {
		bt_dev_err(hdev, "BCM: Device address length mismatch");
		kfree_skb(skb);
		return -EIO;
	}

	bda = (struct hci_rp_read_bd_addr *)skb->data;

	/* Check if the address indicates a controller with either an
	 * invalid or default address. In both cases the device needs
	 * to be marked as not having a valid address.
	 *
	 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
	 * with no configured address.
	 *
	 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
	 * with waiting for configuration state.
	 *
	 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
	 * with waiting for configuration state.
	 */
	if (!bacmp(&bda->bdaddr, BDADDR_BCM20702A0) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM4324B3) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM4330B1)) {
		bt_dev_info(hdev, "BCM: Using default device address (%pMR)",
			    &bda->bdaddr);
		set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
	}

	kfree_skb(skb);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);

int btbcm_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
{
	struct sk_buff *skb;
	int err;

	skb = __hci_cmd_sync(hdev, 0xfc01, 6, bdaddr, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		err = PTR_ERR(skb);
		bt_dev_err(hdev, "BCM: Change address command failed (%d)", err);
		return err;
	}
	kfree_skb(skb);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);

int btbcm_patchram(struct hci_dev *hdev, const struct firmware *fw)
{
	const struct hci_command_hdr *cmd;
	const u8 *fw_ptr;
	size_t fw_size;
	struct sk_buff *skb;
	u16 opcode;
	int err = 0;

	/* Start Download */
	skb = __hci_cmd_sync(hdev, 0xfc2e, 0, NULL, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		err = PTR_ERR(skb);
		bt_dev_err(hdev, "BCM: Download Minidrv command failed (%d)",
			   err);
		goto done;
	}
	kfree_skb(skb);

	/* 50 msec delay after Download Minidrv completes */
	msleep(50);

	fw_ptr = fw->data;
	fw_size = fw->size;

	while (fw_size >= sizeof(*cmd)) {
		const u8 *cmd_param;

		cmd = (struct hci_command_hdr *)fw_ptr;
		fw_ptr += sizeof(*cmd);
		fw_size -= sizeof(*cmd);

		if (fw_size < cmd->plen) {
			bt_dev_err(hdev, "BCM: Patch is corrupted");
			err = -EINVAL;
			goto done;
		}

		cmd_param = fw_ptr;
		fw_ptr += cmd->plen;
		fw_size -= cmd->plen;

		opcode = le16_to_cpu(cmd->opcode);

		skb = __hci_cmd_sync(hdev, opcode, cmd->plen, cmd_param,
				     HCI_INIT_TIMEOUT);
		if (IS_ERR(skb)) {
			err = PTR_ERR(skb);
			bt_dev_err(hdev, "BCM: Patch command %04x failed (%d)",
				   opcode, err);
			goto done;
		}
		kfree_skb(skb);
	}

	/* 250 msec delay after Launch Ram completes */
	msleep(250);

done:
	return err;
}
EXPORT_SYMBOL(btbcm_patchram);

static int btbcm_reset(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		int err = PTR_ERR(skb);
		bt_dev_err(hdev, "BCM: Reset failed (%d)", err);
		return err;
	}
	kfree_skb(skb);

	/* 100 msec delay for module to complete reset process */
	msleep(100);

	return 0;
}

static struct sk_buff *btbcm_read_local_name(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_NAME, 0, NULL,
			     HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		bt_dev_err(hdev, "BCM: Reading local name failed (%ld)",
			   PTR_ERR(skb));
		return skb;
	}

	if (skb->len != sizeof(struct hci_rp_read_local_name)) {
		bt_dev_err(hdev, "BCM: Local name length mismatch");
		kfree_skb(skb);
		return ERR_PTR(-EIO);
	}

	return skb;
}

static struct sk_buff *btbcm_read_local_version(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
			     HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		bt_dev_err(hdev, "BCM: Reading local version info failed (%ld)",
			   PTR_ERR(skb));
		return skb;
	}

	if (skb->len != sizeof(struct hci_rp_read_local_version)) {
		bt_dev_err(hdev, "BCM: Local version length mismatch");
		kfree_skb(skb);
		return ERR_PTR(-EIO);
	}

	return skb;
}

static struct sk_buff *btbcm_read_verbose_config(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, 0xfc79, 0, NULL, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		bt_dev_err(hdev, "BCM: Read verbose config info failed (%ld)",
			   PTR_ERR(skb));
		return skb;
	}

	if (skb->len != 7) {
		bt_dev_err(hdev, "BCM: Verbose config length mismatch");
		kfree_skb(skb);
		return ERR_PTR(-EIO);
	}

	return skb;
}

static struct sk_buff *btbcm_read_controller_features(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, 0xfc6e, 0, NULL, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		bt_dev_err(hdev, "BCM: Read controller features failed (%ld)",
			   PTR_ERR(skb));
		return skb;
	}

	if (skb->len != 9) {
		bt_dev_err(hdev, "BCM: Controller features length mismatch");
		kfree_skb(skb);
		return ERR_PTR(-EIO);
	}

	return skb;
}

static struct sk_buff *btbcm_read_usb_product(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	skb = __hci_cmd_sync(hdev, 0xfc5a, 0, NULL, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		bt_dev_err(hdev, "BCM: Read USB product info failed (%ld)",
			   PTR_ERR(skb));
		return skb;
	}

	if (skb->len != 5) {
		bt_dev_err(hdev, "BCM: USB product length mismatch");
		kfree_skb(skb);
		return ERR_PTR(-EIO);
	}

	return skb;
}

static int btbcm_read_info(struct hci_dev *hdev)
{
	struct sk_buff *skb;

	/* Read Verbose Config Version Info */
	skb = btbcm_read_verbose_config(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	bt_dev_info(hdev, "BCM: chip id %u", skb->data[1]);
	kfree_skb(skb);

	/* Read Controller Features */
	skb = btbcm_read_controller_features(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
	kfree_skb(skb);

	/* Read Local Name */
	skb = btbcm_read_local_name(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
	kfree_skb(skb);

	return 0;
}

struct bcm_subver_table {
	u16 subver;
	const char *name;
};

static const struct bcm_subver_table bcm_uart_subver_table[] = {
	{ 0x4103, "BCM4330B1"	},	/* 002.001.003 */
	{ 0x410e, "BCM43341B0"	},	/* 002.001.014 */
	{ 0x4406, "BCM4324B3"	},	/* 002.004.006 */
	{ 0x610c, "BCM4354"	},	/* 003.001.012 */
	{ 0x2122, "BCM4343A0"	},	/* 001.001.034 */
	{ 0x2209, "BCM43430A1"  },	/* 001.002.009 */
	{ 0x6119, "BCM4345C0"	},	/* 003.001.025 */
	{ 0x230f, "BCM4356A2"	},	/* 001.003.015 */
	{ }
};

static const struct bcm_subver_table bcm_usb_subver_table[] = {
	{ 0x210b, "BCM43142A0"	},	/* 001.001.011 */
	{ 0x2112, "BCM4314A0"	},	/* 001.001.018 */
	{ 0x2118, "BCM20702A0"	},	/* 001.001.024 */
	{ 0x2126, "BCM4335A0"	},	/* 001.001.038 */
	{ 0x220e, "BCM20702A1"	},	/* 001.002.014 */
	{ 0x230f, "BCM4354A2"	},	/* 001.003.015 */
	{ 0x4106, "BCM4335B0"	},	/* 002.001.006 */
	{ 0x410e, "BCM20702B0"	},	/* 002.001.014 */
	{ 0x6109, "BCM4335C0"	},	/* 003.001.009 */
	{ 0x610c, "BCM4354"	},	/* 003.001.012 */
	{ }
};

int btbcm_initialize(struct hci_dev *hdev, char *fw_name, size_t len,
		     bool reinit)
{
	u16 subver, rev, pid, vid;
	const char *hw_name = NULL;
	struct sk_buff *skb;
	struct hci_rp_read_local_version *ver;
	const struct bcm_subver_table *bcm_subver_table;
	int i, err;

	/* Reset */
	err = btbcm_reset(hdev);
	if (err)
		return err;

	/* Read Local Version Info */
	skb = btbcm_read_local_version(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	ver = (struct hci_rp_read_local_version *)skb->data;
	rev = le16_to_cpu(ver->hci_rev);
	subver = le16_to_cpu(ver->lmp_subver);
	kfree_skb(skb);

	/* Read controller information */
	if (!reinit) {
		err = btbcm_read_info(hdev);
		if (err)
			return err;
	}

	/* Upper nibble of rev should be between 0 and 3? */
	if (((rev & 0xf000) >> 12) > 3)
		return 0;

	bcm_subver_table = (hdev->bus == HCI_USB) ? bcm_usb_subver_table :
						    bcm_uart_subver_table;

	for (i = 0; bcm_subver_table[i].name; i++) {
		if (subver == bcm_subver_table[i].subver) {
			hw_name = bcm_subver_table[i].name;
			break;
		}
	}

	if (hdev->bus == HCI_USB) {
		/* Read USB Product Info */
		skb = btbcm_read_usb_product(hdev);
		if (IS_ERR(skb))
			return PTR_ERR(skb);

		vid = get_unaligned_le16(skb->data + 1);
		pid = get_unaligned_le16(skb->data + 3);
		kfree_skb(skb);

		snprintf(fw_name, len, "brcm/%s-%4.4x-%4.4x.hcd",
			 hw_name ? : "BCM", vid, pid);
	} else {
		snprintf(fw_name, len, "brcm/%s.hcd",
			 hw_name ? : "BCM");
	}

	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
		    hw_name ? : "BCM", (subver & 0xe000) >> 13,
		    (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_initialize);

int btbcm_finalize(struct hci_dev *hdev)
{
	char fw_name[64];
	int err;

	/* Re-initialize */
	err = btbcm_initialize(hdev, fw_name, sizeof(fw_name), true);
	if (err)
		return err;

	btbcm_check_bdaddr(hdev);

	set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_finalize);

int btbcm_setup_patchram(struct hci_dev *hdev)
{
	char fw_name[64];
	const struct firmware *fw;
	u16 subver, rev, pid, vid;
	const char *hw_name = NULL;
	struct sk_buff *skb;
	struct hci_rp_read_local_version *ver;
	const struct bcm_subver_table *bcm_subver_table;
	int i, err;

	/* Reset */
	err = btbcm_reset(hdev);
	if (err)
		return err;

	/* Read Local Version Info */
	skb = btbcm_read_local_version(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	ver = (struct hci_rp_read_local_version *)skb->data;
	rev = le16_to_cpu(ver->hci_rev);
	subver = le16_to_cpu(ver->lmp_subver);
	kfree_skb(skb);

	/* Read controller information */
	err = btbcm_read_info(hdev);
	if (err)
		return err;

	/* Upper nibble of rev should be between 0 and 3? */
	if (((rev & 0xf000) >> 12) > 3)
		return 0;

	bcm_subver_table = (hdev->bus == HCI_USB) ? bcm_usb_subver_table :
						    bcm_uart_subver_table;

	for (i = 0; bcm_subver_table[i].name; i++) {
		if (subver == bcm_subver_table[i].subver) {
			hw_name = bcm_subver_table[i].name;
			break;
		}
	}

	if (hdev->bus == HCI_USB) {
		/* Read USB Product Info */
		skb = btbcm_read_usb_product(hdev);
		if (IS_ERR(skb))
			return PTR_ERR(skb);

		vid = get_unaligned_le16(skb->data + 1);
		pid = get_unaligned_le16(skb->data + 3);
		kfree_skb(skb);

		snprintf(fw_name, sizeof(fw_name), "brcm/%s-%4.4x-%4.4x.hcd",
			 hw_name ? : "BCM", vid, pid);
	} else {
		snprintf(fw_name, sizeof(fw_name), "brcm/%s.hcd",
			 hw_name ? : "BCM");
	}

	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
		    hw_name ? : "BCM", (subver & 0xe000) >> 13,
		    (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);

	err = request_firmware(&fw, fw_name, &hdev->dev);
	if (err < 0) {
		bt_dev_info(hdev, "BCM: Patch %s not found", fw_name);
		goto done;
	}

	btbcm_patchram(hdev, fw);

	release_firmware(fw);

	/* Reset */
	err = btbcm_reset(hdev);
	if (err)
		return err;

	/* Read Local Version Info */
	skb = btbcm_read_local_version(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	ver = (struct hci_rp_read_local_version *)skb->data;
	rev = le16_to_cpu(ver->hci_rev);
	subver = le16_to_cpu(ver->lmp_subver);
	kfree_skb(skb);

	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
		    hw_name ? : "BCM", (subver & 0xe000) >> 13,
		    (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);

	/* Read Local Name */
	skb = btbcm_read_local_name(hdev);
	if (IS_ERR(skb))
		return PTR_ERR(skb);

	bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
	kfree_skb(skb);

done:
	btbcm_check_bdaddr(hdev);

	set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_setup_patchram);

int btbcm_setup_apple(struct hci_dev *hdev)
{
	struct sk_buff *skb;
	int err;

	/* Reset */
	err = btbcm_reset(hdev);
	if (err)
		return err;

	/* Read Verbose Config Version Info */
	skb = btbcm_read_verbose_config(hdev);
	if (!IS_ERR(skb)) {
		bt_dev_info(hdev, "BCM: chip id %u build %4.4u",
			    skb->data[1], get_unaligned_le16(skb->data + 5));
		kfree_skb(skb);
	}

	/* Read USB Product Info */
	skb = btbcm_read_usb_product(hdev);
	if (!IS_ERR(skb)) {
		bt_dev_info(hdev, "BCM: product %4.4x:%4.4x",
			    get_unaligned_le16(skb->data + 1),
			    get_unaligned_le16(skb->data + 3));
		kfree_skb(skb);
	}

	/* Read Controller Features */
	skb = btbcm_read_controller_features(hdev);
	if (!IS_ERR(skb)) {
		bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
		kfree_skb(skb);
	}

	/* Read Local Name */
	skb = btbcm_read_local_name(hdev);
	if (!IS_ERR(skb)) {
		bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
		kfree_skb(skb);
	}

	set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_setup_apple);

MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION);
MODULE_VERSION(VERSION);
MODULE_LICENSE("GPL");
Commit	Line	Data
4fba30f0 MH	1	/*
	2	*
	3	* Bluetooth support for Broadcom devices
	4	*
	5	* Copyright (C) 2015 Intel Corporation
	6	*
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	21	*
	22	*/
	23
	24	#include <linux/module.h>
1c8ba6d0 MH	25	#include <linux/firmware.h>
1c8ba6d0 MH	26	#include <asm/unaligned.h>
4fba30f0 MH	27
	28	#include <net/bluetooth/bluetooth.h>
	29	#include <net/bluetooth/hci_core.h>
	30
	31	#include "btbcm.h"
	32
	33	#define VERSION "0.1"
	34
	35	#define BDADDR_BCM20702A0 (&(bdaddr_t) {{0x00, 0xa0, 0x02, 0x70, 0x20, 0x00}})
a8f3b941	36	#define BDADDR_BCM4324B3 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb3, 0x24, 0x43}})
4a546ec3	37	#define BDADDR_BCM4330B1 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb1, 0x30, 0x43}})
4fba30f0 MH	38
	39	int btbcm_check_bdaddr(struct hci_dev *hdev)
	40	{
	41	struct hci_rp_read_bd_addr *bda;
	42	struct sk_buff *skb;
	43
	44	skb = __hci_cmd_sync(hdev, HCI_OP_READ_BD_ADDR, 0, NULL,
	45	HCI_INIT_TIMEOUT);
	46	if (IS_ERR(skb)) {
	47	int err = PTR_ERR(skb);
2064ee33	48	bt_dev_err(hdev, "BCM: Reading device address failed (%d)", err);
4fba30f0 MH	49	return err;
	50	}
	51
	52	if (skb->len != sizeof(*bda)) {
2064ee33	53	bt_dev_err(hdev, "BCM: Device address length mismatch");
4fba30f0 MH	54	kfree_skb(skb);
	55	return -EIO;
	56	}
	57
	58	bda = (struct hci_rp_read_bd_addr *)skb->data;
4fba30f0	59
a8f3b941 FD	60	/* Check if the address indicates a controller with either an
	61	* invalid or default address. In both cases the device needs
	62	* to be marked as not having a valid address.
	63	*
	64	* The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
4fba30f0	65	* with no configured address.
a8f3b941 FD	66	*
	67	* The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
	68	* with waiting for configuration state.
4a546ec3 FD	69	*
	70	* The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
	71	* with waiting for configuration state.
4fba30f0	72	*/
a8f3b941	73	if (!bacmp(&bda->bdaddr, BDADDR_BCM20702A0) \|\|
4a546ec3 FD	74	!bacmp(&bda->bdaddr, BDADDR_BCM4324B3) \|\|
4a546ec3 FD	75	!bacmp(&bda->bdaddr, BDADDR_BCM4330B1)) {
2064ee33 MH	76	bt_dev_info(hdev, "BCM: Using default device address (%pMR)",
2064ee33 MH	77	&bda->bdaddr);
4fba30f0 MH	78	set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
	79	}
	80
	81	kfree_skb(skb);
	82
	83	return 0;
	84	}
	85	EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);
	86
	87	int btbcm_set_bdaddr(struct hci_dev hdev, const bdaddr_t bdaddr)
	88	{
	89	struct sk_buff *skb;
	90	int err;
	91
	92	skb = __hci_cmd_sync(hdev, 0xfc01, 6, bdaddr, HCI_INIT_TIMEOUT);
	93	if (IS_ERR(skb)) {
	94	err = PTR_ERR(skb);
2064ee33	95	bt_dev_err(hdev, "BCM: Change address command failed (%d)", err);
4fba30f0 MH	96	return err;
	97	}
	98	kfree_skb(skb);
	99
	100	return 0;
	101	}
	102	EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);
	103
18aeb444	104	int btbcm_patchram(struct hci_dev hdev, const struct firmware fw)
50862ee5 MH	105	{
50862ee5 MH	106	const struct hci_command_hdr *cmd;
50862ee5 MH	107	const u8 *fw_ptr;
	108	size_t fw_size;
	109	struct sk_buff *skb;
	110	u16 opcode;
18aeb444	111	int err = 0;
50862ee5 MH	112
	113	/* Start Download */
	114	skb = __hci_cmd_sync(hdev, 0xfc2e, 0, NULL, HCI_INIT_TIMEOUT);
	115	if (IS_ERR(skb)) {
	116	err = PTR_ERR(skb);
2064ee33 MH	117	bt_dev_err(hdev, "BCM: Download Minidrv command failed (%d)",
2064ee33 MH	118	err);
50862ee5 MH	119	goto done;
	120	}
	121	kfree_skb(skb);
	122
	123	/* 50 msec delay after Download Minidrv completes */
	124	msleep(50);
	125
	126	fw_ptr = fw->data;
	127	fw_size = fw->size;
	128
	129	while (fw_size >= sizeof(*cmd)) {
	130	const u8 *cmd_param;
	131
	132	cmd = (struct hci_command_hdr *)fw_ptr;
	133	fw_ptr += sizeof(*cmd);
	134	fw_size -= sizeof(*cmd);
	135
	136	if (fw_size < cmd->plen) {
2064ee33	137	bt_dev_err(hdev, "BCM: Patch is corrupted");
50862ee5 MH	138	err = -EINVAL;
	139	goto done;
	140	}
	141
	142	cmd_param = fw_ptr;
	143	fw_ptr += cmd->plen;
	144	fw_size -= cmd->plen;
	145
	146	opcode = le16_to_cpu(cmd->opcode);
	147
	148	skb = __hci_cmd_sync(hdev, opcode, cmd->plen, cmd_param,
	149	HCI_INIT_TIMEOUT);
	150	if (IS_ERR(skb)) {
	151	err = PTR_ERR(skb);
2064ee33 MH	152	bt_dev_err(hdev, "BCM: Patch command %04x failed (%d)",
2064ee33 MH	153	opcode, err);
50862ee5 MH	154	goto done;
	155	}
	156	kfree_skb(skb);
	157	}
	158
	159	/* 250 msec delay after Launch Ram completes */
	160	msleep(250);
	161
	162	done:
50862ee5 MH	163	return err;
	164	}
	165	EXPORT_SYMBOL(btbcm_patchram);
	166
1c8ba6d0 MH	167	static int btbcm_reset(struct hci_dev *hdev)
	168	{
	169	struct sk_buff *skb;
	170
	171	skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
	172	if (IS_ERR(skb)) {
	173	int err = PTR_ERR(skb);
2064ee33	174	bt_dev_err(hdev, "BCM: Reset failed (%d)", err);
1c8ba6d0 MH	175	return err;
	176	}
	177	kfree_skb(skb);
	178
3af3a594 WJS	179	/* 100 msec delay for module to complete reset process */
	180	msleep(100);
	181
1c8ba6d0 MH	182	return 0;
	183	}
	184
9bc63ca0 MH	185	static struct sk_buff btbcm_read_local_name(struct hci_dev hdev)
	186	{
	187	struct sk_buff *skb;
	188
	189	skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_NAME, 0, NULL,
	190	HCI_INIT_TIMEOUT);
	191	if (IS_ERR(skb)) {
2064ee33 MH	192	bt_dev_err(hdev, "BCM: Reading local name failed (%ld)",
2064ee33 MH	193	PTR_ERR(skb));
9bc63ca0 MH	194	return skb;
	195	}
	196
	197	if (skb->len != sizeof(struct hci_rp_read_local_name)) {
2064ee33	198	bt_dev_err(hdev, "BCM: Local name length mismatch");
9bc63ca0 MH	199	kfree_skb(skb);
	200	return ERR_PTR(-EIO);
	201	}
	202
	203	return skb;
	204	}
	205
1c8ba6d0 MH	206	static struct sk_buff btbcm_read_local_version(struct hci_dev hdev)
	207	{
	208	struct sk_buff *skb;
	209
	210	skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
	211	HCI_INIT_TIMEOUT);
	212	if (IS_ERR(skb)) {
2064ee33 MH	213	bt_dev_err(hdev, "BCM: Reading local version info failed (%ld)",
2064ee33 MH	214	PTR_ERR(skb));
1c8ba6d0 MH	215	return skb;
	216	}
	217
	218	if (skb->len != sizeof(struct hci_rp_read_local_version)) {
2064ee33	219	bt_dev_err(hdev, "BCM: Local version length mismatch");
1c8ba6d0 MH	220	kfree_skb(skb);
	221	return ERR_PTR(-EIO);
	222	}
	223
	224	return skb;
	225	}
	226
	227	static struct sk_buff btbcm_read_verbose_config(struct hci_dev hdev)
	228	{
	229	struct sk_buff *skb;
	230
	231	skb = __hci_cmd_sync(hdev, 0xfc79, 0, NULL, HCI_INIT_TIMEOUT);
	232	if (IS_ERR(skb)) {
2064ee33 MH	233	bt_dev_err(hdev, "BCM: Read verbose config info failed (%ld)",
2064ee33 MH	234	PTR_ERR(skb));
1c8ba6d0 MH	235	return skb;
	236	}
	237
	238	if (skb->len != 7) {
2064ee33	239	bt_dev_err(hdev, "BCM: Verbose config length mismatch");
1c8ba6d0 MH	240	kfree_skb(skb);
	241	return ERR_PTR(-EIO);
	242	}
	243
	244	return skb;
	245	}
	246
4284ecbe MH	247	static struct sk_buff btbcm_read_controller_features(struct hci_dev hdev)
	248	{
	249	struct sk_buff *skb;
	250
	251	skb = __hci_cmd_sync(hdev, 0xfc6e, 0, NULL, HCI_INIT_TIMEOUT);
	252	if (IS_ERR(skb)) {
2064ee33 MH	253	bt_dev_err(hdev, "BCM: Read controller features failed (%ld)",
2064ee33 MH	254	PTR_ERR(skb));
4284ecbe MH	255	return skb;
	256	}
	257
	258	if (skb->len != 9) {
2064ee33	259	bt_dev_err(hdev, "BCM: Controller features length mismatch");
4284ecbe MH	260	kfree_skb(skb);
	261	return ERR_PTR(-EIO);
	262	}
	263
	264	return skb;
	265	}
	266
1c8ba6d0 MH	267	static struct sk_buff btbcm_read_usb_product(struct hci_dev hdev)
	268	{
	269	struct sk_buff *skb;
	270
	271	skb = __hci_cmd_sync(hdev, 0xfc5a, 0, NULL, HCI_INIT_TIMEOUT);
	272	if (IS_ERR(skb)) {
2064ee33 MH	273	bt_dev_err(hdev, "BCM: Read USB product info failed (%ld)",
2064ee33 MH	274	PTR_ERR(skb));
1c8ba6d0 MH	275	return skb;
	276	}
	277
	278	if (skb->len != 5) {
2064ee33	279	bt_dev_err(hdev, "BCM: USB product length mismatch");
1c8ba6d0 MH	280	kfree_skb(skb);
	281	return ERR_PTR(-EIO);
	282	}
	283
	284	return skb;
	285	}
	286
e76dc1dd MH	287	static int btbcm_read_info(struct hci_dev *hdev)
	288	{
	289	struct sk_buff *skb;
	290
	291	/* Read Verbose Config Version Info */
	292	skb = btbcm_read_verbose_config(hdev);
	293	if (IS_ERR(skb))
	294	return PTR_ERR(skb);
	295
2064ee33	296	bt_dev_info(hdev, "BCM: chip id %u", skb->data[1]);
e76dc1dd MH	297	kfree_skb(skb);
	298
	299	/* Read Controller Features */
	300	skb = btbcm_read_controller_features(hdev);
	301	if (IS_ERR(skb))
	302	return PTR_ERR(skb);
	303
2064ee33	304	bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
e76dc1dd MH	305	kfree_skb(skb);
	306
	307	/* Read Local Name */
	308	skb = btbcm_read_local_name(hdev);
	309	if (IS_ERR(skb))
	310	return PTR_ERR(skb);
	311
2064ee33	312	bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
e76dc1dd MH	313	kfree_skb(skb);
	314
	315	return 0;
	316	}
	317
f7328381	318	struct bcm_subver_table {
1c8ba6d0 MH	319	u16 subver;
1c8ba6d0 MH	320	const char *name;
f7328381 HG	321	};
	322
	323	static const struct bcm_subver_table bcm_uart_subver_table[] = {
4a546ec3	324	{ 0x4103, "BCM4330B1" }, /* 002.001.003 */
9a0bb57d	325	{ 0x410e, "BCM43341B0" }, /* 002.001.014 */
a8f3b941	326	{ 0x4406, "BCM4324B3" }, /* 002.004.006 */
40db5f0e	327	{ 0x610c, "BCM4354" }, /* 003.001.012 */
d456f678	328	{ 0x2122, "BCM4343A0" }, /* 001.001.034 */
feb16722	329	{ 0x2209, "BCM43430A1" }, /* 001.002.009 */
18a39b9a	330	{ 0x6119, "BCM4345C0" }, /* 003.001.025 */
b133e0c4	331	{ 0x230f, "BCM4356A2" }, /* 001.003.015 */
9a0bb57d MH	332	{ }
	333	};
	334
fec0de23 HG	335	static const struct bcm_subver_table bcm_usb_subver_table[] = {
	336	{ 0x210b, "BCM43142A0" }, /* 001.001.011 */
	337	{ 0x2112, "BCM4314A0" }, /* 001.001.018 */
	338	{ 0x2118, "BCM20702A0" }, /* 001.001.024 */
	339	{ 0x2126, "BCM4335A0" }, /* 001.001.038 */
	340	{ 0x220e, "BCM20702A1" }, /* 001.002.014 */
	341	{ 0x230f, "BCM4354A2" }, /* 001.003.015 */
	342	{ 0x4106, "BCM4335B0" }, /* 002.001.006 */
	343	{ 0x410e, "BCM20702B0" }, /* 002.001.014 */
	344	{ 0x6109, "BCM4335C0" }, /* 003.001.009 */
	345	{ 0x610c, "BCM4354" }, /* 003.001.012 */
	346	{ }
	347	};
	348
22ac1916 HG	349	int btbcm_initialize(struct hci_dev hdev, char fw_name, size_t len,
22ac1916 HG	350	bool reinit)
75e167e6	351	{
fec0de23	352	u16 subver, rev, pid, vid;
75e167e6 FD	353	const char *hw_name = NULL;
	354	struct sk_buff *skb;
	355	struct hci_rp_read_local_version *ver;
fec0de23	356	const struct bcm_subver_table *bcm_subver_table;
75e167e6 FD	357	int i, err;
	358
	359	/* Reset */
	360	err = btbcm_reset(hdev);
	361	if (err)
	362	return err;
	363
	364	/* Read Local Version Info */
	365	skb = btbcm_read_local_version(hdev);
	366	if (IS_ERR(skb))
	367	return PTR_ERR(skb);
	368
	369	ver = (struct hci_rp_read_local_version *)skb->data;
	370	rev = le16_to_cpu(ver->hci_rev);
	371	subver = le16_to_cpu(ver->lmp_subver);
	372	kfree_skb(skb);
	373
e76dc1dd	374	/* Read controller information */
22ac1916 HG	375	if (!reinit) {
	376	err = btbcm_read_info(hdev);
	377	if (err)
	378	return err;
	379	}
75e167e6	380
fec0de23 HG	381	/* Upper nibble of rev should be between 0 and 3? */
	382	if (((rev & 0xf000) >> 12) > 3)
	383	return 0;
	384
	385	bcm_subver_table = (hdev->bus == HCI_USB) ? bcm_usb_subver_table :
	386	bcm_uart_subver_table;
	387
	388	for (i = 0; bcm_subver_table[i].name; i++) {
	389	if (subver == bcm_subver_table[i].subver) {
	390	hw_name = bcm_subver_table[i].name;
	391	break;
75e167e6	392	}
fec0de23	393	}
75e167e6	394
fec0de23 HG	395	if (hdev->bus == HCI_USB) {
	396	/* Read USB Product Info */
	397	skb = btbcm_read_usb_product(hdev);
	398	if (IS_ERR(skb))
	399	return PTR_ERR(skb);
	400
	401	vid = get_unaligned_le16(skb->data + 1);
	402	pid = get_unaligned_le16(skb->data + 3);
	403	kfree_skb(skb);
	404
	405	snprintf(fw_name, len, "brcm/%s-%4.4x-%4.4x.hcd",
	406	hw_name ? : "BCM", vid, pid);
	407	} else {
	408	snprintf(fw_name, len, "brcm/%s.hcd",
	409	hw_name ? : "BCM");
75e167e6 FD	410	}
75e167e6 FD	411
2064ee33 MH	412	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
	413	hw_name ? : "BCM", (subver & 0xe000) >> 13,
	414	(subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
75e167e6 FD	415
	416	return 0;
	417	}
	418	EXPORT_SYMBOL_GPL(btbcm_initialize);
	419
	420	int btbcm_finalize(struct hci_dev *hdev)
	421	{
22ac1916	422	char fw_name[64];
75e167e6 FD	423	int err;
75e167e6 FD	424
22ac1916 HG	425	/* Re-initialize */
22ac1916 HG	426	err = btbcm_initialize(hdev, fw_name, sizeof(fw_name), true);
75e167e6 FD	427	if (err)
	428	return err;
	429
75e167e6 FD	430	btbcm_check_bdaddr(hdev);
	431
	432	set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
	433
	434	return 0;
	435	}
	436	EXPORT_SYMBOL_GPL(btbcm_finalize);
	437
1c8ba6d0 MH	438	int btbcm_setup_patchram(struct hci_dev *hdev)
1c8ba6d0 MH	439	{
1c8ba6d0	440	char fw_name[64];
18aeb444	441	const struct firmware *fw;
50862ee5	442	u16 subver, rev, pid, vid;
1c8ba6d0 MH	443	const char *hw_name = NULL;
	444	struct sk_buff *skb;
	445	struct hci_rp_read_local_version *ver;
f7328381	446	const struct bcm_subver_table *bcm_subver_table;
1c8ba6d0 MH	447	int i, err;
	448
	449	/* Reset */
	450	err = btbcm_reset(hdev);
	451	if (err)
	452	return err;
	453
	454	/* Read Local Version Info */
	455	skb = btbcm_read_local_version(hdev);
	456	if (IS_ERR(skb))
	457	return PTR_ERR(skb);
	458
	459	ver = (struct hci_rp_read_local_version *)skb->data;
	460	rev = le16_to_cpu(ver->hci_rev);
	461	subver = le16_to_cpu(ver->lmp_subver);
	462	kfree_skb(skb);
	463
e76dc1dd MH	464	/* Read controller information */
	465	err = btbcm_read_info(hdev);
	466	if (err)
	467	return err;
9bc63ca0	468
1b2525c0 HG	469	/* Upper nibble of rev should be between 0 and 3? */
	470	if (((rev & 0xf000) >> 12) > 3)
	471	return 0;
	472
f7328381 HG	473	bcm_subver_table = (hdev->bus == HCI_USB) ? bcm_usb_subver_table :
	474	bcm_uart_subver_table;
	475
	476	for (i = 0; bcm_subver_table[i].name; i++) {
	477	if (subver == bcm_subver_table[i].subver) {
	478	hw_name = bcm_subver_table[i].name;
	479	break;
9a0bb57d	480	}
f7328381	481	}
1c8ba6d0	482
f7328381	483	if (hdev->bus == HCI_USB) {
9a0bb57d MH	484	/* Read USB Product Info */
	485	skb = btbcm_read_usb_product(hdev);
	486	if (IS_ERR(skb))
	487	return PTR_ERR(skb);
	488
	489	vid = get_unaligned_le16(skb->data + 1);
	490	pid = get_unaligned_le16(skb->data + 3);
	491	kfree_skb(skb);
1c8ba6d0	492
9a0bb57d MH	493	snprintf(fw_name, sizeof(fw_name), "brcm/%s-%4.4x-%4.4x.hcd",
9a0bb57d MH	494	hw_name ? : "BCM", vid, pid);
f7328381 HG	495	} else {
	496	snprintf(fw_name, sizeof(fw_name), "brcm/%s.hcd",
	497	hw_name ? : "BCM");
1c8ba6d0 MH	498	}
1c8ba6d0 MH	499
2064ee33 MH	500	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
	501	hw_name ? : "BCM", (subver & 0xe000) >> 13,
	502	(subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
1c8ba6d0	503
18aeb444 FD	504	err = request_firmware(&fw, fw_name, &hdev->dev);
18aeb444 FD	505	if (err < 0) {
2064ee33	506	bt_dev_info(hdev, "BCM: Patch %s not found", fw_name);
ad750fa1	507	goto done;
18aeb444 FD	508	}
	509
	510	btbcm_patchram(hdev, fw);
	511
	512	release_firmware(fw);
1c8ba6d0	513
1c8ba6d0 MH	514	/* Reset */
	515	err = btbcm_reset(hdev);
	516	if (err)
50862ee5	517	return err;
1c8ba6d0 MH	518
	519	/* Read Local Version Info */
	520	skb = btbcm_read_local_version(hdev);
50862ee5 MH	521	if (IS_ERR(skb))
50862ee5 MH	522	return PTR_ERR(skb);
1c8ba6d0 MH	523
	524	ver = (struct hci_rp_read_local_version *)skb->data;
	525	rev = le16_to_cpu(ver->hci_rev);
	526	subver = le16_to_cpu(ver->lmp_subver);
	527	kfree_skb(skb);
	528
2064ee33 MH	529	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
	530	hw_name ? : "BCM", (subver & 0xe000) >> 13,
	531	(subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
1c8ba6d0	532
9bc63ca0 MH	533	/* Read Local Name */
	534	skb = btbcm_read_local_name(hdev);
	535	if (IS_ERR(skb))
	536	return PTR_ERR(skb);
	537
2064ee33	538	bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
9bc63ca0 MH	539	kfree_skb(skb);
9bc63ca0 MH	540
ad750fa1	541	done:
1c8ba6d0 MH	542	btbcm_check_bdaddr(hdev);
1c8ba6d0 MH	543
941521e2 MH	544	set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
941521e2 MH	545
50862ee5	546	return 0;
1c8ba6d0 MH	547	}
	548	EXPORT_SYMBOL_GPL(btbcm_setup_patchram);
	549
	550	int btbcm_setup_apple(struct hci_dev *hdev)
	551	{
	552	struct sk_buff *skb;
b224d3ff MH	553	int err;
	554
	555	/* Reset */
	556	err = btbcm_reset(hdev);
	557	if (err)
	558	return err;
1c8ba6d0 MH	559
	560	/* Read Verbose Config Version Info */
	561	skb = btbcm_read_verbose_config(hdev);
7bee8b08	562	if (!IS_ERR(skb)) {
2064ee33 MH	563	bt_dev_info(hdev, "BCM: chip id %u build %4.4u",
2064ee33 MH	564	skb->data[1], get_unaligned_le16(skb->data + 5));
7bee8b08 CM	565	kfree_skb(skb);
7bee8b08 CM	566	}
1c8ba6d0	567
34cea41e MH	568	/* Read USB Product Info */
	569	skb = btbcm_read_usb_product(hdev);
	570	if (!IS_ERR(skb)) {
2064ee33 MH	571	bt_dev_info(hdev, "BCM: product %4.4x:%4.4x",
	572	get_unaligned_le16(skb->data + 1),
	573	get_unaligned_le16(skb->data + 3));
34cea41e MH	574	kfree_skb(skb);
	575	}
	576
4284ecbe MH	577	/* Read Controller Features */
	578	skb = btbcm_read_controller_features(hdev);
	579	if (!IS_ERR(skb)) {
2064ee33	580	bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
4284ecbe MH	581	kfree_skb(skb);
	582	}
	583
9bc63ca0 MH	584	/* Read Local Name */
	585	skb = btbcm_read_local_name(hdev);
	586	if (!IS_ERR(skb)) {
2064ee33	587	bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
9bc63ca0 MH	588	kfree_skb(skb);
	589	}
	590
941521e2 MH	591	set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
941521e2 MH	592
1c8ba6d0 MH	593	return 0;
	594	}
	595	EXPORT_SYMBOL_GPL(btbcm_setup_apple);
	596
4fba30f0 MH	597	MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
	598	MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION);
	599	MODULE_VERSION(VERSION);
	600	MODULE_LICENSE("GPL");