1 // SPDX-License-Identifier: ISC
2 /*
3 * Copyright (c) 2013 Broadcom Corporation
4 */
5
6 #include <linux/efi.h>
7 #include <linux/kernel.h>
8 #include <linux/slab.h>
9 #include <linux/device.h>
10 #include <linux/firmware.h>
11 #include <linux/module.h>
12 #include <linux/bcm47xx_nvram.h>
13
14 #include "debug.h"
15 #include "firmware.h"
16 #include "core.h"
17 #include "common.h"
18 #include "chip.h"
19
20 #define BRCMF_FW_MAX_NVRAM_SIZE 64000
21 #define BRCMF_FW_NVRAM_DEVPATH_LEN 19 /* devpath0=pcie/1/4/ */
22 #define BRCMF_FW_NVRAM_PCIEDEV_LEN 20 /* pcie/1/4/ + \0 */
23 #define BRCMF_FW_DEFAULT_BOARDREV "boardrev=0xff"
24 #define BRCMF_FW_MACADDR_FMT "macaddr=%pM"
25 #define BRCMF_FW_MACADDR_LEN (7 + ETH_ALEN * 3)
26
27 enum nvram_parser_state {
28 IDLE,
29 KEY,
30 VALUE,
31 COMMENT,
32 END
33 };
34
35 /**
36 * struct nvram_parser - internal info for parser.
37 *
38 * @state: current parser state.
39 * @data: input buffer being parsed.
40 * @nvram: output buffer with parse result.
41 * @nvram_len: length of parse result.
42 * @line: current line.
43 * @column: current column in line.
44 * @pos: byte offset in input buffer.
45 * @entry: start position of key,value entry.
46 * @multi_dev_v1: detect pcie multi device v1 (compressed).
47 * @multi_dev_v2: detect pcie multi device v2.
48 * @boardrev_found: nvram contains boardrev information.
49 * @strip_mac: strip the MAC address.
50 */
51 struct nvram_parser {
52 enum nvram_parser_state state;
53 const u8 *data;
54 u8 *nvram;
55 u32 nvram_len;
56 u32 line;
57 u32 column;
58 u32 pos;
59 u32 entry;
60 bool multi_dev_v1;
61 bool multi_dev_v2;
62 bool boardrev_found;
63 bool strip_mac;
64 };
65
66 /*
67 * is_nvram_char() - check if char is a valid one for NVRAM entry
68 *
69 * It accepts all printable ASCII chars except for '#' which opens a comment.
70 * Please note that ' ' (space) while accepted is not a valid key name char.
71 */
is_nvram_char(char c)72 static bool is_nvram_char(char c)
73 {
74 /* comment marker excluded */
75 if (c == '#')
76 return false;
77
78 /* key and value may have any other readable character */
79 return (c >= 0x20 && c < 0x7f);
80 }
81
is_whitespace(char c)82 static bool is_whitespace(char c)
83 {
84 return (c == ' ' || c == '\r' || c == '\n' || c == '\t');
85 }
86
brcmf_nvram_handle_idle(struct nvram_parser * nvp)87 static enum nvram_parser_state brcmf_nvram_handle_idle(struct nvram_parser *nvp)
88 {
89 char c;
90
91 c = nvp->data[nvp->pos];
92 if (c == '\n')
93 return COMMENT;
94 if (is_whitespace(c) || c == '\0')
95 goto proceed;
96 if (c == '#')
97 return COMMENT;
98 if (is_nvram_char(c)) {
99 nvp->entry = nvp->pos;
100 return KEY;
101 }
102 brcmf_dbg(INFO, "warning: ln=%d:col=%d: ignoring invalid character\n",
103 nvp->line, nvp->column);
104 proceed:
105 nvp->column++;
106 nvp->pos++;
107 return IDLE;
108 }
109
brcmf_nvram_handle_key(struct nvram_parser * nvp)110 static enum nvram_parser_state brcmf_nvram_handle_key(struct nvram_parser *nvp)
111 {
112 enum nvram_parser_state st = nvp->state;
113 char c;
114
115 c = nvp->data[nvp->pos];
116 if (c == '=') {
117 /* ignore RAW1 by treating as comment */
118 if (strncmp(&nvp->data[nvp->entry], "RAW1", 4) == 0)
119 st = COMMENT;
120 else
121 st = VALUE;
122 if (strncmp(&nvp->data[nvp->entry], "devpath", 7) == 0)
123 nvp->multi_dev_v1 = true;
124 if (strncmp(&nvp->data[nvp->entry], "pcie/", 5) == 0)
125 nvp->multi_dev_v2 = true;
126 if (strncmp(&nvp->data[nvp->entry], "boardrev", 8) == 0)
127 nvp->boardrev_found = true;
128 /* strip macaddr if platform MAC overrides */
129 if (nvp->strip_mac &&
130 strncmp(&nvp->data[nvp->entry], "macaddr", 7) == 0)
131 st = COMMENT;
132 } else if (!is_nvram_char(c) || c == ' ') {
133 brcmf_dbg(INFO, "warning: ln=%d:col=%d: '=' expected, skip invalid key entry\n",
134 nvp->line, nvp->column);
135 return COMMENT;
136 }
137
138 nvp->column++;
139 nvp->pos++;
140 return st;
141 }
142
143 static enum nvram_parser_state
brcmf_nvram_handle_value(struct nvram_parser * nvp)144 brcmf_nvram_handle_value(struct nvram_parser *nvp)
145 {
146 char c;
147 #if defined(__linux__)
148 char *skv;
149 char *ekv;
150 #elif defined(__FreeBSD__)
151 const char *skv;
152 const char *ekv;
153 #endif
154 u32 cplen;
155
156 c = nvp->data[nvp->pos];
157 if (!is_nvram_char(c)) {
158 /* key,value pair complete */
159 #if defined(__linux__)
160 ekv = (u8 *)&nvp->data[nvp->pos];
161 skv = (u8 *)&nvp->data[nvp->entry];
162 #elif defined(__FreeBSD__)
163 ekv = &nvp->data[nvp->pos];
164 skv = &nvp->data[nvp->entry];
165 #endif
166 cplen = ekv - skv;
167 if (nvp->nvram_len + cplen + 1 >= BRCMF_FW_MAX_NVRAM_SIZE)
168 return END;
169 /* copy to output buffer */
170 memcpy(&nvp->nvram[nvp->nvram_len], skv, cplen);
171 nvp->nvram_len += cplen;
172 nvp->nvram[nvp->nvram_len] = '\0';
173 nvp->nvram_len++;
174 return IDLE;
175 }
176 nvp->pos++;
177 nvp->column++;
178 return VALUE;
179 }
180
181 static enum nvram_parser_state
brcmf_nvram_handle_comment(struct nvram_parser * nvp)182 brcmf_nvram_handle_comment(struct nvram_parser *nvp)
183 {
184 #if defined(__linux__)
185 char *eoc, *sol;
186
187 sol = (char *)&nvp->data[nvp->pos];
188 #elif defined(__FreeBSD__)
189 const char *eoc, *sol;
190
191 sol = &nvp->data[nvp->pos];
192 #endif
193 eoc = strchr(sol, '\n');
194 if (!eoc) {
195 eoc = strchr(sol, '\0');
196 if (!eoc)
197 return END;
198 }
199
200 /* eat all moving to next line */
201 nvp->line++;
202 nvp->column = 1;
203 nvp->pos += (eoc - sol) + 1;
204 return IDLE;
205 }
206
brcmf_nvram_handle_end(struct nvram_parser * nvp)207 static enum nvram_parser_state brcmf_nvram_handle_end(struct nvram_parser *nvp)
208 {
209 /* final state */
210 return END;
211 }
212
213 static enum nvram_parser_state
214 (*nv_parser_states[])(struct nvram_parser *nvp) = {
215 brcmf_nvram_handle_idle,
216 brcmf_nvram_handle_key,
217 brcmf_nvram_handle_value,
218 brcmf_nvram_handle_comment,
219 brcmf_nvram_handle_end
220 };
221
brcmf_init_nvram_parser(struct nvram_parser * nvp,const u8 * data,size_t data_len)222 static int brcmf_init_nvram_parser(struct nvram_parser *nvp,
223 const u8 *data, size_t data_len)
224 {
225 size_t size;
226
227 memset(nvp, 0, sizeof(*nvp));
228 nvp->data = data;
229 /* Limit size to MAX_NVRAM_SIZE, some files contain lot of comment */
230 if (data_len > BRCMF_FW_MAX_NVRAM_SIZE)
231 size = BRCMF_FW_MAX_NVRAM_SIZE;
232 else
233 size = data_len;
234 /* Add space for properties we may add */
235 size += strlen(BRCMF_FW_DEFAULT_BOARDREV) + 1;
236 size += BRCMF_FW_MACADDR_LEN + 1;
237 /* Alloc for extra 0 byte + roundup by 4 + length field */
238 size += 1 + 3 + sizeof(u32);
239 nvp->nvram = kzalloc(size, GFP_KERNEL);
240 if (!nvp->nvram)
241 return -ENOMEM;
242
243 nvp->line = 1;
244 nvp->column = 1;
245 return 0;
246 }
247
248 /* brcmf_fw_strip_multi_v1 :Some nvram files contain settings for multiple
249 * devices. Strip it down for one device, use domain_nr/bus_nr to determine
250 * which data is to be returned. v1 is the version where nvram is stored
251 * compressed and "devpath" maps to index for valid entries.
252 */
brcmf_fw_strip_multi_v1(struct nvram_parser * nvp,u16 domain_nr,u16 bus_nr)253 static void brcmf_fw_strip_multi_v1(struct nvram_parser *nvp, u16 domain_nr,
254 u16 bus_nr)
255 {
256 /* Device path with a leading '=' key-value separator */
257 char pci_path[20];
258 size_t pci_len;
259 char pcie_path[20];
260 size_t pcie_len;
261
262 u32 i, j;
263 bool found;
264 u8 *nvram;
265 u8 id;
266
267 nvram = kzalloc(nvp->nvram_len + 1 + 3 + sizeof(u32), GFP_KERNEL);
268 if (!nvram)
269 goto fail;
270
271 /* min length: devpath0=pcie/1/4/ + 0:x=y */
272 if (nvp->nvram_len < BRCMF_FW_NVRAM_DEVPATH_LEN + 6)
273 goto fail;
274
275 /* First search for the devpathX and see if it is the configuration
276 * for domain_nr/bus_nr. Search complete nvp
277 */
278 snprintf(pci_path, sizeof(pci_path), "=pci/%d/%d", domain_nr,
279 bus_nr);
280 pci_len = strlen(pci_path);
281 snprintf(pcie_path, sizeof(pcie_path), "=pcie/%d/%d", domain_nr,
282 bus_nr);
283 pcie_len = strlen(pcie_path);
284 found = false;
285 i = 0;
286 while (i < nvp->nvram_len - BRCMF_FW_NVRAM_DEVPATH_LEN) {
287 /* Format: devpathX=pcie/Y/Z/
288 * Y = domain_nr, Z = bus_nr, X = virtual ID
289 */
290 if (strncmp(&nvp->nvram[i], "devpath", 7) == 0 &&
291 (!strncmp(&nvp->nvram[i + 8], pci_path, pci_len) ||
292 !strncmp(&nvp->nvram[i + 8], pcie_path, pcie_len))) {
293 id = nvp->nvram[i + 7] - '0';
294 found = true;
295 break;
296 }
297 while (nvp->nvram[i] != 0)
298 i++;
299 i++;
300 }
301 if (!found)
302 goto fail;
303
304 /* Now copy all valid entries, release old nvram and assign new one */
305 i = 0;
306 j = 0;
307 while (i < nvp->nvram_len) {
308 if ((nvp->nvram[i] - '0' == id) && (nvp->nvram[i + 1] == ':')) {
309 i += 2;
310 if (strncmp(&nvp->nvram[i], "boardrev", 8) == 0)
311 nvp->boardrev_found = true;
312 while (nvp->nvram[i] != 0) {
313 nvram[j] = nvp->nvram[i];
314 i++;
315 j++;
316 }
317 nvram[j] = 0;
318 j++;
319 }
320 while (nvp->nvram[i] != 0)
321 i++;
322 i++;
323 }
324 kfree(nvp->nvram);
325 nvp->nvram = nvram;
326 nvp->nvram_len = j;
327 return;
328
329 fail:
330 kfree(nvram);
331 nvp->nvram_len = 0;
332 }
333
334 /* brcmf_fw_strip_multi_v2 :Some nvram files contain settings for multiple
335 * devices. Strip it down for one device, use domain_nr/bus_nr to determine
336 * which data is to be returned. v2 is the version where nvram is stored
337 * uncompressed, all relevant valid entries are identified by
338 * pcie/domain_nr/bus_nr:
339 */
brcmf_fw_strip_multi_v2(struct nvram_parser * nvp,u16 domain_nr,u16 bus_nr)340 static void brcmf_fw_strip_multi_v2(struct nvram_parser *nvp, u16 domain_nr,
341 u16 bus_nr)
342 {
343 char prefix[BRCMF_FW_NVRAM_PCIEDEV_LEN];
344 size_t len;
345 u32 i, j;
346 u8 *nvram;
347
348 nvram = kzalloc(nvp->nvram_len + 1 + 3 + sizeof(u32), GFP_KERNEL);
349 if (!nvram) {
350 nvp->nvram_len = 0;
351 return;
352 }
353
354 /* Copy all valid entries, release old nvram and assign new one.
355 * Valid entries are of type pcie/X/Y/ where X = domain_nr and
356 * Y = bus_nr.
357 */
358 snprintf(prefix, sizeof(prefix), "pcie/%d/%d/", domain_nr, bus_nr);
359 len = strlen(prefix);
360 i = 0;
361 j = 0;
362 while (i < nvp->nvram_len - len) {
363 if (strncmp(&nvp->nvram[i], prefix, len) == 0) {
364 i += len;
365 if (strncmp(&nvp->nvram[i], "boardrev", 8) == 0)
366 nvp->boardrev_found = true;
367 while (nvp->nvram[i] != 0) {
368 nvram[j] = nvp->nvram[i];
369 i++;
370 j++;
371 }
372 nvram[j] = 0;
373 j++;
374 }
375 while (nvp->nvram[i] != 0)
376 i++;
377 i++;
378 }
379 kfree(nvp->nvram);
380 nvp->nvram = nvram;
381 nvp->nvram_len = j;
382 }
383
brcmf_fw_add_defaults(struct nvram_parser * nvp)384 static void brcmf_fw_add_defaults(struct nvram_parser *nvp)
385 {
386 if (nvp->boardrev_found)
387 return;
388
389 memcpy(&nvp->nvram[nvp->nvram_len], &BRCMF_FW_DEFAULT_BOARDREV,
390 strlen(BRCMF_FW_DEFAULT_BOARDREV));
391 nvp->nvram_len += strlen(BRCMF_FW_DEFAULT_BOARDREV);
392 nvp->nvram[nvp->nvram_len] = '\0';
393 nvp->nvram_len++;
394 }
395
brcmf_fw_add_macaddr(struct nvram_parser * nvp,u8 * mac)396 static void brcmf_fw_add_macaddr(struct nvram_parser *nvp, u8 *mac)
397 {
398 int len;
399
400 len = scnprintf(&nvp->nvram[nvp->nvram_len], BRCMF_FW_MACADDR_LEN + 1,
401 BRCMF_FW_MACADDR_FMT, mac);
402 WARN_ON(len != BRCMF_FW_MACADDR_LEN);
403 nvp->nvram_len += len + 1;
404 }
405
406 /* brcmf_nvram_strip :Takes a buffer of "<var>=<value>\n" lines read from a fil
407 * and ending in a NUL. Removes carriage returns, empty lines, comment lines,
408 * and converts newlines to NULs. Shortens buffer as needed and pads with NULs.
409 * End of buffer is completed with token identifying length of buffer.
410 */
brcmf_fw_nvram_strip(const u8 * data,size_t data_len,u32 * new_length,u16 domain_nr,u16 bus_nr,struct device * dev)411 static void *brcmf_fw_nvram_strip(const u8 *data, size_t data_len,
412 u32 *new_length, u16 domain_nr, u16 bus_nr,
413 struct device *dev)
414 {
415 struct nvram_parser nvp;
416 u32 pad;
417 u32 token;
418 __le32 token_le;
419 u8 mac[ETH_ALEN];
420
421 if (brcmf_init_nvram_parser(&nvp, data, data_len) < 0)
422 return NULL;
423
424 if (eth_platform_get_mac_address(dev, mac) == 0)
425 nvp.strip_mac = true;
426
427 while (nvp.pos < data_len) {
428 nvp.state = nv_parser_states[nvp.state](&nvp);
429 if (nvp.state == END)
430 break;
431 }
432 if (nvp.multi_dev_v1) {
433 nvp.boardrev_found = false;
434 brcmf_fw_strip_multi_v1(&nvp, domain_nr, bus_nr);
435 } else if (nvp.multi_dev_v2) {
436 nvp.boardrev_found = false;
437 brcmf_fw_strip_multi_v2(&nvp, domain_nr, bus_nr);
438 }
439
440 if (nvp.nvram_len == 0) {
441 kfree(nvp.nvram);
442 return NULL;
443 }
444
445 brcmf_fw_add_defaults(&nvp);
446
447 if (nvp.strip_mac)
448 brcmf_fw_add_macaddr(&nvp, mac);
449
450 pad = nvp.nvram_len;
451 *new_length = roundup(nvp.nvram_len + 1, 4);
452 while (pad != *new_length) {
453 nvp.nvram[pad] = 0;
454 pad++;
455 }
456
457 token = *new_length / 4;
458 token = (~token << 16) | (token & 0x0000FFFF);
459 token_le = cpu_to_le32(token);
460
461 memcpy(&nvp.nvram[*new_length], &token_le, sizeof(token_le));
462 *new_length += sizeof(token_le);
463
464 return nvp.nvram;
465 }
466
brcmf_fw_nvram_free(void * nvram)467 void brcmf_fw_nvram_free(void *nvram)
468 {
469 kfree(nvram);
470 }
471
472 struct brcmf_fw {
473 struct device *dev;
474 struct brcmf_fw_request *req;
475 u32 curpos;
476 unsigned int board_index;
477 void (*done)(struct device *dev, int err, struct brcmf_fw_request *req);
478 };
479
480 #ifdef CONFIG_EFI
481 /* In some cases the EFI-var stored nvram contains "ccode=ALL" or "ccode=XV"
482 * to specify "worldwide" compatible settings, but these 2 ccode-s do not work
483 * properly. "ccode=ALL" causes channels 12 and 13 to not be available,
484 * "ccode=XV" causes all 5GHz channels to not be available. So we replace both
485 * with "ccode=X2" which allows channels 12+13 and 5Ghz channels in
486 * no-Initiate-Radiation mode. This means that we will never send on these
487 * channels without first having received valid wifi traffic on the channel.
488 */
brcmf_fw_fix_efi_nvram_ccode(char * data,unsigned long data_len)489 static void brcmf_fw_fix_efi_nvram_ccode(char *data, unsigned long data_len)
490 {
491 char *ccode;
492
493 ccode = strnstr((char *)data, "ccode=ALL", data_len);
494 if (!ccode)
495 ccode = strnstr((char *)data, "ccode=XV\r", data_len);
496 if (!ccode)
497 return;
498
499 ccode[6] = 'X';
500 ccode[7] = '2';
501 ccode[8] = '\r';
502 }
503
brcmf_fw_nvram_from_efi(size_t * data_len_ret)504 static u8 *brcmf_fw_nvram_from_efi(size_t *data_len_ret)
505 {
506 efi_guid_t guid = EFI_GUID(0x74b00bd9, 0x805a, 0x4d61, 0xb5, 0x1f,
507 0x43, 0x26, 0x81, 0x23, 0xd1, 0x13);
508 unsigned long data_len = 0;
509 efi_status_t status;
510 u8 *data = NULL;
511
512 if (!efi_rt_services_supported(EFI_RT_SUPPORTED_GET_VARIABLE))
513 return NULL;
514
515 status = efi.get_variable(L"nvram", &guid, NULL, &data_len, NULL);
516 if (status != EFI_BUFFER_TOO_SMALL)
517 goto fail;
518
519 data = kmalloc(data_len, GFP_KERNEL);
520 if (!data)
521 goto fail;
522
523 status = efi.get_variable(L"nvram", &guid, NULL, &data_len, data);
524 if (status != EFI_SUCCESS)
525 goto fail;
526
527 brcmf_fw_fix_efi_nvram_ccode(data, data_len);
528 brcmf_info("Using nvram EFI variable\n");
529
530 *data_len_ret = data_len;
531 return data;
532 fail:
533 kfree(data);
534 return NULL;
535 }
536 #else
brcmf_fw_nvram_from_efi(size_t * data_len)537 static inline u8 *brcmf_fw_nvram_from_efi(size_t *data_len) { return NULL; }
538 #endif
539
brcmf_fw_free_request(struct brcmf_fw_request * req)540 static void brcmf_fw_free_request(struct brcmf_fw_request *req)
541 {
542 struct brcmf_fw_item *item;
543 int i;
544
545 for (i = 0, item = &req->items[0]; i < req->n_items; i++, item++) {
546 if (item->type == BRCMF_FW_TYPE_BINARY)
547 release_firmware(item->binary);
548 else if (item->type == BRCMF_FW_TYPE_NVRAM)
549 brcmf_fw_nvram_free(item->nv_data.data);
550 }
551 kfree(req);
552 }
553
brcmf_fw_request_nvram_done(const struct firmware * fw,void * ctx)554 static int brcmf_fw_request_nvram_done(const struct firmware *fw, void *ctx)
555 {
556 struct brcmf_fw *fwctx = ctx;
557 struct brcmf_fw_item *cur;
558 bool free_bcm47xx_nvram = false;
559 bool kfree_nvram = false;
560 u32 nvram_length = 0;
561 void *nvram = NULL;
562 #if defined(__linux__)
563 u8 *data = NULL;
564 #elif defined(__FreeBSD__)
565 const u8 *data = NULL;
566 #endif
567 size_t data_len;
568
569 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
570
571 cur = &fwctx->req->items[fwctx->curpos];
572
573 if (fw && fw->data) {
574 #if defined(__linux__)
575 data = (u8 *)fw->data;
576 #elif defined(__FreeBSD__)
577 data = fw->data;
578 #endif
579 data_len = fw->size;
580 } else {
581 data = bcm47xx_nvram_get_contents(&data_len);
582 if (data) {
583 free_bcm47xx_nvram = true;
584 } else {
585 data = brcmf_fw_nvram_from_efi(&data_len);
586 if (data)
587 kfree_nvram = true;
588 else if (!(cur->flags & BRCMF_FW_REQF_OPTIONAL))
589 goto fail;
590 }
591 }
592
593 if (data)
594 nvram = brcmf_fw_nvram_strip(data, data_len, &nvram_length,
595 fwctx->req->domain_nr,
596 fwctx->req->bus_nr,
597 fwctx->dev);
598
599 if (free_bcm47xx_nvram)
600 bcm47xx_nvram_release_contents(data);
601 if (kfree_nvram)
602 kfree(data);
603
604 release_firmware(fw);
605 if (!nvram && !(cur->flags & BRCMF_FW_REQF_OPTIONAL))
606 goto fail;
607
608 brcmf_dbg(TRACE, "nvram %p len %d\n", nvram, nvram_length);
609 cur->nv_data.data = nvram;
610 cur->nv_data.len = nvram_length;
611 return 0;
612
613 fail:
614 return -ENOENT;
615 }
616
brcmf_fw_complete_request(const struct firmware * fw,struct brcmf_fw * fwctx)617 static int brcmf_fw_complete_request(const struct firmware *fw,
618 struct brcmf_fw *fwctx)
619 {
620 struct brcmf_fw_item *cur = &fwctx->req->items[fwctx->curpos];
621 int ret = 0;
622
623 brcmf_dbg(TRACE, "firmware %s %sfound\n", cur->path, fw ? "" : "not ");
624
625 switch (cur->type) {
626 case BRCMF_FW_TYPE_NVRAM:
627 ret = brcmf_fw_request_nvram_done(fw, fwctx);
628 break;
629 case BRCMF_FW_TYPE_BINARY:
630 if (fw)
631 cur->binary = fw;
632 else
633 ret = -ENOENT;
634 break;
635 default:
636 /* something fishy here so bail out early */
637 brcmf_err("unknown fw type: %d\n", cur->type);
638 release_firmware(fw);
639 ret = -EINVAL;
640 }
641
642 return (cur->flags & BRCMF_FW_REQF_OPTIONAL) ? 0 : ret;
643 }
644
brcm_alt_fw_path(const char * path,const char * board_type)645 static char *brcm_alt_fw_path(const char *path, const char *board_type)
646 {
647 char base[BRCMF_FW_NAME_LEN];
648 const char *suffix;
649 char *ret;
650
651 if (!board_type)
652 return NULL;
653
654 suffix = strrchr(path, '.');
655 if (!suffix || suffix == path)
656 return NULL;
657
658 /* strip extension at the end */
659 strscpy(base, path, BRCMF_FW_NAME_LEN);
660 base[suffix - path] = 0;
661
662 ret = kasprintf(GFP_KERNEL, "%s.%s%s", base, board_type, suffix);
663 if (!ret)
664 brcmf_err("out of memory allocating firmware path for '%s'\n",
665 path);
666
667 brcmf_dbg(TRACE, "FW alt path: %s\n", ret);
668
669 return ret;
670 }
671
brcmf_fw_request_firmware(const struct firmware ** fw,struct brcmf_fw * fwctx)672 static int brcmf_fw_request_firmware(const struct firmware **fw,
673 struct brcmf_fw *fwctx)
674 {
675 struct brcmf_fw_item *cur = &fwctx->req->items[fwctx->curpos];
676 unsigned int i;
677 int ret;
678
679 /* Files can be board-specific, first try board-specific paths */
680 for (i = 0; i < ARRAY_SIZE(fwctx->req->board_types); i++) {
681 char *alt_path;
682
683 if (!fwctx->req->board_types[i])
684 goto fallback;
685 alt_path = brcm_alt_fw_path(cur->path,
686 fwctx->req->board_types[i]);
687 if (!alt_path)
688 goto fallback;
689
690 ret = firmware_request_nowarn(fw, alt_path, fwctx->dev);
691 kfree(alt_path);
692 if (ret == 0)
693 return ret;
694 }
695
696 fallback:
697 return request_firmware(fw, cur->path, fwctx->dev);
698 }
699
brcmf_fw_request_done(const struct firmware * fw,void * ctx)700 static void brcmf_fw_request_done(const struct firmware *fw, void *ctx)
701 {
702 struct brcmf_fw *fwctx = ctx;
703 int ret;
704
705 ret = brcmf_fw_complete_request(fw, fwctx);
706
707 while (ret == 0 && ++fwctx->curpos < fwctx->req->n_items) {
708 brcmf_fw_request_firmware(&fw, fwctx);
709 ret = brcmf_fw_complete_request(fw, ctx);
710 }
711
712 if (ret) {
713 brcmf_fw_free_request(fwctx->req);
714 fwctx->req = NULL;
715 }
716 fwctx->done(fwctx->dev, ret, fwctx->req);
717 kfree(fwctx);
718 }
719
brcmf_fw_request_done_alt_path(const struct firmware * fw,void * ctx)720 static void brcmf_fw_request_done_alt_path(const struct firmware *fw, void *ctx)
721 {
722 struct brcmf_fw *fwctx = ctx;
723 struct brcmf_fw_item *first = &fwctx->req->items[0];
724 const char *board_type, *alt_path;
725 int ret = 0;
726
727 if (fw) {
728 brcmf_fw_request_done(fw, ctx);
729 return;
730 }
731
732 /* Try next board firmware */
733 if (fwctx->board_index < ARRAY_SIZE(fwctx->req->board_types)) {
734 board_type = fwctx->req->board_types[fwctx->board_index++];
735 if (!board_type)
736 goto fallback;
737 alt_path = brcm_alt_fw_path(first->path, board_type);
738 if (!alt_path)
739 goto fallback;
740
741 ret = request_firmware_nowait(THIS_MODULE, true, alt_path,
742 fwctx->dev, GFP_KERNEL, fwctx,
743 brcmf_fw_request_done_alt_path);
744 kfree(alt_path);
745
746 if (ret < 0)
747 brcmf_fw_request_done(fw, ctx);
748 return;
749 }
750
751 fallback:
752 /* Fall back to canonical path if board firmware not found */
753 ret = request_firmware_nowait(THIS_MODULE, true, first->path,
754 fwctx->dev, GFP_KERNEL, fwctx,
755 brcmf_fw_request_done);
756
757 if (ret < 0)
758 brcmf_fw_request_done(fw, ctx);
759 }
760
brcmf_fw_request_is_valid(struct brcmf_fw_request * req)761 static bool brcmf_fw_request_is_valid(struct brcmf_fw_request *req)
762 {
763 struct brcmf_fw_item *item;
764 int i;
765
766 if (!req->n_items)
767 return false;
768
769 for (i = 0, item = &req->items[0]; i < req->n_items; i++, item++) {
770 if (!item->path)
771 return false;
772 }
773 return true;
774 }
775
brcmf_fw_get_firmwares(struct device * dev,struct brcmf_fw_request * req,void (* fw_cb)(struct device * dev,int err,struct brcmf_fw_request * req))776 int brcmf_fw_get_firmwares(struct device *dev, struct brcmf_fw_request *req,
777 void (*fw_cb)(struct device *dev, int err,
778 struct brcmf_fw_request *req))
779 {
780 struct brcmf_fw_item *first = &req->items[0];
781 struct brcmf_fw *fwctx;
782 char *alt_path = NULL;
783 int ret;
784
785 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(dev));
786 if (!fw_cb)
787 return -EINVAL;
788
789 if (!brcmf_fw_request_is_valid(req))
790 return -EINVAL;
791
792 fwctx = kzalloc(sizeof(*fwctx), GFP_KERNEL);
793 if (!fwctx)
794 return -ENOMEM;
795
796 fwctx->dev = dev;
797 fwctx->req = req;
798 fwctx->done = fw_cb;
799
800 /* First try alternative board-specific path if any */
801 if (fwctx->req->board_types[0])
802 alt_path = brcm_alt_fw_path(first->path,
803 fwctx->req->board_types[0]);
804 if (alt_path) {
805 fwctx->board_index++;
806 ret = request_firmware_nowait(THIS_MODULE, true, alt_path,
807 fwctx->dev, GFP_KERNEL, fwctx,
808 brcmf_fw_request_done_alt_path);
809 kfree(alt_path);
810 } else {
811 ret = request_firmware_nowait(THIS_MODULE, true, first->path,
812 fwctx->dev, GFP_KERNEL, fwctx,
813 brcmf_fw_request_done);
814 }
815 if (ret < 0)
816 brcmf_fw_request_done(NULL, fwctx);
817
818 return 0;
819 }
820
821 struct brcmf_fw_request *
brcmf_fw_alloc_request(u32 chip,u32 chiprev,const struct brcmf_firmware_mapping mapping_table[],u32 table_size,struct brcmf_fw_name * fwnames,u32 n_fwnames)822 brcmf_fw_alloc_request(u32 chip, u32 chiprev,
823 const struct brcmf_firmware_mapping mapping_table[],
824 u32 table_size, struct brcmf_fw_name *fwnames,
825 u32 n_fwnames)
826 {
827 struct brcmf_fw_request *fwreq;
828 char chipname[12];
829 const char *mp_path;
830 size_t mp_path_len;
831 u32 i, j;
832 char end = '\0';
833
834 if (chiprev >= BITS_PER_TYPE(u32)) {
835 brcmf_err("Invalid chip revision %u\n", chiprev);
836 return NULL;
837 }
838
839 for (i = 0; i < table_size; i++) {
840 if (mapping_table[i].chipid == chip &&
841 mapping_table[i].revmask & BIT(chiprev))
842 break;
843 }
844
845 brcmf_chip_name(chip, chiprev, chipname, sizeof(chipname));
846
847 if (i == table_size) {
848 brcmf_err("Unknown chip %s\n", chipname);
849 return NULL;
850 }
851
852 fwreq = kzalloc(struct_size(fwreq, items, n_fwnames), GFP_KERNEL);
853 if (!fwreq)
854 return NULL;
855
856 brcmf_info("using %s for chip %s\n",
857 mapping_table[i].fw_base, chipname);
858
859 mp_path = brcmf_mp_global.firmware_path;
860 mp_path_len = strnlen(mp_path, BRCMF_FW_ALTPATH_LEN);
861 if (mp_path_len)
862 end = mp_path[mp_path_len - 1];
863
864 fwreq->n_items = n_fwnames;
865
866 for (j = 0; j < n_fwnames; j++) {
867 fwreq->items[j].path = fwnames[j].path;
868 fwnames[j].path[0] = '\0';
869 /* check if firmware path is provided by module parameter */
870 if (brcmf_mp_global.firmware_path[0] != '\0') {
871 strscpy(fwnames[j].path, mp_path,
872 BRCMF_FW_NAME_LEN);
873
874 if (end != '/') {
875 strlcat(fwnames[j].path, "/",
876 BRCMF_FW_NAME_LEN);
877 }
878 }
879 strlcat(fwnames[j].path, mapping_table[i].fw_base,
880 BRCMF_FW_NAME_LEN);
881 strlcat(fwnames[j].path, fwnames[j].extension,
882 BRCMF_FW_NAME_LEN);
883 fwreq->items[j].path = fwnames[j].path;
884 }
885
886 return fwreq;
887 }
888