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

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *
 *  Bluetooth support for Broadcom devices
 *
 *  Copyright (C) 2015  Intel Corporation
 */

#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_BCM20702A1 (&(bdaddr_t) {{0x00, 0x00, 0xa0, 0x02, 0x70, 0x20}})
#define BDADDR_BCM2076B1 (&(bdaddr_t) {{0x79, 0x56, 0x00, 0xa0, 0x76, 0x20}})
#define BDADDR_BCM43430A0 (&(bdaddr_t) {{0xac, 0x1f, 0x12, 0xa0, 0x43, 0x43}})
#define BDADDR_BCM4324B3 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb3, 0x24, 0x43}})
#define BDADDR_BCM4330B1 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb1, 0x30, 0x43}})
#define BDADDR_BCM43341B (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0x1b, 0x34, 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 20:70:02:A0:00:00 indicates a BCM20702A1 controller
	 * with no configured address.
	 *
	 * The address 20:76:A0:00:56:79 indicates a BCM2076B1 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.
	 *
	 * The address 43:43:A0:12:1F:AC indicates a BCM43430A0 controller
	 * with no configured address.
	 */
	if (!bacmp(&bda->bdaddr, BDADDR_BCM20702A0) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM20702A1) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM2076B1) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM4324B3) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM4330B1) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM43430A0) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM43341B)) {
		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 */
	{ 0x4204, "BCM2076B1"	},	/* 002.002.004 */
	{ 0x4406, "BCM4324B3"	},	/* 002.004.006 */
	{ 0x6109, "BCM4335C0"	},	/* 003.001.009 */
	{ 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 */
	{ 0x220e, "BCM20702A1"  },	/* 001.002.014 */
	{ 0x4217, "BCM4329B1"   },	/* 002.002.023 */
	{ }
};

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 = "BCM";
	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, vid, pid);
	} else {
		snprintf(fw_name, len, "brcm/%s.hcd", hw_name);
	}

	bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
		    hw_name, (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;
	struct sk_buff *skb;
	int err;

	/* Initialize */
	err = btbcm_initialize(hdev, fw_name, sizeof(fw_name), false);
	if (err)
		return err;

	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);

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

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