drivers/firmware/broadcom/bcm47xx_nvram.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * BCM947xx nvram variable access
   4  *
   5  * Copyright (C) 2005 Broadcom Corporation
   6  * Copyright (C) 2006 Felix Fietkau <nbd@openwrt.org>
   7  * Copyright (C) 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
   8  */
   9
  10 #include <linux/io.h>
  11 #include <linux/types.h>
  12 #include <linux/module.h>
  13 #include <linux/kernel.h>
  14 #include <linux/string.h>
  15 #include <linux/mtd/mtd.h>
  16 #include <linux/bcm47xx_nvram.h>
  17
  18 #define NVRAM_MAGIC                     0x48534C46      /* 'FLSH' */
  19 #define NVRAM_SPACE                     0x10000
  20 #define NVRAM_MAX_GPIO_ENTRIES          32
  21 #define NVRAM_MAX_GPIO_VALUE_LEN        30
  22
  23 #define FLASH_MIN               0x00020000      /* Minimum flash size */
  24
  25 struct nvram_header {
  26         u32 magic;
  27         u32 len;
  28         u32 crc_ver_init;       /* 0:7 crc, 8:15 ver, 16:31 sdram_init */
  29         u32 config_refresh;     /* 0:15 sdram_config, 16:31 sdram_refresh */
  30         u32 config_ncdl;        /* ncdl values for memc */
  31 };
  32
  33 static char nvram_buf[NVRAM_SPACE];
  34 static size_t nvram_len;
  35 static const u32 nvram_sizes[] = {0x6000, 0x8000, 0xF000, 0x10000};
  36
  37 /**
  38  * bcm47xx_nvram_is_valid - check for a valid NVRAM at specified memory
  39  */
  40 static bool bcm47xx_nvram_is_valid(void __iomem *nvram)
  41 {
  42         return ((struct nvram_header *)nvram)->magic == NVRAM_MAGIC;
  43 }
  44
  45 static u32 find_nvram_size(void __iomem *end)
  46 {
  47         int i;
  48
  49         for (i = 0; i < ARRAY_SIZE(nvram_sizes); i++) {
  50                 if (bcm47xx_nvram_is_valid(end - nvram_sizes[i]))
  51                         return nvram_sizes[i];
  52         }
  53
  54         return 0;
  55 }
  56
  57 /**
  58  * bcm47xx_nvram_copy - copy NVRAM to internal buffer
  59  */
  60 static void bcm47xx_nvram_copy(void __iomem *nvram_start, size_t res_size)
  61 {
  62         struct nvram_header __iomem *header = nvram_start;
  63         size_t copy_size;
  64
  65         copy_size = header->len;
  66         if (copy_size > res_size) {
  67                 pr_err("The nvram size according to the header seems to be bigger than the partition on flash\n");
  68                 copy_size = res_size;
  69         }
  70         if (copy_size >= NVRAM_SPACE) {
  71                 pr_err("nvram on flash (%zu bytes) is bigger than the reserved space in memory, will just copy the first %i bytes\n",
  72                        copy_size, NVRAM_SPACE - 1);
  73                 copy_size = NVRAM_SPACE - 1;
  74         }
  75
  76         __ioread32_copy(nvram_buf, nvram_start, DIV_ROUND_UP(copy_size, 4));
  77         nvram_buf[NVRAM_SPACE - 1] = '\0';
  78         nvram_len = copy_size;
  79 }
  80
  81 /**
  82  * bcm47xx_nvram_find_and_copy - find NVRAM on flash mapping & copy it
  83  */
  84 static int bcm47xx_nvram_find_and_copy(void __iomem *flash_start, size_t res_size)
  85 {
  86         size_t flash_size;
  87         size_t offset;
  88         u32 size;
  89
  90         if (nvram_len) {
  91                 pr_warn("nvram already initialized\n");
  92                 return -EEXIST;
  93         }
  94
  95         /* TODO: when nvram is on nand flash check for bad blocks first. */
  96         for (flash_size = FLASH_MIN; flash_size <= res_size; flash_size <<= 1) {
  97                 /* Windowed flash access */
  98                 size = find_nvram_size(flash_start + flash_size);
  99                 if (size) {
 100                         offset = flash_size - size;
 101                         goto found;
 102                 }
 103         }
 104
 105         /* Try embedded NVRAM at 4 KB and 1 KB as last resorts */
 106
 107         offset = 4096;
 108         if (bcm47xx_nvram_is_valid(flash_start + offset))
 109                 goto found;
 110
 111         offset = 1024;
 112         if (bcm47xx_nvram_is_valid(flash_start + offset))
 113                 goto found;
 114
 115         pr_err("no nvram found\n");
 116         return -ENXIO;
 117
 118 found:
 119         bcm47xx_nvram_copy(flash_start + offset, res_size - offset);
 120
 121         return 0;
 122 }
 123
 124 /*
 125  * On bcm47xx we need access to the NVRAM very early, so we can't use mtd
 126  * subsystem to access flash. We can't even use platform device / driver to
 127  * store memory offset.
 128  * To handle this we provide following symbol. It's supposed to be called as
 129  * soon as we get info about flash device, before any NVRAM entry is needed.
 130  */
 131 int bcm47xx_nvram_init_from_mem(u32 base, u32 lim)
 132 {
 133         void __iomem *iobase;
 134         int err;
 135
 136         iobase = ioremap(base, lim);
 137         if (!iobase)
 138                 return -ENOMEM;
 139
 140         err = bcm47xx_nvram_find_and_copy(iobase, lim);
 141
 142         iounmap(iobase);
 143
 144         return err;
 145 }
 146
 147 static int nvram_init(void)
 148 {
 149 #ifdef CONFIG_MTD
 150         struct mtd_info *mtd;
 151         struct nvram_header header;
 152         size_t bytes_read;
 153         int err;
 154
 155         mtd = get_mtd_device_nm("nvram");
 156         if (IS_ERR(mtd))
 157                 return -ENODEV;
 158
 159         err = mtd_read(mtd, 0, sizeof(header), &bytes_read, (uint8_t *)&header);
 160         if (!err && header.magic == NVRAM_MAGIC &&
 161             header.len > sizeof(header)) {
 162                 nvram_len = header.len;
 163                 if (nvram_len >= NVRAM_SPACE) {
 164                         pr_err("nvram on flash (%zu bytes) is bigger than the reserved space in memory, will just copy the first %i bytes\n",
 165                                 nvram_len, NVRAM_SPACE);
 166                         nvram_len = NVRAM_SPACE - 1;
 167                 }
 168
 169                 err = mtd_read(mtd, 0, nvram_len, &nvram_len,
 170                                (u8 *)nvram_buf);
 171                 return err;
 172         }
 173 #endif
 174
 175         return -ENXIO;
 176 }
 177
 178 int bcm47xx_nvram_getenv(const char *name, char *val, size_t val_len)
 179 {
 180         char *var, *value, *end, *eq;
 181         int err;
 182
 183         if (!name)
 184                 return -EINVAL;
 185
 186         if (!nvram_len) {
 187                 err = nvram_init();
 188                 if (err)
 189                         return err;
 190         }
 191
 192         /* Look for name=value and return value */
 193         var = &nvram_buf[sizeof(struct nvram_header)];
 194         end = nvram_buf + sizeof(nvram_buf);
 195         while (var < end && *var) {
 196                 eq = strchr(var, '=');
 197                 if (!eq)
 198                         break;
 199                 value = eq + 1;
 200                 if (eq - var == strlen(name) &&
 201                     strncmp(var, name, eq - var) == 0)
 202                         return snprintf(val, val_len, "%s", value);
 203                 var = value + strlen(value) + 1;
 204         }
 205         return -ENOENT;
 206 }
 207 EXPORT_SYMBOL(bcm47xx_nvram_getenv);
 208
 209 int bcm47xx_nvram_gpio_pin(const char *name)
 210 {
 211         int i, err;
 212         char nvram_var[] = "gpioXX";
 213         char buf[NVRAM_MAX_GPIO_VALUE_LEN];
 214
 215         /* TODO: Optimize it to don't call getenv so many times */
 216         for (i = 0; i < NVRAM_MAX_GPIO_ENTRIES; i++) {
 217                 err = snprintf(nvram_var, sizeof(nvram_var), "gpio%i", i);
 218                 if (err <= 0)
 219                         continue;
 220                 err = bcm47xx_nvram_getenv(nvram_var, buf, sizeof(buf));
 221                 if (err <= 0)
 222                         continue;
 223                 if (!strcmp(name, buf))
 224                         return i;
 225         }
 226         return -ENOENT;
 227 }
 228 EXPORT_SYMBOL(bcm47xx_nvram_gpio_pin);
 229
 230 char *bcm47xx_nvram_get_contents(size_t *nvram_size)
 231 {
 232         int err;
 233         char *nvram;
 234
 235         if (!nvram_len) {
 236                 err = nvram_init();
 237                 if (err)
 238                         return NULL;
 239         }
 240
 241         *nvram_size = nvram_len - sizeof(struct nvram_header);
 242         nvram = vmalloc(*nvram_size);
 243         if (!nvram)
 244                 return NULL;
 245         memcpy(nvram, &nvram_buf[sizeof(struct nvram_header)], *nvram_size);
 246
 247         return nvram;
 248 }
 249 EXPORT_SYMBOL(bcm47xx_nvram_get_contents);
 250
 251 MODULE_LICENSE("GPL v2");