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