1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (C) 2022 - 2023 Rafał Miłecki <rafal@milecki.pl> 4 */ 5 6 #include <linux/crc32.h> 7 #include <linux/etherdevice.h> 8 #include <linux/export.h> 9 #include <linux/hex.h> 10 #include <linux/if_ether.h> 11 #include <linux/nvmem-consumer.h> 12 #include <linux/nvmem-provider.h> 13 #include <linux/of.h> 14 #include <linux/slab.h> 15 16 #include "u-boot-env.h" 17 18 struct u_boot_env_image_single { 19 __le32 crc32; 20 uint8_t data[]; 21 } __packed; 22 23 struct u_boot_env_image_redundant { 24 __le32 crc32; 25 u8 mark; 26 uint8_t data[]; 27 } __packed; 28 29 struct u_boot_env_image_broadcom { 30 __le32 magic; 31 __le32 len; 32 __le32 crc32; 33 DECLARE_FLEX_ARRAY(uint8_t, data); 34 } __packed; 35 36 static int u_boot_env_read_post_process_ethaddr(void *context, const char *id, int index, 37 unsigned int offset, void *buf, size_t bytes) 38 { 39 u8 mac[ETH_ALEN]; 40 41 if (!mac_pton(buf, mac)) 42 return -EINVAL; 43 44 if (index) 45 eth_addr_add(mac, index); 46 47 ether_addr_copy(buf, mac); 48 49 return 0; 50 } 51 52 static int u_boot_env_parse_cells(struct device *dev, struct nvmem_device *nvmem, uint8_t *buf, 53 size_t data_offset, size_t data_len) 54 { 55 char *data = buf + data_offset; 56 char *var, *value, *eq; 57 58 for (var = data; 59 var < data + data_len && *var; 60 var = value + strlen(value) + 1) { 61 struct nvmem_cell_info info = {}; 62 63 eq = strchr(var, '='); 64 if (!eq) 65 break; 66 *eq = '\0'; 67 value = eq + 1; 68 69 info.name = devm_kstrdup(dev, var, GFP_KERNEL); 70 if (!info.name) 71 return -ENOMEM; 72 info.offset = data_offset + value - data; 73 info.bytes = strlen(value); 74 info.np = of_get_child_by_name(dev->of_node, info.name); 75 if (!strcmp(var, "ethaddr") && info.bytes == MAC_ADDR_STR_LEN) { 76 info.raw_len = strlen(value); 77 info.bytes = ETH_ALEN; 78 info.read_post_process = u_boot_env_read_post_process_ethaddr; 79 } 80 81 nvmem_add_one_cell(nvmem, &info); 82 } 83 84 return 0; 85 } 86 87 int u_boot_env_parse(struct device *dev, struct nvmem_device *nvmem, 88 enum u_boot_env_format format) 89 { 90 size_t crc32_data_offset; 91 size_t crc32_data_len; 92 size_t crc32_offset; 93 uint32_t *crc32_addr; 94 size_t data_offset; 95 size_t data_len; 96 size_t dev_size; 97 uint32_t crc32; 98 uint32_t calc; 99 uint8_t *buf; 100 u32 env_size; 101 int bytes; 102 int err; 103 104 dev_size = device_property_read_u32(dev, "env-size", &env_size) ? 105 nvmem_dev_size(nvmem) : (size_t)env_size; 106 107 buf = kzalloc(dev_size, GFP_KERNEL); 108 if (!buf) { 109 err = -ENOMEM; 110 goto err_out; 111 } 112 113 bytes = nvmem_device_read(nvmem, 0, dev_size, buf); 114 if (bytes < 0) { 115 err = bytes; 116 goto err_kfree; 117 } else if (bytes != dev_size) { 118 err = -EIO; 119 goto err_kfree; 120 } 121 122 switch (format) { 123 case U_BOOT_FORMAT_SINGLE: 124 crc32_offset = offsetof(struct u_boot_env_image_single, crc32); 125 crc32_data_offset = offsetof(struct u_boot_env_image_single, data); 126 data_offset = offsetof(struct u_boot_env_image_single, data); 127 break; 128 case U_BOOT_FORMAT_REDUNDANT: 129 crc32_offset = offsetof(struct u_boot_env_image_redundant, crc32); 130 crc32_data_offset = offsetof(struct u_boot_env_image_redundant, data); 131 data_offset = offsetof(struct u_boot_env_image_redundant, data); 132 break; 133 case U_BOOT_FORMAT_BROADCOM: 134 crc32_offset = offsetof(struct u_boot_env_image_broadcom, crc32); 135 crc32_data_offset = offsetof(struct u_boot_env_image_broadcom, data); 136 data_offset = offsetof(struct u_boot_env_image_broadcom, data); 137 break; 138 } 139 140 if (dev_size < data_offset) { 141 dev_err(dev, "Device too small for u-boot-env\n"); 142 err = -EIO; 143 goto err_kfree; 144 } 145 146 crc32_addr = (uint32_t *)(buf + crc32_offset); 147 crc32 = *crc32_addr; 148 crc32_data_len = dev_size - crc32_data_offset; 149 data_len = dev_size - data_offset; 150 151 calc = crc32_le(~0, buf + crc32_data_offset, crc32_data_len) ^ ~0L; 152 if (calc != crc32) { 153 dev_err(dev, "Invalid calculated CRC32: 0x%08x (expected: 0x%08x)\n", calc, crc32); 154 err = -EINVAL; 155 goto err_kfree; 156 } 157 158 buf[dev_size - 1] = '\0'; 159 err = u_boot_env_parse_cells(dev, nvmem, buf, data_offset, data_len); 160 161 err_kfree: 162 kfree(buf); 163 err_out: 164 return err; 165 } 166 EXPORT_SYMBOL_GPL(u_boot_env_parse); 167 168 static int u_boot_env_add_cells(struct nvmem_layout *layout) 169 { 170 struct device *dev = &layout->dev; 171 enum u_boot_env_format format; 172 173 format = (uintptr_t)device_get_match_data(dev); 174 175 return u_boot_env_parse(dev, layout->nvmem, format); 176 } 177 178 static int u_boot_env_probe(struct nvmem_layout *layout) 179 { 180 layout->add_cells = u_boot_env_add_cells; 181 182 return nvmem_layout_register(layout); 183 } 184 185 static void u_boot_env_remove(struct nvmem_layout *layout) 186 { 187 nvmem_layout_unregister(layout); 188 } 189 190 static const struct of_device_id u_boot_env_of_match_table[] = { 191 { .compatible = "u-boot,env", .data = (void *)U_BOOT_FORMAT_SINGLE, }, 192 { .compatible = "u-boot,env-redundant-bool", .data = (void *)U_BOOT_FORMAT_REDUNDANT, }, 193 { .compatible = "u-boot,env-redundant-count", .data = (void *)U_BOOT_FORMAT_REDUNDANT, }, 194 { .compatible = "brcm,env", .data = (void *)U_BOOT_FORMAT_BROADCOM, }, 195 {}, 196 }; 197 198 static struct nvmem_layout_driver u_boot_env_layout = { 199 .driver = { 200 .name = "u-boot-env-layout", 201 .of_match_table = u_boot_env_of_match_table, 202 }, 203 .probe = u_boot_env_probe, 204 .remove = u_boot_env_remove, 205 }; 206 module_nvmem_layout_driver(u_boot_env_layout); 207 208 MODULE_AUTHOR("Rafał Miłecki"); 209 MODULE_LICENSE("GPL"); 210 MODULE_DEVICE_TABLE(of, u_boot_env_of_match_table); 211 MODULE_DESCRIPTION("NVMEM layout driver for U-Boot environment variables"); 212