Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *
4 * Bluetooth support for Broadcom devices
5 *
6 * Copyright (C) 2015 Intel Corporation
7 */
8
9#include <linux/module.h>
10#include <linux/firmware.h>
11#include <linux/dmi.h>
12#include <linux/of.h>
13#include <asm/unaligned.h>
14
15#include <net/bluetooth/bluetooth.h>
16#include <net/bluetooth/hci_core.h>
17
18#include "btbcm.h"
19
20#define VERSION "0.1"
21
22#define BDADDR_BCM20702A0 (&(bdaddr_t) {{0x00, 0xa0, 0x02, 0x70, 0x20, 0x00}})
23#define BDADDR_BCM20702A1 (&(bdaddr_t) {{0x00, 0x00, 0xa0, 0x02, 0x70, 0x20}})
24#define BDADDR_BCM2076B1 (&(bdaddr_t) {{0x79, 0x56, 0x00, 0xa0, 0x76, 0x20}})
25#define BDADDR_BCM43430A0 (&(bdaddr_t) {{0xac, 0x1f, 0x12, 0xa0, 0x43, 0x43}})
26#define BDADDR_BCM4324B3 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb3, 0x24, 0x43}})
27#define BDADDR_BCM4330B1 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb1, 0x30, 0x43}})
28#define BDADDR_BCM4334B0 (&(bdaddr_t) {{0x00, 0x00, 0x00, 0xb0, 0x34, 0x43}})
29#define BDADDR_BCM4345C5 (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0xc5, 0x45, 0x43}})
30#define BDADDR_BCM43341B (&(bdaddr_t) {{0xac, 0x1f, 0x00, 0x1b, 0x34, 0x43}})
31
32#define BCM_FW_NAME_LEN 64
33#define BCM_FW_NAME_COUNT_MAX 4
34/* For kmalloc-ing the fw-name array instead of putting it on the stack */
35typedef char bcm_fw_name[BCM_FW_NAME_LEN];
36
37int btbcm_check_bdaddr(struct hci_dev *hdev)
38{
39 struct hci_rp_read_bd_addr *bda;
40 struct sk_buff *skb;
41
42 skb = __hci_cmd_sync(hdev, HCI_OP_READ_BD_ADDR, 0, NULL,
43 HCI_INIT_TIMEOUT);
44 if (IS_ERR(skb)) {
45 int err = PTR_ERR(skb);
46
47 bt_dev_err(hdev, "BCM: Reading device address failed (%d)", err);
48 return err;
49 }
50
51 if (skb->len != sizeof(*bda)) {
52 bt_dev_err(hdev, "BCM: Device address length mismatch");
53 kfree_skb(skb);
54 return -EIO;
55 }
56
57 bda = (struct hci_rp_read_bd_addr *)skb->data;
58
59 /* Check if the address indicates a controller with either an
60 * invalid or default address. In both cases the device needs
61 * to be marked as not having a valid address.
62 *
63 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
64 * with no configured address.
65 *
66 * The address 20:70:02:A0:00:00 indicates a BCM20702A1 controller
67 * with no configured address.
68 *
69 * The address 20:76:A0:00:56:79 indicates a BCM2076B1 controller
70 * with no configured address.
71 *
72 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
73 * with waiting for configuration state.
74 *
75 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
76 * with waiting for configuration state.
77 *
78 * The address 43:43:A0:12:1F:AC indicates a BCM43430A0 controller
79 * with no configured address.
80 */
81 if (!bacmp(&bda->bdaddr, BDADDR_BCM20702A0) ||
82 !bacmp(&bda->bdaddr, BDADDR_BCM20702A1) ||
83 !bacmp(&bda->bdaddr, BDADDR_BCM2076B1) ||
84 !bacmp(&bda->bdaddr, BDADDR_BCM4324B3) ||
85 !bacmp(&bda->bdaddr, BDADDR_BCM4330B1) ||
86 !bacmp(&bda->bdaddr, BDADDR_BCM4334B0) ||
87 !bacmp(&bda->bdaddr, BDADDR_BCM4345C5) ||
88 !bacmp(&bda->bdaddr, BDADDR_BCM43430A0) ||
89 !bacmp(&bda->bdaddr, BDADDR_BCM43341B)) {
90 bt_dev_info(hdev, "BCM: Using default device address (%pMR)",
91 &bda->bdaddr);
92 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
93 }
94
95 kfree_skb(skb);
96
97 return 0;
98}
99EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);
100
101int btbcm_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
102{
103 struct sk_buff *skb;
104 int err;
105
106 skb = __hci_cmd_sync(hdev, 0xfc01, 6, bdaddr, HCI_INIT_TIMEOUT);
107 if (IS_ERR(skb)) {
108 err = PTR_ERR(skb);
109 bt_dev_err(hdev, "BCM: Change address command failed (%d)", err);
110 return err;
111 }
112 kfree_skb(skb);
113
114 return 0;
115}
116EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);
117
118int btbcm_read_pcm_int_params(struct hci_dev *hdev,
119 struct bcm_set_pcm_int_params *params)
120{
121 struct sk_buff *skb;
122 int err = 0;
123
124 skb = __hci_cmd_sync(hdev, 0xfc1d, 0, NULL, HCI_INIT_TIMEOUT);
125 if (IS_ERR(skb)) {
126 err = PTR_ERR(skb);
127 bt_dev_err(hdev, "BCM: Read PCM int params failed (%d)", err);
128 return err;
129 }
130
131 if (skb->len != 6 || skb->data[0]) {
132 bt_dev_err(hdev, "BCM: Read PCM int params length mismatch");
133 kfree_skb(skb);
134 return -EIO;
135 }
136
137 if (params)
138 memcpy(params, skb->data + 1, 5);
139
140 kfree_skb(skb);
141
142 return 0;
143}
144EXPORT_SYMBOL_GPL(btbcm_read_pcm_int_params);
145
146int btbcm_write_pcm_int_params(struct hci_dev *hdev,
147 const struct bcm_set_pcm_int_params *params)
148{
149 struct sk_buff *skb;
150 int err;
151
152 skb = __hci_cmd_sync(hdev, 0xfc1c, 5, params, HCI_INIT_TIMEOUT);
153 if (IS_ERR(skb)) {
154 err = PTR_ERR(skb);
155 bt_dev_err(hdev, "BCM: Write PCM int params failed (%d)", err);
156 return err;
157 }
158 kfree_skb(skb);
159
160 return 0;
161}
162EXPORT_SYMBOL_GPL(btbcm_write_pcm_int_params);
163
164int btbcm_patchram(struct hci_dev *hdev, const struct firmware *fw)
165{
166 const struct hci_command_hdr *cmd;
167 const u8 *fw_ptr;
168 size_t fw_size;
169 struct sk_buff *skb;
170 u16 opcode;
171 int err = 0;
172
173 /* Start Download */
174 skb = __hci_cmd_sync(hdev, 0xfc2e, 0, NULL, HCI_INIT_TIMEOUT);
175 if (IS_ERR(skb)) {
176 err = PTR_ERR(skb);
177 bt_dev_err(hdev, "BCM: Download Minidrv command failed (%d)",
178 err);
179 goto done;
180 }
181 kfree_skb(skb);
182
183 /* 50 msec delay after Download Minidrv completes */
184 msleep(50);
185
186 fw_ptr = fw->data;
187 fw_size = fw->size;
188
189 while (fw_size >= sizeof(*cmd)) {
190 const u8 *cmd_param;
191
192 cmd = (struct hci_command_hdr *)fw_ptr;
193 fw_ptr += sizeof(*cmd);
194 fw_size -= sizeof(*cmd);
195
196 if (fw_size < cmd->plen) {
197 bt_dev_err(hdev, "BCM: Patch is corrupted");
198 err = -EINVAL;
199 goto done;
200 }
201
202 cmd_param = fw_ptr;
203 fw_ptr += cmd->plen;
204 fw_size -= cmd->plen;
205
206 opcode = le16_to_cpu(cmd->opcode);
207
208 skb = __hci_cmd_sync(hdev, opcode, cmd->plen, cmd_param,
209 HCI_INIT_TIMEOUT);
210 if (IS_ERR(skb)) {
211 err = PTR_ERR(skb);
212 bt_dev_err(hdev, "BCM: Patch command %04x failed (%d)",
213 opcode, err);
214 goto done;
215 }
216 kfree_skb(skb);
217 }
218
219 /* 250 msec delay after Launch Ram completes */
220 msleep(250);
221
222done:
223 return err;
224}
225EXPORT_SYMBOL(btbcm_patchram);
226
227static int btbcm_reset(struct hci_dev *hdev)
228{
229 struct sk_buff *skb;
230
231 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
232 if (IS_ERR(skb)) {
233 int err = PTR_ERR(skb);
234
235 bt_dev_err(hdev, "BCM: Reset failed (%d)", err);
236 return err;
237 }
238 kfree_skb(skb);
239
240 /* 100 msec delay for module to complete reset process */
241 msleep(100);
242
243 return 0;
244}
245
246static struct sk_buff *btbcm_read_local_name(struct hci_dev *hdev)
247{
248 struct sk_buff *skb;
249
250 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_NAME, 0, NULL,
251 HCI_INIT_TIMEOUT);
252 if (IS_ERR(skb)) {
253 bt_dev_err(hdev, "BCM: Reading local name failed (%ld)",
254 PTR_ERR(skb));
255 return skb;
256 }
257
258 if (skb->len != sizeof(struct hci_rp_read_local_name)) {
259 bt_dev_err(hdev, "BCM: Local name length mismatch");
260 kfree_skb(skb);
261 return ERR_PTR(-EIO);
262 }
263
264 return skb;
265}
266
267static struct sk_buff *btbcm_read_local_version(struct hci_dev *hdev)
268{
269 struct sk_buff *skb;
270
271 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
272 HCI_INIT_TIMEOUT);
273 if (IS_ERR(skb)) {
274 bt_dev_err(hdev, "BCM: Reading local version info failed (%ld)",
275 PTR_ERR(skb));
276 return skb;
277 }
278
279 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
280 bt_dev_err(hdev, "BCM: Local version length mismatch");
281 kfree_skb(skb);
282 return ERR_PTR(-EIO);
283 }
284
285 return skb;
286}
287
288static struct sk_buff *btbcm_read_verbose_config(struct hci_dev *hdev)
289{
290 struct sk_buff *skb;
291
292 skb = __hci_cmd_sync(hdev, 0xfc79, 0, NULL, HCI_INIT_TIMEOUT);
293 if (IS_ERR(skb)) {
294 bt_dev_err(hdev, "BCM: Read verbose config info failed (%ld)",
295 PTR_ERR(skb));
296 return skb;
297 }
298
299 if (skb->len != 7) {
300 bt_dev_err(hdev, "BCM: Verbose config length mismatch");
301 kfree_skb(skb);
302 return ERR_PTR(-EIO);
303 }
304
305 return skb;
306}
307
308static struct sk_buff *btbcm_read_controller_features(struct hci_dev *hdev)
309{
310 struct sk_buff *skb;
311
312 skb = __hci_cmd_sync(hdev, 0xfc6e, 0, NULL, HCI_INIT_TIMEOUT);
313 if (IS_ERR(skb)) {
314 bt_dev_err(hdev, "BCM: Read controller features failed (%ld)",
315 PTR_ERR(skb));
316 return skb;
317 }
318
319 if (skb->len != 9) {
320 bt_dev_err(hdev, "BCM: Controller features length mismatch");
321 kfree_skb(skb);
322 return ERR_PTR(-EIO);
323 }
324
325 return skb;
326}
327
328static struct sk_buff *btbcm_read_usb_product(struct hci_dev *hdev)
329{
330 struct sk_buff *skb;
331
332 skb = __hci_cmd_sync(hdev, 0xfc5a, 0, NULL, HCI_INIT_TIMEOUT);
333 if (IS_ERR(skb)) {
334 bt_dev_err(hdev, "BCM: Read USB product info failed (%ld)",
335 PTR_ERR(skb));
336 return skb;
337 }
338
339 if (skb->len != 5) {
340 bt_dev_err(hdev, "BCM: USB product length mismatch");
341 kfree_skb(skb);
342 return ERR_PTR(-EIO);
343 }
344
345 return skb;
346}
347
348static const struct dmi_system_id disable_broken_read_transmit_power[] = {
349 {
350 .matches = {
351 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
352 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro16,1"),
353 },
354 },
355 {
356 .matches = {
357 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
358 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro16,2"),
359 },
360 },
361 {
362 .matches = {
363 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
364 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookPro16,4"),
365 },
366 },
367 {
368 .matches = {
369 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
370 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookAir8,1"),
371 },
372 },
373 {
374 .matches = {
375 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
376 DMI_MATCH(DMI_PRODUCT_NAME, "MacBookAir8,2"),
377 },
378 },
379 {
380 .matches = {
381 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
382 DMI_MATCH(DMI_PRODUCT_NAME, "iMac20,1"),
383 },
384 },
385 {
386 .matches = {
387 DMI_MATCH(DMI_BOARD_VENDOR, "Apple Inc."),
388 DMI_MATCH(DMI_PRODUCT_NAME, "iMac20,2"),
389 },
390 },
391 { }
392};
393
394static int btbcm_read_info(struct hci_dev *hdev)
395{
396 struct sk_buff *skb;
397
398 /* Read Verbose Config Version Info */
399 skb = btbcm_read_verbose_config(hdev);
400 if (IS_ERR(skb))
401 return PTR_ERR(skb);
402
403 bt_dev_info(hdev, "BCM: chip id %u", skb->data[1]);
404 kfree_skb(skb);
405
406 return 0;
407}
408
409static int btbcm_print_controller_features(struct hci_dev *hdev)
410{
411 struct sk_buff *skb;
412
413 /* Read Controller Features */
414 skb = btbcm_read_controller_features(hdev);
415 if (IS_ERR(skb))
416 return PTR_ERR(skb);
417
418 bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
419 kfree_skb(skb);
420
421 /* Read DMI and disable broken Read LE Min/Max Tx Power */
422 if (dmi_first_match(disable_broken_read_transmit_power))
423 set_bit(HCI_QUIRK_BROKEN_READ_TRANSMIT_POWER, &hdev->quirks);
424
425 return 0;
426}
427
428static int btbcm_print_local_name(struct hci_dev *hdev)
429{
430 struct sk_buff *skb;
431
432 /* Read Local Name */
433 skb = btbcm_read_local_name(hdev);
434 if (IS_ERR(skb))
435 return PTR_ERR(skb);
436
437 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
438 kfree_skb(skb);
439
440 return 0;
441}
442
443struct bcm_subver_table {
444 u16 subver;
445 const char *name;
446};
447
448static const struct bcm_subver_table bcm_uart_subver_table[] = {
449 { 0x1111, "BCM4362A2" }, /* 000.017.017 */
450 { 0x4103, "BCM4330B1" }, /* 002.001.003 */
451 { 0x410d, "BCM4334B0" }, /* 002.001.013 */
452 { 0x410e, "BCM43341B0" }, /* 002.001.014 */
453 { 0x4204, "BCM2076B1" }, /* 002.002.004 */
454 { 0x4406, "BCM4324B3" }, /* 002.004.006 */
455 { 0x4606, "BCM4324B5" }, /* 002.006.006 */
456 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
457 { 0x610c, "BCM4354" }, /* 003.001.012 */
458 { 0x2122, "BCM4343A0" }, /* 001.001.034 */
459 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
460 { 0x6119, "BCM4345C0" }, /* 003.001.025 */
461 { 0x6606, "BCM4345C5" }, /* 003.006.006 */
462 { 0x230f, "BCM4356A2" }, /* 001.003.015 */
463 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
464 { 0x420d, "BCM4349B1" }, /* 002.002.013 */
465 { 0x420e, "BCM4349B1" }, /* 002.002.014 */
466 { 0x4217, "BCM4329B1" }, /* 002.002.023 */
467 { 0x6106, "BCM4359C0" }, /* 003.001.006 */
468 { 0x4106, "BCM4335A0" }, /* 002.001.006 */
469 { 0x410c, "BCM43430B0" }, /* 002.001.012 */
470 { 0x2119, "BCM4373A0" }, /* 001.001.025 */
471 { }
472};
473
474static const struct bcm_subver_table bcm_usb_subver_table[] = {
475 { 0x2105, "BCM20703A1" }, /* 001.001.005 */
476 { 0x210b, "BCM43142A0" }, /* 001.001.011 */
477 { 0x2112, "BCM4314A0" }, /* 001.001.018 */
478 { 0x2118, "BCM20702A0" }, /* 001.001.024 */
479 { 0x2126, "BCM4335A0" }, /* 001.001.038 */
480 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
481 { 0x230f, "BCM4356A2" }, /* 001.003.015 */
482 { 0x4106, "BCM4335B0" }, /* 002.001.006 */
483 { 0x410e, "BCM20702B0" }, /* 002.001.014 */
484 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
485 { 0x610c, "BCM4354" }, /* 003.001.012 */
486 { 0x6607, "BCM4350C5" }, /* 003.006.007 */
487 { }
488};
489
490/*
491 * This currently only looks up the device tree board appendix,
492 * but can be expanded to other mechanisms.
493 */
494static const char *btbcm_get_board_name(struct device *dev)
495{
496#ifdef CONFIG_OF
497 struct device_node *root;
498 char *board_type;
499 const char *tmp;
500 int len;
501 int i;
502
503 root = of_find_node_by_path("/");
504 if (!root)
505 return NULL;
506
507 if (of_property_read_string_index(root, "compatible", 0, &tmp))
508 return NULL;
509
510 /* get rid of any '/' in the compatible string */
511 len = strlen(tmp) + 1;
512 board_type = devm_kzalloc(dev, len, GFP_KERNEL);
513 strscpy(board_type, tmp, len);
514 for (i = 0; i < board_type[i]; i++) {
515 if (board_type[i] == '/')
516 board_type[i] = '-';
517 }
518 of_node_put(root);
519
520 return board_type;
521#else
522 return NULL;
523#endif
524}
525
526int btbcm_initialize(struct hci_dev *hdev, bool *fw_load_done, bool use_autobaud_mode)
527{
528 u16 subver, rev, pid, vid;
529 struct sk_buff *skb;
530 struct hci_rp_read_local_version *ver;
531 const struct bcm_subver_table *bcm_subver_table;
532 const char *hw_name = NULL;
533 const char *board_name;
534 char postfix[16] = "";
535 int fw_name_count = 0;
536 bcm_fw_name *fw_name;
537 const struct firmware *fw;
538 int i, err;
539
540 board_name = btbcm_get_board_name(&hdev->dev);
541
542 /* Reset */
543 err = btbcm_reset(hdev);
544 if (err)
545 return err;
546
547 /* Read Local Version Info */
548 skb = btbcm_read_local_version(hdev);
549 if (IS_ERR(skb))
550 return PTR_ERR(skb);
551
552 ver = (struct hci_rp_read_local_version *)skb->data;
553 rev = le16_to_cpu(ver->hci_rev);
554 subver = le16_to_cpu(ver->lmp_subver);
555 kfree_skb(skb);
556
557 /* Read controller information */
558 if (!(*fw_load_done)) {
559 err = btbcm_read_info(hdev);
560 if (err)
561 return err;
562 }
563
564 if (!use_autobaud_mode) {
565 err = btbcm_print_controller_features(hdev);
566 if (err)
567 return err;
568
569 err = btbcm_print_local_name(hdev);
570 if (err)
571 return err;
572 }
573
574 bcm_subver_table = (hdev->bus == HCI_USB) ? bcm_usb_subver_table :
575 bcm_uart_subver_table;
576
577 for (i = 0; bcm_subver_table[i].name; i++) {
578 if (subver == bcm_subver_table[i].subver) {
579 hw_name = bcm_subver_table[i].name;
580 break;
581 }
582 }
583
584 bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
585 hw_name ? hw_name : "BCM", (subver & 0xe000) >> 13,
586 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
587
588 if (*fw_load_done)
589 return 0;
590
591 if (hdev->bus == HCI_USB) {
592 /* Read USB Product Info */
593 skb = btbcm_read_usb_product(hdev);
594 if (IS_ERR(skb))
595 return PTR_ERR(skb);
596
597 vid = get_unaligned_le16(skb->data + 1);
598 pid = get_unaligned_le16(skb->data + 3);
599 kfree_skb(skb);
600
601 snprintf(postfix, sizeof(postfix), "-%4.4x-%4.4x", vid, pid);
602 }
603
604 fw_name = kmalloc(BCM_FW_NAME_COUNT_MAX * BCM_FW_NAME_LEN, GFP_KERNEL);
605 if (!fw_name)
606 return -ENOMEM;
607
608 if (hw_name) {
609 if (board_name) {
610 snprintf(fw_name[fw_name_count], BCM_FW_NAME_LEN,
611 "brcm/%s%s.%s.hcd", hw_name, postfix, board_name);
612 fw_name_count++;
613 }
614 snprintf(fw_name[fw_name_count], BCM_FW_NAME_LEN,
615 "brcm/%s%s.hcd", hw_name, postfix);
616 fw_name_count++;
617 }
618
619 if (board_name) {
620 snprintf(fw_name[fw_name_count], BCM_FW_NAME_LEN,
621 "brcm/BCM%s.%s.hcd", postfix, board_name);
622 fw_name_count++;
623 }
624 snprintf(fw_name[fw_name_count], BCM_FW_NAME_LEN,
625 "brcm/BCM%s.hcd", postfix);
626 fw_name_count++;
627
628 for (i = 0; i < fw_name_count; i++) {
629 err = firmware_request_nowarn(&fw, fw_name[i], &hdev->dev);
630 if (err == 0) {
631 bt_dev_info(hdev, "%s '%s' Patch",
632 hw_name ? hw_name : "BCM", fw_name[i]);
633 *fw_load_done = true;
634 break;
635 }
636 }
637
638 if (*fw_load_done) {
639 err = btbcm_patchram(hdev, fw);
640 if (err)
641 bt_dev_info(hdev, "BCM: Patch failed (%d)", err);
642
643 release_firmware(fw);
644 } else {
645 bt_dev_err(hdev, "BCM: firmware Patch file not found, tried:");
646 for (i = 0; i < fw_name_count; i++)
647 bt_dev_err(hdev, "BCM: '%s'", fw_name[i]);
648 }
649
650 kfree(fw_name);
651 return 0;
652}
653EXPORT_SYMBOL_GPL(btbcm_initialize);
654
655int btbcm_finalize(struct hci_dev *hdev, bool *fw_load_done, bool use_autobaud_mode)
656{
657 int err;
658
659 /* Re-initialize if necessary */
660 if (*fw_load_done) {
661 err = btbcm_initialize(hdev, fw_load_done, use_autobaud_mode);
662 if (err)
663 return err;
664 }
665
666 btbcm_check_bdaddr(hdev);
667
668 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
669
670 return 0;
671}
672EXPORT_SYMBOL_GPL(btbcm_finalize);
673
674int btbcm_setup_patchram(struct hci_dev *hdev)
675{
676 bool fw_load_done = false;
677 bool use_autobaud_mode = false;
678 int err;
679
680 /* Initialize */
681 err = btbcm_initialize(hdev, &fw_load_done, use_autobaud_mode);
682 if (err)
683 return err;
684
685 /* Re-initialize after loading Patch */
686 return btbcm_finalize(hdev, &fw_load_done, use_autobaud_mode);
687}
688EXPORT_SYMBOL_GPL(btbcm_setup_patchram);
689
690int btbcm_setup_apple(struct hci_dev *hdev)
691{
692 struct sk_buff *skb;
693 int err;
694
695 /* Reset */
696 err = btbcm_reset(hdev);
697 if (err)
698 return err;
699
700 /* Read Verbose Config Version Info */
701 skb = btbcm_read_verbose_config(hdev);
702 if (!IS_ERR(skb)) {
703 bt_dev_info(hdev, "BCM: chip id %u build %4.4u",
704 skb->data[1], get_unaligned_le16(skb->data + 5));
705 kfree_skb(skb);
706 }
707
708 /* Read USB Product Info */
709 skb = btbcm_read_usb_product(hdev);
710 if (!IS_ERR(skb)) {
711 bt_dev_info(hdev, "BCM: product %4.4x:%4.4x",
712 get_unaligned_le16(skb->data + 1),
713 get_unaligned_le16(skb->data + 3));
714 kfree_skb(skb);
715 }
716
717 /* Read Controller Features */
718 skb = btbcm_read_controller_features(hdev);
719 if (!IS_ERR(skb)) {
720 bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
721 kfree_skb(skb);
722 }
723
724 /* Read Local Name */
725 skb = btbcm_read_local_name(hdev);
726 if (!IS_ERR(skb)) {
727 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
728 kfree_skb(skb);
729 }
730
731 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
732
733 return 0;
734}
735EXPORT_SYMBOL_GPL(btbcm_setup_apple);
736
737MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
738MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION);
739MODULE_VERSION(VERSION);
740MODULE_LICENSE("GPL");
1/*
2 *
3 * Bluetooth support for Broadcom devices
4 *
5 * Copyright (C) 2015 Intel Corporation
6 *
7 *
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.
12 *
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.
17 *
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
21 *
22 */
23
24#include <linux/module.h>
25#include <linux/firmware.h>
26#include <asm/unaligned.h>
27
28#include <net/bluetooth/bluetooth.h>
29#include <net/bluetooth/hci_core.h>
30
31#include "btbcm.h"
32
33#define VERSION "0.1"
34
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}})
38
39int btbcm_check_bdaddr(struct hci_dev *hdev)
40{
41 struct hci_rp_read_bd_addr *bda;
42 struct sk_buff *skb;
43
44 skb = __hci_cmd_sync(hdev, HCI_OP_READ_BD_ADDR, 0, NULL,
45 HCI_INIT_TIMEOUT);
46 if (IS_ERR(skb)) {
47 int err = PTR_ERR(skb);
48 bt_dev_err(hdev, "BCM: Reading device address failed (%d)", err);
49 return err;
50 }
51
52 if (skb->len != sizeof(*bda)) {
53 bt_dev_err(hdev, "BCM: Device address length mismatch");
54 kfree_skb(skb);
55 return -EIO;
56 }
57
58 bda = (struct hci_rp_read_bd_addr *)skb->data;
59
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.
63 *
64 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
65 * with no configured address.
66 *
67 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
68 * with waiting for configuration state.
69 *
70 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
71 * with waiting for configuration state.
72 */
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)",
77 &bda->bdaddr);
78 set_bit(HCI_QUIRK_INVALID_BDADDR, &hdev->quirks);
79 }
80
81 kfree_skb(skb);
82
83 return 0;
84}
85EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);
86
87int btbcm_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
88{
89 struct sk_buff *skb;
90 int err;
91
92 skb = __hci_cmd_sync(hdev, 0xfc01, 6, bdaddr, HCI_INIT_TIMEOUT);
93 if (IS_ERR(skb)) {
94 err = PTR_ERR(skb);
95 bt_dev_err(hdev, "BCM: Change address command failed (%d)", err);
96 return err;
97 }
98 kfree_skb(skb);
99
100 return 0;
101}
102EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);
103
104int btbcm_patchram(struct hci_dev *hdev, const struct firmware *fw)
105{
106 const struct hci_command_hdr *cmd;
107 const u8 *fw_ptr;
108 size_t fw_size;
109 struct sk_buff *skb;
110 u16 opcode;
111 int err = 0;
112
113 /* Start Download */
114 skb = __hci_cmd_sync(hdev, 0xfc2e, 0, NULL, HCI_INIT_TIMEOUT);
115 if (IS_ERR(skb)) {
116 err = PTR_ERR(skb);
117 bt_dev_err(hdev, "BCM: Download Minidrv command failed (%d)",
118 err);
119 goto done;
120 }
121 kfree_skb(skb);
122
123 /* 50 msec delay after Download Minidrv completes */
124 msleep(50);
125
126 fw_ptr = fw->data;
127 fw_size = fw->size;
128
129 while (fw_size >= sizeof(*cmd)) {
130 const u8 *cmd_param;
131
132 cmd = (struct hci_command_hdr *)fw_ptr;
133 fw_ptr += sizeof(*cmd);
134 fw_size -= sizeof(*cmd);
135
136 if (fw_size < cmd->plen) {
137 bt_dev_err(hdev, "BCM: Patch is corrupted");
138 err = -EINVAL;
139 goto done;
140 }
141
142 cmd_param = fw_ptr;
143 fw_ptr += cmd->plen;
144 fw_size -= cmd->plen;
145
146 opcode = le16_to_cpu(cmd->opcode);
147
148 skb = __hci_cmd_sync(hdev, opcode, cmd->plen, cmd_param,
149 HCI_INIT_TIMEOUT);
150 if (IS_ERR(skb)) {
151 err = PTR_ERR(skb);
152 bt_dev_err(hdev, "BCM: Patch command %04x failed (%d)",
153 opcode, err);
154 goto done;
155 }
156 kfree_skb(skb);
157 }
158
159 /* 250 msec delay after Launch Ram completes */
160 msleep(250);
161
162done:
163 return err;
164}
165EXPORT_SYMBOL(btbcm_patchram);
166
167static int btbcm_reset(struct hci_dev *hdev)
168{
169 struct sk_buff *skb;
170
171 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
172 if (IS_ERR(skb)) {
173 int err = PTR_ERR(skb);
174 bt_dev_err(hdev, "BCM: Reset failed (%d)", err);
175 return err;
176 }
177 kfree_skb(skb);
178
179 /* 100 msec delay for module to complete reset process */
180 msleep(100);
181
182 return 0;
183}
184
185static struct sk_buff *btbcm_read_local_name(struct hci_dev *hdev)
186{
187 struct sk_buff *skb;
188
189 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_NAME, 0, NULL,
190 HCI_INIT_TIMEOUT);
191 if (IS_ERR(skb)) {
192 bt_dev_err(hdev, "BCM: Reading local name failed (%ld)",
193 PTR_ERR(skb));
194 return skb;
195 }
196
197 if (skb->len != sizeof(struct hci_rp_read_local_name)) {
198 bt_dev_err(hdev, "BCM: Local name length mismatch");
199 kfree_skb(skb);
200 return ERR_PTR(-EIO);
201 }
202
203 return skb;
204}
205
206static struct sk_buff *btbcm_read_local_version(struct hci_dev *hdev)
207{
208 struct sk_buff *skb;
209
210 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
211 HCI_INIT_TIMEOUT);
212 if (IS_ERR(skb)) {
213 bt_dev_err(hdev, "BCM: Reading local version info failed (%ld)",
214 PTR_ERR(skb));
215 return skb;
216 }
217
218 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
219 bt_dev_err(hdev, "BCM: Local version length mismatch");
220 kfree_skb(skb);
221 return ERR_PTR(-EIO);
222 }
223
224 return skb;
225}
226
227static struct sk_buff *btbcm_read_verbose_config(struct hci_dev *hdev)
228{
229 struct sk_buff *skb;
230
231 skb = __hci_cmd_sync(hdev, 0xfc79, 0, NULL, HCI_INIT_TIMEOUT);
232 if (IS_ERR(skb)) {
233 bt_dev_err(hdev, "BCM: Read verbose config info failed (%ld)",
234 PTR_ERR(skb));
235 return skb;
236 }
237
238 if (skb->len != 7) {
239 bt_dev_err(hdev, "BCM: Verbose config length mismatch");
240 kfree_skb(skb);
241 return ERR_PTR(-EIO);
242 }
243
244 return skb;
245}
246
247static struct sk_buff *btbcm_read_controller_features(struct hci_dev *hdev)
248{
249 struct sk_buff *skb;
250
251 skb = __hci_cmd_sync(hdev, 0xfc6e, 0, NULL, HCI_INIT_TIMEOUT);
252 if (IS_ERR(skb)) {
253 bt_dev_err(hdev, "BCM: Read controller features failed (%ld)",
254 PTR_ERR(skb));
255 return skb;
256 }
257
258 if (skb->len != 9) {
259 bt_dev_err(hdev, "BCM: Controller features length mismatch");
260 kfree_skb(skb);
261 return ERR_PTR(-EIO);
262 }
263
264 return skb;
265}
266
267static struct sk_buff *btbcm_read_usb_product(struct hci_dev *hdev)
268{
269 struct sk_buff *skb;
270
271 skb = __hci_cmd_sync(hdev, 0xfc5a, 0, NULL, HCI_INIT_TIMEOUT);
272 if (IS_ERR(skb)) {
273 bt_dev_err(hdev, "BCM: Read USB product info failed (%ld)",
274 PTR_ERR(skb));
275 return skb;
276 }
277
278 if (skb->len != 5) {
279 bt_dev_err(hdev, "BCM: USB product length mismatch");
280 kfree_skb(skb);
281 return ERR_PTR(-EIO);
282 }
283
284 return skb;
285}
286
287static int btbcm_read_info(struct hci_dev *hdev)
288{
289 struct sk_buff *skb;
290
291 /* Read Verbose Config Version Info */
292 skb = btbcm_read_verbose_config(hdev);
293 if (IS_ERR(skb))
294 return PTR_ERR(skb);
295
296 bt_dev_info(hdev, "BCM: chip id %u", skb->data[1]);
297 kfree_skb(skb);
298
299 /* Read Controller Features */
300 skb = btbcm_read_controller_features(hdev);
301 if (IS_ERR(skb))
302 return PTR_ERR(skb);
303
304 bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
305 kfree_skb(skb);
306
307 /* Read Local Name */
308 skb = btbcm_read_local_name(hdev);
309 if (IS_ERR(skb))
310 return PTR_ERR(skb);
311
312 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
313 kfree_skb(skb);
314
315 return 0;
316}
317
318static const struct {
319 u16 subver;
320 const char *name;
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 { 0x2122, "BCM4343A0" }, /* 001.001.034 */
327 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
328 { 0x6119, "BCM4345C0" }, /* 003.001.025 */
329 { 0x230f, "BCM4356A2" }, /* 001.003.015 */
330 { }
331};
332
333int btbcm_initialize(struct hci_dev *hdev, char *fw_name, size_t len)
334{
335 u16 subver, rev;
336 const char *hw_name = NULL;
337 struct sk_buff *skb;
338 struct hci_rp_read_local_version *ver;
339 int i, err;
340
341 /* Reset */
342 err = btbcm_reset(hdev);
343 if (err)
344 return err;
345
346 /* Read Local Version Info */
347 skb = btbcm_read_local_version(hdev);
348 if (IS_ERR(skb))
349 return PTR_ERR(skb);
350
351 ver = (struct hci_rp_read_local_version *)skb->data;
352 rev = le16_to_cpu(ver->hci_rev);
353 subver = le16_to_cpu(ver->lmp_subver);
354 kfree_skb(skb);
355
356 /* Read controller information */
357 err = btbcm_read_info(hdev);
358 if (err)
359 return err;
360
361 switch ((rev & 0xf000) >> 12) {
362 case 0:
363 case 1:
364 case 2:
365 case 3:
366 for (i = 0; bcm_uart_subver_table[i].name; i++) {
367 if (subver == bcm_uart_subver_table[i].subver) {
368 hw_name = bcm_uart_subver_table[i].name;
369 break;
370 }
371 }
372
373 snprintf(fw_name, len, "brcm/%s.hcd", hw_name ? : "BCM");
374 break;
375 default:
376 return 0;
377 }
378
379 bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
380 hw_name ? : "BCM", (subver & 0xe000) >> 13,
381 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
382
383 return 0;
384}
385EXPORT_SYMBOL_GPL(btbcm_initialize);
386
387int btbcm_finalize(struct hci_dev *hdev)
388{
389 struct sk_buff *skb;
390 struct hci_rp_read_local_version *ver;
391 u16 subver, rev;
392 int err;
393
394 /* Reset */
395 err = btbcm_reset(hdev);
396 if (err)
397 return err;
398
399 /* Read Local Version Info */
400 skb = btbcm_read_local_version(hdev);
401 if (IS_ERR(skb))
402 return PTR_ERR(skb);
403
404 ver = (struct hci_rp_read_local_version *)skb->data;
405 rev = le16_to_cpu(ver->hci_rev);
406 subver = le16_to_cpu(ver->lmp_subver);
407 kfree_skb(skb);
408
409 bt_dev_info(hdev, "BCM (%3.3u.%3.3u.%3.3u) build %4.4u",
410 (subver & 0xe000) >> 13, (subver & 0x1f00) >> 8,
411 (subver & 0x00ff), rev & 0x0fff);
412
413 btbcm_check_bdaddr(hdev);
414
415 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
416
417 return 0;
418}
419EXPORT_SYMBOL_GPL(btbcm_finalize);
420
421static const struct {
422 u16 subver;
423 const char *name;
424} bcm_usb_subver_table[] = {
425 { 0x210b, "BCM43142A0" }, /* 001.001.011 */
426 { 0x2112, "BCM4314A0" }, /* 001.001.018 */
427 { 0x2118, "BCM20702A0" }, /* 001.001.024 */
428 { 0x2126, "BCM4335A0" }, /* 001.001.038 */
429 { 0x220e, "BCM20702A1" }, /* 001.002.014 */
430 { 0x230f, "BCM4354A2" }, /* 001.003.015 */
431 { 0x4106, "BCM4335B0" }, /* 002.001.006 */
432 { 0x410e, "BCM20702B0" }, /* 002.001.014 */
433 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
434 { 0x610c, "BCM4354" }, /* 003.001.012 */
435 { }
436};
437
438int btbcm_setup_patchram(struct hci_dev *hdev)
439{
440 char fw_name[64];
441 const struct firmware *fw;
442 u16 subver, rev, pid, vid;
443 const char *hw_name = NULL;
444 struct sk_buff *skb;
445 struct hci_rp_read_local_version *ver;
446 int i, err;
447
448 /* Reset */
449 err = btbcm_reset(hdev);
450 if (err)
451 return err;
452
453 /* Read Local Version Info */
454 skb = btbcm_read_local_version(hdev);
455 if (IS_ERR(skb))
456 return PTR_ERR(skb);
457
458 ver = (struct hci_rp_read_local_version *)skb->data;
459 rev = le16_to_cpu(ver->hci_rev);
460 subver = le16_to_cpu(ver->lmp_subver);
461 kfree_skb(skb);
462
463 /* Read controller information */
464 err = btbcm_read_info(hdev);
465 if (err)
466 return err;
467
468 switch ((rev & 0xf000) >> 12) {
469 case 0:
470 case 3:
471 for (i = 0; bcm_uart_subver_table[i].name; i++) {
472 if (subver == bcm_uart_subver_table[i].subver) {
473 hw_name = bcm_uart_subver_table[i].name;
474 break;
475 }
476 }
477
478 snprintf(fw_name, sizeof(fw_name), "brcm/%s.hcd",
479 hw_name ? : "BCM");
480 break;
481 case 1:
482 case 2:
483 /* Read USB Product Info */
484 skb = btbcm_read_usb_product(hdev);
485 if (IS_ERR(skb))
486 return PTR_ERR(skb);
487
488 vid = get_unaligned_le16(skb->data + 1);
489 pid = get_unaligned_le16(skb->data + 3);
490 kfree_skb(skb);
491
492 for (i = 0; bcm_usb_subver_table[i].name; i++) {
493 if (subver == bcm_usb_subver_table[i].subver) {
494 hw_name = bcm_usb_subver_table[i].name;
495 break;
496 }
497 }
498
499 snprintf(fw_name, sizeof(fw_name), "brcm/%s-%4.4x-%4.4x.hcd",
500 hw_name ? : "BCM", vid, pid);
501 break;
502 default:
503 return 0;
504 }
505
506 bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
507 hw_name ? : "BCM", (subver & 0xe000) >> 13,
508 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
509
510 err = request_firmware(&fw, fw_name, &hdev->dev);
511 if (err < 0) {
512 bt_dev_info(hdev, "BCM: Patch %s not found", fw_name);
513 goto done;
514 }
515
516 btbcm_patchram(hdev, fw);
517
518 release_firmware(fw);
519
520 /* Reset */
521 err = btbcm_reset(hdev);
522 if (err)
523 return err;
524
525 /* Read Local Version Info */
526 skb = btbcm_read_local_version(hdev);
527 if (IS_ERR(skb))
528 return PTR_ERR(skb);
529
530 ver = (struct hci_rp_read_local_version *)skb->data;
531 rev = le16_to_cpu(ver->hci_rev);
532 subver = le16_to_cpu(ver->lmp_subver);
533 kfree_skb(skb);
534
535 bt_dev_info(hdev, "%s (%3.3u.%3.3u.%3.3u) build %4.4u",
536 hw_name ? : "BCM", (subver & 0xe000) >> 13,
537 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
538
539 /* Read Local Name */
540 skb = btbcm_read_local_name(hdev);
541 if (IS_ERR(skb))
542 return PTR_ERR(skb);
543
544 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
545 kfree_skb(skb);
546
547done:
548 btbcm_check_bdaddr(hdev);
549
550 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
551
552 return 0;
553}
554EXPORT_SYMBOL_GPL(btbcm_setup_patchram);
555
556int btbcm_setup_apple(struct hci_dev *hdev)
557{
558 struct sk_buff *skb;
559 int err;
560
561 /* Reset */
562 err = btbcm_reset(hdev);
563 if (err)
564 return err;
565
566 /* Read Verbose Config Version Info */
567 skb = btbcm_read_verbose_config(hdev);
568 if (!IS_ERR(skb)) {
569 bt_dev_info(hdev, "BCM: chip id %u build %4.4u",
570 skb->data[1], get_unaligned_le16(skb->data + 5));
571 kfree_skb(skb);
572 }
573
574 /* Read USB Product Info */
575 skb = btbcm_read_usb_product(hdev);
576 if (!IS_ERR(skb)) {
577 bt_dev_info(hdev, "BCM: product %4.4x:%4.4x",
578 get_unaligned_le16(skb->data + 1),
579 get_unaligned_le16(skb->data + 3));
580 kfree_skb(skb);
581 }
582
583 /* Read Controller Features */
584 skb = btbcm_read_controller_features(hdev);
585 if (!IS_ERR(skb)) {
586 bt_dev_info(hdev, "BCM: features 0x%2.2x", skb->data[1]);
587 kfree_skb(skb);
588 }
589
590 /* Read Local Name */
591 skb = btbcm_read_local_name(hdev);
592 if (!IS_ERR(skb)) {
593 bt_dev_info(hdev, "%s", (char *)(skb->data + 1));
594 kfree_skb(skb);
595 }
596
597 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
598
599 return 0;
600}
601EXPORT_SYMBOL_GPL(btbcm_setup_apple);
602
603MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
604MODULE_DESCRIPTION("Bluetooth support for Broadcom devices ver " VERSION);
605MODULE_VERSION(VERSION);
606MODULE_LICENSE("GPL");