1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Bluetooth support for Realtek devices
4 *
5 * Copyright (C) 2015 Endless Mobile, Inc.
6 */
7
8 #include <linux/module.h>
9 #include <linux/firmware.h>
10 #include <linux/unaligned.h>
11 #include <linux/usb.h>
12
13 #include <net/bluetooth/bluetooth.h>
14 #include <net/bluetooth/hci_core.h>
15
16 #include "btrtl.h"
17
18 #define VERSION "0.1"
19
20 #define RTL_CHIP_8723CS_CG 3
21 #define RTL_CHIP_8723CS_VF 4
22 #define RTL_CHIP_8723CS_XX 5
23 #define RTL_EPATCH_SIGNATURE "Realtech"
24 #define RTL_EPATCH_SIGNATURE_V2 "RTBTCore"
25 #define RTL_ROM_LMP_8703B 0x8703
26 #define RTL_ROM_LMP_8723A 0x1200
27 #define RTL_ROM_LMP_8723B 0x8723
28 #define RTL_ROM_LMP_8821A 0x8821
29 #define RTL_ROM_LMP_8761A 0x8761
30 #define RTL_ROM_LMP_8822B 0x8822
31 #define RTL_ROM_LMP_8852A 0x8852
32 #define RTL_ROM_LMP_8851B 0x8851
33 #define RTL_ROM_LMP_8922A 0x8922
34 #define RTL_CONFIG_MAGIC 0x8723ab55
35
36 #define RTL_VSC_OP_COREDUMP 0xfcff
37
38 #define IC_MATCH_FL_LMPSUBV (1 << 0)
39 #define IC_MATCH_FL_HCIREV (1 << 1)
40 #define IC_MATCH_FL_HCIVER (1 << 2)
41 #define IC_MATCH_FL_HCIBUS (1 << 3)
42 #define IC_MATCH_FL_CHIP_TYPE (1 << 4)
43 #define IC_INFO(lmps, hcir, hciv, bus) \
44 .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_HCIREV | \
45 IC_MATCH_FL_HCIVER | IC_MATCH_FL_HCIBUS, \
46 .lmp_subver = (lmps), \
47 .hci_rev = (hcir), \
48 .hci_ver = (hciv), \
49 .hci_bus = (bus)
50
51 #define RTL_CHIP_SUBVER (&(struct rtl_vendor_cmd) {{0x10, 0x38, 0x04, 0x28, 0x80}})
52 #define RTL_CHIP_REV (&(struct rtl_vendor_cmd) {{0x10, 0x3A, 0x04, 0x28, 0x80}})
53 #define RTL_SEC_PROJ (&(struct rtl_vendor_cmd) {{0x10, 0xA4, 0xAD, 0x00, 0xb0}})
54
55 #define RTL_PATCH_SNIPPETS 0x01
56 #define RTL_PATCH_DUMMY_HEADER 0x02
57 #define RTL_PATCH_SECURITY_HEADER 0x03
58
59 enum btrtl_chip_id {
60 CHIP_ID_8723A,
61 CHIP_ID_8723B,
62 CHIP_ID_8821A,
63 CHIP_ID_8761A,
64 CHIP_ID_8822B = 8,
65 CHIP_ID_8723D,
66 CHIP_ID_8821C,
67 CHIP_ID_8822C = 13,
68 CHIP_ID_8761B,
69 CHIP_ID_8852A = 18,
70 CHIP_ID_8852B = 20,
71 CHIP_ID_8852C = 25,
72 CHIP_ID_8851B = 36,
73 CHIP_ID_8922A = 44,
74 CHIP_ID_8852BT = 47,
75 };
76
77 struct id_table {
78 __u16 match_flags;
79 __u16 lmp_subver;
80 __u16 hci_rev;
81 __u8 hci_ver;
82 __u8 hci_bus;
83 __u8 chip_type;
84 bool config_needed;
85 bool has_rom_version;
86 bool has_msft_ext;
87 char *fw_name;
88 char *cfg_name;
89 char *hw_info;
90 };
91
92 struct btrtl_device_info {
93 const struct id_table *ic_info;
94 u8 rom_version;
95 u8 *fw_data;
96 int fw_len;
97 u8 *cfg_data;
98 int cfg_len;
99 bool drop_fw;
100 int project_id;
101 u8 key_id;
102 struct list_head patch_subsecs;
103 };
104
105 static const struct id_table ic_id_table[] = {
106 /* 8723A */
107 { IC_INFO(RTL_ROM_LMP_8723A, 0xb, 0x6, HCI_USB),
108 .config_needed = false,
109 .has_rom_version = false,
110 .fw_name = "rtl_bt/rtl8723a_fw",
111 .cfg_name = NULL,
112 .hw_info = "rtl8723au" },
113
114 /* 8723BS */
115 { IC_INFO(RTL_ROM_LMP_8723B, 0xb, 0x6, HCI_UART),
116 .config_needed = true,
117 .has_rom_version = true,
118 .fw_name = "rtl_bt/rtl8723bs_fw",
119 .cfg_name = "rtl_bt/rtl8723bs_config",
120 .hw_info = "rtl8723bs" },
121
122 /* 8723B */
123 { IC_INFO(RTL_ROM_LMP_8723B, 0xb, 0x6, HCI_USB),
124 .config_needed = false,
125 .has_rom_version = true,
126 .fw_name = "rtl_bt/rtl8723b_fw",
127 .cfg_name = "rtl_bt/rtl8723b_config",
128 .hw_info = "rtl8723bu" },
129
130 /* 8723CS-CG */
131 { .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_CHIP_TYPE |
132 IC_MATCH_FL_HCIBUS,
133 .lmp_subver = RTL_ROM_LMP_8703B,
134 .chip_type = RTL_CHIP_8723CS_CG,
135 .hci_bus = HCI_UART,
136 .config_needed = true,
137 .has_rom_version = true,
138 .fw_name = "rtl_bt/rtl8723cs_cg_fw",
139 .cfg_name = "rtl_bt/rtl8723cs_cg_config",
140 .hw_info = "rtl8723cs-cg" },
141
142 /* 8723CS-VF */
143 { .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_CHIP_TYPE |
144 IC_MATCH_FL_HCIBUS,
145 .lmp_subver = RTL_ROM_LMP_8703B,
146 .chip_type = RTL_CHIP_8723CS_VF,
147 .hci_bus = HCI_UART,
148 .config_needed = true,
149 .has_rom_version = true,
150 .fw_name = "rtl_bt/rtl8723cs_vf_fw",
151 .cfg_name = "rtl_bt/rtl8723cs_vf_config",
152 .hw_info = "rtl8723cs-vf" },
153
154 /* 8723CS-XX */
155 { .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_CHIP_TYPE |
156 IC_MATCH_FL_HCIBUS,
157 .lmp_subver = RTL_ROM_LMP_8703B,
158 .chip_type = RTL_CHIP_8723CS_XX,
159 .hci_bus = HCI_UART,
160 .config_needed = true,
161 .has_rom_version = true,
162 .fw_name = "rtl_bt/rtl8723cs_xx_fw",
163 .cfg_name = "rtl_bt/rtl8723cs_xx_config",
164 .hw_info = "rtl8723cs" },
165
166 /* 8723D */
167 { IC_INFO(RTL_ROM_LMP_8723B, 0xd, 0x8, HCI_USB),
168 .config_needed = true,
169 .has_rom_version = true,
170 .fw_name = "rtl_bt/rtl8723d_fw",
171 .cfg_name = "rtl_bt/rtl8723d_config",
172 .hw_info = "rtl8723du" },
173
174 /* 8723DS */
175 { IC_INFO(RTL_ROM_LMP_8723B, 0xd, 0x8, HCI_UART),
176 .config_needed = true,
177 .has_rom_version = true,
178 .fw_name = "rtl_bt/rtl8723ds_fw",
179 .cfg_name = "rtl_bt/rtl8723ds_config",
180 .hw_info = "rtl8723ds" },
181
182 /* 8821A */
183 { IC_INFO(RTL_ROM_LMP_8821A, 0xa, 0x6, HCI_USB),
184 .config_needed = false,
185 .has_rom_version = true,
186 .fw_name = "rtl_bt/rtl8821a_fw",
187 .cfg_name = "rtl_bt/rtl8821a_config",
188 .hw_info = "rtl8821au" },
189
190 /* 8821C */
191 { IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_USB),
192 .config_needed = false,
193 .has_rom_version = true,
194 .has_msft_ext = true,
195 .fw_name = "rtl_bt/rtl8821c_fw",
196 .cfg_name = "rtl_bt/rtl8821c_config",
197 .hw_info = "rtl8821cu" },
198
199 /* 8821CS */
200 { IC_INFO(RTL_ROM_LMP_8821A, 0xc, 0x8, HCI_UART),
201 .config_needed = true,
202 .has_rom_version = true,
203 .has_msft_ext = true,
204 .fw_name = "rtl_bt/rtl8821cs_fw",
205 .cfg_name = "rtl_bt/rtl8821cs_config",
206 .hw_info = "rtl8821cs" },
207
208 /* 8761A */
209 { IC_INFO(RTL_ROM_LMP_8761A, 0xa, 0x6, HCI_USB),
210 .config_needed = false,
211 .has_rom_version = true,
212 .fw_name = "rtl_bt/rtl8761a_fw",
213 .cfg_name = "rtl_bt/rtl8761a_config",
214 .hw_info = "rtl8761au" },
215
216 /* 8761B */
217 { IC_INFO(RTL_ROM_LMP_8761A, 0xb, 0xa, HCI_UART),
218 .config_needed = false,
219 .has_rom_version = true,
220 .has_msft_ext = true,
221 .fw_name = "rtl_bt/rtl8761b_fw",
222 .cfg_name = "rtl_bt/rtl8761b_config",
223 .hw_info = "rtl8761btv" },
224
225 /* 8761BU */
226 { IC_INFO(RTL_ROM_LMP_8761A, 0xb, 0xa, HCI_USB),
227 .config_needed = false,
228 .has_rom_version = true,
229 .fw_name = "rtl_bt/rtl8761bu_fw",
230 .cfg_name = "rtl_bt/rtl8761bu_config",
231 .hw_info = "rtl8761bu" },
232
233 /* 8822C with UART interface */
234 { IC_INFO(RTL_ROM_LMP_8822B, 0xc, 0x8, HCI_UART),
235 .config_needed = true,
236 .has_rom_version = true,
237 .has_msft_ext = true,
238 .fw_name = "rtl_bt/rtl8822cs_fw",
239 .cfg_name = "rtl_bt/rtl8822cs_config",
240 .hw_info = "rtl8822cs" },
241
242 /* 8822C with UART interface */
243 { IC_INFO(RTL_ROM_LMP_8822B, 0xc, 0xa, HCI_UART),
244 .config_needed = true,
245 .has_rom_version = true,
246 .has_msft_ext = true,
247 .fw_name = "rtl_bt/rtl8822cs_fw",
248 .cfg_name = "rtl_bt/rtl8822cs_config",
249 .hw_info = "rtl8822cs" },
250
251 /* 8822C with USB interface */
252 { IC_INFO(RTL_ROM_LMP_8822B, 0xc, 0xa, HCI_USB),
253 .config_needed = false,
254 .has_rom_version = true,
255 .has_msft_ext = true,
256 .fw_name = "rtl_bt/rtl8822cu_fw",
257 .cfg_name = "rtl_bt/rtl8822cu_config",
258 .hw_info = "rtl8822cu" },
259
260 /* 8822B */
261 { IC_INFO(RTL_ROM_LMP_8822B, 0xb, 0x7, HCI_USB),
262 .config_needed = true,
263 .has_rom_version = true,
264 .has_msft_ext = true,
265 .fw_name = "rtl_bt/rtl8822b_fw",
266 .cfg_name = "rtl_bt/rtl8822b_config",
267 .hw_info = "rtl8822bu" },
268
269 /* 8852A */
270 { IC_INFO(RTL_ROM_LMP_8852A, 0xa, 0xb, HCI_USB),
271 .config_needed = false,
272 .has_rom_version = true,
273 .has_msft_ext = true,
274 .fw_name = "rtl_bt/rtl8852au_fw",
275 .cfg_name = "rtl_bt/rtl8852au_config",
276 .hw_info = "rtl8852au" },
277
278 /* 8852B with UART interface */
279 { IC_INFO(RTL_ROM_LMP_8852A, 0xb, 0xb, HCI_UART),
280 .config_needed = true,
281 .has_rom_version = true,
282 .has_msft_ext = true,
283 .fw_name = "rtl_bt/rtl8852bs_fw",
284 .cfg_name = "rtl_bt/rtl8852bs_config",
285 .hw_info = "rtl8852bs" },
286
287 /* 8852B */
288 { IC_INFO(RTL_ROM_LMP_8852A, 0xb, 0xb, HCI_USB),
289 .config_needed = false,
290 .has_rom_version = true,
291 .has_msft_ext = true,
292 .fw_name = "rtl_bt/rtl8852bu_fw",
293 .cfg_name = "rtl_bt/rtl8852bu_config",
294 .hw_info = "rtl8852bu" },
295
296 /* 8852C */
297 { IC_INFO(RTL_ROM_LMP_8852A, 0xc, 0xc, HCI_USB),
298 .config_needed = false,
299 .has_rom_version = true,
300 .has_msft_ext = true,
301 .fw_name = "rtl_bt/rtl8852cu_fw",
302 .cfg_name = "rtl_bt/rtl8852cu_config",
303 .hw_info = "rtl8852cu" },
304
305 /* 8851B */
306 { IC_INFO(RTL_ROM_LMP_8851B, 0xb, 0xc, HCI_USB),
307 .config_needed = false,
308 .has_rom_version = true,
309 .has_msft_ext = false,
310 .fw_name = "rtl_bt/rtl8851bu_fw",
311 .cfg_name = "rtl_bt/rtl8851bu_config",
312 .hw_info = "rtl8851bu" },
313
314 /* 8922A */
315 { IC_INFO(RTL_ROM_LMP_8922A, 0xa, 0xc, HCI_USB),
316 .config_needed = false,
317 .has_rom_version = true,
318 .has_msft_ext = true,
319 .fw_name = "rtl_bt/rtl8922au_fw",
320 .cfg_name = "rtl_bt/rtl8922au_config",
321 .hw_info = "rtl8922au" },
322
323 /* 8852BT/8852BE-VT */
324 { IC_INFO(RTL_ROM_LMP_8852A, 0x87, 0xc, HCI_USB),
325 .config_needed = false,
326 .has_rom_version = true,
327 .has_msft_ext = true,
328 .fw_name = "rtl_bt/rtl8852btu_fw",
329 .cfg_name = "rtl_bt/rtl8852btu_config",
330 .hw_info = "rtl8852btu" },
331 };
332
btrtl_match_ic(u16 lmp_subver,u16 hci_rev,u8 hci_ver,u8 hci_bus,u8 chip_type)333 static const struct id_table *btrtl_match_ic(u16 lmp_subver, u16 hci_rev,
334 u8 hci_ver, u8 hci_bus,
335 u8 chip_type)
336 {
337 int i;
338
339 for (i = 0; i < ARRAY_SIZE(ic_id_table); i++) {
340 if ((ic_id_table[i].match_flags & IC_MATCH_FL_LMPSUBV) &&
341 (ic_id_table[i].lmp_subver != lmp_subver))
342 continue;
343 if ((ic_id_table[i].match_flags & IC_MATCH_FL_HCIREV) &&
344 (ic_id_table[i].hci_rev != hci_rev))
345 continue;
346 if ((ic_id_table[i].match_flags & IC_MATCH_FL_HCIVER) &&
347 (ic_id_table[i].hci_ver != hci_ver))
348 continue;
349 if ((ic_id_table[i].match_flags & IC_MATCH_FL_HCIBUS) &&
350 (ic_id_table[i].hci_bus != hci_bus))
351 continue;
352 if ((ic_id_table[i].match_flags & IC_MATCH_FL_CHIP_TYPE) &&
353 (ic_id_table[i].chip_type != chip_type))
354 continue;
355
356 break;
357 }
358 if (i >= ARRAY_SIZE(ic_id_table))
359 return NULL;
360
361 return &ic_id_table[i];
362 }
363
btrtl_read_local_version(struct hci_dev * hdev)364 static struct sk_buff *btrtl_read_local_version(struct hci_dev *hdev)
365 {
366 struct sk_buff *skb;
367
368 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
369 HCI_INIT_TIMEOUT);
370 if (IS_ERR(skb)) {
371 rtl_dev_err(hdev, "HCI_OP_READ_LOCAL_VERSION failed (%ld)",
372 PTR_ERR(skb));
373 return skb;
374 }
375
376 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
377 rtl_dev_err(hdev, "HCI_OP_READ_LOCAL_VERSION event length mismatch");
378 kfree_skb(skb);
379 return ERR_PTR(-EIO);
380 }
381
382 return skb;
383 }
384
rtl_read_rom_version(struct hci_dev * hdev,u8 * version)385 static int rtl_read_rom_version(struct hci_dev *hdev, u8 *version)
386 {
387 struct rtl_rom_version_evt *rom_version;
388 struct sk_buff *skb;
389
390 /* Read RTL ROM version command */
391 skb = __hci_cmd_sync(hdev, 0xfc6d, 0, NULL, HCI_INIT_TIMEOUT);
392 if (IS_ERR(skb)) {
393 rtl_dev_err(hdev, "Read ROM version failed (%ld)",
394 PTR_ERR(skb));
395 return PTR_ERR(skb);
396 }
397
398 if (skb->len != sizeof(*rom_version)) {
399 rtl_dev_err(hdev, "version event length mismatch");
400 kfree_skb(skb);
401 return -EIO;
402 }
403
404 rom_version = (struct rtl_rom_version_evt *)skb->data;
405 rtl_dev_info(hdev, "rom_version status=%x version=%x",
406 rom_version->status, rom_version->version);
407
408 *version = rom_version->version;
409
410 kfree_skb(skb);
411 return 0;
412 }
413
btrtl_vendor_read_reg16(struct hci_dev * hdev,struct rtl_vendor_cmd * cmd,u8 * rp)414 static int btrtl_vendor_read_reg16(struct hci_dev *hdev,
415 struct rtl_vendor_cmd *cmd, u8 *rp)
416 {
417 struct sk_buff *skb;
418 int err = 0;
419
420 skb = __hci_cmd_sync(hdev, 0xfc61, sizeof(*cmd), cmd,
421 HCI_INIT_TIMEOUT);
422 if (IS_ERR(skb)) {
423 err = PTR_ERR(skb);
424 rtl_dev_err(hdev, "RTL: Read reg16 failed (%d)", err);
425 return err;
426 }
427
428 if (skb->len != 3 || skb->data[0]) {
429 bt_dev_err(hdev, "RTL: Read reg16 length mismatch");
430 kfree_skb(skb);
431 return -EIO;
432 }
433
434 if (rp)
435 memcpy(rp, skb->data + 1, 2);
436
437 kfree_skb(skb);
438
439 return 0;
440 }
441
rtl_iov_pull_data(struct rtl_iovec * iov,u32 len)442 static void *rtl_iov_pull_data(struct rtl_iovec *iov, u32 len)
443 {
444 void *data = iov->data;
445
446 if (iov->len < len)
447 return NULL;
448
449 iov->data += len;
450 iov->len -= len;
451
452 return data;
453 }
454
btrtl_insert_ordered_subsec(struct rtl_subsection * node,struct btrtl_device_info * btrtl_dev)455 static void btrtl_insert_ordered_subsec(struct rtl_subsection *node,
456 struct btrtl_device_info *btrtl_dev)
457 {
458 struct list_head *pos;
459 struct list_head *next;
460 struct rtl_subsection *subsec;
461
462 list_for_each_safe(pos, next, &btrtl_dev->patch_subsecs) {
463 subsec = list_entry(pos, struct rtl_subsection, list);
464 if (subsec->prio >= node->prio)
465 break;
466 }
467 __list_add(&node->list, pos->prev, pos);
468 }
469
btrtl_parse_section(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev,u32 opcode,u8 * data,u32 len)470 static int btrtl_parse_section(struct hci_dev *hdev,
471 struct btrtl_device_info *btrtl_dev, u32 opcode,
472 u8 *data, u32 len)
473 {
474 struct rtl_section_hdr *hdr;
475 struct rtl_subsection *subsec;
476 struct rtl_common_subsec *common_subsec;
477 struct rtl_sec_hdr *sec_hdr;
478 int i;
479 u8 *ptr;
480 u16 num_subsecs;
481 u32 subsec_len;
482 int rc = 0;
483 struct rtl_iovec iov = {
484 .data = data,
485 .len = len,
486 };
487
488 hdr = rtl_iov_pull_data(&iov, sizeof(*hdr));
489 if (!hdr)
490 return -EINVAL;
491 num_subsecs = le16_to_cpu(hdr->num);
492
493 for (i = 0; i < num_subsecs; i++) {
494 common_subsec = rtl_iov_pull_data(&iov, sizeof(*common_subsec));
495 if (!common_subsec)
496 break;
497 subsec_len = le32_to_cpu(common_subsec->len);
498
499 rtl_dev_dbg(hdev, "subsec, eco 0x%02x, len %08x",
500 common_subsec->eco, subsec_len);
501
502 ptr = rtl_iov_pull_data(&iov, subsec_len);
503 if (!ptr)
504 break;
505
506 if (common_subsec->eco != btrtl_dev->rom_version + 1)
507 continue;
508
509 switch (opcode) {
510 case RTL_PATCH_SECURITY_HEADER:
511 sec_hdr = (void *)common_subsec;
512 if (sec_hdr->key_id != btrtl_dev->key_id)
513 continue;
514 break;
515 }
516
517 subsec = kzalloc(sizeof(*subsec), GFP_KERNEL);
518 if (!subsec)
519 return -ENOMEM;
520 subsec->opcode = opcode;
521 subsec->prio = common_subsec->prio;
522 subsec->len = subsec_len;
523 subsec->data = ptr;
524 btrtl_insert_ordered_subsec(subsec, btrtl_dev);
525 rc += subsec_len;
526 }
527
528 return rc;
529 }
530
rtlbt_parse_firmware_v2(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev,unsigned char ** _buf)531 static int rtlbt_parse_firmware_v2(struct hci_dev *hdev,
532 struct btrtl_device_info *btrtl_dev,
533 unsigned char **_buf)
534 {
535 struct rtl_epatch_header_v2 *hdr;
536 int rc;
537 u8 key_id;
538 u32 num_sections;
539 struct rtl_section *section;
540 struct rtl_subsection *entry, *tmp;
541 u32 section_len;
542 u32 opcode;
543 int len = 0;
544 int i;
545 u8 *ptr;
546 struct rtl_iovec iov = {
547 .data = btrtl_dev->fw_data,
548 .len = btrtl_dev->fw_len - 7, /* Cut the tail */
549 };
550
551 key_id = btrtl_dev->key_id;
552
553 hdr = rtl_iov_pull_data(&iov, sizeof(*hdr));
554 if (!hdr)
555 return -EINVAL;
556 num_sections = le32_to_cpu(hdr->num_sections);
557
558 rtl_dev_dbg(hdev, "FW version %08x-%08x", *((u32 *)hdr->fw_version),
559 *((u32 *)(hdr->fw_version + 4)));
560
561 for (i = 0; i < num_sections; i++) {
562 section = rtl_iov_pull_data(&iov, sizeof(*section));
563 if (!section)
564 break;
565 section_len = le32_to_cpu(section->len);
566 opcode = le32_to_cpu(section->opcode);
567
568 rtl_dev_dbg(hdev, "opcode 0x%04x", section->opcode);
569
570 ptr = rtl_iov_pull_data(&iov, section_len);
571 if (!ptr)
572 break;
573
574 switch (opcode) {
575 case RTL_PATCH_SNIPPETS:
576 rc = btrtl_parse_section(hdev, btrtl_dev, opcode,
577 ptr, section_len);
578 break;
579 case RTL_PATCH_SECURITY_HEADER:
580 /* If key_id from chip is zero, ignore all security
581 * headers.
582 */
583 if (!key_id)
584 break;
585 rc = btrtl_parse_section(hdev, btrtl_dev, opcode,
586 ptr, section_len);
587 break;
588 case RTL_PATCH_DUMMY_HEADER:
589 rc = btrtl_parse_section(hdev, btrtl_dev, opcode,
590 ptr, section_len);
591 break;
592 default:
593 rc = 0;
594 break;
595 }
596 if (rc < 0) {
597 rtl_dev_err(hdev, "RTL: Parse section (%u) err %d",
598 opcode, rc);
599 return rc;
600 }
601 len += rc;
602 }
603
604 if (!len)
605 return -ENODATA;
606
607 /* Allocate mem and copy all found subsecs. */
608 ptr = kvmalloc(len, GFP_KERNEL);
609 if (!ptr)
610 return -ENOMEM;
611
612 len = 0;
613 list_for_each_entry_safe(entry, tmp, &btrtl_dev->patch_subsecs, list) {
614 rtl_dev_dbg(hdev, "RTL: opcode %08x, addr %p, len 0x%x",
615 entry->opcode, entry->data, entry->len);
616 memcpy(ptr + len, entry->data, entry->len);
617 len += entry->len;
618 }
619
620 if (!len) {
621 kvfree(ptr);
622 return -EPERM;
623 }
624
625 *_buf = ptr;
626 return len;
627 }
628
rtlbt_parse_firmware(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev,unsigned char ** _buf)629 static int rtlbt_parse_firmware(struct hci_dev *hdev,
630 struct btrtl_device_info *btrtl_dev,
631 unsigned char **_buf)
632 {
633 static const u8 extension_sig[] = { 0x51, 0x04, 0xfd, 0x77 };
634 struct btrealtek_data *coredump_info = hci_get_priv(hdev);
635 struct rtl_epatch_header *epatch_info;
636 unsigned char *buf;
637 int i, len;
638 size_t min_size;
639 u8 opcode, length, data;
640 int project_id = -1;
641 const unsigned char *fwptr, *chip_id_base;
642 const unsigned char *patch_length_base, *patch_offset_base;
643 u32 patch_offset = 0;
644 u16 patch_length, num_patches;
645 static const struct {
646 __u16 lmp_subver;
647 __u8 id;
648 } project_id_to_lmp_subver[] = {
649 { RTL_ROM_LMP_8723A, 0 },
650 { RTL_ROM_LMP_8723B, 1 },
651 { RTL_ROM_LMP_8821A, 2 },
652 { RTL_ROM_LMP_8761A, 3 },
653 { RTL_ROM_LMP_8703B, 7 },
654 { RTL_ROM_LMP_8822B, 8 },
655 { RTL_ROM_LMP_8723B, 9 }, /* 8723D */
656 { RTL_ROM_LMP_8821A, 10 }, /* 8821C */
657 { RTL_ROM_LMP_8822B, 13 }, /* 8822C */
658 { RTL_ROM_LMP_8761A, 14 }, /* 8761B */
659 { RTL_ROM_LMP_8852A, 18 }, /* 8852A */
660 { RTL_ROM_LMP_8852A, 20 }, /* 8852B */
661 { RTL_ROM_LMP_8852A, 25 }, /* 8852C */
662 { RTL_ROM_LMP_8851B, 36 }, /* 8851B */
663 { RTL_ROM_LMP_8922A, 44 }, /* 8922A */
664 { RTL_ROM_LMP_8852A, 47 }, /* 8852BT */
665 };
666
667 if (btrtl_dev->fw_len <= 8)
668 return -EINVAL;
669
670 if (!memcmp(btrtl_dev->fw_data, RTL_EPATCH_SIGNATURE, 8))
671 min_size = sizeof(struct rtl_epatch_header) +
672 sizeof(extension_sig) + 3;
673 else if (!memcmp(btrtl_dev->fw_data, RTL_EPATCH_SIGNATURE_V2, 8))
674 min_size = sizeof(struct rtl_epatch_header_v2) +
675 sizeof(extension_sig) + 3;
676 else
677 return -EINVAL;
678
679 if (btrtl_dev->fw_len < min_size)
680 return -EINVAL;
681
682 fwptr = btrtl_dev->fw_data + btrtl_dev->fw_len - sizeof(extension_sig);
683 if (memcmp(fwptr, extension_sig, sizeof(extension_sig)) != 0) {
684 rtl_dev_err(hdev, "extension section signature mismatch");
685 return -EINVAL;
686 }
687
688 /* Loop from the end of the firmware parsing instructions, until
689 * we find an instruction that identifies the "project ID" for the
690 * hardware supported by this firmware file.
691 * Once we have that, we double-check that project_id is suitable
692 * for the hardware we are working with.
693 */
694 while (fwptr >= btrtl_dev->fw_data + (sizeof(*epatch_info) + 3)) {
695 opcode = *--fwptr;
696 length = *--fwptr;
697 data = *--fwptr;
698
699 BT_DBG("check op=%x len=%x data=%x", opcode, length, data);
700
701 if (opcode == 0xff) /* EOF */
702 break;
703
704 if (length == 0) {
705 rtl_dev_err(hdev, "found instruction with length 0");
706 return -EINVAL;
707 }
708
709 if (opcode == 0 && length == 1) {
710 project_id = data;
711 break;
712 }
713
714 fwptr -= length;
715 }
716
717 if (project_id < 0) {
718 rtl_dev_err(hdev, "failed to find version instruction");
719 return -EINVAL;
720 }
721
722 /* Find project_id in table */
723 for (i = 0; i < ARRAY_SIZE(project_id_to_lmp_subver); i++) {
724 if (project_id == project_id_to_lmp_subver[i].id) {
725 btrtl_dev->project_id = project_id;
726 break;
727 }
728 }
729
730 if (i >= ARRAY_SIZE(project_id_to_lmp_subver)) {
731 rtl_dev_err(hdev, "unknown project id %d", project_id);
732 return -EINVAL;
733 }
734
735 if (btrtl_dev->ic_info->lmp_subver !=
736 project_id_to_lmp_subver[i].lmp_subver) {
737 rtl_dev_err(hdev, "firmware is for %x but this is a %x",
738 project_id_to_lmp_subver[i].lmp_subver,
739 btrtl_dev->ic_info->lmp_subver);
740 return -EINVAL;
741 }
742
743 if (memcmp(btrtl_dev->fw_data, RTL_EPATCH_SIGNATURE, 8) != 0) {
744 if (!memcmp(btrtl_dev->fw_data, RTL_EPATCH_SIGNATURE_V2, 8))
745 return rtlbt_parse_firmware_v2(hdev, btrtl_dev, _buf);
746 rtl_dev_err(hdev, "bad EPATCH signature");
747 return -EINVAL;
748 }
749
750 epatch_info = (struct rtl_epatch_header *)btrtl_dev->fw_data;
751 num_patches = le16_to_cpu(epatch_info->num_patches);
752
753 BT_DBG("fw_version=%x, num_patches=%d",
754 le32_to_cpu(epatch_info->fw_version), num_patches);
755 coredump_info->rtl_dump.fw_version = le32_to_cpu(epatch_info->fw_version);
756
757 /* After the rtl_epatch_header there is a funky patch metadata section.
758 * Assuming 2 patches, the layout is:
759 * ChipID1 ChipID2 PatchLength1 PatchLength2 PatchOffset1 PatchOffset2
760 *
761 * Find the right patch for this chip.
762 */
763 min_size += 8 * num_patches;
764 if (btrtl_dev->fw_len < min_size)
765 return -EINVAL;
766
767 chip_id_base = btrtl_dev->fw_data + sizeof(struct rtl_epatch_header);
768 patch_length_base = chip_id_base + (sizeof(u16) * num_patches);
769 patch_offset_base = patch_length_base + (sizeof(u16) * num_patches);
770 for (i = 0; i < num_patches; i++) {
771 u16 chip_id = get_unaligned_le16(chip_id_base +
772 (i * sizeof(u16)));
773 if (chip_id == btrtl_dev->rom_version + 1) {
774 patch_length = get_unaligned_le16(patch_length_base +
775 (i * sizeof(u16)));
776 patch_offset = get_unaligned_le32(patch_offset_base +
777 (i * sizeof(u32)));
778 break;
779 }
780 }
781
782 if (!patch_offset) {
783 rtl_dev_err(hdev, "didn't find patch for chip id %d",
784 btrtl_dev->rom_version);
785 return -EINVAL;
786 }
787
788 BT_DBG("length=%x offset=%x index %d", patch_length, patch_offset, i);
789 min_size = patch_offset + patch_length;
790 if (btrtl_dev->fw_len < min_size)
791 return -EINVAL;
792
793 /* Copy the firmware into a new buffer and write the version at
794 * the end.
795 */
796 len = patch_length;
797 buf = kvmalloc(patch_length, GFP_KERNEL);
798 if (!buf)
799 return -ENOMEM;
800
801 memcpy(buf, btrtl_dev->fw_data + patch_offset, patch_length - 4);
802 memcpy(buf + patch_length - 4, &epatch_info->fw_version, 4);
803
804 *_buf = buf;
805 return len;
806 }
807
rtl_download_firmware(struct hci_dev * hdev,const unsigned char * data,int fw_len)808 static int rtl_download_firmware(struct hci_dev *hdev,
809 const unsigned char *data, int fw_len)
810 {
811 struct rtl_download_cmd *dl_cmd;
812 int frag_num = fw_len / RTL_FRAG_LEN + 1;
813 int frag_len = RTL_FRAG_LEN;
814 int ret = 0;
815 int i;
816 int j = 0;
817 struct sk_buff *skb;
818 struct hci_rp_read_local_version *rp;
819
820 dl_cmd = kmalloc(sizeof(*dl_cmd), GFP_KERNEL);
821 if (!dl_cmd)
822 return -ENOMEM;
823
824 for (i = 0; i < frag_num; i++) {
825 struct sk_buff *skb;
826
827 dl_cmd->index = j++;
828 if (dl_cmd->index == 0x7f)
829 j = 1;
830
831 if (i == (frag_num - 1)) {
832 dl_cmd->index |= 0x80; /* data end */
833 frag_len = fw_len % RTL_FRAG_LEN;
834 }
835 rtl_dev_dbg(hdev, "download fw (%d/%d). index = %d", i,
836 frag_num, dl_cmd->index);
837 memcpy(dl_cmd->data, data, frag_len);
838
839 /* Send download command */
840 skb = __hci_cmd_sync(hdev, 0xfc20, frag_len + 1, dl_cmd,
841 HCI_INIT_TIMEOUT);
842 if (IS_ERR(skb)) {
843 rtl_dev_err(hdev, "download fw command failed (%ld)",
844 PTR_ERR(skb));
845 ret = PTR_ERR(skb);
846 goto out;
847 }
848
849 if (skb->len != sizeof(struct rtl_download_response)) {
850 rtl_dev_err(hdev, "download fw event length mismatch");
851 kfree_skb(skb);
852 ret = -EIO;
853 goto out;
854 }
855
856 kfree_skb(skb);
857 data += RTL_FRAG_LEN;
858 }
859
860 skb = btrtl_read_local_version(hdev);
861 if (IS_ERR(skb)) {
862 ret = PTR_ERR(skb);
863 rtl_dev_err(hdev, "read local version failed");
864 goto out;
865 }
866
867 rp = (struct hci_rp_read_local_version *)skb->data;
868 rtl_dev_info(hdev, "fw version 0x%04x%04x",
869 __le16_to_cpu(rp->hci_rev), __le16_to_cpu(rp->lmp_subver));
870 kfree_skb(skb);
871
872 out:
873 kfree(dl_cmd);
874 return ret;
875 }
876
rtl_load_file(struct hci_dev * hdev,const char * name,u8 ** buff)877 static int rtl_load_file(struct hci_dev *hdev, const char *name, u8 **buff)
878 {
879 const struct firmware *fw;
880 int ret;
881
882 rtl_dev_info(hdev, "loading %s", name);
883 ret = request_firmware(&fw, name, &hdev->dev);
884 if (ret < 0)
885 return ret;
886 ret = fw->size;
887 *buff = kvmemdup(fw->data, fw->size, GFP_KERNEL);
888 if (!*buff)
889 ret = -ENOMEM;
890
891 release_firmware(fw);
892
893 return ret;
894 }
895
btrtl_setup_rtl8723a(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev)896 static int btrtl_setup_rtl8723a(struct hci_dev *hdev,
897 struct btrtl_device_info *btrtl_dev)
898 {
899 if (btrtl_dev->fw_len < 8)
900 return -EINVAL;
901
902 /* Check that the firmware doesn't have the epatch signature
903 * (which is only for RTL8723B and newer).
904 */
905 if (!memcmp(btrtl_dev->fw_data, RTL_EPATCH_SIGNATURE, 8)) {
906 rtl_dev_err(hdev, "unexpected EPATCH signature!");
907 return -EINVAL;
908 }
909
910 return rtl_download_firmware(hdev, btrtl_dev->fw_data,
911 btrtl_dev->fw_len);
912 }
913
btrtl_setup_rtl8723b(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev)914 static int btrtl_setup_rtl8723b(struct hci_dev *hdev,
915 struct btrtl_device_info *btrtl_dev)
916 {
917 unsigned char *fw_data = NULL;
918 int ret;
919 u8 *tbuff;
920
921 ret = rtlbt_parse_firmware(hdev, btrtl_dev, &fw_data);
922 if (ret < 0)
923 goto out;
924
925 if (btrtl_dev->cfg_len > 0) {
926 tbuff = kvzalloc(ret + btrtl_dev->cfg_len, GFP_KERNEL);
927 if (!tbuff) {
928 ret = -ENOMEM;
929 goto out;
930 }
931
932 memcpy(tbuff, fw_data, ret);
933 kvfree(fw_data);
934
935 memcpy(tbuff + ret, btrtl_dev->cfg_data, btrtl_dev->cfg_len);
936 ret += btrtl_dev->cfg_len;
937
938 fw_data = tbuff;
939 }
940
941 rtl_dev_info(hdev, "cfg_sz %d, total sz %d", btrtl_dev->cfg_len, ret);
942
943 ret = rtl_download_firmware(hdev, fw_data, ret);
944
945 out:
946 kvfree(fw_data);
947 return ret;
948 }
949
btrtl_coredump(struct hci_dev * hdev)950 static void btrtl_coredump(struct hci_dev *hdev)
951 {
952 static const u8 param[] = { 0x00, 0x00 };
953
954 __hci_cmd_send(hdev, RTL_VSC_OP_COREDUMP, sizeof(param), param);
955 }
956
btrtl_dmp_hdr(struct hci_dev * hdev,struct sk_buff * skb)957 static void btrtl_dmp_hdr(struct hci_dev *hdev, struct sk_buff *skb)
958 {
959 struct btrealtek_data *coredump_info = hci_get_priv(hdev);
960 char buf[80];
961
962 if (coredump_info->rtl_dump.controller)
963 snprintf(buf, sizeof(buf), "Controller Name: %s\n",
964 coredump_info->rtl_dump.controller);
965 else
966 snprintf(buf, sizeof(buf), "Controller Name: Unknown\n");
967 skb_put_data(skb, buf, strlen(buf));
968
969 snprintf(buf, sizeof(buf), "Firmware Version: 0x%X\n",
970 coredump_info->rtl_dump.fw_version);
971 skb_put_data(skb, buf, strlen(buf));
972
973 snprintf(buf, sizeof(buf), "Driver: %s\n", coredump_info->rtl_dump.driver_name);
974 skb_put_data(skb, buf, strlen(buf));
975
976 snprintf(buf, sizeof(buf), "Vendor: Realtek\n");
977 skb_put_data(skb, buf, strlen(buf));
978 }
979
btrtl_register_devcoredump_support(struct hci_dev * hdev)980 static void btrtl_register_devcoredump_support(struct hci_dev *hdev)
981 {
982 hci_devcd_register(hdev, btrtl_coredump, btrtl_dmp_hdr, NULL);
983
984 }
985
btrtl_set_driver_name(struct hci_dev * hdev,const char * driver_name)986 void btrtl_set_driver_name(struct hci_dev *hdev, const char *driver_name)
987 {
988 struct btrealtek_data *coredump_info = hci_get_priv(hdev);
989
990 coredump_info->rtl_dump.driver_name = driver_name;
991 }
992 EXPORT_SYMBOL_GPL(btrtl_set_driver_name);
993
rtl_has_chip_type(u16 lmp_subver)994 static bool rtl_has_chip_type(u16 lmp_subver)
995 {
996 switch (lmp_subver) {
997 case RTL_ROM_LMP_8703B:
998 return true;
999 default:
1000 break;
1001 }
1002
1003 return false;
1004 }
1005
rtl_read_chip_type(struct hci_dev * hdev,u8 * type)1006 static int rtl_read_chip_type(struct hci_dev *hdev, u8 *type)
1007 {
1008 struct rtl_chip_type_evt *chip_type;
1009 struct sk_buff *skb;
1010 const unsigned char cmd_buf[] = {0x00, 0x94, 0xa0, 0x00, 0xb0};
1011
1012 /* Read RTL chip type command */
1013 skb = __hci_cmd_sync(hdev, 0xfc61, 5, cmd_buf, HCI_INIT_TIMEOUT);
1014 if (IS_ERR(skb)) {
1015 rtl_dev_err(hdev, "Read chip type failed (%ld)",
1016 PTR_ERR(skb));
1017 return PTR_ERR(skb);
1018 }
1019
1020 chip_type = skb_pull_data(skb, sizeof(*chip_type));
1021 if (!chip_type) {
1022 rtl_dev_err(hdev, "RTL chip type event length mismatch");
1023 kfree_skb(skb);
1024 return -EIO;
1025 }
1026
1027 rtl_dev_info(hdev, "chip_type status=%x type=%x",
1028 chip_type->status, chip_type->type);
1029
1030 *type = chip_type->type & 0x0f;
1031
1032 kfree_skb(skb);
1033 return 0;
1034 }
1035
btrtl_free(struct btrtl_device_info * btrtl_dev)1036 void btrtl_free(struct btrtl_device_info *btrtl_dev)
1037 {
1038 struct rtl_subsection *entry, *tmp;
1039
1040 kvfree(btrtl_dev->fw_data);
1041 kvfree(btrtl_dev->cfg_data);
1042
1043 list_for_each_entry_safe(entry, tmp, &btrtl_dev->patch_subsecs, list) {
1044 list_del(&entry->list);
1045 kfree(entry);
1046 }
1047
1048 kfree(btrtl_dev);
1049 }
1050 EXPORT_SYMBOL_GPL(btrtl_free);
1051
btrtl_initialize(struct hci_dev * hdev,const char * postfix)1052 struct btrtl_device_info *btrtl_initialize(struct hci_dev *hdev,
1053 const char *postfix)
1054 {
1055 struct btrealtek_data *coredump_info = hci_get_priv(hdev);
1056 struct btrtl_device_info *btrtl_dev;
1057 struct sk_buff *skb;
1058 struct hci_rp_read_local_version *resp;
1059 struct hci_command_hdr *cmd;
1060 char fw_name[40];
1061 char cfg_name[40];
1062 u16 hci_rev, lmp_subver;
1063 u8 hci_ver, lmp_ver, chip_type = 0;
1064 int ret;
1065 int rc;
1066 u8 key_id;
1067 u8 reg_val[2];
1068
1069 btrtl_dev = kzalloc(sizeof(*btrtl_dev), GFP_KERNEL);
1070 if (!btrtl_dev) {
1071 ret = -ENOMEM;
1072 goto err_alloc;
1073 }
1074
1075 INIT_LIST_HEAD(&btrtl_dev->patch_subsecs);
1076
1077 check_version:
1078 ret = btrtl_vendor_read_reg16(hdev, RTL_CHIP_SUBVER, reg_val);
1079 if (ret < 0)
1080 goto err_free;
1081 lmp_subver = get_unaligned_le16(reg_val);
1082
1083 if (lmp_subver == RTL_ROM_LMP_8822B) {
1084 ret = btrtl_vendor_read_reg16(hdev, RTL_CHIP_REV, reg_val);
1085 if (ret < 0)
1086 goto err_free;
1087 hci_rev = get_unaligned_le16(reg_val);
1088
1089 /* 8822E */
1090 if (hci_rev == 0x000e) {
1091 hci_ver = 0x0c;
1092 lmp_ver = 0x0c;
1093 btrtl_dev->ic_info = btrtl_match_ic(lmp_subver, hci_rev,
1094 hci_ver, hdev->bus,
1095 chip_type);
1096 goto next;
1097 }
1098 }
1099
1100 skb = btrtl_read_local_version(hdev);
1101 if (IS_ERR(skb)) {
1102 ret = PTR_ERR(skb);
1103 goto err_free;
1104 }
1105
1106 resp = (struct hci_rp_read_local_version *)skb->data;
1107
1108 hci_ver = resp->hci_ver;
1109 hci_rev = le16_to_cpu(resp->hci_rev);
1110 lmp_ver = resp->lmp_ver;
1111 lmp_subver = le16_to_cpu(resp->lmp_subver);
1112
1113 kfree_skb(skb);
1114
1115 if (rtl_has_chip_type(lmp_subver)) {
1116 ret = rtl_read_chip_type(hdev, &chip_type);
1117 if (ret)
1118 goto err_free;
1119 }
1120
1121 btrtl_dev->ic_info = btrtl_match_ic(lmp_subver, hci_rev, hci_ver,
1122 hdev->bus, chip_type);
1123
1124 next:
1125 rtl_dev_info(hdev, "examining hci_ver=%02x hci_rev=%04x lmp_ver=%02x lmp_subver=%04x",
1126 hci_ver, hci_rev,
1127 lmp_ver, lmp_subver);
1128
1129 if (!btrtl_dev->ic_info && !btrtl_dev->drop_fw)
1130 btrtl_dev->drop_fw = true;
1131 else
1132 btrtl_dev->drop_fw = false;
1133
1134 if (btrtl_dev->drop_fw) {
1135 skb = bt_skb_alloc(sizeof(*cmd), GFP_KERNEL);
1136 if (!skb)
1137 goto err_free;
1138
1139 cmd = skb_put(skb, HCI_COMMAND_HDR_SIZE);
1140 cmd->opcode = cpu_to_le16(0xfc66);
1141 cmd->plen = 0;
1142
1143 hci_skb_pkt_type(skb) = HCI_COMMAND_PKT;
1144
1145 ret = hdev->send(hdev, skb);
1146 if (ret < 0) {
1147 bt_dev_err(hdev, "sending frame failed (%d)", ret);
1148 kfree_skb(skb);
1149 goto err_free;
1150 }
1151
1152 /* Ensure the above vendor command is sent to controller and
1153 * process has done.
1154 */
1155 msleep(200);
1156
1157 goto check_version;
1158 }
1159
1160 if (!btrtl_dev->ic_info) {
1161 rtl_dev_info(hdev, "unknown IC info, lmp subver %04x, hci rev %04x, hci ver %04x",
1162 lmp_subver, hci_rev, hci_ver);
1163 return btrtl_dev;
1164 }
1165
1166 if (btrtl_dev->ic_info->has_rom_version) {
1167 ret = rtl_read_rom_version(hdev, &btrtl_dev->rom_version);
1168 if (ret)
1169 goto err_free;
1170 }
1171
1172 if (!btrtl_dev->ic_info->fw_name) {
1173 ret = -ENOMEM;
1174 goto err_free;
1175 }
1176
1177 rc = btrtl_vendor_read_reg16(hdev, RTL_SEC_PROJ, reg_val);
1178 if (rc < 0)
1179 goto err_free;
1180
1181 key_id = reg_val[0];
1182 btrtl_dev->key_id = key_id;
1183 rtl_dev_info(hdev, "%s: key id %u", __func__, key_id);
1184
1185 btrtl_dev->fw_len = -EIO;
1186 if (lmp_subver == RTL_ROM_LMP_8852A && hci_rev == 0x000c) {
1187 snprintf(fw_name, sizeof(fw_name), "%s_v2.bin",
1188 btrtl_dev->ic_info->fw_name);
1189 btrtl_dev->fw_len = rtl_load_file(hdev, fw_name,
1190 &btrtl_dev->fw_data);
1191 }
1192
1193 if (btrtl_dev->fw_len < 0) {
1194 snprintf(fw_name, sizeof(fw_name), "%s.bin",
1195 btrtl_dev->ic_info->fw_name);
1196 btrtl_dev->fw_len = rtl_load_file(hdev, fw_name,
1197 &btrtl_dev->fw_data);
1198 }
1199
1200 if (btrtl_dev->fw_len < 0) {
1201 rtl_dev_err(hdev, "firmware file %s not found",
1202 btrtl_dev->ic_info->fw_name);
1203 ret = btrtl_dev->fw_len;
1204 goto err_free;
1205 }
1206
1207 if (btrtl_dev->ic_info->cfg_name && !btrtl_dev->key_id) {
1208 if (postfix) {
1209 snprintf(cfg_name, sizeof(cfg_name), "%s-%s.bin",
1210 btrtl_dev->ic_info->cfg_name, postfix);
1211 } else {
1212 snprintf(cfg_name, sizeof(cfg_name), "%s.bin",
1213 btrtl_dev->ic_info->cfg_name);
1214 }
1215 btrtl_dev->cfg_len = rtl_load_file(hdev, cfg_name,
1216 &btrtl_dev->cfg_data);
1217 if (btrtl_dev->ic_info->config_needed &&
1218 btrtl_dev->cfg_len <= 0) {
1219 rtl_dev_err(hdev, "mandatory config file %s not found",
1220 btrtl_dev->ic_info->cfg_name);
1221 ret = btrtl_dev->cfg_len;
1222 if (!ret)
1223 ret = -EINVAL;
1224 goto err_free;
1225 }
1226 }
1227
1228 /* The following chips supports the Microsoft vendor extension,
1229 * therefore set the corresponding VsMsftOpCode.
1230 */
1231 if (btrtl_dev->ic_info->has_msft_ext)
1232 hci_set_msft_opcode(hdev, 0xFCF0);
1233
1234 if (btrtl_dev->ic_info)
1235 coredump_info->rtl_dump.controller = btrtl_dev->ic_info->hw_info;
1236
1237 return btrtl_dev;
1238
1239 err_free:
1240 btrtl_free(btrtl_dev);
1241 err_alloc:
1242 return ERR_PTR(ret);
1243 }
1244 EXPORT_SYMBOL_GPL(btrtl_initialize);
1245
btrtl_download_firmware(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev)1246 int btrtl_download_firmware(struct hci_dev *hdev,
1247 struct btrtl_device_info *btrtl_dev)
1248 {
1249 int err = 0;
1250
1251 /* Match a set of subver values that correspond to stock firmware,
1252 * which is not compatible with standard btusb.
1253 * If matched, upload an alternative firmware that does conform to
1254 * standard btusb. Once that firmware is uploaded, the subver changes
1255 * to a different value.
1256 */
1257 if (!btrtl_dev->ic_info) {
1258 rtl_dev_info(hdev, "assuming no firmware upload needed");
1259 err = 0;
1260 goto done;
1261 }
1262
1263 switch (btrtl_dev->ic_info->lmp_subver) {
1264 case RTL_ROM_LMP_8723A:
1265 err = btrtl_setup_rtl8723a(hdev, btrtl_dev);
1266 break;
1267 case RTL_ROM_LMP_8723B:
1268 case RTL_ROM_LMP_8821A:
1269 case RTL_ROM_LMP_8761A:
1270 case RTL_ROM_LMP_8822B:
1271 case RTL_ROM_LMP_8852A:
1272 case RTL_ROM_LMP_8703B:
1273 case RTL_ROM_LMP_8851B:
1274 case RTL_ROM_LMP_8922A:
1275 err = btrtl_setup_rtl8723b(hdev, btrtl_dev);
1276 break;
1277 default:
1278 rtl_dev_info(hdev, "assuming no firmware upload needed");
1279 break;
1280 }
1281
1282 done:
1283 btrtl_register_devcoredump_support(hdev);
1284
1285 return err;
1286 }
1287 EXPORT_SYMBOL_GPL(btrtl_download_firmware);
1288
btrtl_set_quirks(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev)1289 void btrtl_set_quirks(struct hci_dev *hdev, struct btrtl_device_info *btrtl_dev)
1290 {
1291 /* Enable controller to do both LE scan and BR/EDR inquiry
1292 * simultaneously.
1293 */
1294 hci_set_quirk(hdev, HCI_QUIRK_SIMULTANEOUS_DISCOVERY);
1295
1296 /* Enable central-peripheral role (able to create new connections with
1297 * an existing connection in slave role).
1298 */
1299 /* Enable WBS supported for the specific Realtek devices. */
1300 switch (btrtl_dev->project_id) {
1301 case CHIP_ID_8822C:
1302 case CHIP_ID_8852A:
1303 case CHIP_ID_8852B:
1304 case CHIP_ID_8852C:
1305 case CHIP_ID_8851B:
1306 case CHIP_ID_8922A:
1307 case CHIP_ID_8852BT:
1308 hci_set_quirk(hdev, HCI_QUIRK_WIDEBAND_SPEECH_SUPPORTED);
1309
1310 /* RTL8852C needs to transmit mSBC data continuously without
1311 * the zero length of USB packets for the ALT 6 supported chips
1312 */
1313 if (btrtl_dev->project_id == CHIP_ID_8852C)
1314 btrealtek_set_flag(hdev, REALTEK_ALT6_CONTINUOUS_TX_CHIP);
1315
1316 if (btrtl_dev->project_id == CHIP_ID_8852A ||
1317 btrtl_dev->project_id == CHIP_ID_8852B ||
1318 btrtl_dev->project_id == CHIP_ID_8852C)
1319 hci_set_quirk(hdev,
1320 HCI_QUIRK_USE_MSFT_EXT_ADDRESS_FILTER);
1321
1322 hci_set_aosp_capable(hdev);
1323 break;
1324 default:
1325 rtl_dev_dbg(hdev, "Central-peripheral role not enabled.");
1326 rtl_dev_dbg(hdev, "WBS supported not enabled.");
1327 break;
1328 }
1329
1330 if (!btrtl_dev->ic_info)
1331 return;
1332
1333 switch (btrtl_dev->ic_info->lmp_subver) {
1334 case RTL_ROM_LMP_8703B:
1335 /* 8723CS reports two pages for local ext features,
1336 * but it doesn't support any features from page 2 -
1337 * it either responds with garbage or with error status
1338 */
1339 hci_set_quirk(hdev, HCI_QUIRK_BROKEN_LOCAL_EXT_FEATURES_PAGE_2);
1340 break;
1341 default:
1342 break;
1343 }
1344 }
1345 EXPORT_SYMBOL_GPL(btrtl_set_quirks);
1346
btrtl_setup_realtek(struct hci_dev * hdev)1347 int btrtl_setup_realtek(struct hci_dev *hdev)
1348 {
1349 struct btrtl_device_info *btrtl_dev;
1350 int ret;
1351
1352 btrtl_dev = btrtl_initialize(hdev, NULL);
1353 if (IS_ERR(btrtl_dev))
1354 return PTR_ERR(btrtl_dev);
1355
1356 ret = btrtl_download_firmware(hdev, btrtl_dev);
1357
1358 btrtl_set_quirks(hdev, btrtl_dev);
1359
1360 if (btrtl_dev->ic_info) {
1361 hci_set_hw_info(hdev,
1362 "RTL lmp_subver=%u hci_rev=%u hci_ver=%u hci_bus=%u",
1363 btrtl_dev->ic_info->lmp_subver,
1364 btrtl_dev->ic_info->hci_rev,
1365 btrtl_dev->ic_info->hci_ver,
1366 btrtl_dev->ic_info->hci_bus);
1367 }
1368
1369 btrtl_free(btrtl_dev);
1370 return ret;
1371 }
1372 EXPORT_SYMBOL_GPL(btrtl_setup_realtek);
1373
btrtl_shutdown_realtek(struct hci_dev * hdev)1374 int btrtl_shutdown_realtek(struct hci_dev *hdev)
1375 {
1376 struct sk_buff *skb;
1377 int ret;
1378
1379 /* According to the vendor driver, BT must be reset on close to avoid
1380 * firmware crash.
1381 */
1382 skb = __hci_cmd_sync(hdev, HCI_OP_RESET, 0, NULL, HCI_CMD_TIMEOUT);
1383 if (IS_ERR(skb)) {
1384 ret = PTR_ERR(skb);
1385 bt_dev_err(hdev, "HCI reset during shutdown failed");
1386 return ret;
1387 }
1388 kfree_skb(skb);
1389
1390 return 0;
1391 }
1392 EXPORT_SYMBOL_GPL(btrtl_shutdown_realtek);
1393
btrtl_convert_baudrate(u32 device_baudrate)1394 static unsigned int btrtl_convert_baudrate(u32 device_baudrate)
1395 {
1396 switch (device_baudrate) {
1397 case 0x0252a00a:
1398 return 230400;
1399
1400 case 0x05f75004:
1401 return 921600;
1402
1403 case 0x00005004:
1404 return 1000000;
1405
1406 case 0x04928002:
1407 case 0x01128002:
1408 return 1500000;
1409
1410 case 0x00005002:
1411 return 2000000;
1412
1413 case 0x0000b001:
1414 return 2500000;
1415
1416 case 0x04928001:
1417 return 3000000;
1418
1419 case 0x052a6001:
1420 return 3500000;
1421
1422 case 0x00005001:
1423 return 4000000;
1424
1425 case 0x0252c014:
1426 default:
1427 return 115200;
1428 }
1429 }
1430
btrtl_get_uart_settings(struct hci_dev * hdev,struct btrtl_device_info * btrtl_dev,unsigned int * controller_baudrate,u32 * device_baudrate,bool * flow_control)1431 int btrtl_get_uart_settings(struct hci_dev *hdev,
1432 struct btrtl_device_info *btrtl_dev,
1433 unsigned int *controller_baudrate,
1434 u32 *device_baudrate, bool *flow_control)
1435 {
1436 struct rtl_vendor_config *config;
1437 struct rtl_vendor_config_entry *entry;
1438 int i, total_data_len;
1439 bool found = false;
1440
1441 total_data_len = btrtl_dev->cfg_len - sizeof(*config);
1442 if (total_data_len <= 0) {
1443 rtl_dev_warn(hdev, "no config loaded");
1444 return -EINVAL;
1445 }
1446
1447 config = (struct rtl_vendor_config *)btrtl_dev->cfg_data;
1448 if (le32_to_cpu(config->signature) != RTL_CONFIG_MAGIC) {
1449 rtl_dev_err(hdev, "invalid config magic");
1450 return -EINVAL;
1451 }
1452
1453 if (total_data_len < le16_to_cpu(config->total_len)) {
1454 rtl_dev_err(hdev, "config is too short");
1455 return -EINVAL;
1456 }
1457
1458 for (i = 0; i < total_data_len; ) {
1459 entry = ((void *)config->entry) + i;
1460
1461 switch (le16_to_cpu(entry->offset)) {
1462 case 0xc:
1463 if (entry->len < sizeof(*device_baudrate)) {
1464 rtl_dev_err(hdev, "invalid UART config entry");
1465 return -EINVAL;
1466 }
1467
1468 *device_baudrate = get_unaligned_le32(entry->data);
1469 *controller_baudrate = btrtl_convert_baudrate(
1470 *device_baudrate);
1471
1472 if (entry->len >= 13)
1473 *flow_control = !!(entry->data[12] & BIT(2));
1474 else
1475 *flow_control = false;
1476
1477 found = true;
1478 break;
1479
1480 default:
1481 rtl_dev_dbg(hdev, "skipping config entry 0x%x (len %u)",
1482 le16_to_cpu(entry->offset), entry->len);
1483 break;
1484 }
1485
1486 i += sizeof(*entry) + entry->len;
1487 }
1488
1489 if (!found) {
1490 rtl_dev_err(hdev, "no UART config entry found");
1491 return -ENOENT;
1492 }
1493
1494 rtl_dev_dbg(hdev, "device baudrate = 0x%08x", *device_baudrate);
1495 rtl_dev_dbg(hdev, "controller baudrate = %u", *controller_baudrate);
1496 rtl_dev_dbg(hdev, "flow control %d", *flow_control);
1497
1498 return 0;
1499 }
1500 EXPORT_SYMBOL_GPL(btrtl_get_uart_settings);
1501
1502 MODULE_AUTHOR("Daniel Drake <drake@endlessm.com>");
1503 MODULE_DESCRIPTION("Bluetooth support for Realtek devices ver " VERSION);
1504 MODULE_VERSION(VERSION);
1505 MODULE_LICENSE("GPL");
1506 MODULE_FIRMWARE("rtl_bt/rtl8723a_fw.bin");
1507 MODULE_FIRMWARE("rtl_bt/rtl8723b_fw.bin");
1508 MODULE_FIRMWARE("rtl_bt/rtl8723b_config.bin");
1509 MODULE_FIRMWARE("rtl_bt/rtl8723bs_fw.bin");
1510 MODULE_FIRMWARE("rtl_bt/rtl8723bs_config.bin");
1511 MODULE_FIRMWARE("rtl_bt/rtl8723cs_cg_fw.bin");
1512 MODULE_FIRMWARE("rtl_bt/rtl8723cs_cg_config.bin");
1513 MODULE_FIRMWARE("rtl_bt/rtl8723cs_vf_fw.bin");
1514 MODULE_FIRMWARE("rtl_bt/rtl8723cs_vf_config.bin");
1515 MODULE_FIRMWARE("rtl_bt/rtl8723cs_xx_fw.bin");
1516 MODULE_FIRMWARE("rtl_bt/rtl8723cs_xx_config.bin");
1517 MODULE_FIRMWARE("rtl_bt/rtl8723d_fw.bin");
1518 MODULE_FIRMWARE("rtl_bt/rtl8723d_config.bin");
1519 MODULE_FIRMWARE("rtl_bt/rtl8723ds_fw.bin");
1520 MODULE_FIRMWARE("rtl_bt/rtl8723ds_config.bin");
1521 MODULE_FIRMWARE("rtl_bt/rtl8761a_fw.bin");
1522 MODULE_FIRMWARE("rtl_bt/rtl8761a_config.bin");
1523 MODULE_FIRMWARE("rtl_bt/rtl8761b_fw.bin");
1524 MODULE_FIRMWARE("rtl_bt/rtl8761b_config.bin");
1525 MODULE_FIRMWARE("rtl_bt/rtl8761bu_fw.bin");
1526 MODULE_FIRMWARE("rtl_bt/rtl8761bu_config.bin");
1527 MODULE_FIRMWARE("rtl_bt/rtl8821a_fw.bin");
1528 MODULE_FIRMWARE("rtl_bt/rtl8821a_config.bin");
1529 MODULE_FIRMWARE("rtl_bt/rtl8821c_fw.bin");
1530 MODULE_FIRMWARE("rtl_bt/rtl8821c_config.bin");
1531 MODULE_FIRMWARE("rtl_bt/rtl8821cs_fw.bin");
1532 MODULE_FIRMWARE("rtl_bt/rtl8821cs_config.bin");
1533 MODULE_FIRMWARE("rtl_bt/rtl8822b_fw.bin");
1534 MODULE_FIRMWARE("rtl_bt/rtl8822b_config.bin");
1535 MODULE_FIRMWARE("rtl_bt/rtl8822cs_fw.bin");
1536 MODULE_FIRMWARE("rtl_bt/rtl8822cs_config.bin");
1537 MODULE_FIRMWARE("rtl_bt/rtl8822cu_fw.bin");
1538 MODULE_FIRMWARE("rtl_bt/rtl8822cu_config.bin");
1539 MODULE_FIRMWARE("rtl_bt/rtl8851bu_fw.bin");
1540 MODULE_FIRMWARE("rtl_bt/rtl8851bu_config.bin");
1541 MODULE_FIRMWARE("rtl_bt/rtl8852au_fw.bin");
1542 MODULE_FIRMWARE("rtl_bt/rtl8852au_config.bin");
1543 MODULE_FIRMWARE("rtl_bt/rtl8852bs_fw.bin");
1544 MODULE_FIRMWARE("rtl_bt/rtl8852bs_config.bin");
1545 MODULE_FIRMWARE("rtl_bt/rtl8852bu_fw.bin");
1546 MODULE_FIRMWARE("rtl_bt/rtl8852bu_config.bin");
1547 MODULE_FIRMWARE("rtl_bt/rtl8852btu_fw.bin");
1548 MODULE_FIRMWARE("rtl_bt/rtl8852btu_config.bin");
1549 MODULE_FIRMWARE("rtl_bt/rtl8852cu_fw.bin");
1550 MODULE_FIRMWARE("rtl_bt/rtl8852cu_fw_v2.bin");
1551 MODULE_FIRMWARE("rtl_bt/rtl8852cu_config.bin");
1552 MODULE_FIRMWARE("rtl_bt/rtl8922au_fw.bin");
1553 MODULE_FIRMWARE("rtl_bt/rtl8922au_config.bin");
1554