arch/mips/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         if (header->len > size)
  98                 pr_err("The nvram size accoridng to the header seems to be bigger than the partition on flash\n");
  99         if (header->len > NVRAM_SPACE)
 100                 pr_err("nvram on flash (%i bytes) is bigger than the reserved space in memory, will just copy the first %i bytes\n",
 101                        header->len, NVRAM_SPACE);
 102
 103         src = (u32 *)header;
 104         dst = (u32 *)nvram_buf;
 105         for (i = 0; i < sizeof(struct nvram_header); i += 4)
 106                 *dst++ = __raw_readl(src++);
 107         for (; i < header->len && i < NVRAM_SPACE && i < size; i += 4)
 108                 *dst++ = readl(src++);
 109
 110         return 0;
 111 }
 112
 113 /*
 114  * On bcm47xx we need access to the NVRAM very early, so we can't use mtd
 115  * subsystem to access flash. We can't even use platform device / driver to
 116  * store memory offset.
 117  * To handle this we provide following symbol. It's supposed to be called as
 118  * soon as we get info about flash device, before any NVRAM entry is needed.
 119  */
 120 int bcm47xx_nvram_init_from_mem(u32 base, u32 lim)
 121 {
 122         void __iomem *iobase;
 123         int err;
 124
 125         iobase = ioremap_nocache(base, lim);
 126         if (!iobase)
 127                 return -ENOMEM;
 128
 129         err = nvram_find_and_copy(iobase, lim);
 130
 131         iounmap(iobase);
 132
 133         return err;
 134 }
 135
 136 static int nvram_init(void)
 137 {
 138 #ifdef CONFIG_MTD
 139         struct mtd_info *mtd;
 140         struct nvram_header header;
 141         size_t bytes_read;
 142         int err, i;
 143
 144         mtd = get_mtd_device_nm("nvram");
 145         if (IS_ERR(mtd))
 146                 return -ENODEV;
 147
 148         for (i = 0; i < ARRAY_SIZE(nvram_sizes); i++) {
 149                 loff_t from = mtd->size - nvram_sizes[i];
 150
 151                 if (from < 0)
 152                         continue;
 153
 154                 err = mtd_read(mtd, from, sizeof(header), &bytes_read,
 155                                (uint8_t *)&header);
 156                 if (!err && header.magic == NVRAM_MAGIC) {
 157                         u8 *dst = (uint8_t *)nvram_buf;
 158                         size_t len = header.len;
 159
 160                         if (header.len > NVRAM_SPACE) {
 161                                 pr_err("nvram on flash (%i bytes) is bigger than the reserved space in memory, will just copy the first %i bytes\n",
 162                                        header.len, NVRAM_SPACE);
 163                                 len = NVRAM_SPACE;
 164                         }
 165
 166                         err = mtd_read(mtd, from, len, &bytes_read, dst);
 167                         if (err)
 168                                 return err;
 169
 170                         return 0;
 171                 }
 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 data_left, 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) - 2;
 195         end[0] = '\0';
 196         end[1] = '\0';
 197         for (; *var; var = value + strlen(value) + 1) {
 198                 data_left = end - var;
 199
 200                 eq = strnchr(var, data_left, '=');
 201                 if (!eq)
 202                         break;
 203                 value = eq + 1;
 204                 if (eq - var == strlen(name) &&
 205                     strncmp(var, name, eq - var) == 0)
 206                         return snprintf(val, val_len, "%s", value);
 207         }
 208         return -ENOENT;
 209 }
 210 EXPORT_SYMBOL(bcm47xx_nvram_getenv);
 211
 212 int bcm47xx_nvram_gpio_pin(const char *name)
 213 {
 214         int i, err;
 215         char nvram_var[] = "gpioXX";
 216         char buf[NVRAM_MAX_GPIO_VALUE_LEN];
 217
 218         /* TODO: Optimize it to don't call getenv so many times */
 219         for (i = 0; i < NVRAM_MAX_GPIO_ENTRIES; i++) {
 220                 err = snprintf(nvram_var, sizeof(nvram_var), "gpio%i", i);
 221                 if (err <= 0)
 222                         continue;
 223                 err = bcm47xx_nvram_getenv(nvram_var, buf, sizeof(buf));
 224                 if (err <= 0)
 225                         continue;
 226                 if (!strcmp(name, buf))
 227                         return i;
 228         }
 229         return -ENOENT;
 230 }
 231 EXPORT_SYMBOL(bcm47xx_nvram_gpio_pin);