[linux-2.6-block.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_BCM4334B0 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb0, 0x34, 0x43}})
#define BDADDR_BCM4345C5 (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0xc5, 0x45, 0x43}})
#define BDADDR_BCM43341B (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0x1b, 0x34, 0x43}})

#define BCM_FW_NAME_LEN			64

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_BCM4334B0) ||
	    !bacmp(&bda->bdaddr, BDADDR_BCM4345C5) ||
	    !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_read_pcm_int_params(struct hci_dev *hdev,
			      struct bcm_set_pcm_int_params *params)
{
	struct sk_buff *skb;
	int err = 0;

	skb = __hci_cmd_sync(hdev, 0xfc1d, 0, NULL, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		err = PTR_ERR(skb);
		bt_dev_err(hdev, "BCM: Read PCM int params failed (%d)", err);
		return err;
	}

	if (skb->len != 6 || skb->data[0]) {
		bt_dev_err(hdev, "BCM: Read PCM int params length mismatch");
		kfree_skb(skb);
		return -EIO;
	}

	if (params)
		memcpy(params, skb->data + 1, 5);

	kfree_skb(skb);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_read_pcm_int_params);

int btbcm_write_pcm_int_params(struct hci_dev *hdev,
			       const struct bcm_set_pcm_int_params *params)
{
	struct sk_buff *skb;
	int err;

	skb = __hci_cmd_sync(hdev, 0xfc1c, 5, params, HCI_INIT_TIMEOUT);
	if (IS_ERR(skb)) {
		err = PTR_ERR(skb);
		bt_dev_err(hdev, "BCM: Write PCM int params failed (%d)", err);
		return err;
	}
	kfree_skb(skb);

	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_write_pcm_int_params);

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

	return 0;
}

static int btbcm_print_local_name(struct hci_dev *hdev)
{
	struct sk_buff *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 */
	{ 0x410d, "BCM4334B0"	},	/* 002.001.013 */
	{ 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 */
	{ 0x6606, "BCM4345C5"	},	/* 003.006.006 */
	{ 0x230f, "BCM4356A2"	},	/* 001.003.015 */
	{ 0x220e, "BCM20702A1"  },	/* 001.002.014 */
	{ 0x4217, "BCM4329B1"   },	/* 002.002.023 */
	{ 0x6106, "BCM4359C0"	},	/* 003.001.006 */
	{ 0x4106, "BCM4335A0"	},	/* 002.001.006 */
	{ }
};

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, bool *fw_load_done)
{
	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;
	char fw_name[BCM_FW_NAME_LEN];
	const struct firmware *fw;
	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 (!(*fw_load_done)) {
		err = btbcm_read_info(hdev);
		if (err)
			return err;
	}
	err = btbcm_print_local_name(hdev);
	if (err)
		return err;

	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, BCM_FW_NAME_LEN, "brcm/%s-%4.4x-%4.4x.hcd",
			 hw_name, vid, pid);
	} else {
		snprintf(fw_name, BCM_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);

	if (*fw_load_done)
		return 0;

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

	err = btbcm_patchram(hdev, fw);
	if (err)
		bt_dev_info(hdev, "BCM: Patch failed (%d)", err);

	release_firmware(fw);
	*fw_load_done = true;
	return 0;
}
EXPORT_SYMBOL_GPL(btbcm_initialize);

int btbcm_finalize(struct hci_dev *hdev)
{
	bool fw_load_done = true;
	int err;

	/* Re-initialize */
	err = btbcm_initialize(hdev, &fw_load_done);
	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)
{
	bool fw_load_done = false;
	int err;

	/* Initialize */
	err = btbcm_initialize(hdev, &fw_load_done);
	if (err)
		return err;

	if (!fw_load_done)
		goto done;

	/* Re-initialize after loading Patch */
	err = btbcm_initialize(hdev, &fw_load_done);
	if (err)
		return err;

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