blob: fa9fd60e93aabe5e3fd5f35dbcbe371f3161f832 [file] [log] [blame]
Carlo Caionedb33c772015-05-14 10:49:09 +02001/*
2 * Bluetooth support for Realtek devices
3 *
4 * Copyright (C) 2015 Endless Mobile, Inc.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 */
17
18#include <linux/module.h>
19#include <linux/firmware.h>
20#include <asm/unaligned.h>
21#include <linux/usb.h>
22
23#include <net/bluetooth/bluetooth.h>
24#include <net/bluetooth/hci_core.h>
25
26#include "btrtl.h"
27
28#define VERSION "0.1"
29
30#define RTL_EPATCH_SIGNATURE "Realtech"
31#define RTL_ROM_LMP_3499 0x3499
32#define RTL_ROM_LMP_8723A 0x1200
33#define RTL_ROM_LMP_8723B 0x8723
34#define RTL_ROM_LMP_8821A 0x8821
35#define RTL_ROM_LMP_8761A 0x8761
Larry Finger1110a2d2016-09-09 10:02:05 -050036#define RTL_ROM_LMP_8822B 0x8822
Martin Blumenstinglb85b0ee2018-08-02 16:57:15 +020037#define RTL_CONFIG_MAGIC 0x8723ab55
Carlo Caionedb33c772015-05-14 10:49:09 +020038
Alex Lu907f8492018-02-11 12:24:33 -060039#define IC_MATCH_FL_LMPSUBV (1 << 0)
40#define IC_MATCH_FL_HCIREV (1 << 1)
Martin Blumenstinglc50903e2018-08-02 16:57:16 +020041#define IC_MATCH_FL_HCIVER (1 << 2)
42#define IC_MATCH_FL_HCIBUS (1 << 3)
Alex Lu907f8492018-02-11 12:24:33 -060043#define IC_INFO(lmps, hcir) \
44 .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_HCIREV, \
45 .lmp_subver = (lmps), \
46 .hci_rev = (hcir)
47
48struct id_table {
49 __u16 match_flags;
50 __u16 lmp_subver;
51 __u16 hci_rev;
Martin Blumenstinglc50903e2018-08-02 16:57:16 +020052 __u8 hci_ver;
53 __u8 hci_bus;
Alex Lu907f8492018-02-11 12:24:33 -060054 bool config_needed;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +020055 bool has_rom_version;
Alex Lu907f8492018-02-11 12:24:33 -060056 char *fw_name;
57 char *cfg_name;
58};
59
Martin Blumenstingl26503ad22018-08-02 16:57:13 +020060struct btrtl_device_info {
61 const struct id_table *ic_info;
62 u8 rom_version;
63 u8 *fw_data;
64 int fw_len;
65 u8 *cfg_data;
66 int cfg_len;
67};
68
Alex Lu907f8492018-02-11 12:24:33 -060069static const struct id_table ic_id_table[] = {
Martin Blumenstingl26503ad22018-08-02 16:57:13 +020070 { IC_MATCH_FL_LMPSUBV, RTL_ROM_LMP_8723A, 0x0,
71 .config_needed = false,
72 .has_rom_version = false,
73 .fw_name = "rtl_bt/rtl8723a_fw.bin",
74 .cfg_name = NULL },
75
76 { IC_MATCH_FL_LMPSUBV, RTL_ROM_LMP_3499, 0x0,
77 .config_needed = false,
78 .has_rom_version = false,
79 .fw_name = "rtl_bt/rtl8723a_fw.bin",
80 .cfg_name = NULL },
81
Martin Blumenstinglc50903e2018-08-02 16:57:16 +020082 /* 8723BS */
83 { .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_HCIREV |
84 IC_MATCH_FL_HCIVER | IC_MATCH_FL_HCIBUS,
85 .lmp_subver = RTL_ROM_LMP_8723B,
86 .hci_rev = 0xb,
87 .hci_ver = 6,
88 .hci_bus = HCI_UART,
89 .config_needed = true,
90 .has_rom_version = true,
91 .fw_name = "rtl_bt/rtl8723bs_fw.bin",
92 .cfg_name = "rtl_bt/rtl8723bs_config.bin" },
93
Alex Lu907f8492018-02-11 12:24:33 -060094 /* 8723B */
95 { IC_INFO(RTL_ROM_LMP_8723B, 0xb),
96 .config_needed = false,
Martin Blumenstingl26503ad22018-08-02 16:57:13 +020097 .has_rom_version = true,
Alex Lu907f8492018-02-11 12:24:33 -060098 .fw_name = "rtl_bt/rtl8723b_fw.bin",
99 .cfg_name = "rtl_bt/rtl8723b_config.bin" },
100
101 /* 8723D */
102 { IC_INFO(RTL_ROM_LMP_8723B, 0xd),
103 .config_needed = true,
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200104 .has_rom_version = true,
Alex Lu907f8492018-02-11 12:24:33 -0600105 .fw_name = "rtl_bt/rtl8723d_fw.bin",
106 .cfg_name = "rtl_bt/rtl8723d_config.bin" },
107
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200108 /* 8723DS */
109 { .match_flags = IC_MATCH_FL_LMPSUBV | IC_MATCH_FL_HCIREV |
110 IC_MATCH_FL_HCIVER | IC_MATCH_FL_HCIBUS,
111 .lmp_subver = RTL_ROM_LMP_8723B,
112 .hci_rev = 0xd,
113 .hci_ver = 8,
114 .hci_bus = HCI_UART,
115 .config_needed = true,
116 .has_rom_version = true,
117 .fw_name = "rtl_bt/rtl8723ds_fw.bin",
118 .cfg_name = "rtl_bt/rtl8723ds_config.bin" },
119
Alex Lu907f8492018-02-11 12:24:33 -0600120 /* 8821A */
121 { IC_INFO(RTL_ROM_LMP_8821A, 0xa),
122 .config_needed = false,
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200123 .has_rom_version = true,
Alex Lu907f8492018-02-11 12:24:33 -0600124 .fw_name = "rtl_bt/rtl8821a_fw.bin",
125 .cfg_name = "rtl_bt/rtl8821a_config.bin" },
126
127 /* 8821C */
128 { IC_INFO(RTL_ROM_LMP_8821A, 0xc),
129 .config_needed = false,
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200130 .has_rom_version = true,
Alex Lu907f8492018-02-11 12:24:33 -0600131 .fw_name = "rtl_bt/rtl8821c_fw.bin",
132 .cfg_name = "rtl_bt/rtl8821c_config.bin" },
133
134 /* 8761A */
135 { IC_MATCH_FL_LMPSUBV, RTL_ROM_LMP_8761A, 0x0,
136 .config_needed = false,
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200137 .has_rom_version = true,
Alex Lu907f8492018-02-11 12:24:33 -0600138 .fw_name = "rtl_bt/rtl8761a_fw.bin",
139 .cfg_name = "rtl_bt/rtl8761a_config.bin" },
140
141 /* 8822B */
142 { IC_INFO(RTL_ROM_LMP_8822B, 0xb),
143 .config_needed = true,
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200144 .has_rom_version = true,
Alex Lu907f8492018-02-11 12:24:33 -0600145 .fw_name = "rtl_bt/rtl8822b_fw.bin",
146 .cfg_name = "rtl_bt/rtl8822b_config.bin" },
147 };
148
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200149static const struct id_table *btrtl_match_ic(u16 lmp_subver, u16 hci_rev,
150 u8 hci_ver, u8 hci_bus)
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200151{
152 int i;
153
154 for (i = 0; i < ARRAY_SIZE(ic_id_table); i++) {
155 if ((ic_id_table[i].match_flags & IC_MATCH_FL_LMPSUBV) &&
156 (ic_id_table[i].lmp_subver != lmp_subver))
157 continue;
158 if ((ic_id_table[i].match_flags & IC_MATCH_FL_HCIREV) &&
159 (ic_id_table[i].hci_rev != hci_rev))
160 continue;
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200161 if ((ic_id_table[i].match_flags & IC_MATCH_FL_HCIVER) &&
162 (ic_id_table[i].hci_ver != hci_ver))
163 continue;
164 if ((ic_id_table[i].match_flags & IC_MATCH_FL_HCIBUS) &&
165 (ic_id_table[i].hci_bus != hci_bus))
166 continue;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200167
168 break;
169 }
170 if (i >= ARRAY_SIZE(ic_id_table))
171 return NULL;
172
173 return &ic_id_table[i];
174}
175
Carlo Caionedb33c772015-05-14 10:49:09 +0200176static int rtl_read_rom_version(struct hci_dev *hdev, u8 *version)
177{
178 struct rtl_rom_version_evt *rom_version;
179 struct sk_buff *skb;
180
181 /* Read RTL ROM version command */
182 skb = __hci_cmd_sync(hdev, 0xfc6d, 0, NULL, HCI_INIT_TIMEOUT);
183 if (IS_ERR(skb)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200184 rtl_dev_err(hdev, "Read ROM version failed (%ld)\n",
185 PTR_ERR(skb));
Carlo Caionedb33c772015-05-14 10:49:09 +0200186 return PTR_ERR(skb);
187 }
188
189 if (skb->len != sizeof(*rom_version)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200190 rtl_dev_err(hdev, "RTL version event length mismatch\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200191 kfree_skb(skb);
192 return -EIO;
193 }
194
195 rom_version = (struct rtl_rom_version_evt *)skb->data;
Hans de Goedea5c76e62018-08-02 16:57:14 +0200196 rtl_dev_info(hdev, "rom_version status=%x version=%x\n",
197 rom_version->status, rom_version->version);
Carlo Caionedb33c772015-05-14 10:49:09 +0200198
199 *version = rom_version->version;
200
201 kfree_skb(skb);
202 return 0;
203}
204
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200205static int rtlbt_parse_firmware(struct hci_dev *hdev,
206 struct btrtl_device_info *btrtl_dev,
Alex Lu907f8492018-02-11 12:24:33 -0600207 unsigned char **_buf)
Carlo Caionedb33c772015-05-14 10:49:09 +0200208{
209 const u8 extension_sig[] = { 0x51, 0x04, 0xfd, 0x77 };
210 struct rtl_epatch_header *epatch_info;
211 unsigned char *buf;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200212 int i, len;
Carlo Caionedb33c772015-05-14 10:49:09 +0200213 size_t min_size;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200214 u8 opcode, length, data;
Carlo Caionedb33c772015-05-14 10:49:09 +0200215 int project_id = -1;
216 const unsigned char *fwptr, *chip_id_base;
217 const unsigned char *patch_length_base, *patch_offset_base;
218 u32 patch_offset = 0;
219 u16 patch_length, num_patches;
Larry Finger1110a2d2016-09-09 10:02:05 -0500220 static const struct {
221 __u16 lmp_subver;
222 __u8 id;
223 } project_id_to_lmp_subver[] = {
224 { RTL_ROM_LMP_8723A, 0 },
225 { RTL_ROM_LMP_8723B, 1 },
226 { RTL_ROM_LMP_8821A, 2 },
227 { RTL_ROM_LMP_8761A, 3 },
228 { RTL_ROM_LMP_8822B, 8 },
Alex Lu907f8492018-02-11 12:24:33 -0600229 { RTL_ROM_LMP_8723B, 9 }, /* 8723D */
230 { RTL_ROM_LMP_8821A, 10 }, /* 8821C */
Carlo Caionedb33c772015-05-14 10:49:09 +0200231 };
232
Carlo Caionedb33c772015-05-14 10:49:09 +0200233 min_size = sizeof(struct rtl_epatch_header) + sizeof(extension_sig) + 3;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200234 if (btrtl_dev->fw_len < min_size)
Carlo Caionedb33c772015-05-14 10:49:09 +0200235 return -EINVAL;
236
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200237 fwptr = btrtl_dev->fw_data + btrtl_dev->fw_len - sizeof(extension_sig);
Carlo Caionedb33c772015-05-14 10:49:09 +0200238 if (memcmp(fwptr, extension_sig, sizeof(extension_sig)) != 0) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200239 rtl_dev_err(hdev, "extension section signature mismatch\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200240 return -EINVAL;
241 }
242
243 /* Loop from the end of the firmware parsing instructions, until
244 * we find an instruction that identifies the "project ID" for the
245 * hardware supported by this firwmare file.
246 * Once we have that, we double-check that that project_id is suitable
247 * for the hardware we are working with.
248 */
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200249 while (fwptr >= btrtl_dev->fw_data + (sizeof(*epatch_info) + 3)) {
Carlo Caionedb33c772015-05-14 10:49:09 +0200250 opcode = *--fwptr;
251 length = *--fwptr;
252 data = *--fwptr;
253
254 BT_DBG("check op=%x len=%x data=%x", opcode, length, data);
255
256 if (opcode == 0xff) /* EOF */
257 break;
258
259 if (length == 0) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200260 rtl_dev_err(hdev, "found instruction with length 0\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200261 return -EINVAL;
262 }
263
264 if (opcode == 0 && length == 1) {
265 project_id = data;
266 break;
267 }
268
269 fwptr -= length;
270 }
271
272 if (project_id < 0) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200273 rtl_dev_err(hdev, "failed to find version instruction\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200274 return -EINVAL;
275 }
276
Larry Finger1110a2d2016-09-09 10:02:05 -0500277 /* Find project_id in table */
278 for (i = 0; i < ARRAY_SIZE(project_id_to_lmp_subver); i++) {
279 if (project_id == project_id_to_lmp_subver[i].id)
280 break;
281 }
282
283 if (i >= ARRAY_SIZE(project_id_to_lmp_subver)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200284 rtl_dev_err(hdev, "unknown project id %d\n", project_id);
Carlo Caionedb33c772015-05-14 10:49:09 +0200285 return -EINVAL;
286 }
287
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200288 if (btrtl_dev->ic_info->lmp_subver !=
289 project_id_to_lmp_subver[i].lmp_subver) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200290 rtl_dev_err(hdev, "firmware is for %x but this is a %x\n",
291 project_id_to_lmp_subver[i].lmp_subver,
292 btrtl_dev->ic_info->lmp_subver);
Carlo Caionedb33c772015-05-14 10:49:09 +0200293 return -EINVAL;
294 }
295
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200296 epatch_info = (struct rtl_epatch_header *)btrtl_dev->fw_data;
Carlo Caionedb33c772015-05-14 10:49:09 +0200297 if (memcmp(epatch_info->signature, RTL_EPATCH_SIGNATURE, 8) != 0) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200298 rtl_dev_err(hdev, "bad EPATCH signature\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200299 return -EINVAL;
300 }
301
302 num_patches = le16_to_cpu(epatch_info->num_patches);
303 BT_DBG("fw_version=%x, num_patches=%d",
304 le32_to_cpu(epatch_info->fw_version), num_patches);
305
306 /* After the rtl_epatch_header there is a funky patch metadata section.
307 * Assuming 2 patches, the layout is:
308 * ChipID1 ChipID2 PatchLength1 PatchLength2 PatchOffset1 PatchOffset2
309 *
310 * Find the right patch for this chip.
311 */
312 min_size += 8 * num_patches;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200313 if (btrtl_dev->fw_len < min_size)
Carlo Caionedb33c772015-05-14 10:49:09 +0200314 return -EINVAL;
315
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200316 chip_id_base = btrtl_dev->fw_data + sizeof(struct rtl_epatch_header);
Carlo Caionedb33c772015-05-14 10:49:09 +0200317 patch_length_base = chip_id_base + (sizeof(u16) * num_patches);
318 patch_offset_base = patch_length_base + (sizeof(u16) * num_patches);
319 for (i = 0; i < num_patches; i++) {
320 u16 chip_id = get_unaligned_le16(chip_id_base +
321 (i * sizeof(u16)));
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200322 if (chip_id == btrtl_dev->rom_version + 1) {
Carlo Caionedb33c772015-05-14 10:49:09 +0200323 patch_length = get_unaligned_le16(patch_length_base +
324 (i * sizeof(u16)));
325 patch_offset = get_unaligned_le32(patch_offset_base +
326 (i * sizeof(u32)));
327 break;
328 }
329 }
330
331 if (!patch_offset) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200332 rtl_dev_err(hdev, "didn't find patch for chip id %d",
333 btrtl_dev->rom_version);
Carlo Caionedb33c772015-05-14 10:49:09 +0200334 return -EINVAL;
335 }
336
337 BT_DBG("length=%x offset=%x index %d", patch_length, patch_offset, i);
338 min_size = patch_offset + patch_length;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200339 if (btrtl_dev->fw_len < min_size)
Carlo Caionedb33c772015-05-14 10:49:09 +0200340 return -EINVAL;
341
342 /* Copy the firmware into a new buffer and write the version at
343 * the end.
344 */
345 len = patch_length;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200346 buf = kmemdup(btrtl_dev->fw_data + patch_offset, patch_length,
347 GFP_KERNEL);
Carlo Caionedb33c772015-05-14 10:49:09 +0200348 if (!buf)
349 return -ENOMEM;
350
351 memcpy(buf + patch_length - 4, &epatch_info->fw_version, 4);
352
353 *_buf = buf;
354 return len;
355}
356
357static int rtl_download_firmware(struct hci_dev *hdev,
358 const unsigned char *data, int fw_len)
359{
360 struct rtl_download_cmd *dl_cmd;
361 int frag_num = fw_len / RTL_FRAG_LEN + 1;
362 int frag_len = RTL_FRAG_LEN;
363 int ret = 0;
364 int i;
365
366 dl_cmd = kmalloc(sizeof(struct rtl_download_cmd), GFP_KERNEL);
367 if (!dl_cmd)
368 return -ENOMEM;
369
370 for (i = 0; i < frag_num; i++) {
371 struct sk_buff *skb;
372
373 BT_DBG("download fw (%d/%d)", i, frag_num);
374
375 dl_cmd->index = i;
376 if (i == (frag_num - 1)) {
377 dl_cmd->index |= 0x80; /* data end */
378 frag_len = fw_len % RTL_FRAG_LEN;
379 }
380 memcpy(dl_cmd->data, data, frag_len);
381
382 /* Send download command */
383 skb = __hci_cmd_sync(hdev, 0xfc20, frag_len + 1, dl_cmd,
384 HCI_INIT_TIMEOUT);
385 if (IS_ERR(skb)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200386 rtl_dev_err(hdev, "download fw command failed (%ld)\n",
387 PTR_ERR(skb));
Carlo Caionedb33c772015-05-14 10:49:09 +0200388 ret = -PTR_ERR(skb);
389 goto out;
390 }
391
392 if (skb->len != sizeof(struct rtl_download_response)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200393 rtl_dev_err(hdev, "download fw event length mismatch\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200394 kfree_skb(skb);
395 ret = -EIO;
396 goto out;
397 }
398
399 kfree_skb(skb);
400 data += RTL_FRAG_LEN;
401 }
402
403out:
404 kfree(dl_cmd);
405 return ret;
406}
407
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200408static int rtl_load_file(struct hci_dev *hdev, const char *name, u8 **buff)
Larry Finger1110a2d2016-09-09 10:02:05 -0500409{
410 const struct firmware *fw;
411 int ret;
412
Hans de Goedea5c76e62018-08-02 16:57:14 +0200413 rtl_dev_info(hdev, "rtl: loading %s\n", name);
Larry Finger1110a2d2016-09-09 10:02:05 -0500414 ret = request_firmware(&fw, name, &hdev->dev);
Larry Fingerabed84a2017-02-19 20:04:57 -0600415 if (ret < 0)
Larry Finger1110a2d2016-09-09 10:02:05 -0500416 return ret;
Larry Finger1110a2d2016-09-09 10:02:05 -0500417 ret = fw->size;
418 *buff = kmemdup(fw->data, ret, GFP_KERNEL);
Dan Carpenterc3327bd2017-07-28 17:41:11 +0300419 if (!*buff)
420 ret = -ENOMEM;
Larry Finger1110a2d2016-09-09 10:02:05 -0500421
422 release_firmware(fw);
423
424 return ret;
425}
426
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200427static int btrtl_setup_rtl8723a(struct hci_dev *hdev,
428 struct btrtl_device_info *btrtl_dev)
Carlo Caionedb33c772015-05-14 10:49:09 +0200429{
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200430 if (btrtl_dev->fw_len < 8)
431 return -EINVAL;
Carlo Caionedb33c772015-05-14 10:49:09 +0200432
433 /* Check that the firmware doesn't have the epatch signature
434 * (which is only for RTL8723B and newer).
435 */
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200436 if (!memcmp(btrtl_dev->fw_data, RTL_EPATCH_SIGNATURE, 8)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200437 rtl_dev_err(hdev, "unexpected EPATCH signature!\n");
Alex Lu907f8492018-02-11 12:24:33 -0600438 return -EINVAL;
439 }
440
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200441 return rtl_download_firmware(hdev, btrtl_dev->fw_data,
442 btrtl_dev->fw_len);
443}
Alex Lu907f8492018-02-11 12:24:33 -0600444
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200445static int btrtl_setup_rtl8723b(struct hci_dev *hdev,
446 struct btrtl_device_info *btrtl_dev)
447{
448 unsigned char *fw_data = NULL;
449 int ret;
450 u8 *tbuff;
Carlo Caionedb33c772015-05-14 10:49:09 +0200451
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200452 ret = rtlbt_parse_firmware(hdev, btrtl_dev, &fw_data);
Carlo Caionedb33c772015-05-14 10:49:09 +0200453 if (ret < 0)
454 goto out;
455
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200456 if (btrtl_dev->cfg_len > 0) {
457 tbuff = kzalloc(ret + btrtl_dev->cfg_len, GFP_KERNEL);
Larry Finger1110a2d2016-09-09 10:02:05 -0500458 if (!tbuff) {
459 ret = -ENOMEM;
460 goto out;
461 }
462
463 memcpy(tbuff, fw_data, ret);
464 kfree(fw_data);
465
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200466 memcpy(tbuff + ret, btrtl_dev->cfg_data, btrtl_dev->cfg_len);
467 ret += btrtl_dev->cfg_len;
Larry Finger1110a2d2016-09-09 10:02:05 -0500468
469 fw_data = tbuff;
470 }
471
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200472 rtl_dev_info(hdev, "cfg_sz %d, total sz %d\n", btrtl_dev->cfg_len, ret);
Larry Finger1110a2d2016-09-09 10:02:05 -0500473
Carlo Caionedb33c772015-05-14 10:49:09 +0200474 ret = rtl_download_firmware(hdev, fw_data, ret);
Carlo Caionedb33c772015-05-14 10:49:09 +0200475
476out:
Larry Finger1110a2d2016-09-09 10:02:05 -0500477 kfree(fw_data);
Carlo Caionedb33c772015-05-14 10:49:09 +0200478 return ret;
479}
480
481static struct sk_buff *btrtl_read_local_version(struct hci_dev *hdev)
482{
483 struct sk_buff *skb;
484
485 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
486 HCI_INIT_TIMEOUT);
487 if (IS_ERR(skb)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200488 rtl_dev_err(hdev, "HCI_OP_READ_LOCAL_VERSION failed (%ld)\n",
489 PTR_ERR(skb));
Carlo Caionedb33c772015-05-14 10:49:09 +0200490 return skb;
491 }
492
493 if (skb->len != sizeof(struct hci_rp_read_local_version)) {
Hans de Goedea5c76e62018-08-02 16:57:14 +0200494 rtl_dev_err(hdev, "HCI_OP_READ_LOCAL_VERSION event length mismatch\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200495 kfree_skb(skb);
496 return ERR_PTR(-EIO);
497 }
498
499 return skb;
500}
501
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200502void btrtl_free(struct btrtl_device_info *btrtl_dev)
Carlo Caionedb33c772015-05-14 10:49:09 +0200503{
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200504 kfree(btrtl_dev->fw_data);
505 kfree(btrtl_dev->cfg_data);
506 kfree(btrtl_dev);
507}
508EXPORT_SYMBOL_GPL(btrtl_free);
509
510struct btrtl_device_info *btrtl_initialize(struct hci_dev *hdev)
511{
512 struct btrtl_device_info *btrtl_dev;
Carlo Caionedb33c772015-05-14 10:49:09 +0200513 struct sk_buff *skb;
514 struct hci_rp_read_local_version *resp;
Alex Lu907f8492018-02-11 12:24:33 -0600515 u16 hci_rev, lmp_subver;
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200516 u8 hci_ver;
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200517 int ret;
518
519 btrtl_dev = kzalloc(sizeof(*btrtl_dev), GFP_KERNEL);
520 if (!btrtl_dev) {
521 ret = -ENOMEM;
522 goto err_alloc;
523 }
Carlo Caionedb33c772015-05-14 10:49:09 +0200524
525 skb = btrtl_read_local_version(hdev);
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200526 if (IS_ERR(skb)) {
527 ret = PTR_ERR(skb);
528 goto err_free;
529 }
Carlo Caionedb33c772015-05-14 10:49:09 +0200530
531 resp = (struct hci_rp_read_local_version *)skb->data;
Hans de Goedea5c76e62018-08-02 16:57:14 +0200532 rtl_dev_info(hdev, "rtl: examining hci_ver=%02x hci_rev=%04x lmp_ver=%02x lmp_subver=%04x\n",
533 resp->hci_ver, resp->hci_rev,
534 resp->lmp_ver, resp->lmp_subver);
Carlo Caionedb33c772015-05-14 10:49:09 +0200535
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200536 hci_ver = resp->hci_ver;
Alex Lu907f8492018-02-11 12:24:33 -0600537 hci_rev = le16_to_cpu(resp->hci_rev);
Carlo Caionedb33c772015-05-14 10:49:09 +0200538 lmp_subver = le16_to_cpu(resp->lmp_subver);
539 kfree_skb(skb);
540
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200541 btrtl_dev->ic_info = btrtl_match_ic(lmp_subver, hci_rev, hci_ver,
542 hdev->bus);
543
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200544 if (!btrtl_dev->ic_info) {
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200545 rtl_dev_err(hdev, "rtl: unknown IC info, lmp subver %04x, hci rev %04x, hci ver %04x",
546 lmp_subver, hci_rev, hci_ver);
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200547 ret = -EINVAL;
548 goto err_free;
549 }
550
551 if (btrtl_dev->ic_info->has_rom_version) {
552 ret = rtl_read_rom_version(hdev, &btrtl_dev->rom_version);
553 if (ret)
554 goto err_free;
555 }
556
557 btrtl_dev->fw_len = rtl_load_file(hdev, btrtl_dev->ic_info->fw_name,
558 &btrtl_dev->fw_data);
559 if (btrtl_dev->fw_len < 0) {
560 rtl_dev_err(hdev, "firmware file %s not found\n",
561 btrtl_dev->ic_info->fw_name);
562 ret = btrtl_dev->fw_len;
563 goto err_free;
564 }
565
566 if (btrtl_dev->ic_info->cfg_name) {
567 btrtl_dev->cfg_len = rtl_load_file(hdev,
568 btrtl_dev->ic_info->cfg_name,
569 &btrtl_dev->cfg_data);
570 if (btrtl_dev->ic_info->config_needed &&
571 btrtl_dev->cfg_len <= 0) {
572 rtl_dev_err(hdev, "mandatory config file %s not found\n",
573 btrtl_dev->ic_info->cfg_name);
574 ret = btrtl_dev->cfg_len;
575 goto err_free;
576 }
577 }
578
579 return btrtl_dev;
580
581err_free:
582 btrtl_free(btrtl_dev);
583err_alloc:
584 return ERR_PTR(ret);
585}
586EXPORT_SYMBOL_GPL(btrtl_initialize);
587
588int btrtl_download_firmware(struct hci_dev *hdev,
589 struct btrtl_device_info *btrtl_dev)
590{
Carlo Caionedb33c772015-05-14 10:49:09 +0200591 /* Match a set of subver values that correspond to stock firmware,
592 * which is not compatible with standard btusb.
593 * If matched, upload an alternative firmware that does conform to
594 * standard btusb. Once that firmware is uploaded, the subver changes
595 * to a different value.
596 */
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200597 switch (btrtl_dev->ic_info->lmp_subver) {
Carlo Caionedb33c772015-05-14 10:49:09 +0200598 case RTL_ROM_LMP_8723A:
599 case RTL_ROM_LMP_3499:
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200600 return btrtl_setup_rtl8723a(hdev, btrtl_dev);
Carlo Caionedb33c772015-05-14 10:49:09 +0200601 case RTL_ROM_LMP_8723B:
Carlo Caionedb33c772015-05-14 10:49:09 +0200602 case RTL_ROM_LMP_8821A:
Carlo Caionedb33c772015-05-14 10:49:09 +0200603 case RTL_ROM_LMP_8761A:
Larry Finger1110a2d2016-09-09 10:02:05 -0500604 case RTL_ROM_LMP_8822B:
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200605 return btrtl_setup_rtl8723b(hdev, btrtl_dev);
Carlo Caionedb33c772015-05-14 10:49:09 +0200606 default:
Hans de Goedea5c76e62018-08-02 16:57:14 +0200607 rtl_dev_info(hdev, "rtl: assuming no firmware upload needed\n");
Carlo Caionedb33c772015-05-14 10:49:09 +0200608 return 0;
609 }
610}
Martin Blumenstingl26503ad22018-08-02 16:57:13 +0200611EXPORT_SYMBOL_GPL(btrtl_download_firmware);
612
613int btrtl_setup_realtek(struct hci_dev *hdev)
614{
615 struct btrtl_device_info *btrtl_dev;
616 int ret;
617
618 btrtl_dev = btrtl_initialize(hdev);
619 if (IS_ERR(btrtl_dev))
620 return PTR_ERR(btrtl_dev);
621
622 ret = btrtl_download_firmware(hdev, btrtl_dev);
623
624 btrtl_free(btrtl_dev);
625
626 return ret;
627}
Carlo Caionedb33c772015-05-14 10:49:09 +0200628EXPORT_SYMBOL_GPL(btrtl_setup_realtek);
629
Martin Blumenstinglb85b0ee2018-08-02 16:57:15 +0200630static unsigned int btrtl_convert_baudrate(u32 device_baudrate)
631{
632 switch (device_baudrate) {
633 case 0x0252a00a:
634 return 230400;
635
636 case 0x05f75004:
637 return 921600;
638
639 case 0x00005004:
640 return 1000000;
641
642 case 0x04928002:
643 case 0x01128002:
644 return 1500000;
645
646 case 0x00005002:
647 return 2000000;
648
649 case 0x0000b001:
650 return 2500000;
651
652 case 0x04928001:
653 return 3000000;
654
655 case 0x052a6001:
656 return 3500000;
657
658 case 0x00005001:
659 return 4000000;
660
661 case 0x0252c014:
662 default:
663 return 115200;
664 }
665}
666
667int btrtl_get_uart_settings(struct hci_dev *hdev,
668 struct btrtl_device_info *btrtl_dev,
669 unsigned int *controller_baudrate,
670 u32 *device_baudrate, bool *flow_control)
671{
672 struct rtl_vendor_config *config;
673 struct rtl_vendor_config_entry *entry;
674 int i, total_data_len;
675 bool found = false;
676
677 total_data_len = btrtl_dev->cfg_len - sizeof(*config);
678 if (total_data_len <= 0) {
679 rtl_dev_warn(hdev, "no config loaded\n");
680 return -EINVAL;
681 }
682
683 config = (struct rtl_vendor_config *)btrtl_dev->cfg_data;
684 if (le32_to_cpu(config->signature) != RTL_CONFIG_MAGIC) {
685 rtl_dev_err(hdev, "invalid config magic\n");
686 return -EINVAL;
687 }
688
689 if (total_data_len < le16_to_cpu(config->total_len)) {
690 rtl_dev_err(hdev, "config is too short\n");
691 return -EINVAL;
692 }
693
694 for (i = 0; i < total_data_len; ) {
695 entry = ((void *)config->entry) + i;
696
697 switch (le16_to_cpu(entry->offset)) {
698 case 0xc:
699 if (entry->len < sizeof(*device_baudrate)) {
700 rtl_dev_err(hdev, "invalid UART config entry\n");
701 return -EINVAL;
702 }
703
704 *device_baudrate = get_unaligned_le32(entry->data);
705 *controller_baudrate = btrtl_convert_baudrate(
706 *device_baudrate);
707
708 if (entry->len >= 13)
709 *flow_control = !!(entry->data[12] & BIT(2));
710 else
711 *flow_control = false;
712
713 found = true;
714 break;
715
716 default:
717 rtl_dev_dbg(hdev, "skipping config entry 0x%x (len %u)\n",
718 le16_to_cpu(entry->offset), entry->len);
719 break;
720 };
721
722 i += sizeof(*entry) + entry->len;
723 }
724
725 if (!found) {
726 rtl_dev_err(hdev, "no UART config entry found\n");
727 return -ENOENT;
728 }
729
730 rtl_dev_dbg(hdev, "device baudrate = 0x%08x\n", *device_baudrate);
731 rtl_dev_dbg(hdev, "controller baudrate = %u\n", *controller_baudrate);
732 rtl_dev_dbg(hdev, "flow control %d\n", *flow_control);
733
734 return 0;
735}
736EXPORT_SYMBOL_GPL(btrtl_get_uart_settings);
737
Carlo Caionedb33c772015-05-14 10:49:09 +0200738MODULE_AUTHOR("Daniel Drake <drake@endlessm.com>");
739MODULE_DESCRIPTION("Bluetooth support for Realtek devices ver " VERSION);
740MODULE_VERSION(VERSION);
741MODULE_LICENSE("GPL");
Martin Blumenstinglf96dbd32018-08-02 16:57:12 +0200742MODULE_FIRMWARE("rtl_bt/rtl8723a_fw.bin");
743MODULE_FIRMWARE("rtl_bt/rtl8723b_fw.bin");
744MODULE_FIRMWARE("rtl_bt/rtl8723b_config.bin");
Martin Blumenstinglc50903e2018-08-02 16:57:16 +0200745MODULE_FIRMWARE("rtl_bt/rtl8723bs_fw.bin");
746MODULE_FIRMWARE("rtl_bt/rtl8723bs_config.bin");
747MODULE_FIRMWARE("rtl_bt/rtl8723ds_fw.bin");
748MODULE_FIRMWARE("rtl_bt/rtl8723ds_config.bin");
Martin Blumenstinglf96dbd32018-08-02 16:57:12 +0200749MODULE_FIRMWARE("rtl_bt/rtl8761a_fw.bin");
750MODULE_FIRMWARE("rtl_bt/rtl8761a_config.bin");
751MODULE_FIRMWARE("rtl_bt/rtl8821a_fw.bin");
752MODULE_FIRMWARE("rtl_bt/rtl8821a_config.bin");
753MODULE_FIRMWARE("rtl_bt/rtl8822b_fw.bin");
754MODULE_FIRMWARE("rtl_bt/rtl8822b_config.bin");