target/linux/bcm53xx/files/drivers/firmware/broadcom/bcm47xx_nvram.c

   1 /*
   2  * BCM947xx nvram variable access
   3  *
   4  * Copyright (C) 2005 Broadcom Corporation
   5  * Copyright (C) 2006 Felix Fietkau <nbd@openwrt.org>
   6  * Copyright (C) 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  */
  13
  14 #include <linux/io.h>
  15 #include <linux/types.h>
  16 #include <linux/module.h>
  17 #include <linux/kernel.h>
  18 #include <linux/string.h>
  19 #include <linux/mtd/mtd.h>
  20 #include <linux/bcm47xx_nvram.h>
  21
  22 #define NVRAM_MAGIC                     0x48534C46      /* 'FLSH' */
  23 #define NVRAM_SPACE                     0x10000
  24 #define NVRAM_MAX_GPIO_ENTRIES          32
  25 #define NVRAM_MAX_GPIO_VALUE_LEN        30
  26
  27 #define FLASH_MIN               0x00020000      /* Minimum flash size */
  28
  29 struct nvram_header {
  30         u32 magic;
  31         u32 len;
  32         u32 crc_ver_init;       /* 0:7 crc, 8:15 ver, 16:31 sdram_init */
  33         u32 config_refresh;     /* 0:15 sdram_config, 16:31 sdram_refresh */
  34         u32 config_ncdl;        /* ncdl values for memc */
  35 };
  36
  37 static char nvram_buf[NVRAM_SPACE];
  38 static const u32 nvram_sizes[] = {0x8000, 0xF000, 0x10000};
  39
  40 static u32 find_nvram_size(void __iomem *end)
  41 {
  42         struct nvram_header __iomem *header;
  43         int i;
  44
  45         for (i = 0; i < ARRAY_SIZE(nvram_sizes); i++) {
  46                 header = (struct nvram_header *)(end - nvram_sizes[i]);
  47                 if (header->magic == NVRAM_MAGIC)
  48                         return nvram_sizes[i];
  49         }
  50
  51         return 0;
  52 }
  53
  54 /* Probe for NVRAM header */
  55 static int nvram_find_and_copy(void __iomem *iobase, u32 lim)
  56 {
  57         struct nvram_header __iomem *header;
  58         int i;
  59         u32 off;
  60         u32 *src, *dst;
  61         u32 size;
  62
  63         if (nvram_buf[0]) {
  64                 pr_warn("nvram already initialized\n");
  65                 return -EEXIST;
  66         }
  67
  68         /* TODO: when nvram is on nand flash check for bad blocks first. */
  69         off = FLASH_MIN;
  70         while (off <= lim) {
  71                 /* Windowed flash access */
  72                 size = find_nvram_size(iobase + off);
  73                 if (size) {
  74                         header = (struct nvram_header *)(iobase + off - size);
  75                         goto found;
  76                 }
  77                 off <<= 1;
  78         }
  79
  80         /* Try embedded NVRAM at 4 KB and 1 KB as last resorts */
  81         header = (struct nvram_header *)(iobase + 4096);
  82         if (header->magic == NVRAM_MAGIC) {
  83                 size = NVRAM_SPACE;
  84                 goto found;
  85         }
  86
  87         header = (struct nvram_header *)(iobase + 1024);
  88         if (header->magic == NVRAM_MAGIC) {
  89                 size = NVRAM_SPACE;
  90                 goto found;
  91         }
  92
  93         pr_err("no nvram found\n");
  94         return -ENXIO;
  95
  96 found:
  97         src = (u32 *)header;
  98         dst = (u32 *)nvram_buf;
  99         for (i = 0; i < sizeof(struct nvram_header); i += 4)
 100                 *dst++ = __raw_readl(src++);
 101         header = (struct nvram_header *)nvram_buf;
 102         if (header->len > size) {
 103                 pr_err("The nvram size according to the header seems to be bigger than the partition on flash\n");
 104                 header->len = size;
 105         }
 106         if (header->len >= NVRAM_SPACE) {
 107                 pr_err("nvram on flash (%i bytes) is bigger than the reserved space in memory, will just copy the first %i bytes\n",
 108                        header->len, NVRAM_SPACE - 1);
 109                 header->len = NVRAM_SPACE - 1;
 110         }
 111         /* proceed reading data after header */
 112         for (; i < header->len; i += 4)
 113                 *dst++ = readl(src++);
 114         nvram_buf[NVRAM_SPACE - 1] = '\0';
 115
 116         return 0;
 117 }
 118
 119 /*
 120  * On bcm47xx we need access to the NVRAM very early, so we can't use mtd
 121  * subsystem to access flash. We can't even use platform device / driver to
 122  * store memory offset.
 123  * To handle this we provide following symbol. It's supposed to be called as
 124  * soon as we get info about flash device, before any NVRAM entry is needed.
 125  */
 126 int bcm47xx_nvram_init_from_mem(u32 base, u32 lim)
 127 {
 128         void __iomem *iobase;
 129         int err;
 130
 131         iobase = ioremap_nocache(base, lim);
 132         if (!iobase)
 133                 return -ENOMEM;
 134
 135         err = nvram_find_and_copy(iobase, lim);
 136
 137         iounmap(iobase);
 138
 139         return err;
 140 }
 141
 142 static int nvram_init(void)
 143 {
 144 #ifdef CONFIG_MTD
 145         struct mtd_info *mtd;
 146         struct nvram_header header;
 147         struct nvram_header *pheader;
 148         size_t bytes_read;
 149         int err;
 150
 151         mtd = get_mtd_device_nm("nvram");
 152         if (IS_ERR(mtd))
 153                 return -ENODEV;
 154
 155         err = mtd_read(mtd, 0, sizeof(header), &bytes_read, (uint8_t *)&header);
 156         if (!err && header.magic == NVRAM_MAGIC &&
 157             header.len > sizeof(header)) {
 158                 if (header.len >= NVRAM_SPACE) {
 159                         pr_err("nvram on flash (%i bytes) is bigger than the reserved space in memory, will just copy the first %i bytes\n",
 160                                 header.len, NVRAM_SPACE);
 161                         header.len = NVRAM_SPACE - 1;
 162                 }
 163
 164                 err = mtd_read(mtd, 0, header.len, &bytes_read,
 165                                (u8 *)nvram_buf);
 166                 if (err)
 167                         return err;
 168
 169                 pheader = (struct nvram_header *)nvram_buf;
 170                 pheader->len = header.len;
 171                 return 0;
 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_buf[0]) {
 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         struct nvram_header *header;
 235
 236         if (!nvram_buf[0]) {
 237                 err = nvram_init();
 238                 if (err)
 239                         return NULL;
 240         }
 241
 242         header = (struct nvram_header *)nvram_buf;
 243         *nvram_size = header->len - sizeof(struct nvram_header);
 244         nvram = vmalloc(*nvram_size);
 245         if (!nvram)
 246                 return NULL;
 247         memcpy(nvram, &nvram_buf[sizeof(struct nvram_header)], *nvram_size);
 248
 249         return nvram;
 250 }
 251 EXPORT_SYMBOL(bcm47xx_nvram_get_contents);
 252
 253 MODULE_LICENSE("GPLv2");