xref: /linux/drivers/bluetooth/btqca.c (revision 26ba30221c03364d6ed9910be8da4c1fd871b07b)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  Bluetooth supports for Qualcomm Atheros chips
4  *
5  *  Copyright (c) 2015 The Linux Foundation. All rights reserved.
6  */
7 #include <linux/module.h>
8 #include <linux/firmware.h>
9 #include <linux/vmalloc.h>
10 
11 #include <net/bluetooth/bluetooth.h>
12 #include <net/bluetooth/hci_core.h>
13 
14 #include "btqca.h"
15 
16 int qca_read_soc_version(struct hci_dev *hdev, struct qca_btsoc_version *ver,
17 			 enum qca_btsoc_type soc_type)
18 {
19 	struct sk_buff *skb;
20 	struct edl_event_hdr *edl;
21 	char cmd;
22 	int err = 0;
23 	u8 event_type = HCI_EV_VENDOR;
24 	u8 rlen = sizeof(*edl) + sizeof(*ver);
25 	u8 rtype = EDL_APP_VER_RES_EVT;
26 
27 	bt_dev_dbg(hdev, "QCA Version Request");
28 
29 	/* Unlike other SoC's sending version command response as payload to
30 	 * VSE event. WCN3991 sends version command response as a payload to
31 	 * command complete event.
32 	 */
33 	if (soc_type >= QCA_WCN3991) {
34 		event_type = 0;
35 		rlen += 1;
36 		rtype = EDL_PATCH_VER_REQ_CMD;
37 	}
38 
39 	cmd = EDL_PATCH_VER_REQ_CMD;
40 	skb = __hci_cmd_sync_ev(hdev, EDL_PATCH_CMD_OPCODE, EDL_PATCH_CMD_LEN,
41 				&cmd, event_type, HCI_INIT_TIMEOUT);
42 	if (IS_ERR(skb)) {
43 		err = PTR_ERR(skb);
44 		bt_dev_err(hdev, "Reading QCA version information failed (%d)",
45 			   err);
46 		return err;
47 	}
48 
49 	if (skb->len != rlen) {
50 		bt_dev_err(hdev, "QCA Version size mismatch len %d", skb->len);
51 		err = -EILSEQ;
52 		goto out;
53 	}
54 
55 	edl = (struct edl_event_hdr *)(skb->data);
56 
57 	if (edl->cresp != EDL_CMD_REQ_RES_EVT ||
58 	    edl->rtype != rtype) {
59 		bt_dev_err(hdev, "QCA Wrong packet received %d %d", edl->cresp,
60 			   edl->rtype);
61 		err = -EIO;
62 		goto out;
63 	}
64 
65 	if (soc_type >= QCA_WCN3991)
66 		memcpy(ver, edl->data + 1, sizeof(*ver));
67 	else
68 		memcpy(ver, &edl->data, sizeof(*ver));
69 
70 	bt_dev_info(hdev, "QCA Product ID   :0x%08x",
71 		    le32_to_cpu(ver->product_id));
72 	bt_dev_info(hdev, "QCA SOC Version  :0x%08x",
73 		    le32_to_cpu(ver->soc_id));
74 	bt_dev_info(hdev, "QCA ROM Version  :0x%08x",
75 		    le16_to_cpu(ver->rom_ver));
76 	bt_dev_info(hdev, "QCA Patch Version:0x%08x",
77 		    le16_to_cpu(ver->patch_ver));
78 
79 	if (ver->soc_id == 0 || ver->rom_ver == 0)
80 		err = -EILSEQ;
81 
82 out:
83 	kfree_skb(skb);
84 	if (err)
85 		bt_dev_err(hdev, "QCA Failed to get version (%d)", err);
86 
87 	return err;
88 }
89 EXPORT_SYMBOL_GPL(qca_read_soc_version);
90 
91 static int qca_read_fw_build_info(struct hci_dev *hdev)
92 {
93 	struct sk_buff *skb;
94 	struct edl_event_hdr *edl;
95 	char *build_label;
96 	char cmd;
97 	int build_lbl_len, err = 0;
98 
99 	bt_dev_dbg(hdev, "QCA read fw build info");
100 
101 	cmd = EDL_GET_BUILD_INFO_CMD;
102 	skb = __hci_cmd_sync_ev(hdev, EDL_PATCH_CMD_OPCODE, EDL_PATCH_CMD_LEN,
103 				&cmd, 0, HCI_INIT_TIMEOUT);
104 	if (IS_ERR(skb)) {
105 		err = PTR_ERR(skb);
106 		bt_dev_err(hdev, "Reading QCA fw build info failed (%d)",
107 			   err);
108 		return err;
109 	}
110 
111 	if (skb->len < sizeof(*edl)) {
112 		err = -EILSEQ;
113 		goto out;
114 	}
115 
116 	edl = (struct edl_event_hdr *)(skb->data);
117 
118 	if (edl->cresp != EDL_CMD_REQ_RES_EVT ||
119 	    edl->rtype != EDL_GET_BUILD_INFO_CMD) {
120 		bt_dev_err(hdev, "QCA Wrong packet received %d %d", edl->cresp,
121 			   edl->rtype);
122 		err = -EIO;
123 		goto out;
124 	}
125 
126 	if (skb->len < sizeof(*edl) + 1) {
127 		err = -EILSEQ;
128 		goto out;
129 	}
130 
131 	build_lbl_len = edl->data[0];
132 
133 	if (skb->len < sizeof(*edl) + 1 + build_lbl_len) {
134 		err = -EILSEQ;
135 		goto out;
136 	}
137 
138 	build_label = kstrndup(&edl->data[1], build_lbl_len, GFP_KERNEL);
139 	if (!build_label) {
140 		err = -ENOMEM;
141 		goto out;
142 	}
143 
144 	hci_set_fw_info(hdev, "%s", build_label);
145 
146 	bt_dev_info(hdev, "QCA FW build version: %s", build_label);
147 
148 	kfree(build_label);
149 out:
150 	kfree_skb(skb);
151 	return err;
152 }
153 
154 static int qca_send_patch_config_cmd(struct hci_dev *hdev)
155 {
156 	const u8 cmd[] = { EDL_PATCH_CONFIG_CMD, 0x01, 0, 0, 0 };
157 	struct sk_buff *skb;
158 	struct edl_event_hdr *edl;
159 	int err;
160 
161 	bt_dev_dbg(hdev, "QCA Patch config");
162 
163 	skb = __hci_cmd_sync_ev(hdev, EDL_PATCH_CMD_OPCODE, sizeof(cmd),
164 				cmd, 0, HCI_INIT_TIMEOUT);
165 	if (IS_ERR(skb)) {
166 		err = PTR_ERR(skb);
167 		bt_dev_err(hdev, "Sending QCA Patch config failed (%d)", err);
168 		return err;
169 	}
170 
171 	if (skb->len != 2) {
172 		bt_dev_err(hdev, "QCA Patch config cmd size mismatch len %d", skb->len);
173 		err = -EILSEQ;
174 		goto out;
175 	}
176 
177 	edl = (struct edl_event_hdr *)(skb->data);
178 
179 	if (edl->cresp != EDL_PATCH_CONFIG_RES_EVT || edl->rtype != EDL_PATCH_CONFIG_CMD) {
180 		bt_dev_err(hdev, "QCA Wrong packet received %d %d", edl->cresp,
181 			   edl->rtype);
182 		err = -EIO;
183 		goto out;
184 	}
185 
186 	err = 0;
187 
188 out:
189 	kfree_skb(skb);
190 	return err;
191 }
192 
193 static int qca_read_fw_board_id(struct hci_dev *hdev, u16 *bid)
194 {
195 	u8 cmd;
196 	struct sk_buff *skb;
197 	struct edl_event_hdr *edl;
198 	int err = 0;
199 
200 	cmd = EDL_GET_BID_REQ_CMD;
201 	skb = __hci_cmd_sync_ev(hdev, EDL_PATCH_CMD_OPCODE, EDL_PATCH_CMD_LEN,
202 				&cmd, 0, HCI_INIT_TIMEOUT);
203 	if (IS_ERR(skb)) {
204 		err = PTR_ERR(skb);
205 		bt_dev_err(hdev, "Reading QCA board ID failed (%d)", err);
206 		return err;
207 	}
208 
209 	edl = skb_pull_data(skb, sizeof(*edl));
210 	if (!edl) {
211 		bt_dev_err(hdev, "QCA read board ID with no header");
212 		err = -EILSEQ;
213 		goto out;
214 	}
215 
216 	if (edl->cresp != EDL_CMD_REQ_RES_EVT ||
217 	    edl->rtype != EDL_GET_BID_REQ_CMD) {
218 		bt_dev_err(hdev, "QCA Wrong packet: %d %d", edl->cresp, edl->rtype);
219 		err = -EIO;
220 		goto out;
221 	}
222 
223 	if (skb->len < 3) {
224 		err = -EILSEQ;
225 		goto out;
226 	}
227 
228 	*bid = (edl->data[1] << 8) + edl->data[2];
229 	bt_dev_dbg(hdev, "%s: bid = %x", __func__, *bid);
230 
231 out:
232 	kfree_skb(skb);
233 	return err;
234 }
235 
236 int qca_send_pre_shutdown_cmd(struct hci_dev *hdev)
237 {
238 	struct sk_buff *skb;
239 	int err;
240 
241 	bt_dev_dbg(hdev, "QCA pre shutdown cmd");
242 
243 	skb = __hci_cmd_sync_ev(hdev, QCA_PRE_SHUTDOWN_CMD, 0,
244 				NULL, HCI_EV_CMD_COMPLETE, HCI_INIT_TIMEOUT);
245 
246 	if (IS_ERR(skb)) {
247 		err = PTR_ERR(skb);
248 		bt_dev_err(hdev, "QCA preshutdown_cmd failed (%d)", err);
249 		return err;
250 	}
251 
252 	kfree_skb(skb);
253 
254 	return 0;
255 }
256 EXPORT_SYMBOL_GPL(qca_send_pre_shutdown_cmd);
257 
258 static bool qca_filename_has_extension(const char *filename)
259 {
260 	const char *suffix = strrchr(filename, '.');
261 
262 	/* File extensions require a dot, but not as the first or last character */
263 	if (!suffix || suffix == filename || *(suffix + 1) == '\0')
264 		return 0;
265 
266 	/* Avoid matching directories with names that look like files with extensions */
267 	return !strchr(suffix, '/');
268 }
269 
270 static bool qca_get_alt_nvm_file(char *filename, size_t max_size)
271 {
272 	char fwname[64];
273 	const char *suffix;
274 
275 	/* nvm file name has an extension, replace with .bin */
276 	if (qca_filename_has_extension(filename)) {
277 		suffix = strrchr(filename, '.');
278 		strscpy(fwname, filename, suffix - filename + 1);
279 		snprintf(fwname + (suffix - filename),
280 		       sizeof(fwname) - (suffix - filename), ".bin");
281 		/* If nvm file is already the default one, return false to skip the retry. */
282 		if (strcmp(fwname, filename) == 0)
283 			return false;
284 
285 		snprintf(filename, max_size, "%s", fwname);
286 		return true;
287 	}
288 	return false;
289 }
290 
291 static int qca_tlv_check_data(struct hci_dev *hdev,
292 			       struct qca_fw_config *config,
293 			       u8 *fw_data, size_t fw_size,
294 			       enum qca_btsoc_type soc_type)
295 {
296 	const u8 *data;
297 	u32 type_len;
298 	u16 tag_id, tag_len;
299 	int idx, length;
300 	struct tlv_type_hdr *tlv;
301 	struct tlv_type_patch *tlv_patch;
302 	struct tlv_type_nvm *tlv_nvm;
303 	uint8_t nvm_baud_rate = config->user_baud_rate;
304 	u8 type;
305 
306 	config->dnld_mode = QCA_SKIP_EVT_NONE;
307 	config->dnld_type = QCA_SKIP_EVT_NONE;
308 
309 	switch (config->type) {
310 	case ELF_TYPE_PATCH:
311 		if (fw_size < 7)
312 			return -EINVAL;
313 
314 		config->dnld_mode = QCA_SKIP_EVT_VSE_CC;
315 		config->dnld_type = QCA_SKIP_EVT_VSE_CC;
316 
317 		bt_dev_dbg(hdev, "File Class        : 0x%x", fw_data[4]);
318 		bt_dev_dbg(hdev, "Data Encoding     : 0x%x", fw_data[5]);
319 		bt_dev_dbg(hdev, "File version      : 0x%x", fw_data[6]);
320 		break;
321 	case TLV_TYPE_PATCH:
322 		if (fw_size < sizeof(struct tlv_type_hdr) + sizeof(struct tlv_type_patch))
323 			return -EINVAL;
324 
325 		tlv = (struct tlv_type_hdr *)fw_data;
326 		type_len = le32_to_cpu(tlv->type_len);
327 		tlv_patch = (struct tlv_type_patch *)tlv->data;
328 
329 		/* For Rome version 1.1 to 3.1, all segment commands
330 		 * are acked by a vendor specific event (VSE).
331 		 * For Rome >= 3.2, the download mode field indicates
332 		 * if VSE is skipped by the controller.
333 		 * In case VSE is skipped, only the last segment is acked.
334 		 */
335 		config->dnld_mode = tlv_patch->download_mode;
336 		config->dnld_type = config->dnld_mode;
337 
338 		BT_DBG("TLV Type\t\t : 0x%x", type_len & 0x000000ff);
339 		BT_DBG("Total Length           : %d bytes",
340 		       le32_to_cpu(tlv_patch->total_size));
341 		BT_DBG("Patch Data Length      : %d bytes",
342 		       le32_to_cpu(tlv_patch->data_length));
343 		BT_DBG("Signing Format Version : 0x%x",
344 		       tlv_patch->format_version);
345 		BT_DBG("Signature Algorithm    : 0x%x",
346 		       tlv_patch->signature);
347 		BT_DBG("Download mode          : 0x%x",
348 		       tlv_patch->download_mode);
349 		BT_DBG("Reserved               : 0x%x",
350 		       tlv_patch->reserved1);
351 		BT_DBG("Product ID             : 0x%04x",
352 		       le16_to_cpu(tlv_patch->product_id));
353 		BT_DBG("Rom Build Version      : 0x%04x",
354 		       le16_to_cpu(tlv_patch->rom_build));
355 		BT_DBG("Patch Version          : 0x%04x",
356 		       le16_to_cpu(tlv_patch->patch_version));
357 		BT_DBG("Reserved               : 0x%x",
358 		       le16_to_cpu(tlv_patch->reserved2));
359 		BT_DBG("Patch Entry Address    : 0x%x",
360 		       le32_to_cpu(tlv_patch->entry));
361 		break;
362 
363 	case TLV_TYPE_NVM:
364 		if (fw_size < sizeof(struct tlv_type_hdr))
365 			return -EINVAL;
366 
367 		tlv = (struct tlv_type_hdr *)fw_data;
368 
369 		type_len = le32_to_cpu(tlv->type_len);
370 		length = type_len >> 8;
371 		type = type_len & 0xff;
372 
373 		/* Some NVM files have more than one set of tags, only parse
374 		 * the first set when it has type 2 for now. When there is
375 		 * more than one set there is an enclosing header of type 4.
376 		 */
377 		if (type == 4) {
378 			if (fw_size < 2 * sizeof(struct tlv_type_hdr))
379 				return -EINVAL;
380 
381 			tlv++;
382 
383 			type_len = le32_to_cpu(tlv->type_len);
384 			length = type_len >> 8;
385 			type = type_len & 0xff;
386 		}
387 
388 		BT_DBG("TLV Type\t\t : 0x%x", type);
389 		BT_DBG("Length\t\t : %d bytes", length);
390 
391 		if (type != 2)
392 			break;
393 
394 		if (fw_size < length + (tlv->data - fw_data))
395 			return -EINVAL;
396 
397 		idx = 0;
398 		data = tlv->data;
399 		while (idx + sizeof(struct tlv_type_nvm) <= length) {
400 			tlv_nvm = (struct tlv_type_nvm *)(data + idx);
401 
402 			tag_id = le16_to_cpu(tlv_nvm->tag_id);
403 			tag_len = le16_to_cpu(tlv_nvm->tag_len);
404 
405 			if (length < idx + sizeof(struct tlv_type_nvm) + tag_len)
406 				return -EINVAL;
407 
408 			/* Update NVM tags as needed */
409 			switch (tag_id) {
410 			case EDL_TAG_ID_BD_ADDR:
411 				if (tag_len != sizeof(bdaddr_t))
412 					return -EINVAL;
413 
414 				memcpy(&config->bdaddr, tlv_nvm->data, sizeof(bdaddr_t));
415 
416 				break;
417 
418 			case EDL_TAG_ID_HCI:
419 				if (tag_len < 3)
420 					return -EINVAL;
421 
422 				/* HCI transport layer parameters
423 				 * enabling software inband sleep
424 				 * onto controller side.
425 				 */
426 				tlv_nvm->data[0] |= 0x80;
427 
428 				/* UART Baud Rate */
429 				if (soc_type >= QCA_WCN3991)
430 					tlv_nvm->data[1] = nvm_baud_rate;
431 				else
432 					tlv_nvm->data[2] = nvm_baud_rate;
433 
434 				break;
435 
436 			case EDL_TAG_ID_DEEP_SLEEP:
437 				if (tag_len < 1)
438 					return -EINVAL;
439 
440 				/* Sleep enable mask
441 				 * enabling deep sleep feature on controller.
442 				 */
443 				tlv_nvm->data[0] |= 0x01;
444 
445 				break;
446 			}
447 
448 			idx += sizeof(struct tlv_type_nvm) + tag_len;
449 		}
450 		break;
451 
452 	default:
453 		BT_ERR("Unknown TLV type %d", config->type);
454 		return -EINVAL;
455 	}
456 
457 	return 0;
458 }
459 
460 static int qca_tlv_send_segment(struct hci_dev *hdev, int seg_size,
461 				const u8 *data, enum qca_tlv_dnld_mode mode,
462 				enum qca_btsoc_type soc_type)
463 {
464 	struct sk_buff *skb;
465 	struct edl_event_hdr *edl;
466 	struct tlv_seg_resp *tlv_resp;
467 	u8 cmd[MAX_SIZE_PER_TLV_SEGMENT + 2];
468 	int err = 0;
469 	u8 event_type = HCI_EV_VENDOR;
470 	u8 rlen = (sizeof(*edl) + sizeof(*tlv_resp));
471 	u8 rtype = EDL_TVL_DNLD_RES_EVT;
472 
473 	cmd[0] = EDL_PATCH_TLV_REQ_CMD;
474 	cmd[1] = seg_size;
475 	memcpy(cmd + 2, data, seg_size);
476 
477 	if (mode == QCA_SKIP_EVT_VSE_CC || mode == QCA_SKIP_EVT_VSE)
478 		return __hci_cmd_send(hdev, EDL_PATCH_CMD_OPCODE, seg_size + 2,
479 				      cmd);
480 
481 	/* Unlike other SoC's sending version command response as payload to
482 	 * VSE event. WCN3991 sends version command response as a payload to
483 	 * command complete event.
484 	 */
485 	if (soc_type >= QCA_WCN3991) {
486 		event_type = 0;
487 		rlen = sizeof(*edl);
488 		rtype = EDL_PATCH_TLV_REQ_CMD;
489 	}
490 
491 	skb = __hci_cmd_sync_ev(hdev, EDL_PATCH_CMD_OPCODE, seg_size + 2, cmd,
492 				event_type, HCI_INIT_TIMEOUT);
493 	if (IS_ERR(skb)) {
494 		err = PTR_ERR(skb);
495 		bt_dev_err(hdev, "QCA Failed to send TLV segment (%d)", err);
496 		return err;
497 	}
498 
499 	if (skb->len != rlen) {
500 		bt_dev_err(hdev, "QCA TLV response size mismatch");
501 		err = -EILSEQ;
502 		goto out;
503 	}
504 
505 	edl = (struct edl_event_hdr *)(skb->data);
506 
507 	if (edl->cresp != EDL_CMD_REQ_RES_EVT || edl->rtype != rtype) {
508 		bt_dev_err(hdev, "QCA TLV with error stat 0x%x rtype 0x%x",
509 			   edl->cresp, edl->rtype);
510 		err = -EIO;
511 	}
512 
513 	if (soc_type >= QCA_WCN3991)
514 		goto out;
515 
516 	tlv_resp = (struct tlv_seg_resp *)(edl->data);
517 	if (tlv_resp->result) {
518 		bt_dev_err(hdev, "QCA TLV with error stat 0x%x rtype 0x%x (0x%x)",
519 			   edl->cresp, edl->rtype, tlv_resp->result);
520 	}
521 
522 out:
523 	kfree_skb(skb);
524 
525 	return err;
526 }
527 
528 static int qca_inject_cmd_complete_event(struct hci_dev *hdev)
529 {
530 	struct hci_event_hdr *hdr;
531 	struct hci_ev_cmd_complete *evt;
532 	struct sk_buff *skb;
533 
534 	skb = bt_skb_alloc(sizeof(*hdr) + sizeof(*evt) + 1, GFP_KERNEL);
535 	if (!skb)
536 		return -ENOMEM;
537 
538 	hdr = skb_put(skb, sizeof(*hdr));
539 	hdr->evt = HCI_EV_CMD_COMPLETE;
540 	hdr->plen = sizeof(*evt) + 1;
541 
542 	evt = skb_put(skb, sizeof(*evt));
543 	evt->ncmd = 1;
544 	evt->opcode = cpu_to_le16(QCA_HCI_CC_OPCODE);
545 
546 	skb_put_u8(skb, QCA_HCI_CC_SUCCESS);
547 
548 	hci_skb_pkt_type(skb) = HCI_EVENT_PKT;
549 
550 	return hci_recv_frame(hdev, skb);
551 }
552 
553 static int qca_download_firmware(struct hci_dev *hdev,
554 				 struct qca_fw_config *config,
555 				 enum qca_btsoc_type soc_type,
556 				 u8 rom_ver)
557 {
558 	const struct firmware *fw;
559 	u8 *data;
560 	const u8 *segment;
561 	int ret, size, remain, i = 0;
562 
563 	bt_dev_info(hdev, "QCA Downloading %s", config->fwname);
564 
565 	ret = request_firmware(&fw, config->fwname, &hdev->dev);
566 	if (ret) {
567 		/* If the board-specific file is missing, try loading the default
568 		 * one, unless that was attempted already.
569 		 */
570 		if (config->type == TLV_TYPE_NVM &&
571 		    qca_get_alt_nvm_file(config->fwname, sizeof(config->fwname))) {
572 			bt_dev_info(hdev, "QCA Downloading %s", config->fwname);
573 			ret = request_firmware(&fw, config->fwname, &hdev->dev);
574 			if (ret) {
575 				bt_dev_err(hdev, "QCA Failed to request file: %s (%d)",
576 					   config->fwname, ret);
577 				return ret;
578 			}
579 		} else {
580 			bt_dev_err(hdev, "QCA Failed to request file: %s (%d)",
581 				   config->fwname, ret);
582 			return ret;
583 		}
584 	}
585 
586 	size = fw->size;
587 	data = vmalloc(fw->size);
588 	if (!data) {
589 		bt_dev_err(hdev, "QCA Failed to allocate memory for file: %s",
590 			   config->fwname);
591 		release_firmware(fw);
592 		return -ENOMEM;
593 	}
594 
595 	memcpy(data, fw->data, size);
596 	release_firmware(fw);
597 
598 	ret = qca_tlv_check_data(hdev, config, data, size, soc_type);
599 	if (ret)
600 		goto out;
601 
602 	segment = data;
603 	remain = size;
604 	while (remain > 0) {
605 		int segsize = min(MAX_SIZE_PER_TLV_SEGMENT, remain);
606 
607 		bt_dev_dbg(hdev, "Send segment %d, size %d", i++, segsize);
608 
609 		remain -= segsize;
610 		/* The last segment is always acked regardless download mode */
611 		if (!remain || segsize < MAX_SIZE_PER_TLV_SEGMENT)
612 			config->dnld_mode = QCA_SKIP_EVT_NONE;
613 
614 		ret = qca_tlv_send_segment(hdev, segsize, segment,
615 					   config->dnld_mode, soc_type);
616 		if (ret)
617 			goto out;
618 
619 		segment += segsize;
620 	}
621 
622 	/* Latest qualcomm chipsets are not sending a command complete event
623 	 * for every fw packet sent. They only respond with a vendor specific
624 	 * event for the last packet. This optimization in the chip will
625 	 * decrease the BT in initialization time. Here we will inject a command
626 	 * complete event to avoid a command timeout error message.
627 	 */
628 	if (config->dnld_type == QCA_SKIP_EVT_VSE_CC ||
629 	    config->dnld_type == QCA_SKIP_EVT_VSE)
630 		ret = qca_inject_cmd_complete_event(hdev);
631 
632 out:
633 	vfree(data);
634 
635 	return ret;
636 }
637 
638 static int qca_disable_soc_logging(struct hci_dev *hdev)
639 {
640 	struct sk_buff *skb;
641 	u8 cmd[2];
642 	int err;
643 
644 	cmd[0] = QCA_DISABLE_LOGGING_SUB_OP;
645 	cmd[1] = 0x00;
646 	skb = __hci_cmd_sync_ev(hdev, QCA_DISABLE_LOGGING, sizeof(cmd), cmd,
647 				HCI_EV_CMD_COMPLETE, HCI_INIT_TIMEOUT);
648 	if (IS_ERR(skb)) {
649 		err = PTR_ERR(skb);
650 		bt_dev_err(hdev, "QCA Failed to disable soc logging(%d)", err);
651 		return err;
652 	}
653 
654 	kfree_skb(skb);
655 
656 	return 0;
657 }
658 
659 int qca_set_bdaddr_rome(struct hci_dev *hdev, const bdaddr_t *bdaddr)
660 {
661 	struct sk_buff *skb;
662 	u8 cmd[9];
663 	int err;
664 
665 	cmd[0] = EDL_NVM_ACCESS_SET_REQ_CMD;
666 	cmd[1] = 0x02; 			/* TAG ID */
667 	cmd[2] = sizeof(bdaddr_t);	/* size */
668 	memcpy(cmd + 3, bdaddr, sizeof(bdaddr_t));
669 	skb = __hci_cmd_sync_ev(hdev, EDL_NVM_ACCESS_OPCODE, sizeof(cmd), cmd,
670 				HCI_EV_VENDOR, HCI_INIT_TIMEOUT);
671 	if (IS_ERR(skb)) {
672 		err = PTR_ERR(skb);
673 		bt_dev_err(hdev, "QCA Change address command failed (%d)", err);
674 		return err;
675 	}
676 
677 	kfree_skb(skb);
678 
679 	return 0;
680 }
681 EXPORT_SYMBOL_GPL(qca_set_bdaddr_rome);
682 
683 static int qca_check_bdaddr(struct hci_dev *hdev, const struct qca_fw_config *config)
684 {
685 	struct hci_rp_read_bd_addr *bda;
686 	struct sk_buff *skb;
687 	int err;
688 
689 	if (bacmp(&hdev->public_addr, BDADDR_ANY))
690 		return 0;
691 
692 	skb = __hci_cmd_sync(hdev, HCI_OP_READ_BD_ADDR, 0, NULL,
693 			     HCI_INIT_TIMEOUT);
694 	if (IS_ERR(skb)) {
695 		err = PTR_ERR(skb);
696 		bt_dev_err(hdev, "Failed to read device address (%d)", err);
697 		return err;
698 	}
699 
700 	if (skb->len != sizeof(*bda)) {
701 		bt_dev_err(hdev, "Device address length mismatch");
702 		kfree_skb(skb);
703 		return -EIO;
704 	}
705 
706 	bda = (struct hci_rp_read_bd_addr *)skb->data;
707 	if (!bacmp(&bda->bdaddr, &config->bdaddr))
708 		hci_set_quirk(hdev, HCI_QUIRK_USE_BDADDR_PROPERTY);
709 
710 	kfree_skb(skb);
711 
712 	return 0;
713 }
714 
715 static void qca_get_nvm_name_by_board(char *fwname, size_t max_size,
716 		const char *stem, enum qca_btsoc_type soc_type,
717 		struct qca_btsoc_version ver, u8 rom_ver, u16 bid)
718 {
719 	const char *variant;
720 	const char *prefix;
721 
722 	/* Set the default value to variant and prefix */
723 	variant = "";
724 	prefix = "b";
725 
726 	if (soc_type == QCA_QCA2066)
727 		prefix = "";
728 
729 	if (soc_type == QCA_WCN6855 || soc_type == QCA_QCA2066) {
730 		/* If the chip is manufactured by GlobalFoundries */
731 		if ((le32_to_cpu(ver.soc_id) & QCA_HSP_GF_SOC_MASK) == QCA_HSP_GF_SOC_ID)
732 			variant = "g";
733 	}
734 
735 	if (rom_ver != 0) {
736 		if (bid == 0x0 || bid == 0xffff)
737 			snprintf(fwname, max_size, "qca/%s%02x%s.bin", stem, rom_ver, variant);
738 		else
739 			snprintf(fwname, max_size, "qca/%s%02x%s.%s%02x", stem, rom_ver,
740 						variant, prefix, bid);
741 	} else {
742 		if (bid == 0x0 || bid == 0xffff)
743 			snprintf(fwname, max_size, "qca/%s%s.bin", stem, variant);
744 		else
745 			snprintf(fwname, max_size, "qca/%s%s.%s%02x", stem, variant, prefix, bid);
746 	}
747 }
748 
749 int qca_uart_setup(struct hci_dev *hdev, uint8_t baudrate,
750 		   enum qca_btsoc_type soc_type, struct qca_btsoc_version ver,
751 		   const char *firmware_name, const char *rampatch_name)
752 {
753 	struct qca_fw_config config = {};
754 	const char *variant = "";
755 	int err;
756 	u8 rom_ver = 0;
757 	u32 soc_ver;
758 	u16 boardid = 0;
759 
760 	bt_dev_dbg(hdev, "QCA setup on UART");
761 
762 	soc_ver = get_soc_ver(ver.soc_id, ver.rom_ver);
763 
764 	bt_dev_info(hdev, "QCA controller version 0x%08x", soc_ver);
765 
766 	config.user_baud_rate = baudrate;
767 
768 	/* Firmware files to download are based on ROM version.
769 	 * ROM version is derived from last two bytes of soc_ver.
770 	 */
771 	if (soc_type == QCA_WCN3988)
772 		rom_ver = ((soc_ver & 0x00000f00) >> 0x05) | (soc_ver & 0x0000000f);
773 	else if (soc_type == QCA_WCN3998)
774 		rom_ver = ((soc_ver & 0x0000f000) >> 0x07) | (soc_ver & 0x0000000f);
775 	else
776 		rom_ver = ((soc_ver & 0x00000f00) >> 0x04) | (soc_ver & 0x0000000f);
777 
778 	if (soc_type == QCA_WCN6750)
779 		qca_send_patch_config_cmd(hdev);
780 
781 	/* Download rampatch file */
782 	config.type = TLV_TYPE_PATCH;
783 	if (rampatch_name) {
784 		snprintf(config.fwname, sizeof(config.fwname), "qca/%s", rampatch_name);
785 	} else {
786 		switch (soc_type) {
787 		case QCA_QCA2066:
788 			snprintf(config.fwname, sizeof(config.fwname),
789 				 "qca/hpbtfw%02x.tlv", rom_ver);
790 			break;
791 		case QCA_QCA6390:
792 			snprintf(config.fwname, sizeof(config.fwname),
793 				 "qca/htbtfw%02x.tlv", rom_ver);
794 			break;
795 		case QCA_WCN3950:
796 			snprintf(config.fwname, sizeof(config.fwname),
797 				 "qca/cmbtfw%02x.tlv", rom_ver);
798 			break;
799 		case QCA_WCN3990:
800 		case QCA_WCN3991:
801 		case QCA_WCN3998:
802 			snprintf(config.fwname, sizeof(config.fwname),
803 				 "qca/crbtfw%02x.tlv", rom_ver);
804 			break;
805 		case QCA_WCN3988:
806 			snprintf(config.fwname, sizeof(config.fwname),
807 				 "qca/apbtfw%02x.tlv", rom_ver);
808 			break;
809 		case QCA_WCN6750:
810 			/* Choose mbn file by default.If mbn file is not found
811 			 * then choose tlv file
812 			 */
813 			config.type = ELF_TYPE_PATCH;
814 			snprintf(config.fwname, sizeof(config.fwname),
815 				 "qca/msbtfw%02x.mbn", rom_ver);
816 			break;
817 		case QCA_WCN6855:
818 			/* Due to historical reasons, WCN685x chip has been using firmware
819 			 * without the "wcn" prefix. The mapping between the chip and its
820 			 * corresponding firmware has now been corrected.
821 			 */
822 			snprintf(config.fwname, sizeof(config.fwname),
823 				 "qca/wcnhpbtfw%02x.tlv", rom_ver);
824 			break;
825 		case QCA_WCN7850:
826 			snprintf(config.fwname, sizeof(config.fwname),
827 				 "qca/hmtbtfw%02x.tlv", rom_ver);
828 			break;
829 		default:
830 			snprintf(config.fwname, sizeof(config.fwname),
831 				 "qca/rampatch_%08x.bin", soc_ver);
832 		}
833 	}
834 
835 	err = qca_download_firmware(hdev, &config, soc_type, rom_ver);
836 	/* For WCN6750, if mbn file is not present then check for
837 	 * tlv file.
838 	 */
839 	if (err < 0 && soc_type == QCA_WCN6750) {
840 		bt_dev_dbg(hdev, "QCA Failed to request file: %s (%d)",
841 			   config.fwname, err);
842 		config.type = TLV_TYPE_PATCH;
843 		snprintf(config.fwname, sizeof(config.fwname),
844 			 "qca/msbtfw%02x.tlv", rom_ver);
845 		bt_dev_info(hdev, "QCA Downloading %s", config.fwname);
846 		err = qca_download_firmware(hdev, &config, soc_type, rom_ver);
847 	} else if (err < 0 && !rampatch_name && soc_type == QCA_WCN6855) {
848 		snprintf(config.fwname, sizeof(config.fwname),
849 			 "qca/hpbtfw%02x.tlv", rom_ver);
850 		err = qca_download_firmware(hdev, &config, soc_type, rom_ver);
851 	}
852 
853 	if (err < 0) {
854 		bt_dev_err(hdev, "QCA Failed to request file: %s (%d)",
855 			   config.fwname, err);
856 		return err;
857 	}
858 
859 	/* Give the controller some time to get ready to receive the NVM */
860 	msleep(10);
861 
862 	if (soc_type == QCA_QCA2066 || soc_type == QCA_WCN7850)
863 		qca_read_fw_board_id(hdev, &boardid);
864 
865 	/* Download NVM configuration */
866 	config.type = TLV_TYPE_NVM;
867 	if (firmware_name) {
868 		/* The firmware name has an extension, use it directly */
869 		if (qca_filename_has_extension(firmware_name)) {
870 			snprintf(config.fwname, sizeof(config.fwname), "qca/%s", firmware_name);
871 		} else {
872 			qca_read_fw_board_id(hdev, &boardid);
873 			qca_get_nvm_name_by_board(config.fwname, sizeof(config.fwname),
874 				 firmware_name, soc_type, ver, 0, boardid);
875 		}
876 	} else {
877 		switch (soc_type) {
878 		case QCA_QCA2066:
879 			qca_get_nvm_name_by_board(config.fwname,
880 						  sizeof(config.fwname),
881 						  "hpnv", soc_type, ver,
882 						  rom_ver, boardid);
883 			break;
884 		case QCA_QCA6390:
885 			snprintf(config.fwname, sizeof(config.fwname),
886 				 "qca/htnv%02x.bin", rom_ver);
887 			break;
888 		case QCA_WCN3950:
889 			if (le32_to_cpu(ver.soc_id) == QCA_WCN3950_SOC_ID_T)
890 				variant = "t";
891 			else if (le32_to_cpu(ver.soc_id) == QCA_WCN3950_SOC_ID_S)
892 				variant = "s";
893 
894 			snprintf(config.fwname, sizeof(config.fwname),
895 				 "qca/cmnv%02x%s.bin", rom_ver, variant);
896 			break;
897 		case QCA_WCN3990:
898 		case QCA_WCN3991:
899 		case QCA_WCN3998:
900 			if (le32_to_cpu(ver.soc_id) == QCA_WCN3991_SOC_ID)
901 				variant = "u";
902 
903 			snprintf(config.fwname, sizeof(config.fwname),
904 				 "qca/crnv%02x%s.bin", rom_ver, variant);
905 			break;
906 		case QCA_WCN3988:
907 			snprintf(config.fwname, sizeof(config.fwname),
908 				 "qca/apnv%02x.bin", rom_ver);
909 			break;
910 		case QCA_WCN6750:
911 			snprintf(config.fwname, sizeof(config.fwname),
912 				 "qca/msnv%02x.bin", rom_ver);
913 			break;
914 		case QCA_WCN6855:
915 			qca_read_fw_board_id(hdev, &boardid);
916 			qca_get_nvm_name_by_board(config.fwname, sizeof(config.fwname),
917 						  "wcnhpnv", soc_type, ver, rom_ver, boardid);
918 			break;
919 		case QCA_WCN7850:
920 			qca_get_nvm_name_by_board(config.fwname, sizeof(config.fwname),
921 				 "hmtnv", soc_type, ver, rom_ver, boardid);
922 			break;
923 		default:
924 			snprintf(config.fwname, sizeof(config.fwname),
925 				 "qca/nvm_%08x.bin", soc_ver);
926 		}
927 	}
928 
929 	err = qca_download_firmware(hdev, &config, soc_type, rom_ver);
930 	if (err < 0 && !firmware_name && soc_type == QCA_WCN6855) {
931 		qca_get_nvm_name_by_board(config.fwname, sizeof(config.fwname),
932 					  "hpnv", soc_type, ver, rom_ver, boardid);
933 		err = qca_download_firmware(hdev, &config, soc_type, rom_ver);
934 	}
935 
936 	if (err < 0) {
937 		bt_dev_err(hdev, "QCA Failed to request file: %s (%d)",
938 			   config.fwname, err);
939 		return err;
940 	}
941 
942 	switch (soc_type) {
943 	case QCA_QCA2066:
944 	case QCA_QCA6390:
945 	case QCA_WCN3991:
946 	case QCA_WCN6750:
947 	case QCA_WCN6855:
948 	case QCA_WCN7850:
949 		err = qca_disable_soc_logging(hdev);
950 		if (err < 0)
951 			return err;
952 		break;
953 	default:
954 		break;
955 	}
956 
957 	/* WCN399x and WCN6750 supports the Microsoft vendor extension with 0xFD70 as the
958 	 * VsMsftOpCode.
959 	 */
960 	switch (soc_type) {
961 	case QCA_WCN3950:
962 	case QCA_WCN3988:
963 	case QCA_WCN3990:
964 	case QCA_WCN3991:
965 	case QCA_WCN3998:
966 	case QCA_WCN6750:
967 		hci_set_msft_opcode(hdev, 0xFD70);
968 		break;
969 	default:
970 		break;
971 	}
972 
973 	/* Perform HCI reset */
974 	err = __hci_reset_sync(hdev);
975 	if (err < 0) {
976 		bt_dev_err(hdev, "QCA Failed to run HCI_RESET (%d)", err);
977 		return err;
978 	}
979 	bt_dev_dbg(hdev, "QCA HCI_RESET succeed");
980 
981 	switch (soc_type) {
982 	case QCA_WCN3991:
983 	case QCA_WCN6750:
984 	case QCA_WCN6855:
985 	case QCA_WCN7850:
986 		/* get fw build info */
987 		err = qca_read_fw_build_info(hdev);
988 		if (err < 0)
989 			return err;
990 		break;
991 	default:
992 		break;
993 	}
994 
995 	err = qca_check_bdaddr(hdev, &config);
996 	if (err)
997 		return err;
998 
999 	bt_dev_info(hdev, "QCA setup on UART is completed");
1000 
1001 	return 0;
1002 }
1003 EXPORT_SYMBOL_GPL(qca_uart_setup);
1004 
1005 int qca_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
1006 {
1007 	bdaddr_t bdaddr_swapped;
1008 	struct sk_buff *skb;
1009 	int err;
1010 
1011 	baswap(&bdaddr_swapped, bdaddr);
1012 
1013 	skb = __hci_cmd_sync_ev(hdev, EDL_WRITE_BD_ADDR_OPCODE, 6,
1014 				&bdaddr_swapped, 0, HCI_INIT_TIMEOUT);
1015 	if (IS_ERR(skb)) {
1016 		err = PTR_ERR(skb);
1017 		bt_dev_err(hdev, "QCA Change address cmd failed (%d)", err);
1018 		return err;
1019 	}
1020 
1021 	kfree_skb(skb);
1022 
1023 	return 0;
1024 }
1025 EXPORT_SYMBOL_GPL(qca_set_bdaddr);
1026 
1027 
1028 MODULE_AUTHOR("Ben Young Tae Kim <ytkim@qca.qualcomm.com>");
1029 MODULE_DESCRIPTION("Bluetooth support for Qualcomm Atheros family");
1030 MODULE_LICENSE("GPL");
1031