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_ERR("%s: BCM: Reading device address failed (%d)",
53 if (skb
->len
!= sizeof(*bda
)) {
54 BT_ERR("%s: BCM: Device address length mismatch", hdev
->name
);
59 bda
= (struct hci_rp_read_bd_addr
*)skb
->data
;
61 /* Check if the address indicates a controller with either an
62 * invalid or default address. In both cases the device needs
63 * to be marked as not having a valid address.
65 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
66 * with no configured address.
68 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
69 * with waiting for configuration state.
71 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
72 * with waiting for configuration state.
74 if (!bacmp(&bda
->bdaddr
, BDADDR_BCM20702A0
) ||
75 !bacmp(&bda
->bdaddr
, BDADDR_BCM4324B3
) ||
76 !bacmp(&bda
->bdaddr
, BDADDR_BCM4330B1
)) {
77 BT_INFO("%s: BCM: Using default device address (%pMR)",
78 hdev
->name
, &bda
->bdaddr
);
79 set_bit(HCI_QUIRK_INVALID_BDADDR
, &hdev
->quirks
);
86 EXPORT_SYMBOL_GPL(btbcm_check_bdaddr
);
88 int btbcm_set_bdaddr(struct hci_dev
*hdev
, const bdaddr_t
*bdaddr
)
93 skb
= __hci_cmd_sync(hdev
, 0xfc01, 6, bdaddr
, HCI_INIT_TIMEOUT
);
96 BT_ERR("%s: BCM: Change address command failed (%d)",
104 EXPORT_SYMBOL_GPL(btbcm_set_bdaddr
);
106 int btbcm_patchram(struct hci_dev
*hdev
, const struct firmware
*fw
)
108 const struct hci_command_hdr
*cmd
;
116 skb
= __hci_cmd_sync(hdev
, 0xfc2e, 0, NULL
, HCI_INIT_TIMEOUT
);
119 BT_ERR("%s: BCM: Download Minidrv command failed (%d)",
125 /* 50 msec delay after Download Minidrv completes */
131 while (fw_size
>= sizeof(*cmd
)) {
134 cmd
= (struct hci_command_hdr
*)fw_ptr
;
135 fw_ptr
+= sizeof(*cmd
);
136 fw_size
-= sizeof(*cmd
);
138 if (fw_size
< cmd
->plen
) {
139 BT_ERR("%s: BCM: Patch is corrupted", hdev
->name
);
146 fw_size
-= cmd
->plen
;
148 opcode
= le16_to_cpu(cmd
->opcode
);
150 skb
= __hci_cmd_sync(hdev
, opcode
, cmd
->plen
, cmd_param
,
154 BT_ERR("%s: BCM: Patch command %04x failed (%d)",
155 hdev
->name
, opcode
, err
);
161 /* 250 msec delay after Launch Ram completes */
167 EXPORT_SYMBOL(btbcm_patchram
);
169 static int btbcm_reset(struct hci_dev
*hdev
)
173 skb
= __hci_cmd_sync(hdev
, HCI_OP_RESET
, 0, NULL
, HCI_INIT_TIMEOUT
);
175 int err
= PTR_ERR(skb
);
176 BT_ERR("%s: BCM: Reset failed (%d)", hdev
->name
, err
);
181 /* 100 msec delay for module to complete reset process */
187 static struct sk_buff
*btbcm_read_local_name(struct hci_dev
*hdev
)
191 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_NAME
, 0, NULL
,
194 BT_ERR("%s: BCM: Reading local name failed (%ld)",
195 hdev
->name
, PTR_ERR(skb
));
199 if (skb
->len
!= sizeof(struct hci_rp_read_local_name
)) {
200 BT_ERR("%s: BCM: Local name length mismatch", hdev
->name
);
202 return ERR_PTR(-EIO
);
208 static struct sk_buff
*btbcm_read_local_version(struct hci_dev
*hdev
)
212 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_VERSION
, 0, NULL
,
215 BT_ERR("%s: BCM: Reading local version info failed (%ld)",
216 hdev
->name
, PTR_ERR(skb
));
220 if (skb
->len
!= sizeof(struct hci_rp_read_local_version
)) {
221 BT_ERR("%s: BCM: Local version length mismatch", hdev
->name
);
223 return ERR_PTR(-EIO
);
229 static struct sk_buff
*btbcm_read_verbose_config(struct hci_dev
*hdev
)
233 skb
= __hci_cmd_sync(hdev
, 0xfc79, 0, NULL
, HCI_INIT_TIMEOUT
);
235 BT_ERR("%s: BCM: Read verbose config info failed (%ld)",
236 hdev
->name
, PTR_ERR(skb
));
241 BT_ERR("%s: BCM: Verbose config length mismatch", hdev
->name
);
243 return ERR_PTR(-EIO
);
249 static struct sk_buff
*btbcm_read_controller_features(struct hci_dev
*hdev
)
253 skb
= __hci_cmd_sync(hdev
, 0xfc6e, 0, NULL
, HCI_INIT_TIMEOUT
);
255 BT_ERR("%s: BCM: Read controller features failed (%ld)",
256 hdev
->name
, PTR_ERR(skb
));
261 BT_ERR("%s: BCM: Controller features length mismatch",
264 return ERR_PTR(-EIO
);
270 static struct sk_buff
*btbcm_read_usb_product(struct hci_dev
*hdev
)
274 skb
= __hci_cmd_sync(hdev
, 0xfc5a, 0, NULL
, HCI_INIT_TIMEOUT
);
276 BT_ERR("%s: BCM: Read USB product info failed (%ld)",
277 hdev
->name
, PTR_ERR(skb
));
282 BT_ERR("%s: BCM: USB product length mismatch", hdev
->name
);
284 return ERR_PTR(-EIO
);
290 static const struct {
293 } bcm_uart_subver_table
[] = {
294 { 0x4103, "BCM4330B1" }, /* 002.001.003 */
295 { 0x410e, "BCM43341B0" }, /* 002.001.014 */
296 { 0x4406, "BCM4324B3" }, /* 002.004.006 */
297 { 0x610c, "BCM4354" }, /* 003.001.012 */
298 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
302 int btbcm_initialize(struct hci_dev
*hdev
, char *fw_name
, size_t len
)
305 const char *hw_name
= NULL
;
307 struct hci_rp_read_local_version
*ver
;
311 err
= btbcm_reset(hdev
);
315 /* Read Local Version Info */
316 skb
= btbcm_read_local_version(hdev
);
320 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
321 rev
= le16_to_cpu(ver
->hci_rev
);
322 subver
= le16_to_cpu(ver
->lmp_subver
);
325 /* Read Verbose Config Version Info */
326 skb
= btbcm_read_verbose_config(hdev
);
330 BT_INFO("%s: BCM: chip id %u", hdev
->name
, skb
->data
[1]);
333 switch ((rev
& 0xf000) >> 12) {
337 for (i
= 0; bcm_uart_subver_table
[i
].name
; i
++) {
338 if (subver
== bcm_uart_subver_table
[i
].subver
) {
339 hw_name
= bcm_uart_subver_table
[i
].name
;
344 snprintf(fw_name
, len
, "brcm/%s.hcd", hw_name
? : "BCM");
350 BT_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev
->name
,
351 hw_name
? : "BCM", (subver
& 0xe000) >> 13,
352 (subver
& 0x1f00) >> 8, (subver
& 0x00ff), rev
& 0x0fff);
356 EXPORT_SYMBOL_GPL(btbcm_initialize
);
358 int btbcm_finalize(struct hci_dev
*hdev
)
361 struct hci_rp_read_local_version
*ver
;
366 err
= btbcm_reset(hdev
);
370 /* Read Local Version Info */
371 skb
= btbcm_read_local_version(hdev
);
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
);
380 BT_INFO("%s: BCM (%3.3u.%3.3u.%3.3u) build %4.4u", hdev
->name
,
381 (subver
& 0xe000) >> 13, (subver
& 0x1f00) >> 8,
382 (subver
& 0x00ff), rev
& 0x0fff);
384 btbcm_check_bdaddr(hdev
);
386 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER
, &hdev
->quirks
);
390 EXPORT_SYMBOL_GPL(btbcm_finalize
);
392 static const struct {
395 } bcm_usb_subver_table
[] = {
396 { 0x210b, "BCM43142A0" }, /* 001.001.011 */
397 { 0x2112, "BCM4314A0" }, /* 001.001.018 */
398 { 0x2118, "BCM20702A0" }, /* 001.001.024 */
399 { 0x2126, "BCM4335A0" }, /* 001.001.038 */
400 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
401 { 0x230f, "BCM4354A2" }, /* 001.003.015 */
402 { 0x4106, "BCM4335B0" }, /* 002.001.006 */
403 { 0x410e, "BCM20702B0" }, /* 002.001.014 */
404 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
405 { 0x610c, "BCM4354" }, /* 003.001.012 */
409 int btbcm_setup_patchram(struct hci_dev
*hdev
)
412 const struct firmware
*fw
;
413 u16 subver
, rev
, pid
, vid
;
414 const char *hw_name
= NULL
;
416 struct hci_rp_read_local_version
*ver
;
420 err
= btbcm_reset(hdev
);
424 /* Read Local Version Info */
425 skb
= btbcm_read_local_version(hdev
);
429 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
430 rev
= le16_to_cpu(ver
->hci_rev
);
431 subver
= le16_to_cpu(ver
->lmp_subver
);
434 /* Read Verbose Config Version Info */
435 skb
= btbcm_read_verbose_config(hdev
);
439 BT_INFO("%s: BCM: chip id %u", hdev
->name
, skb
->data
[1]);
442 /* Read Controller Features */
443 skb
= btbcm_read_controller_features(hdev
);
447 BT_INFO("%s: BCM: features 0x%2.2x", hdev
->name
, skb
->data
[1]);
450 /* Read Local Name */
451 skb
= btbcm_read_local_name(hdev
);
455 BT_INFO("%s: %s", hdev
->name
, (char *)(skb
->data
+ 1));
458 switch ((rev
& 0xf000) >> 12) {
461 for (i
= 0; bcm_uart_subver_table
[i
].name
; i
++) {
462 if (subver
== bcm_uart_subver_table
[i
].subver
) {
463 hw_name
= bcm_uart_subver_table
[i
].name
;
468 snprintf(fw_name
, sizeof(fw_name
), "brcm/%s.hcd",
473 /* Read USB Product Info */
474 skb
= btbcm_read_usb_product(hdev
);
478 vid
= get_unaligned_le16(skb
->data
+ 1);
479 pid
= get_unaligned_le16(skb
->data
+ 3);
482 for (i
= 0; bcm_usb_subver_table
[i
].name
; i
++) {
483 if (subver
== bcm_usb_subver_table
[i
].subver
) {
484 hw_name
= bcm_usb_subver_table
[i
].name
;
489 snprintf(fw_name
, sizeof(fw_name
), "brcm/%s-%4.4x-%4.4x.hcd",
490 hw_name
? : "BCM", vid
, pid
);
496 BT_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev
->name
,
497 hw_name
? : "BCM", (subver
& 0xe000) >> 13,
498 (subver
& 0x1f00) >> 8, (subver
& 0x00ff), rev
& 0x0fff);
500 err
= request_firmware(&fw
, fw_name
, &hdev
->dev
);
502 BT_INFO("%s: BCM: Patch %s not found", hdev
->name
, fw_name
);
506 btbcm_patchram(hdev
, fw
);
508 release_firmware(fw
);
511 err
= btbcm_reset(hdev
);
515 /* Read Local Version Info */
516 skb
= btbcm_read_local_version(hdev
);
520 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
521 rev
= le16_to_cpu(ver
->hci_rev
);
522 subver
= le16_to_cpu(ver
->lmp_subver
);
525 BT_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev
->name
,
526 hw_name
? : "BCM", (subver
& 0xe000) >> 13,
527 (subver
& 0x1f00) >> 8, (subver
& 0x00ff), rev
& 0x0fff);
529 /* Read Local Name */
530 skb
= btbcm_read_local_name(hdev
);
534 BT_INFO("%s: %s", hdev
->name
, (char *)(skb
->data
+ 1));
538 btbcm_check_bdaddr(hdev
);
540 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER
, &hdev
->quirks
);
544 EXPORT_SYMBOL_GPL(btbcm_setup_patchram
);
546 int btbcm_setup_apple(struct hci_dev
*hdev
)
552 err
= btbcm_reset(hdev
);
556 /* Read Verbose Config Version Info */
557 skb
= btbcm_read_verbose_config(hdev
);
559 BT_INFO("%s: BCM: chip id %u build %4.4u", hdev
->name
,
560 skb
->data
[1], get_unaligned_le16(skb
->data
+ 5));
564 /* Read USB Product Info */
565 skb
= btbcm_read_usb_product(hdev
);
567 BT_INFO("%s: BCM: product %4.4x:%4.4x", hdev
->name
,
568 get_unaligned_le16(skb
->data
+ 1),
569 get_unaligned_le16(skb
->data
+ 3));
573 /* Read Controller Features */
574 skb
= btbcm_read_controller_features(hdev
);
576 BT_INFO("%s: BCM: features 0x%2.2x", hdev
->name
, skb
->data
[1]);
580 /* Read Local Name */
581 skb
= btbcm_read_local_name(hdev
);
583 BT_INFO("%s: %s", hdev
->name
, (char *)(skb
->data
+ 1));
587 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER
, &hdev
->quirks
);
591 EXPORT_SYMBOL_GPL(btbcm_setup_apple
);
593 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
594 MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION
);
595 MODULE_VERSION(VERSION
);
596 MODULE_LICENSE("GPL");