blob: 67315cb28826b7a4968891ef74ae8a8f37cc6690 [file] [log] [blame]
rjw1f884582022-01-06 17:20:42 +08001/*
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_ERR("%s: BCM: Reading device address failed (%d)",
49 hdev->name, err);
50 return err;
51 }
52
53 if (skb->len != sizeof(*bda)) {
54 BT_ERR("%s: BCM: Device address length mismatch", hdev->name);
55 kfree_skb(skb);
56 return -EIO;
57 }
58
59 bda = (struct hci_rp_read_bd_addr *)skb->data;
60
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.
64 *
65 * The address 00:20:70:02:A0:00 indicates a BCM20702A0 controller
66 * with no configured address.
67 *
68 * The address 43:24:B3:00:00:00 indicates a BCM4324B3 controller
69 * with waiting for configuration state.
70 *
71 * The address 43:30:B1:00:00:00 indicates a BCM4330B1 controller
72 * with waiting for configuration state.
73 */
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);
80 }
81
82 kfree_skb(skb);
83
84 return 0;
85}
86EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);
87
88int btbcm_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
89{
90 struct sk_buff *skb;
91 int err;
92
93 skb = __hci_cmd_sync(hdev, 0xfc01, 6, bdaddr, HCI_INIT_TIMEOUT);
94 if (IS_ERR(skb)) {
95 err = PTR_ERR(skb);
96 BT_ERR("%s: BCM: Change address command failed (%d)",
97 hdev->name, err);
98 return err;
99 }
100 kfree_skb(skb);
101
102 return 0;
103}
104EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);
105
106int btbcm_patchram(struct hci_dev *hdev, const struct firmware *fw)
107{
108 const struct hci_command_hdr *cmd;
109 const u8 *fw_ptr;
110 size_t fw_size;
111 struct sk_buff *skb;
112 u16 opcode;
113 int err = 0;
114
115 /* Start Download */
116 skb = __hci_cmd_sync(hdev, 0xfc2e, 0, NULL, HCI_INIT_TIMEOUT);
117 if (IS_ERR(skb)) {
118 err = PTR_ERR(skb);
119 BT_ERR("%s: BCM: Download Minidrv command failed (%d)",
120 hdev->name, err);
121 goto done;
122 }
123 kfree_skb(skb);
124
125 /* 50 msec delay after Download Minidrv completes */
126 msleep(50);
127
128 fw_ptr = fw->data;
129 fw_size = fw->size;
130
131 while (fw_size >= sizeof(*cmd)) {
132 const u8 *cmd_param;
133
134 cmd = (struct hci_command_hdr *)fw_ptr;
135 fw_ptr += sizeof(*cmd);
136 fw_size -= sizeof(*cmd);
137
138 if (fw_size < cmd->plen) {
139 BT_ERR("%s: BCM: Patch is corrupted", hdev->name);
140 err = -EINVAL;
141 goto done;
142 }
143
144 cmd_param = fw_ptr;
145 fw_ptr += cmd->plen;
146 fw_size -= cmd->plen;
147
148 opcode = le16_to_cpu(cmd->opcode);
149
150 skb = __hci_cmd_sync(hdev, opcode, cmd->plen, cmd_param,
151 HCI_INIT_TIMEOUT);
152 if (IS_ERR(skb)) {
153 err = PTR_ERR(skb);
154 BT_ERR("%s: BCM: Patch command %04x failed (%d)",
155 hdev->name, opcode, err);
156 goto done;
157 }
158 kfree_skb(skb);
159 }
160
161 /* 250 msec delay after Launch Ram completes */
162 msleep(250);
163
164done:
165 return err;
166}
167EXPORT_SYMBOL(btbcm_patchram);
168
169static int btbcm_reset(struct hci_dev *hdev)
170{
171 struct sk_buff *skb;
172
173 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_INIT_TIMEOUT);
174 if (IS_ERR(skb)) {
175 int err = PTR_ERR(skb);
176 BT_ERR("%s: BCM: Reset failed (%d)", hdev->name, err);
177 return err;
178 }
179 kfree_skb(skb);
180
181 /* 100 msec delay for module to complete reset process */
182 msleep(100);
183
184 return 0;
185}
186
187static struct sk_buff *btbcm_read_local_name(struct hci_dev *hdev)
188{
189 struct sk_buff *skb;
190
191 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_NAME, 0, NULL,
192 HCI_INIT_TIMEOUT);
193 if (IS_ERR(skb)) {
194 BT_ERR("%s: BCM: Reading local name failed (%ld)",
195 hdev->name, PTR_ERR(skb));
196 return skb;
197 }
198
199 if (skb->len != sizeof(struct hci_rp_read_local_name)) {
200 BT_ERR("%s: BCM: Local name length mismatch", hdev->name);
201 kfree_skb(skb);
202 return ERR_PTR(-EIO);
203 }
204
205 return skb;
206}
207
208static struct sk_buff *btbcm_read_local_version(struct hci_dev *hdev)
209{
210 struct sk_buff *skb;
211
212 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
213 HCI_INIT_TIMEOUT);
214 if (IS_ERR(skb)) {
215 BT_ERR("%s: BCM: Reading local version info failed (%ld)",
216 hdev->name, PTR_ERR(skb));
217 return skb;
218 }
219
220 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
221 BT_ERR("%s: BCM: Local version length mismatch", hdev->name);
222 kfree_skb(skb);
223 return ERR_PTR(-EIO);
224 }
225
226 return skb;
227}
228
229static struct sk_buff *btbcm_read_verbose_config(struct hci_dev *hdev)
230{
231 struct sk_buff *skb;
232
233 skb = __hci_cmd_sync(hdev, 0xfc79, 0, NULL, HCI_INIT_TIMEOUT);
234 if (IS_ERR(skb)) {
235 BT_ERR("%s: BCM: Read verbose config info failed (%ld)",
236 hdev->name, PTR_ERR(skb));
237 return skb;
238 }
239
240 if (skb->len != 7) {
241 BT_ERR("%s: BCM: Verbose config length mismatch", hdev->name);
242 kfree_skb(skb);
243 return ERR_PTR(-EIO);
244 }
245
246 return skb;
247}
248
249static struct sk_buff *btbcm_read_controller_features(struct hci_dev *hdev)
250{
251 struct sk_buff *skb;
252
253 skb = __hci_cmd_sync(hdev, 0xfc6e, 0, NULL, HCI_INIT_TIMEOUT);
254 if (IS_ERR(skb)) {
255 BT_ERR("%s: BCM: Read controller features failed (%ld)",
256 hdev->name, PTR_ERR(skb));
257 return skb;
258 }
259
260 if (skb->len != 9) {
261 BT_ERR("%s: BCM: Controller features length mismatch",
262 hdev->name);
263 kfree_skb(skb);
264 return ERR_PTR(-EIO);
265 }
266
267 return skb;
268}
269
270static struct sk_buff *btbcm_read_usb_product(struct hci_dev *hdev)
271{
272 struct sk_buff *skb;
273
274 skb = __hci_cmd_sync(hdev, 0xfc5a, 0, NULL, HCI_INIT_TIMEOUT);
275 if (IS_ERR(skb)) {
276 BT_ERR("%s: BCM: Read USB product info failed (%ld)",
277 hdev->name, PTR_ERR(skb));
278 return skb;
279 }
280
281 if (skb->len != 5) {
282 BT_ERR("%s: BCM: USB product length mismatch", hdev->name);
283 kfree_skb(skb);
284 return ERR_PTR(-EIO);
285 }
286
287 return skb;
288}
289
290static int btbcm_read_info(struct hci_dev *hdev)
291{
292 struct sk_buff *skb;
293
294 /* Read Verbose Config Version Info */
295 skb = btbcm_read_verbose_config(hdev);
296 if (IS_ERR(skb))
297 return PTR_ERR(skb);
298
299 BT_INFO("%s: BCM: chip id %u", hdev->name, skb->data[1]);
300 kfree_skb(skb);
301
302 /* Read Controller Features */
303 skb = btbcm_read_controller_features(hdev);
304 if (IS_ERR(skb))
305 return PTR_ERR(skb);
306
307 BT_INFO("%s: BCM: features 0x%2.2x", hdev->name, skb->data[1]);
308 kfree_skb(skb);
309
310 /* Read Local Name */
311 skb = btbcm_read_local_name(hdev);
312 if (IS_ERR(skb))
313 return PTR_ERR(skb);
314
315 BT_INFO("%s: %s", hdev->name, (char *)(skb->data + 1));
316 kfree_skb(skb);
317
318 return 0;
319}
320
321static const struct {
322 u16 subver;
323 const char *name;
324} bcm_uart_subver_table[] = {
325 { 0x4103, "BCM4330B1" }, /* 002.001.003 */
326 { 0x410e, "BCM43341B0" }, /* 002.001.014 */
327 { 0x4406, "BCM4324B3" }, /* 002.004.006 */
328 { 0x6109, "BCM4335C0" }, /* 003.001.009 */
329 { 0x610c, "BCM4354" }, /* 003.001.012 */
330 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
331 { }
332};
333
334int btbcm_initialize(struct hci_dev *hdev, char *fw_name, size_t len)
335{
336 u16 subver, rev;
337 const char *hw_name = NULL;
338 struct sk_buff *skb;
339 struct hci_rp_read_local_version *ver;
340 int i, err;
341
342 /* Reset */
343 err = btbcm_reset(hdev);
344 if (err)
345 return err;
346
347 /* Read Local Version Info */
348 skb = btbcm_read_local_version(hdev);
349 if (IS_ERR(skb))
350 return PTR_ERR(skb);
351
352 ver = (struct hci_rp_read_local_version *)skb->data;
353 rev = le16_to_cpu(ver->hci_rev);
354 subver = le16_to_cpu(ver->lmp_subver);
355 kfree_skb(skb);
356
357 /* Read controller information */
358 err = btbcm_read_info(hdev);
359 if (err)
360 return err;
361
362 switch ((rev & 0xf000) >> 12) {
363 case 0:
364 case 1:
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_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
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_INFO("%s: BCM (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
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_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
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_INFO("%s: BCM: Patch %s not found", hdev->name, 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_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
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_INFO("%s: %s", hdev->name, (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_INFO("%s: BCM: chip id %u build %4.4u", hdev->name,
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_INFO("%s: BCM: product %4.4x:%4.4x", hdev->name,
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_INFO("%s: BCM: features 0x%2.2x", hdev->name, 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_INFO("%s: %s", hdev->name, (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");