]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/bluetooth/btbcm.c
rpmsg: glink: Unlock on error in qcom_glink_request_intent()
[mirror_ubuntu-bionic-kernel.git] / drivers / bluetooth / btbcm.c
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
39 int 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 }
86 EXPORT_SYMBOL_GPL(btbcm_check_bdaddr);
87
88 int 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 }
104 EXPORT_SYMBOL_GPL(btbcm_set_bdaddr);
105
106 int 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
164 done:
165 return err;
166 }
167 EXPORT_SYMBOL(btbcm_patchram);
168
169 static 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
187 static 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
208 static 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
229 static 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
249 static 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
270 static 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
290 static 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
321 static 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 { 0x610c, "BCM4354" }, /* 003.001.012 */
329 { 0x2209, "BCM43430A1" }, /* 001.002.009 */
330 { }
331 };
332
333 int 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 3:
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;
368 break;
369 }
370 }
371
372 snprintf(fw_name, len, "brcm/%s.hcd", hw_name ? : "BCM");
373 break;
374 default:
375 return 0;
376 }
377
378 BT_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
379 hw_name ? : "BCM", (subver & 0xe000) >> 13,
380 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
381
382 return 0;
383 }
384 EXPORT_SYMBOL_GPL(btbcm_initialize);
385
386 int btbcm_finalize(struct hci_dev *hdev)
387 {
388 struct sk_buff *skb;
389 struct hci_rp_read_local_version *ver;
390 u16 subver, rev;
391 int err;
392
393 /* Reset */
394 err = btbcm_reset(hdev);
395 if (err)
396 return err;
397
398 /* Read Local Version Info */
399 skb = btbcm_read_local_version(hdev);
400 if (IS_ERR(skb))
401 return PTR_ERR(skb);
402
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);
406 kfree_skb(skb);
407
408 BT_INFO("%s: BCM (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
409 (subver & 0xe000) >> 13, (subver & 0x1f00) >> 8,
410 (subver & 0x00ff), rev & 0x0fff);
411
412 btbcm_check_bdaddr(hdev);
413
414 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
415
416 return 0;
417 }
418 EXPORT_SYMBOL_GPL(btbcm_finalize);
419
420 static const struct {
421 u16 subver;
422 const char *name;
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 */
434 { }
435 };
436
437 int btbcm_setup_patchram(struct hci_dev *hdev)
438 {
439 char fw_name[64];
440 const struct firmware *fw;
441 u16 subver, rev, pid, vid;
442 const char *hw_name = NULL;
443 struct sk_buff *skb;
444 struct hci_rp_read_local_version *ver;
445 int i, err;
446
447 /* Reset */
448 err = btbcm_reset(hdev);
449 if (err)
450 return err;
451
452 /* Read Local Version Info */
453 skb = btbcm_read_local_version(hdev);
454 if (IS_ERR(skb))
455 return PTR_ERR(skb);
456
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);
460 kfree_skb(skb);
461
462 /* Read controller information */
463 err = btbcm_read_info(hdev);
464 if (err)
465 return err;
466
467 switch ((rev & 0xf000) >> 12) {
468 case 0:
469 case 3:
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;
473 break;
474 }
475 }
476
477 snprintf(fw_name, sizeof(fw_name), "brcm/%s.hcd",
478 hw_name ? : "BCM");
479 break;
480 case 1:
481 case 2:
482 /* Read USB Product Info */
483 skb = btbcm_read_usb_product(hdev);
484 if (IS_ERR(skb))
485 return PTR_ERR(skb);
486
487 vid = get_unaligned_le16(skb->data + 1);
488 pid = get_unaligned_le16(skb->data + 3);
489 kfree_skb(skb);
490
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;
494 break;
495 }
496 }
497
498 snprintf(fw_name, sizeof(fw_name), "brcm/%s-%4.4x-%4.4x.hcd",
499 hw_name ? : "BCM", vid, pid);
500 break;
501 default:
502 return 0;
503 }
504
505 BT_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
506 hw_name ? : "BCM", (subver & 0xe000) >> 13,
507 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
508
509 err = request_firmware(&fw, fw_name, &hdev->dev);
510 if (err < 0) {
511 BT_INFO("%s: BCM: Patch %s not found", hdev->name, fw_name);
512 goto done;
513 }
514
515 btbcm_patchram(hdev, fw);
516
517 release_firmware(fw);
518
519 /* Reset */
520 err = btbcm_reset(hdev);
521 if (err)
522 return err;
523
524 /* Read Local Version Info */
525 skb = btbcm_read_local_version(hdev);
526 if (IS_ERR(skb))
527 return PTR_ERR(skb);
528
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);
532 kfree_skb(skb);
533
534 BT_INFO("%s: %s (%3.3u.%3.3u.%3.3u) build %4.4u", hdev->name,
535 hw_name ? : "BCM", (subver & 0xe000) >> 13,
536 (subver & 0x1f00) >> 8, (subver & 0x00ff), rev & 0x0fff);
537
538 /* Read Local Name */
539 skb = btbcm_read_local_name(hdev);
540 if (IS_ERR(skb))
541 return PTR_ERR(skb);
542
543 BT_INFO("%s: %s", hdev->name, (char *)(skb->data + 1));
544 kfree_skb(skb);
545
546 done:
547 btbcm_check_bdaddr(hdev);
548
549 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
550
551 return 0;
552 }
553 EXPORT_SYMBOL_GPL(btbcm_setup_patchram);
554
555 int btbcm_setup_apple(struct hci_dev *hdev)
556 {
557 struct sk_buff *skb;
558 int err;
559
560 /* Reset */
561 err = btbcm_reset(hdev);
562 if (err)
563 return err;
564
565 /* Read Verbose Config Version Info */
566 skb = btbcm_read_verbose_config(hdev);
567 if (!IS_ERR(skb)) {
568 BT_INFO("%s: BCM: chip id %u build %4.4u", hdev->name,
569 skb->data[1], get_unaligned_le16(skb->data + 5));
570 kfree_skb(skb);
571 }
572
573 /* Read USB Product Info */
574 skb = btbcm_read_usb_product(hdev);
575 if (!IS_ERR(skb)) {
576 BT_INFO("%s: BCM: product %4.4x:%4.4x", hdev->name,
577 get_unaligned_le16(skb->data + 1),
578 get_unaligned_le16(skb->data + 3));
579 kfree_skb(skb);
580 }
581
582 /* Read Controller Features */
583 skb = btbcm_read_controller_features(hdev);
584 if (!IS_ERR(skb)) {
585 BT_INFO("%s: BCM: features 0x%2.2x", hdev->name, skb->data[1]);
586 kfree_skb(skb);
587 }
588
589 /* Read Local Name */
590 skb = btbcm_read_local_name(hdev);
591 if (!IS_ERR(skb)) {
592 BT_INFO("%s: %s", hdev->name, (char *)(skb->data + 1));
593 kfree_skb(skb);
594 }
595
596 set_bit(HCI_QUIRK_STRICT_DUPLICATE_FILTER, &hdev->quirks);
597
598 return 0;
599 }
600 EXPORT_SYMBOL_GPL(btbcm_setup_apple);
601
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");