2 * Copyright (c) 2013 Broadcom Corporation
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.
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.
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>
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"
34 enum nvram_parser_state {
43 * struct nvram_parser - internal info for parser.
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.
58 enum nvram_parser_state state;
72 * is_nvram_char() - check if char is a valid one for NVRAM entry
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.
77 static bool is_nvram_char(char c)
79 /* comment marker excluded */
83 /* key and value may have any other readable character */
84 return (c >= 0x20 && c < 0x7f);
87 static bool is_whitespace(char c)
89 return (c == ' ' || c == '\r' || c == '\n' || c == '\t');
92 static enum nvram_parser_state brcmf_nvram_handle_idle(struct nvram_parser *nvp)
96 c = nvp->data[nvp->pos];
99 if (is_whitespace(c) || c == '\0')
103 if (is_nvram_char(c)) {
104 nvp->entry = nvp->pos;
107 brcmf_dbg(INFO, "warning: ln=%d:col=%d: ignoring invalid character\n",
108 nvp->line, nvp->column);
115 static enum nvram_parser_state brcmf_nvram_handle_key(struct nvram_parser *nvp)
117 enum nvram_parser_state st = nvp->state;
120 c = nvp->data[nvp->pos];
122 /* ignore RAW1 by treating as comment */
123 if (strncmp(&nvp->data[nvp->entry], "RAW1", 4) == 0)
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);
144 static enum nvram_parser_state
145 brcmf_nvram_handle_value(struct nvram_parser *nvp)
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];
158 if (nvp->nvram_len + cplen + 1 >= BRCMF_FW_MAX_NVRAM_SIZE)
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';
172 static enum nvram_parser_state
173 brcmf_nvram_handle_comment(struct nvram_parser *nvp)
177 sol = (char *)&nvp->data[nvp->pos];
178 eoc = strchr(sol, '\n');
180 eoc = strchr(sol, '\0');
185 /* eat all moving to next line */
188 nvp->pos += (eoc - sol) + 1;
192 static enum nvram_parser_state brcmf_nvram_handle_end(struct nvram_parser *nvp)
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
207 static int brcmf_init_nvram_parser(struct nvram_parser *nvp,
208 const u8 *data, size_t data_len)
212 memset(nvp, 0, sizeof(*nvp));
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;
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);
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.
237 static void brcmf_fw_strip_multi_v1(struct nvram_parser *nvp, u16 domain_nr,
240 /* Device path with a leading '=' key-value separator */
241 char pci_path[] = "=pci/?/?";
243 char pcie_path[] = "=pcie/?/?";
251 nvram = kzalloc(nvp->nvram_len + 1 + 3 + sizeof(u32), GFP_KERNEL);
255 /* min length: devpath0=pcie/1/4/ + 0:x=y */
256 if (nvp->nvram_len < BRCMF_FW_NVRAM_DEVPATH_LEN + 6)
259 /* First search for the devpathX and see if it is the configuration
260 * for domain_nr/bus_nr. Search complete nvp
262 snprintf(pci_path, sizeof(pci_path), "=pci/%d/%d", domain_nr,
264 pci_len = strlen(pci_path);
265 snprintf(pcie_path, sizeof(pcie_path), "=pcie/%d/%d", domain_nr,
267 pcie_len = strlen(pcie_path);
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
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';
281 while (nvp->nvram[i] != 0)
288 /* Now copy all valid entries, release old nvram and assign new one */
291 while (i < nvp->nvram_len) {
292 if ((nvp->nvram[i] - '0' == id) && (nvp->nvram[i + 1] == ':')) {
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];
304 while (nvp->nvram[i] != 0)
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:
324 static void brcmf_fw_strip_multi_v2(struct nvram_parser *nvp, u16 domain_nr,
327 char prefix[BRCMF_FW_NVRAM_PCIEDEV_LEN];
332 nvram = kzalloc(nvp->nvram_len + 1 + 3 + sizeof(u32), GFP_KERNEL);
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
340 snprintf(prefix, sizeof(prefix), "pcie/%d/%d/", domain_nr, bus_nr);
341 len = strlen(prefix);
344 while (i < nvp->nvram_len - len) {
345 if (strncmp(&nvp->nvram[i], prefix, len) == 0) {
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];
357 while (nvp->nvram[i] != 0)
370 static void brcmf_fw_add_defaults(struct nvram_parser *nvp)
372 if (nvp->boardrev_found)
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';
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.
387 static void *brcmf_fw_nvram_strip(const u8 *data, size_t data_len,
388 u32 *new_length, u16 domain_nr, u16 bus_nr)
390 struct nvram_parser nvp;
395 if (brcmf_init_nvram_parser(&nvp, data, data_len) < 0)
398 while (nvp.pos < data_len) {
399 nvp.state = nv_parser_states[nvp.state](&nvp);
400 if (nvp.state == END)
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);
411 if (nvp.nvram_len == 0) {
416 brcmf_fw_add_defaults(&nvp);
419 *new_length = roundup(nvp.nvram_len + 1, 4);
420 while (pad != *new_length) {
425 token = *new_length / 4;
426 token = (~token << 16) | (token & 0x0000FFFF);
427 token_le = cpu_to_le32(token);
429 memcpy(&nvp.nvram[*new_length], &token_le, sizeof(token_le));
430 *new_length += sizeof(token_le);
435 void brcmf_fw_nvram_free(void *nvram)
443 const struct firmware *code;
444 const char *nvram_name;
447 void (*done)(struct device *dev, int err, const struct firmware *fw,
448 void *nvram_image, u32 nvram_len);
451 static void brcmf_fw_request_nvram_done(const struct firmware *fw, void *ctx)
453 struct brcmf_fw *fwctx = ctx;
454 u32 nvram_length = 0;
460 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
461 if (fw && fw->data) {
462 data = (u8 *)fw->data;
466 data = bcm47xx_nvram_get_contents(&data_len);
467 if (!data && !(fwctx->flags & BRCMF_FW_REQ_NV_OPTIONAL))
473 nvram = brcmf_fw_nvram_strip(data, data_len, &nvram_length,
474 fwctx->domain_nr, fwctx->bus_nr);
477 bcm47xx_nvram_release_contents(data);
478 release_firmware(fw);
479 if (!nvram && !(fwctx->flags & BRCMF_FW_REQ_NV_OPTIONAL))
482 fwctx->done(fwctx->dev, 0, fwctx->code, nvram, nvram_length);
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);
493 static void brcmf_fw_request_code_done(const struct firmware *fw, void *ctx)
495 struct brcmf_fw *fwctx = ctx;
498 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(fwctx->dev));
503 /* only requested code so done here */
504 if (!(fwctx->flags & BRCMF_FW_REQUEST_NVRAM))
508 ret = reject_firmware_nowait(THIS_MODULE, true, fwctx->nvram_name,
509 fwctx->dev, GFP_KERNEL, fwctx,
510 brcmf_fw_request_nvram_done);
512 /* pass NULL to nvram callback for bcm47xx fallback */
514 brcmf_fw_request_nvram_done(NULL, fwctx);
518 brcmf_dbg(TRACE, "failed: dev=%s\n", dev_name(fwctx->dev));
520 fwctx->done(fwctx->dev, ret, fw, NULL, 0);
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)
531 struct brcmf_fw *fwctx;
533 brcmf_dbg(TRACE, "enter: dev=%s\n", dev_name(dev));
537 if ((flags & BRCMF_FW_REQUEST_NVRAM) && !nvram)
540 fwctx = kzalloc(sizeof(*fwctx), GFP_KERNEL);
545 fwctx->flags = flags;
547 if (flags & BRCMF_FW_REQUEST_NVRAM)
548 fwctx->nvram_name = nvram;
549 fwctx->domain_nr = domain_nr;
550 fwctx->bus_nr = bus_nr;
552 return reject_firmware_nowait(THIS_MODULE, true, code, dev,
554 brcmf_fw_request_code_done);
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))
563 return brcmf_fw_get_firmwares_pcie(dev, flags, code, nvram, fw_cb, 0,
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])
575 if (chiprev >= BITS_PER_TYPE(u32)) {
576 brcmf_err("Invalid chip revision %u\n", chiprev);
580 for (i = 0; i < table_size; i++) {
581 if (mapping_table[i].chipid == chip &&
582 mapping_table[i].revmask & BIT(chiprev))
586 if (i == table_size) {
587 brcmf_err("Unknown chipid %d [%d]\n", chip, chiprev);
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,
595 if ((nvram_name) && (mapping_table[i].nvram))
596 strlcpy(nvram_name, brcmf_mp_global.firmware_path,
599 end = brcmf_mp_global.firmware_path[
600 strlen(brcmf_mp_global.firmware_path) - 1];
602 strlcat(fw_name, "/", BRCMF_FW_NAME_LEN);
603 if ((nvram_name) && (mapping_table[i].nvram))
604 strlcat(nvram_name, "/", BRCMF_FW_NAME_LEN);
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);
611 brcmf_info("using %s for chip %#08x(%d) rev %#08x\n",
612 fw_name, chip, chip, chiprev);