1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Bluetooth support for Broadcom devices
6 * Copyright (C) 2015 Intel Corporation
9 #include <linux/module.h>
10 #include <linux/firmware.h>
11 #include <asm/unaligned.h>
13 #include <net/bluetooth/bluetooth.h>
14 #include <net/bluetooth/hci_core.h>
20 #define BDADDR_BCM20702A0 (&(bdaddr_t) {{0x00, 0xa0, 0x02, 0x70, 0x20, 0x00}})
21 #define BDADDR_BCM20702A1 (&(bdaddr_t) {{0x00, 0x00, 0xa0, 0x02, 0x70, 0x20}})
22 #define BDADDR_BCM2076B1 (&(bdaddr_t) {{0x79, 0x56, 0x00, 0xa0, 0x76, 0x20}})
23 #define BDADDR_BCM43430A0 (&(bdaddr_t) {{0xac, 0x1f, 0x12, 0xa0, 0x43, 0x43}})
24 #define BDADDR_BCM4324B3 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb3, 0x24, 0x43}})
25 #define BDADDR_BCM4330B1 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb1, 0x30, 0x43}})
26 #define BDADDR_BCM4345C5 (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0xc5, 0x45, 0x43}})
27 #define BDADDR_BCM43341B (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0x1b, 0x34, 0x43}})
29 int btbcm_check_bdaddr(struct hci_dev *hdev)
31 struct hci_rp_read_bd_addr *bda;
34 skb = __hci_cmd_sync(hdev, HCI_OP_READ_BD_ADDR, 0, NULL,
37 int err = PTR_ERR(skb);
38 bt_dev_err(hdev, "BCM: Reading device address failed (%d)", err);
42 if (skb->len != sizeof(*bda)) {
43 bt_dev_err(hdev, "BCM: Device address length mismatch");
48 bda = (struct hci_rp_read_bd_addr *)skb->data;
50 /* Check if the address indicates a controller with either an
51 * invalid or default address. In both cases the device needs
52 * to be marked as not having a valid address.
54 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
55 * with no configured address.
57 * The address 20:70:02:A0:00:00 indicates a BCM20702A1 controller
58 * with no configured address.
60 * The address 20:76:A0:00:56:79 indicates a BCM2076B1 controller
61 * with no configured address.
63 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
64 * with waiting for configuration state.
66 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
67 * with waiting for configuration state.
69 * The address 43:43:A0:12:1F:AC indicates a BCM43430A0 controller
70 * with no configured address.
72 if (!bacmp(&bda->bdaddr, BDADDR_BCM20702A0) ||
73 !bacmp(&bda->bdaddr, BDADDR_BCM20702A1) ||
74 !bacmp(&bda->bdaddr, BDADDR_BCM2076B1) ||
75 !bacmp(&bda->bdaddr, BDADDR_BCM4324B3) ||
76 !bacmp(&bda->bdaddr, BDADDR_BCM4330B1) ||
77 !bacmp(&bda->bdaddr, BDADDR_BCM4345C5) ||
78 !bacmp(&bda->bdaddr, BDADDR_BCM43430A0) ||
79 !bacmp(&bda->bdaddr, BDADDR_BCM43341B)) {
80 bt_dev_info(hdev, "BCM: Using default device address (%pMR)",
82 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
89 EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);
91 int btbcm_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
96 skb = __hci_cmd_sync(hdev, 0xfc01, 6, bdaddr, HCI_INIT_TIMEOUT);
99 bt_dev_err(hdev, "BCM: Change address command failed (%d)", err);
106 EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);
108 int btbcm_patchram(struct hci_dev *hdev, const struct firmware *fw)
110 const struct hci_command_hdr *cmd;
118 skb = __hci_cmd_sync(hdev, 0xfc2e, 0, NULL, HCI_INIT_TIMEOUT);
121 bt_dev_err(hdev, "BCM: Download Minidrv command failed (%d)",
127 /* 50 msec delay after Download Minidrv completes */
133 while (fw_size >= sizeof(*cmd)) {
136 cmd = (struct hci_command_hdr *)fw_ptr;
137 fw_ptr += sizeof(*cmd);
138 fw_size -= sizeof(*cmd);
140 if (fw_size < cmd->plen) {
141 bt_dev_err(hdev, "BCM: Patch is corrupted");
148 fw_size -= cmd->plen;
150 opcode = le16_to_cpu(cmd->opcode);
152 skb = __hci_cmd_sync(hdev, opcode, cmd->plen, cmd_param,
156 bt_dev_err(hdev, "BCM: Patch command %04x failed (%d)",
163 /* 250 msec delay after Launch Ram completes */
169 EXPORT_SYMBOL(btbcm_patchram);
171 static int btbcm_reset(struct hci_dev *hdev)
175 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
177 int err = PTR_ERR(skb);
178 bt_dev_err(hdev, "BCM: Reset failed (%d)", err);
183 /* 100 msec delay for module to complete reset process */
189 static struct sk_buff *btbcm_read_local_name(struct hci_dev *hdev)
193 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_NAME, 0, NULL,
196 bt_dev_err(hdev, "BCM: Reading local name failed (%ld)",
201 if (skb->len != sizeof(struct hci_rp_read_local_name)) {
202 bt_dev_err(hdev, "BCM: Local name length mismatch");
204 return ERR_PTR(-EIO);
210 static struct sk_buff *btbcm_read_local_version(struct hci_dev *hdev)
214 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
217 bt_dev_err(hdev, "BCM: Reading local version info failed (%ld)",
222 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
223 bt_dev_err(hdev, "BCM: Local version length mismatch");
225 return ERR_PTR(-EIO);
231 static struct sk_buff *btbcm_read_verbose_config(struct hci_dev *hdev)
235 skb = __hci_cmd_sync(hdev, 0xfc79, 0, NULL, HCI_INIT_TIMEOUT);
237 bt_dev_err(hdev, "BCM: Read verbose config info failed (%ld)",
243 bt_dev_err(hdev, "BCM: Verbose config length mismatch");
245 return ERR_PTR(-EIO);
251 static struct sk_buff *btbcm_read_controller_features(struct hci_dev *hdev)
255 skb = __hci_cmd_sync(hdev, 0xfc6e, 0, NULL, HCI_INIT_TIMEOUT);
257 bt_dev_err(hdev, "BCM: Read controller features failed (%ld)",
263 bt_dev_err(hdev, "BCM: Controller features length mismatch");
265 return ERR_PTR(-EIO);
271 static struct sk_buff *btbcm_read_usb_product(struct hci_dev *hdev)
275 skb = __hci_cmd_sync(hdev, 0xfc5a, 0, NULL, HCI_INIT_TIMEOUT);
277 bt_dev_err(hdev, "BCM: Read USB product info failed (%ld)",
283 bt_dev_err(hdev, "BCM: USB product length mismatch");
285 return ERR_PTR(-EIO);
291 static int btbcm_read_info(struct hci_dev *hdev)
295 /* Read Verbose Config Version Info */
296 skb = btbcm_read_verbose_config(hdev);
300 bt_dev_info(hdev, "BCM: chip id %u", skb->data[1]);
303 /* Read Controller Features */
304 skb = btbcm_read_controller_features(hdev);
308 bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
311 /* Read Local Name */
312 skb = btbcm_read_local_name(hdev);
316 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
322 struct bcm_subver_table {
327 static const struct bcm_subver_table bcm_uart_subver_table[] = {
328 { 0x4103, "BCM4330B1" }, /* 002.001.003 */
329 { 0x410e, "BCM43341B0" }, /* 002.001.014 */
330 { 0x4204, "BCM2076B1" }, /* 002.002.004 */
331 { 0x4406, "BCM4324B3" }, /* 002.004.006 */
332 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
333 { 0x610c, "BCM4354" }, /* 003.001.012 */
334 { 0x2122, "BCM4343A0" }, /* 001.001.034 */
335 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
336 { 0x6119, "BCM4345C0" }, /* 003.001.025 */
337 { 0x6606, "BCM4345C5" }, /* 003.006.006 */
338 { 0x230f, "BCM4356A2" }, /* 001.003.015 */
339 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
340 { 0x4217, "BCM4329B1" }, /* 002.002.023 */
341 { 0x6106, "BCM4359C0" }, /* 003.001.006 */
345 static const struct bcm_subver_table bcm_usb_subver_table[] = {
346 { 0x210b, "BCM43142A0" }, /* 001.001.011 */
347 { 0x2112, "BCM4314A0" }, /* 001.001.018 */
348 { 0x2118, "BCM20702A0" }, /* 001.001.024 */
349 { 0x2126, "BCM4335A0" }, /* 001.001.038 */
350 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
351 { 0x230f, "BCM4354A2" }, /* 001.003.015 */
352 { 0x4106, "BCM4335B0" }, /* 002.001.006 */
353 { 0x410e, "BCM20702B0" }, /* 002.001.014 */
354 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
355 { 0x610c, "BCM4354" }, /* 003.001.012 */
359 int btbcm_initialize(struct hci_dev *hdev, char *fw_name, size_t len,
362 u16 subver, rev, pid, vid;
363 const char *hw_name = "BCM";
365 struct hci_rp_read_local_version *ver;
366 const struct bcm_subver_table *bcm_subver_table;
370 err = btbcm_reset(hdev);
374 /* Read Local Version Info */
375 skb = btbcm_read_local_version(hdev);
379 ver = (struct hci_rp_read_local_version *)skb->data;
380 rev = le16_to_cpu(ver->hci_rev);
381 subver = le16_to_cpu(ver->lmp_subver);
384 /* Read controller information */
386 err = btbcm_read_info(hdev);
391 /* Upper nibble of rev should be between 0 and 3? */
392 if (((rev & 0xf000) >> 12) > 3)
395 bcm_subver_table = (hdev->bus == HCI_USB) ? bcm_usb_subver_table :
396 bcm_uart_subver_table;
398 for (i = 0; bcm_subver_table[i].name; i++) {
399 if (subver == bcm_subver_table[i].subver) {
400 hw_name = bcm_subver_table[i].name;
405 if (hdev->bus == HCI_USB) {
406 /* Read USB Product Info */
407 skb = btbcm_read_usb_product(hdev);
411 vid = get_unaligned_le16(skb->data + 1);
412 pid = get_unaligned_le16(skb->data + 3);
415 snprintf(fw_name, len, "brcm/%s-%4.4x-%4.4x.hcd",
418 snprintf(fw_name, len, "brcm/%s.hcd", hw_name);
421 bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
422 hw_name, (subver & 0xe000) >> 13,
423 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
427 EXPORT_SYMBOL_GPL(btbcm_initialize);
429 int btbcm_finalize(struct hci_dev *hdev)
435 err = btbcm_initialize(hdev, fw_name, sizeof(fw_name), true);
439 btbcm_check_bdaddr(hdev);
441 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
445 EXPORT_SYMBOL_GPL(btbcm_finalize);
447 int btbcm_setup_patchram(struct hci_dev *hdev)
450 const struct firmware *fw;
455 err = btbcm_initialize(hdev, fw_name, sizeof(fw_name), false);
459 err = request_firmware(&fw, fw_name, &hdev->dev);
461 bt_dev_info(hdev, "BCM: Patch %s not found", fw_name);
465 btbcm_patchram(hdev, fw);
467 release_firmware(fw);
470 err = btbcm_initialize(hdev, fw_name, sizeof(fw_name), true);
474 /* Read Local Name */
475 skb = btbcm_read_local_name(hdev);
479 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
483 btbcm_check_bdaddr(hdev);
485 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
489 EXPORT_SYMBOL_GPL(btbcm_setup_patchram);
491 int btbcm_setup_apple(struct hci_dev *hdev)
497 err = btbcm_reset(hdev);
501 /* Read Verbose Config Version Info */
502 skb = btbcm_read_verbose_config(hdev);
504 bt_dev_info(hdev, "BCM: chip id %u build %4.4u",
505 skb->data[1], get_unaligned_le16(skb->data + 5));
509 /* Read USB Product Info */
510 skb = btbcm_read_usb_product(hdev);
512 bt_dev_info(hdev, "BCM: product %4.4x:%4.4x",
513 get_unaligned_le16(skb->data + 1),
514 get_unaligned_le16(skb->data + 3));
518 /* Read Controller Features */
519 skb = btbcm_read_controller_features(hdev);
521 bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
525 /* Read Local Name */
526 skb = btbcm_read_local_name(hdev);
528 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
532 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
536 EXPORT_SYMBOL_GPL(btbcm_setup_apple);
538 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
539 MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION);
540 MODULE_VERSION(VERSION);
541 MODULE_LICENSE("GPL");