3 * Bluetooth support for Broadcom devices
5 * Copyright (C) 2015 Intel Corporation
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.
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.
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
24 #include <linux/module.h>
25 #include <linux/firmware.h>
26 #include <asm/unaligned.h>
28 #include <net/bluetooth/bluetooth.h>
29 #include <net/bluetooth/hci_core.h>
35 #define BDADDR_BCM20702A0 (&(bdaddr_t) {{0x00, 0xa0, 0x02, 0x70, 0x20, 0x00}})
36 #define BDADDR_BCM4324B3 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb3, 0x24, 0x43}})
37 #define BDADDR_BCM4330B1 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb1, 0x30, 0x43}})
39 int btbcm_check_bdaddr(struct hci_dev
*hdev
)
41 struct hci_rp_read_bd_addr
*bda
;
44 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_BD_ADDR
, 0, NULL
,
47 int err
= PTR_ERR(skb
);
48 bt_dev_err(hdev
, "BCM: Reading device address failed (%d)", err
);
52 if (skb
->len
!= sizeof(*bda
)) {
53 bt_dev_err(hdev
, "BCM: Device address length mismatch");
58 bda
= (struct hci_rp_read_bd_addr
*)skb
->data
;
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.
64 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
65 * with no configured address.
67 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
68 * with waiting for configuration state.
70 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
71 * with waiting for configuration state.
73 if (!bacmp(&bda
->bdaddr
, BDADDR_BCM20702A0
) ||
74 !bacmp(&bda
->bdaddr
, BDADDR_BCM4324B3
) ||
75 !bacmp(&bda
->bdaddr
, BDADDR_BCM4330B1
)) {
76 bt_dev_info(hdev
, "BCM: Using default device address (%pMR)",
78 set_bit(HCI_QUIRK_INVALID_BDADDR
, &hdev
->quirks
);
85 EXPORT_SYMBOL_GPL(btbcm_check_bdaddr
);
87 int btbcm_set_bdaddr(struct hci_dev
*hdev
, const bdaddr_t
*bdaddr
)
92 skb
= __hci_cmd_sync(hdev
, 0xfc01, 6, bdaddr
, HCI_INIT_TIMEOUT
);
95 bt_dev_err(hdev
, "BCM: Change address command failed (%d)", err
);
102 EXPORT_SYMBOL_GPL(btbcm_set_bdaddr
);
104 int btbcm_patchram(struct hci_dev
*hdev
, const struct firmware
*fw
)
106 const struct hci_command_hdr
*cmd
;
114 skb
= __hci_cmd_sync(hdev
, 0xfc2e, 0, NULL
, HCI_INIT_TIMEOUT
);
117 bt_dev_err(hdev
, "BCM: Download Minidrv command failed (%d)",
123 /* 50 msec delay after Download Minidrv completes */
129 while (fw_size
>= sizeof(*cmd
)) {
132 cmd
= (struct hci_command_hdr
*)fw_ptr
;
133 fw_ptr
+= sizeof(*cmd
);
134 fw_size
-= sizeof(*cmd
);
136 if (fw_size
< cmd
->plen
) {
137 bt_dev_err(hdev
, "BCM: Patch is corrupted");
144 fw_size
-= cmd
->plen
;
146 opcode
= le16_to_cpu(cmd
->opcode
);
148 skb
= __hci_cmd_sync(hdev
, opcode
, cmd
->plen
, cmd_param
,
152 bt_dev_err(hdev
, "BCM: Patch command %04x failed (%d)",
159 /* 250 msec delay after Launch Ram completes */
165 EXPORT_SYMBOL(btbcm_patchram
);
167 static int btbcm_reset(struct hci_dev
*hdev
)
171 skb
= __hci_cmd_sync(hdev
, HCI_OP_RESET
, 0, NULL
, HCI_INIT_TIMEOUT
);
173 int err
= PTR_ERR(skb
);
174 bt_dev_err(hdev
, "BCM: Reset failed (%d)", err
);
179 /* 100 msec delay for module to complete reset process */
185 static struct sk_buff
*btbcm_read_local_name(struct hci_dev
*hdev
)
189 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_NAME
, 0, NULL
,
192 bt_dev_err(hdev
, "BCM: Reading local name failed (%ld)",
197 if (skb
->len
!= sizeof(struct hci_rp_read_local_name
)) {
198 bt_dev_err(hdev
, "BCM: Local name length mismatch");
200 return ERR_PTR(-EIO
);
206 static struct sk_buff
*btbcm_read_local_version(struct hci_dev
*hdev
)
210 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_VERSION
, 0, NULL
,
213 bt_dev_err(hdev
, "BCM: Reading local version info failed (%ld)",
218 if (skb
->len
!= sizeof(struct hci_rp_read_local_version
)) {
219 bt_dev_err(hdev
, "BCM: Local version length mismatch");
221 return ERR_PTR(-EIO
);
227 static struct sk_buff
*btbcm_read_verbose_config(struct hci_dev
*hdev
)
231 skb
= __hci_cmd_sync(hdev
, 0xfc79, 0, NULL
, HCI_INIT_TIMEOUT
);
233 bt_dev_err(hdev
, "BCM: Read verbose config info failed (%ld)",
239 bt_dev_err(hdev
, "BCM: Verbose config length mismatch");
241 return ERR_PTR(-EIO
);
247 static struct sk_buff
*btbcm_read_controller_features(struct hci_dev
*hdev
)
251 skb
= __hci_cmd_sync(hdev
, 0xfc6e, 0, NULL
, HCI_INIT_TIMEOUT
);
253 bt_dev_err(hdev
, "BCM: Read controller features failed (%ld)",
259 bt_dev_err(hdev
, "BCM: Controller features length mismatch");
261 return ERR_PTR(-EIO
);
267 static struct sk_buff
*btbcm_read_usb_product(struct hci_dev
*hdev
)
271 skb
= __hci_cmd_sync(hdev
, 0xfc5a, 0, NULL
, HCI_INIT_TIMEOUT
);
273 bt_dev_err(hdev
, "BCM: Read USB product info failed (%ld)",
279 bt_dev_err(hdev
, "BCM: USB product length mismatch");
281 return ERR_PTR(-EIO
);
287 static int btbcm_read_info(struct hci_dev
*hdev
)
291 /* Read Verbose Config Version Info */
292 skb
= btbcm_read_verbose_config(hdev
);
296 bt_dev_info(hdev
, "BCM: chip id %u", skb
->data
[1]);
299 /* Read Controller Features */
300 skb
= btbcm_read_controller_features(hdev
);
304 bt_dev_info(hdev
, "BCM: features 0x%2.2x", skb
->data
[1]);
307 /* Read Local Name */
308 skb
= btbcm_read_local_name(hdev
);
312 bt_dev_info(hdev
, "%s", (char *)(skb
->data
+ 1));
318 static const struct {
321 } bcm_uart_subver_table
[] = {
322 { 0x4103, "BCM4330B1" }, /* 002.001.003 */
323 { 0x410e, "BCM43341B0" }, /* 002.001.014 */
324 { 0x4406, "BCM4324B3" }, /* 002.004.006 */
325 { 0x610c, "BCM4354" }, /* 003.001.012 */
326 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
327 { 0x6119, "BCM4345C0" }, /* 003.001.025 */
328 { 0x230f, "BCM4356A2" }, /* 001.003.015 */
332 int btbcm_initialize(struct hci_dev
*hdev
, char *fw_name
, size_t len
)
335 const char *hw_name
= NULL
;
337 struct hci_rp_read_local_version
*ver
;
341 err
= btbcm_reset(hdev
);
345 /* Read Local Version Info */
346 skb
= btbcm_read_local_version(hdev
);
350 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
351 rev
= le16_to_cpu(ver
->hci_rev
);
352 subver
= le16_to_cpu(ver
->lmp_subver
);
355 /* Read controller information */
356 err
= btbcm_read_info(hdev
);
360 switch ((rev
& 0xf000) >> 12) {
365 for (i
= 0; bcm_uart_subver_table
[i
].name
; i
++) {
366 if (subver
== bcm_uart_subver_table
[i
].subver
) {
367 hw_name
= bcm_uart_subver_table
[i
].name
;
372 snprintf(fw_name
, len
, "brcm/%s.hcd", hw_name
? : "BCM");
378 bt_dev_info(hdev
, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
379 hw_name
? : "BCM", (subver
& 0xe000) >> 13,
380 (subver
& 0x1f00) >> 8, (subver
& 0x00ff), rev
& 0x0fff);
384 EXPORT_SYMBOL_GPL(btbcm_initialize
);
386 int btbcm_finalize(struct hci_dev
*hdev
)
389 struct hci_rp_read_local_version
*ver
;
394 err
= btbcm_reset(hdev
);
398 /* Read Local Version Info */
399 skb
= btbcm_read_local_version(hdev
);
403 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
404 rev
= le16_to_cpu(ver
->hci_rev
);
405 subver
= le16_to_cpu(ver
->lmp_subver
);
408 bt_dev_info(hdev
, "BCM (%3.3u.%3.3u.%3.3u) build %4.4u",
409 (subver
& 0xe000) >> 13, (subver
& 0x1f00) >> 8,
410 (subver
& 0x00ff), rev
& 0x0fff);
412 btbcm_check_bdaddr(hdev
);
414 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER
, &hdev
->quirks
);
418 EXPORT_SYMBOL_GPL(btbcm_finalize
);
420 static const struct {
423 } bcm_usb_subver_table
[] = {
424 { 0x210b, "BCM43142A0" }, /* 001.001.011 */
425 { 0x2112, "BCM4314A0" }, /* 001.001.018 */
426 { 0x2118, "BCM20702A0" }, /* 001.001.024 */
427 { 0x2126, "BCM4335A0" }, /* 001.001.038 */
428 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
429 { 0x230f, "BCM4354A2" }, /* 001.003.015 */
430 { 0x4106, "BCM4335B0" }, /* 002.001.006 */
431 { 0x410e, "BCM20702B0" }, /* 002.001.014 */
432 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
433 { 0x610c, "BCM4354" }, /* 003.001.012 */
437 int btbcm_setup_patchram(struct hci_dev
*hdev
)
440 const struct firmware
*fw
;
441 u16 subver
, rev
, pid
, vid
;
442 const char *hw_name
= NULL
;
444 struct hci_rp_read_local_version
*ver
;
448 err
= btbcm_reset(hdev
);
452 /* Read Local Version Info */
453 skb
= btbcm_read_local_version(hdev
);
457 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
458 rev
= le16_to_cpu(ver
->hci_rev
);
459 subver
= le16_to_cpu(ver
->lmp_subver
);
462 /* Read controller information */
463 err
= btbcm_read_info(hdev
);
467 switch ((rev
& 0xf000) >> 12) {
470 for (i
= 0; bcm_uart_subver_table
[i
].name
; i
++) {
471 if (subver
== bcm_uart_subver_table
[i
].subver
) {
472 hw_name
= bcm_uart_subver_table
[i
].name
;
477 snprintf(fw_name
, sizeof(fw_name
), "brcm/%s.hcd",
482 /* Read USB Product Info */
483 skb
= btbcm_read_usb_product(hdev
);
487 vid
= get_unaligned_le16(skb
->data
+ 1);
488 pid
= get_unaligned_le16(skb
->data
+ 3);
491 for (i
= 0; bcm_usb_subver_table
[i
].name
; i
++) {
492 if (subver
== bcm_usb_subver_table
[i
].subver
) {
493 hw_name
= bcm_usb_subver_table
[i
].name
;
498 snprintf(fw_name
, sizeof(fw_name
), "brcm/%s-%4.4x-%4.4x.hcd",
499 hw_name
? : "BCM", vid
, pid
);
505 bt_dev_info(hdev
, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
506 hw_name
? : "BCM", (subver
& 0xe000) >> 13,
507 (subver
& 0x1f00) >> 8, (subver
& 0x00ff), rev
& 0x0fff);
509 err
= request_firmware(&fw
, fw_name
, &hdev
->dev
);
511 bt_dev_info(hdev
, "BCM: Patch %s not found", fw_name
);
515 btbcm_patchram(hdev
, fw
);
517 release_firmware(fw
);
520 err
= btbcm_reset(hdev
);
524 /* Read Local Version Info */
525 skb
= btbcm_read_local_version(hdev
);
529 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
530 rev
= le16_to_cpu(ver
->hci_rev
);
531 subver
= le16_to_cpu(ver
->lmp_subver
);
534 bt_dev_info(hdev
, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
535 hw_name
? : "BCM", (subver
& 0xe000) >> 13,
536 (subver
& 0x1f00) >> 8, (subver
& 0x00ff), rev
& 0x0fff);
538 /* Read Local Name */
539 skb
= btbcm_read_local_name(hdev
);
543 bt_dev_info(hdev
, "%s", (char *)(skb
->data
+ 1));
547 btbcm_check_bdaddr(hdev
);
549 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER
, &hdev
->quirks
);
553 EXPORT_SYMBOL_GPL(btbcm_setup_patchram
);
555 int btbcm_setup_apple(struct hci_dev
*hdev
)
561 err
= btbcm_reset(hdev
);
565 /* Read Verbose Config Version Info */
566 skb
= btbcm_read_verbose_config(hdev
);
568 bt_dev_info(hdev
, "BCM: chip id %u build %4.4u",
569 skb
->data
[1], get_unaligned_le16(skb
->data
+ 5));
573 /* Read USB Product Info */
574 skb
= btbcm_read_usb_product(hdev
);
576 bt_dev_info(hdev
, "BCM: product %4.4x:%4.4x",
577 get_unaligned_le16(skb
->data
+ 1),
578 get_unaligned_le16(skb
->data
+ 3));
582 /* Read Controller Features */
583 skb
= btbcm_read_controller_features(hdev
);
585 bt_dev_info(hdev
, "BCM: features 0x%2.2x", skb
->data
[1]);
589 /* Read Local Name */
590 skb
= btbcm_read_local_name(hdev
);
592 bt_dev_info(hdev
, "%s", (char *)(skb
->data
+ 1));
596 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER
, &hdev
->quirks
);
600 EXPORT_SYMBOL_GPL(btbcm_setup_apple
);
602 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
603 MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION
);
604 MODULE_VERSION(VERSION
);
605 MODULE_LICENSE("GPL");