GNU Linux-libre 4.14.328-gnu1
[releases.git] / drivers / net / wireless / broadcom / brcm80211 / brcmfmac / firmware.c
1 /*
2  * Copyright (c) 2013 Broadcom Corporation
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16
17 #include <linux/kernel.h>
18 #include <linux/slab.h>
19 #include <linux/device.h>
20 #include <linux/firmware.h>
21 #include <linux/module.h>
22 #include <linux/bcm47xx_nvram.h>
23
24 #include "debug.h"
25 #include "firmware.h"
26 #include "core.h"
27 #include "common.h"
28
29 #define BRCMF_FW_MAX_NVRAM_SIZE                 64000
30 #define BRCMF_FW_NVRAM_DEVPATH_LEN              19      /* devpath0=pcie/1/4/ */
31 #define BRCMF_FW_NVRAM_PCIEDEV_LEN              10      /* pcie/1/4/ + \0 */
32 #define BRCMF_FW_DEFAULT_BOARDREV               "boardrev=0xff"
33
34 enum nvram_parser_state {
35         IDLE,
36         KEY,
37         VALUE,
38         COMMENT,
39         END
40 };
41
42 /**
43  * struct nvram_parser - internal info for parser.
44  *
45  * @state: current parser state.
46  * @data: input buffer being parsed.
47  * @nvram: output buffer with parse result.
48  * @nvram_len: lenght of parse result.
49  * @line: current line.
50  * @column: current column in line.
51  * @pos: byte offset in input buffer.
52  * @entry: start position of key,value entry.
53  * @multi_dev_v1: detect pcie multi device v1 (compressed).
54  * @multi_dev_v2: detect pcie multi device v2.
55  * @boardrev_found: nvram contains boardrev information.
56  */
57 struct nvram_parser {
58         enum nvram_parser_state state;
59         const u8 *data;
60         u8 *nvram;
61         u32 nvram_len;
62         u32 line;
63         u32 column;
64         u32 pos;
65         u32 entry;
66         bool multi_dev_v1;
67         bool multi_dev_v2;
68         bool boardrev_found;
69 };
70
71 /**
72  * is_nvram_char() - check if char is a valid one for NVRAM entry
73  *
74  * It accepts all printable ASCII chars except for '#' which opens a comment.
75  * Please note that ' ' (space) while accepted is not a valid key name char.
76  */
77 static bool is_nvram_char(char c)
78 {
79         /* comment marker excluded */
80         if (c == '#')
81                 return false;
82
83         /* key and value may have any other readable character */
84         return (c >= 0x20 && c < 0x7f);
85 }
86
87 static bool is_whitespace(char c)
88 {
89         return (c == ' ' || c == '\r' || c == '\n' || c == '\t');
90 }
91
92 static enum nvram_parser_state brcmf_nvram_handle_idle(struct nvram_parser *nvp)
93 {
94         char c;
95
96         c = nvp->data[nvp->pos];
97         if (c == '\n')
98                 return COMMENT;
99         if (is_whitespace(c) || c == '\0')
100                 goto proceed;
101         if (c == '#')
102                 return COMMENT;
103         if (is_nvram_char(c)) {
104                 nvp->entry = nvp->pos;
105                 return KEY;
106         }
107         brcmf_dbg(INFO, "warning: ln=%d:col=%d: ignoring invalid character\n",
108                   nvp->line, nvp->column);
109 proceed:
110         nvp->column++;
111         nvp->pos++;
112         return IDLE;
113 }
114
115 static enum nvram_parser_state brcmf_nvram_handle_key(struct nvram_parser *nvp)
116 {
117         enum nvram_parser_state st = nvp->state;
118         char c;
119
120         c = nvp->data[nvp->pos];
121         if (c == '=') {
122                 /* ignore RAW1 by treating as comment */
123                 if (strncmp(&nvp->data[nvp->entry], "RAW1", 4) == 0)
124                         st = COMMENT;
125                 else
126                         st = VALUE;
127                 if (strncmp(&nvp->data[nvp->entry], "devpath", 7) == 0)
128                         nvp->multi_dev_v1 = true;
129                 if (strncmp(&nvp->data[nvp->entry], "pcie/", 5) == 0)
130                         nvp->multi_dev_v2 = true;
131                 if (strncmp(&nvp->data[nvp->entry], "boardrev", 8) == 0)
132                         nvp->boardrev_found = true;
133         } else if (!is_nvram_char(c) || c == ' ') {
134                 brcmf_dbg(INFO, "warning: ln=%d:col=%d: '=' expected, skip invalid key entry\n",
135                           nvp->line, nvp->column);
136                 return COMMENT;
137         }
138
139         nvp->column++;
140         nvp->pos++;
141         return st;
142 }
143
144 static enum nvram_parser_state
145 brcmf_nvram_handle_value(struct nvram_parser *nvp)
146 {
147         char c;
148         char *skv;
149         char *ekv;
150         u32 cplen;
151
152         c = nvp->data[nvp->pos];
153         if (!is_nvram_char(c)) {
154                 /* key,value pair complete */
155                 ekv = (u8 *)&nvp->data[nvp->pos];
156                 skv = (u8 *)&nvp->data[nvp->entry];
157                 cplen = ekv - skv;
158                 if (nvp->nvram_len + cplen + 1 >= BRCMF_FW_MAX_NVRAM_SIZE)
159                         return END;
160                 /* copy to output buffer */
161                 memcpy(&nvp->nvram[nvp->nvram_len], skv, cplen);
162                 nvp->nvram_len += cplen;
163                 nvp->nvram[nvp->nvram_len] = '\0';
164                 nvp->nvram_len++;
165                 return IDLE;
166         }
167         nvp->pos++;
168         nvp->column++;
169         return VALUE;
170 }
171
172 static enum nvram_parser_state
173 brcmf_nvram_handle_comment(struct nvram_parser *nvp)
174 {
175         char *eoc, *sol;
176
177         sol = (char *)&nvp->data[nvp->pos];
178         eoc = strchr(sol, '\n');
179         if (!eoc) {
180                 eoc = strchr(sol, '\0');
181                 if (!eoc)
182                         return END;
183         }
184
185         /* eat all moving to next line */
186         nvp->line++;
187         nvp->column = 1;
188         nvp->pos += (eoc - sol) + 1;
189         return IDLE;
190 }
191
192 static enum nvram_parser_state brcmf_nvram_handle_end(struct nvram_parser *nvp)
193 {
194         /* final state */
195         return END;
196 }
197
198 static enum nvram_parser_state
199 (*nv_parser_states[])(struct nvram_parser *nvp) = {
200         brcmf_nvram_handle_idle,
201         brcmf_nvram_handle_key,
202         brcmf_nvram_handle_value,
203         brcmf_nvram_handle_comment,
204         brcmf_nvram_handle_end
205 };
206
207 static int brcmf_init_nvram_parser(struct nvram_parser *nvp,
208                                    const u8 *data, size_t data_len)
209 {
210         size_t size;
211
212         memset(nvp, 0, sizeof(*nvp));
213         nvp->data = data;
214         /* Limit size to MAX_NVRAM_SIZE, some files contain lot of comment */
215         if (data_len > BRCMF_FW_MAX_NVRAM_SIZE)
216                 size = BRCMF_FW_MAX_NVRAM_SIZE;
217         else
218                 size = data_len;
219         /* Add space for properties we may add */
220         size += strlen(BRCMF_FW_DEFAULT_BOARDREV) + 1;
221         /* Alloc for extra 0 byte + roundup by 4 + length field */
222         size += 1 + 3 + sizeof(u32);
223         nvp->nvram = kzalloc(size, GFP_KERNEL);
224         if (!nvp->nvram)
225                 return -ENOMEM;
226
227         nvp->line = 1;
228         nvp->column = 1;
229         return 0;
230 }
231
232 /* brcmf_fw_strip_multi_v1 :Some nvram files contain settings for multiple
233  * devices. Strip it down for one device, use domain_nr/bus_nr to determine
234  * which data is to be returned. v1 is the version where nvram is stored
235  * compressed and "devpath" maps to index for valid entries.
236  */
237 static void brcmf_fw_strip_multi_v1(struct nvram_parser *nvp, u16 domain_nr,
238                                     u16 bus_nr)
239 {
240         /* Device path with a leading '=' key-value separator */
241         char pci_path[] = "=pci/?/?";
242         size_t pci_len;
243         char pcie_path[] = "=pcie/?/?";
244         size_t pcie_len;
245
246         u32 i, j;
247         bool found;
248         u8 *nvram;
249         u8 id;
250
251         nvram = kzalloc(nvp->nvram_len + 1 + 3 + sizeof(u32), GFP_KERNEL);
252         if (!nvram)
253                 goto fail;
254
255         /* min length: devpath0=pcie/1/4/ + 0:x=y */
256         if (nvp->nvram_len < BRCMF_FW_NVRAM_DEVPATH_LEN + 6)
257                 goto fail;
258
259         /* First search for the devpathX and see if it is the configuration
260          * for domain_nr/bus_nr. Search complete nvp
261          */
262         snprintf(pci_path, sizeof(pci_path), "=pci/%d/%d", domain_nr,
263                  bus_nr);
264         pci_len = strlen(pci_path);
265         snprintf(pcie_path, sizeof(pcie_path), "=pcie/%d/%d", domain_nr,
266                  bus_nr);
267         pcie_len = strlen(pcie_path);
268         found = false;
269         i = 0;
270         while (i < nvp->nvram_len - BRCMF_FW_NVRAM_DEVPATH_LEN) {
271                 /* Format: devpathX=pcie/Y/Z/
272                  * Y = domain_nr, Z = bus_nr, X = virtual ID
273                  */
274                 if (strncmp(&nvp->nvram[i], "devpath", 7) == 0 &&
275                     (!strncmp(&nvp->nvram[i + 8], pci_path, pci_len) ||
276                      !strncmp(&nvp->nvram[i + 8], pcie_path, pcie_len))) {
277                         id = nvp->nvram[i + 7] - '0';
278                         found = true;
279                         break;
280                 }
281                 while (nvp->nvram[i] != 0)
282                         i++;
283                 i++;
284         }
285         if (!found)
286                 goto fail;
287
288         /* Now copy all valid entries, release old nvram and assign new one */
289         i = 0;
290         j = 0;
291         while (i < nvp->nvram_len) {
292                 if ((nvp->nvram[i] - '0' == id) && (nvp->nvram[i + 1] == ':')) {
293                         i += 2;
294                         if (strncmp(&nvp->nvram[i], "boardrev", 8) == 0)
295                                 nvp->boardrev_found = true;
296                         while (nvp->nvram[i] != 0) {
297                                 nvram[j] = nvp->nvram[i];
298                                 i++;
299                                 j++;
300                         }
301                         nvram[j] = 0;
302                         j++;
303                 }
304                 while (nvp->nvram[i] != 0)
305                         i++;
306                 i++;
307         }
308         kfree(nvp->nvram);
309         nvp->nvram = nvram;
310         nvp->nvram_len = j;
311         return;
312
313 fail:
314         kfree(nvram);
315         nvp->nvram_len = 0;
316 }
317
318 /* brcmf_fw_strip_multi_v2 :Some nvram files contain settings for multiple
319  * devices. Strip it down for one device, use domain_nr/bus_nr to determine
320  * which data is to be returned. v2 is the version where nvram is stored
321  * uncompressed, all relevant valid entries are identified by
322  * pcie/domain_nr/bus_nr:
323  */
324 static void brcmf_fw_strip_multi_v2(struct nvram_parser *nvp, u16 domain_nr,
325                                     u16 bus_nr)
326 {
327         char prefix[BRCMF_FW_NVRAM_PCIEDEV_LEN];
328         size_t len;
329         u32 i, j;
330         u8 *nvram;
331
332         nvram = kzalloc(nvp->nvram_len + 1 + 3 + sizeof(u32), GFP_KERNEL);
333         if (!nvram)
334                 goto fail;
335
336         /* Copy all valid entries, release old nvram and assign new one.
337          * Valid entries are of type pcie/X/Y/ where X = domain_nr and
338          * Y = bus_nr.
339          */
340         snprintf(prefix, sizeof(prefix), "pcie/%d/%d/", domain_nr, bus_nr);
341         len = strlen(prefix);
342         i = 0;
343         j = 0;
344         while (i < nvp->nvram_len - len) {
345                 if (strncmp(&nvp->nvram[i], prefix, len) == 0) {
346                         i += len;
347                         if (strncmp(&nvp->nvram[i], "boardrev", 8) == 0)
348                                 nvp->boardrev_found = true;
349                         while (nvp->nvram[i] != 0) {
350                                 nvram[j] = nvp->nvram[i];
351                                 i++;
352                                 j++;
353                         }
354                         nvram[j] = 0;
355                         j++;
356                 }
357                 while (nvp->nvram[i] != 0)
358                         i++;
359                 i++;
360         }
361         kfree(nvp->nvram);
362         nvp->nvram = nvram;
363         nvp->nvram_len = j;
364         return;
365 fail:
366         kfree(nvram);
367         nvp->nvram_len = 0;
368 }
369
370 static void brcmf_fw_add_defaults(struct nvram_parser *nvp)
371 {
372         if (nvp->boardrev_found)
373                 return;
374
375         memcpy(&nvp->nvram[nvp->nvram_len], &BRCMF_FW_DEFAULT_BOARDREV,
376                strlen(BRCMF_FW_DEFAULT_BOARDREV));
377         nvp->nvram_len += strlen(BRCMF_FW_DEFAULT_BOARDREV);
378         nvp->nvram[nvp->nvram_len] = '\0';
379         nvp->nvram_len++;
380 }
381
382 /* brcmf_nvram_strip :Takes a buffer of "<var>=<value>\n" lines read from a fil
383  * and ending in a NUL. Removes carriage returns, empty lines, comment lines,
384  * and converts newlines to NULs. Shortens buffer as needed and pads with NULs.
385  * End of buffer is completed with token identifying length of buffer.
386  */
387 static void *brcmf_fw_nvram_strip(const u8 *data, size_t data_len,
388                                   u32 *new_length, u16 domain_nr, u16 bus_nr)
389 {
390         struct nvram_parser nvp;
391         u32 pad;
392         u32 token;
393         __le32 token_le;
394
395         if (brcmf_init_nvram_parser(&nvp, data, data_len) < 0)
396                 return NULL;
397
398         while (nvp.pos < data_len) {
399                 nvp.state = nv_parser_states[nvp.state](&nvp);
400                 if (nvp.state == END)
401                         break;
402         }
403         if (nvp.multi_dev_v1) {
404                 nvp.boardrev_found = false;
405                 brcmf_fw_strip_multi_v1(&nvp, domain_nr, bus_nr);
406         } else if (nvp.multi_dev_v2) {
407                 nvp.boardrev_found = false;
408                 brcmf_fw_strip_multi_v2(&nvp, domain_nr, bus_nr);
409         }
410
411         if (nvp.nvram_len == 0) {
412                 kfree(nvp.nvram);
413                 return NULL;
414         }
415
416         brcmf_fw_add_defaults(&nvp);
417
418         pad = nvp.nvram_len;
419         *new_length = roundup(nvp.nvram_len + 1, 4);
420         while (pad != *new_length) {
421                 nvp.nvram[pad] = 0;
422                 pad++;
423         }
424
425         token = *new_length / 4;
426         token = (~token << 16) | (token & 0x0000FFFF);
427         token_le = cpu_to_le32(token);
428
429         memcpy(&nvp.nvram[*new_length], &token_le, sizeof(token_le));
430         *new_length += sizeof(token_le);
431
432         return nvp.nvram;
433 }
434
435 void brcmf_fw_nvram_free(void *nvram)
436 {
437         kfree(nvram);
438 }
439
440 struct brcmf_fw {
441         struct device *dev;
442         u16 flags;
443         const struct firmware *code;
444         const char *nvram_name;
445         u16 domain_nr;
446         u16 bus_nr;
447         void (*done)(struct device *dev, int err, const struct firmware *fw,
448                      void *nvram_image, u32 nvram_len);
449 };
450
451 static void brcmf_fw_request_nvram_done(const struct firmware *fw, void *ctx)
452 {
453         struct brcmf_fw *fwctx = ctx;
454         u32 nvram_length = 0;
455         void *nvram = NULL;
456         u8 *data = NULL;
457         size_t data_len;
458         bool raw_nvram;
459
460         brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
461         if (fw && fw->data) {
462                 data = (u8 *)fw->data;
463                 data_len = fw->size;
464                 raw_nvram = false;
465         } else {
466                 data = bcm47xx_nvram_get_contents(&data_len);
467                 if (!data && !(fwctx->flags & BRCMF_FW_REQ_NV_OPTIONAL))
468                         goto fail;
469                 raw_nvram = true;
470         }
471
472         if (data)
473                 nvram = brcmf_fw_nvram_strip(data, data_len, &nvram_length,
474                                              fwctx->domain_nr, fwctx->bus_nr);
475
476         if (raw_nvram)
477                 bcm47xx_nvram_release_contents(data);
478         release_firmware(fw);
479         if (!nvram && !(fwctx->flags & BRCMF_FW_REQ_NV_OPTIONAL))
480                 goto fail;
481
482         fwctx->done(fwctx->dev, 0, fwctx->code, nvram, nvram_length);
483         kfree(fwctx);
484         return;
485
486 fail:
487         brcmf_dbg(TRACE, "failed: dev=%s\n", dev_name(fwctx->dev));
488         release_firmware(fwctx->code);
489         fwctx->done(fwctx->dev, -ENOENT, NULL, NULL, 0);
490         kfree(fwctx);
491 }
492
493 static void brcmf_fw_request_code_done(const struct firmware *fw, void *ctx)
494 {
495         struct brcmf_fw *fwctx = ctx;
496         int ret = 0;
497
498         brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
499         if (!fw) {
500                 ret = -ENOENT;
501                 goto fail;
502         }
503         /* only requested code so done here */
504         if (!(fwctx->flags & BRCMF_FW_REQUEST_NVRAM))
505                 goto done;
506
507         fwctx->code = fw;
508         ret = reject_firmware_nowait(THIS_MODULE, true, fwctx->nvram_name,
509                                       fwctx->dev, GFP_KERNEL, fwctx,
510                                       brcmf_fw_request_nvram_done);
511
512         /* pass NULL to nvram callback for bcm47xx fallback */
513         if (ret)
514                 brcmf_fw_request_nvram_done(NULL, fwctx);
515         return;
516
517 fail:
518         brcmf_dbg(TRACE, "failed: dev=%s\n", dev_name(fwctx->dev));
519 done:
520         fwctx->done(fwctx->dev, ret, fw, NULL, 0);
521         kfree(fwctx);
522 }
523
524 int brcmf_fw_get_firmwares_pcie(struct device *dev, u16 flags,
525                                 const char *code, const char *nvram,
526                                 void (*fw_cb)(struct device *dev, int err,
527                                               const struct firmware *fw,
528                                               void *nvram_image, u32 nvram_len),
529                                 u16 domain_nr, u16 bus_nr)
530 {
531         struct brcmf_fw *fwctx;
532
533         brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(dev));
534         if (!fw_cb || !code)
535                 return -EINVAL;
536
537         if ((flags & BRCMF_FW_REQUEST_NVRAM) && !nvram)
538                 return -EINVAL;
539
540         fwctx = kzalloc(sizeof(*fwctx), GFP_KERNEL);
541         if (!fwctx)
542                 return -ENOMEM;
543
544         fwctx->dev = dev;
545         fwctx->flags = flags;
546         fwctx->done = fw_cb;
547         if (flags & BRCMF_FW_REQUEST_NVRAM)
548                 fwctx->nvram_name = nvram;
549         fwctx->domain_nr = domain_nr;
550         fwctx->bus_nr = bus_nr;
551
552         return reject_firmware_nowait(THIS_MODULE, true, code, dev,
553                                        GFP_KERNEL, fwctx,
554                                        brcmf_fw_request_code_done);
555 }
556
557 int brcmf_fw_get_firmwares(struct device *dev, u16 flags,
558                            const char *code, const char *nvram,
559                            void (*fw_cb)(struct device *dev, int err,
560                                          const struct firmware *fw,
561                                          void *nvram_image, u32 nvram_len))
562 {
563         return brcmf_fw_get_firmwares_pcie(dev, flags, code, nvram, fw_cb, 0,
564                                            0);
565 }
566
567 int brcmf_fw_map_chip_to_name(u32 chip, u32 chiprev,
568                               struct brcmf_firmware_mapping mapping_table[],
569                               u32 table_size, char fw_name[BRCMF_FW_NAME_LEN],
570                               char nvram_name[BRCMF_FW_NAME_LEN])
571 {
572         u32 i;
573         char end;
574
575         if (chiprev >= BITS_PER_TYPE(u32)) {
576                 brcmf_err("Invalid chip revision %u\n", chiprev);
577                 return -EINVAL;
578         }
579
580         for (i = 0; i < table_size; i++) {
581                 if (mapping_table[i].chipid == chip &&
582                     mapping_table[i].revmask & BIT(chiprev))
583                         break;
584         }
585
586         if (i == table_size) {
587                 brcmf_err("Unknown chipid %d [%d]\n", chip, chiprev);
588                 return -ENODEV;
589         }
590
591         /* check if firmware path is provided by module parameter */
592         if (brcmf_mp_global.firmware_path[0] != '\0') {
593                 strlcpy(fw_name, brcmf_mp_global.firmware_path,
594                         BRCMF_FW_NAME_LEN);
595                 if ((nvram_name) && (mapping_table[i].nvram))
596                         strlcpy(nvram_name, brcmf_mp_global.firmware_path,
597                                 BRCMF_FW_NAME_LEN);
598
599                 end = brcmf_mp_global.firmware_path[
600                                 strlen(brcmf_mp_global.firmware_path) - 1];
601                 if (end != '/') {
602                         strlcat(fw_name, "/", BRCMF_FW_NAME_LEN);
603                         if ((nvram_name) && (mapping_table[i].nvram))
604                                 strlcat(nvram_name, "/", BRCMF_FW_NAME_LEN);
605                 }
606         }
607         strlcat(fw_name, mapping_table[i].fw, BRCMF_FW_NAME_LEN);
608         if ((nvram_name) && (mapping_table[i].nvram))
609                 strlcat(nvram_name, mapping_table[i].nvram, BRCMF_FW_NAME_LEN);
610
611         brcmf_info("using %s for chip %#08x(%d) rev %#08x\n",
612                    fw_name, chip, chip, chiprev);
613
614         return 0;
615 }
616