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