1 /* 2 * Copyright (C) 2016 Google, Inc 3 * Written by Simon Glass <sjg@chromium.org> 4 * 5 * SPDX-License-Identifier: GPL-2.0+ 6 */ 7 8 #include <common.h> 9 #include <errno.h> 10 #include <image.h> 11 #include <libfdt.h> 12 #include <spl.h> 13 14 #ifndef CONFIG_SYS_BOOTM_LEN 15 #define CONFIG_SYS_BOOTM_LEN (64 << 20) 16 #endif 17 18 /** 19 * spl_fit_get_image_node(): By using the matching configuration subnode, 20 * retrieve the name of an image, specified by a property name and an index 21 * into that. 22 * @fit: Pointer to the FDT blob. 23 * @images: Offset of the /images subnode. 24 * @type: Name of the property within the configuration subnode. 25 * @index: Index into the list of strings in this property. 26 * 27 * Return: the node offset of the respective image node or a negative 28 * error number. 29 */ 30 static int spl_fit_get_image_node(const void *fit, int images, 31 const char *type, int index) 32 { 33 const char *name, *str; 34 int node, conf_node; 35 int len, i; 36 37 conf_node = fit_find_config_node(fit); 38 if (conf_node < 0) { 39 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 40 printf("No matching DT out of these options:\n"); 41 for (node = fdt_first_subnode(fit, conf_node); 42 node >= 0; 43 node = fdt_next_subnode(fit, node)) { 44 name = fdt_getprop(fit, node, "description", &len); 45 printf(" %s\n", name); 46 } 47 #endif 48 return conf_node; 49 } 50 51 name = fdt_getprop(fit, conf_node, type, &len); 52 if (!name) { 53 debug("cannot find property '%s': %d\n", type, len); 54 return -EINVAL; 55 } 56 57 str = name; 58 for (i = 0; i < index; i++) { 59 str = strchr(str, '\0') + 1; 60 if (!str || (str - name >= len)) { 61 debug("no string for index %d\n", index); 62 return -E2BIG; 63 } 64 } 65 66 debug("%s: '%s'\n", type, str); 67 node = fdt_subnode_offset(fit, images, str); 68 if (node < 0) { 69 debug("cannot find image node '%s': %d\n", str, node); 70 return -EINVAL; 71 } 72 73 return node; 74 } 75 76 static int get_aligned_image_offset(struct spl_load_info *info, int offset) 77 { 78 /* 79 * If it is a FS read, get the first address before offset which is 80 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the 81 * block number to which offset belongs. 82 */ 83 if (info->filename) 84 return offset & ~(ARCH_DMA_MINALIGN - 1); 85 86 return offset / info->bl_len; 87 } 88 89 static int get_aligned_image_overhead(struct spl_load_info *info, int offset) 90 { 91 /* 92 * If it is a FS read, get the difference between the offset and 93 * the first address before offset which is aligned to 94 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the 95 * block. 96 */ 97 if (info->filename) 98 return offset & (ARCH_DMA_MINALIGN - 1); 99 100 return offset % info->bl_len; 101 } 102 103 static int get_aligned_image_size(struct spl_load_info *info, int data_size, 104 int offset) 105 { 106 data_size = data_size + get_aligned_image_overhead(info, offset); 107 108 if (info->filename) 109 return data_size; 110 111 return (data_size + info->bl_len - 1) / info->bl_len; 112 } 113 114 /** 115 * spl_load_fit_image(): load the image described in a certain FIT node 116 * @info: points to information about the device to load data from 117 * @sector: the start sector of the FIT image on the device 118 * @fit: points to the flattened device tree blob describing the FIT 119 * image 120 * @base_offset: the beginning of the data area containing the actual 121 * image data, relative to the beginning of the FIT 122 * @node: offset of the DT node describing the image to load (relative 123 * to @fit) 124 * @image_info: will be filled with information about the loaded image 125 * If the FIT node does not contain a "load" (address) property, 126 * the image gets loaded to the address pointed to by the 127 * load_addr member in this struct. 128 * 129 * Return: 0 on success or a negative error number. 130 */ 131 static int spl_load_fit_image(struct spl_load_info *info, ulong sector, 132 void *fit, ulong base_offset, int node, 133 struct spl_image_info *image_info) 134 { 135 int offset; 136 size_t length; 137 int len; 138 ulong load_addr, load_ptr; 139 void *src; 140 ulong overhead; 141 int nr_sectors; 142 int align_len = ARCH_DMA_MINALIGN - 1; 143 uint8_t image_comp = -1, type = -1; 144 const void *data; 145 146 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) { 147 if (fit_image_get_comp(fit, node, &image_comp)) 148 puts("Cannot get image compression format.\n"); 149 else 150 debug("%s ", genimg_get_comp_name(image_comp)); 151 152 if (fit_image_get_type(fit, node, &type)) 153 puts("Cannot get image type.\n"); 154 else 155 debug("%s ", genimg_get_type_name(type)); 156 } 157 158 if (fit_image_get_load(fit, node, &load_addr)) 159 load_addr = image_info->load_addr; 160 161 if (!fit_image_get_data_offset(fit, node, &offset)) { 162 /* External data */ 163 offset += base_offset; 164 if (fit_image_get_data_size(fit, node, &len)) 165 return -ENOENT; 166 167 load_ptr = (load_addr + align_len) & ~align_len; 168 length = len; 169 170 overhead = get_aligned_image_overhead(info, offset); 171 nr_sectors = get_aligned_image_size(info, length, offset); 172 173 if (info->read(info, 174 sector + get_aligned_image_offset(info, offset), 175 nr_sectors, (void *)load_ptr) != nr_sectors) 176 return -EIO; 177 178 debug("External data: dst=%lx, offset=%x, size=%lx\n", 179 load_ptr, offset, (unsigned long)length); 180 src = (void *)load_ptr + overhead; 181 } else { 182 /* Embedded data */ 183 if (fit_image_get_data(fit, node, &data, &length)) { 184 puts("Cannot get image data/size\n"); 185 return -ENOENT; 186 } 187 debug("Embedded data: dst=%lx, size=%lx\n", load_addr, 188 (unsigned long)length); 189 src = (void *)data; 190 } 191 192 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS 193 board_fit_image_post_process(&src, &length); 194 #endif 195 196 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && 197 IS_ENABLED(CONFIG_SPL_GZIP) && 198 image_comp == IH_COMP_GZIP && 199 type == IH_TYPE_KERNEL) { 200 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN, 201 src, &length)) { 202 puts("Uncompressing error\n"); 203 return -EIO; 204 } 205 } else { 206 memcpy((void *)load_addr, src, length); 207 } 208 209 if (image_info) { 210 image_info->load_addr = load_addr; 211 image_info->size = length; 212 image_info->entry_point = fdt_getprop_u32(fit, node, "entry"); 213 } 214 215 return 0; 216 } 217 218 int spl_load_simple_fit(struct spl_image_info *spl_image, 219 struct spl_load_info *info, ulong sector, void *fit) 220 { 221 int sectors; 222 ulong size; 223 unsigned long count; 224 struct spl_image_info image_info; 225 int node, images, ret; 226 int base_offset, align_len = ARCH_DMA_MINALIGN - 1; 227 int index = 0; 228 229 /* 230 * Figure out where the external images start. This is the base for the 231 * data-offset properties in each image. 232 */ 233 size = fdt_totalsize(fit); 234 size = (size + 3) & ~3; 235 base_offset = (size + 3) & ~3; 236 237 /* 238 * So far we only have one block of data from the FIT. Read the entire 239 * thing, including that first block, placing it so it finishes before 240 * where we will load the image. 241 * 242 * Note that we will load the image such that its first byte will be 243 * at the load address. Since that byte may be part-way through a 244 * block, we may load the image up to one block before the load 245 * address. So take account of that here by subtracting an addition 246 * block length from the FIT start position. 247 * 248 * In fact the FIT has its own load address, but we assume it cannot 249 * be before CONFIG_SYS_TEXT_BASE. 250 */ 251 fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len - 252 align_len) & ~align_len); 253 sectors = get_aligned_image_size(info, size, 0); 254 count = info->read(info, sector, sectors, fit); 255 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n", 256 sector, sectors, fit, count); 257 if (count == 0) 258 return -EIO; 259 260 /* find the node holding the images information */ 261 images = fdt_path_offset(fit, FIT_IMAGES_PATH); 262 if (images < 0) { 263 debug("%s: Cannot find /images node: %d\n", __func__, images); 264 return -1; 265 } 266 267 /* find the U-Boot image */ 268 node = spl_fit_get_image_node(fit, images, "firmware", 0); 269 if (node < 0) { 270 debug("could not find firmware image, trying loadables...\n"); 271 node = spl_fit_get_image_node(fit, images, "loadables", 0); 272 /* 273 * If we pick the U-Boot image from "loadables", start at 274 * the second image when later loading additional images. 275 */ 276 index = 1; 277 } 278 if (node < 0) { 279 debug("%s: Cannot find u-boot image node: %d\n", 280 __func__, node); 281 return -1; 282 } 283 284 /* Load the image and set up the spl_image structure */ 285 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 286 spl_image); 287 if (ret) 288 return ret; 289 290 spl_image->os = IH_OS_U_BOOT; 291 292 /* Figure out which device tree the board wants to use */ 293 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0); 294 if (node < 0) { 295 debug("%s: cannot find FDT node\n", __func__); 296 return node; 297 } 298 299 /* 300 * Read the device tree and place it after the image. 301 * Align the destination address to ARCH_DMA_MINALIGN. 302 */ 303 image_info.load_addr = spl_image->load_addr + spl_image->size; 304 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 305 &image_info); 306 if (ret < 0) 307 return ret; 308 309 /* Now check if there are more images for us to load */ 310 for (; ; index++) { 311 node = spl_fit_get_image_node(fit, images, "loadables", index); 312 if (node < 0) 313 break; 314 315 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 316 &image_info); 317 if (ret < 0) 318 continue; 319 320 /* 321 * If the "firmware" image did not provide an entry point, 322 * use the first valid entry point from the loadables. 323 */ 324 if (spl_image->entry_point == FDT_ERROR && 325 image_info.entry_point != FDT_ERROR) 326 spl_image->entry_point = image_info.entry_point; 327 } 328 329 /* 330 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's 331 * Makefile will set it to 0 and it will end up as the entry point 332 * here. What it actually means is: use the load address. 333 */ 334 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0) 335 spl_image->entry_point = spl_image->load_addr; 336 337 return 0; 338 } 339