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 <linux/libfdt.h> 12 #include <spl.h> 13 #include <malloc.h> 14 15 #ifndef CONFIG_SYS_BOOTM_LEN 16 #define CONFIG_SYS_BOOTM_LEN (64 << 20) 17 #endif 18 19 /** 20 * spl_fit_get_image_name(): By using the matching configuration subnode, 21 * retrieve the name of an image, specified by a property name and an index 22 * into that. 23 * @fit: Pointer to the FDT blob. 24 * @images: Offset of the /images subnode. 25 * @type: Name of the property within the configuration subnode. 26 * @index: Index into the list of strings in this property. 27 * @outname: Name of the image 28 * 29 * Return: 0 on success, or a negative error number 30 */ 31 static int spl_fit_get_image_name(const void *fit, int images, 32 const char *type, int index, 33 char **outname) 34 { 35 const char *name, *str; 36 __maybe_unused int node; 37 int conf_node; 38 int len, i; 39 40 conf_node = fit_find_config_node(fit); 41 if (conf_node < 0) { 42 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 43 printf("No matching DT out of these options:\n"); 44 for (node = fdt_first_subnode(fit, conf_node); 45 node >= 0; 46 node = fdt_next_subnode(fit, node)) { 47 name = fdt_getprop(fit, node, "description", &len); 48 printf(" %s\n", name); 49 } 50 #endif 51 return conf_node; 52 } 53 54 name = fdt_getprop(fit, conf_node, type, &len); 55 if (!name) { 56 debug("cannot find property '%s': %d\n", type, len); 57 return -EINVAL; 58 } 59 60 str = name; 61 for (i = 0; i < index; i++) { 62 str = strchr(str, '\0') + 1; 63 if (!str || (str - name >= len)) { 64 debug("no string for index %d\n", index); 65 return -E2BIG; 66 } 67 } 68 69 *outname = (char *)str; 70 return 0; 71 } 72 73 /** 74 * spl_fit_get_image_node(): By using the matching configuration subnode, 75 * retrieve the name of an image, specified by a property name and an index 76 * into that. 77 * @fit: Pointer to the FDT blob. 78 * @images: Offset of the /images subnode. 79 * @type: Name of the property within the configuration subnode. 80 * @index: Index into the list of strings in this property. 81 * 82 * Return: the node offset of the respective image node or a negative 83 * error number. 84 */ 85 static int spl_fit_get_image_node(const void *fit, int images, 86 const char *type, int index) 87 { 88 char *str; 89 int err; 90 int node; 91 92 err = spl_fit_get_image_name(fit, images, type, index, &str); 93 if (err) 94 return err; 95 96 debug("%s: '%s'\n", type, str); 97 98 node = fdt_subnode_offset(fit, images, str); 99 if (node < 0) { 100 debug("cannot find image node '%s': %d\n", str, node); 101 return -EINVAL; 102 } 103 104 return node; 105 } 106 107 static int get_aligned_image_offset(struct spl_load_info *info, int offset) 108 { 109 /* 110 * If it is a FS read, get the first address before offset which is 111 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the 112 * block number to which offset belongs. 113 */ 114 if (info->filename) 115 return offset & ~(ARCH_DMA_MINALIGN - 1); 116 117 return offset / info->bl_len; 118 } 119 120 static int get_aligned_image_overhead(struct spl_load_info *info, int offset) 121 { 122 /* 123 * If it is a FS read, get the difference between the offset and 124 * the first address before offset which is aligned to 125 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the 126 * block. 127 */ 128 if (info->filename) 129 return offset & (ARCH_DMA_MINALIGN - 1); 130 131 return offset % info->bl_len; 132 } 133 134 static int get_aligned_image_size(struct spl_load_info *info, int data_size, 135 int offset) 136 { 137 data_size = data_size + get_aligned_image_overhead(info, offset); 138 139 if (info->filename) 140 return data_size; 141 142 return (data_size + info->bl_len - 1) / info->bl_len; 143 } 144 145 /** 146 * spl_load_fit_image(): load the image described in a certain FIT node 147 * @info: points to information about the device to load data from 148 * @sector: the start sector of the FIT image on the device 149 * @fit: points to the flattened device tree blob describing the FIT 150 * image 151 * @base_offset: the beginning of the data area containing the actual 152 * image data, relative to the beginning of the FIT 153 * @node: offset of the DT node describing the image to load (relative 154 * to @fit) 155 * @image_info: will be filled with information about the loaded image 156 * If the FIT node does not contain a "load" (address) property, 157 * the image gets loaded to the address pointed to by the 158 * load_addr member in this struct. 159 * 160 * Return: 0 on success or a negative error number. 161 */ 162 static int spl_load_fit_image(struct spl_load_info *info, ulong sector, 163 void *fit, ulong base_offset, int node, 164 struct spl_image_info *image_info) 165 { 166 int offset; 167 size_t length; 168 int len; 169 ulong size; 170 ulong load_addr, load_ptr; 171 void *src; 172 ulong overhead; 173 int nr_sectors; 174 int align_len = ARCH_DMA_MINALIGN - 1; 175 uint8_t image_comp = -1, type = -1; 176 const void *data; 177 178 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) { 179 if (fit_image_get_comp(fit, node, &image_comp)) 180 puts("Cannot get image compression format.\n"); 181 else 182 debug("%s ", genimg_get_comp_name(image_comp)); 183 184 if (fit_image_get_type(fit, node, &type)) 185 puts("Cannot get image type.\n"); 186 else 187 debug("%s ", genimg_get_type_name(type)); 188 } 189 190 if (fit_image_get_load(fit, node, &load_addr)) 191 load_addr = image_info->load_addr; 192 193 if (!fit_image_get_data_offset(fit, node, &offset)) { 194 /* External data */ 195 offset += base_offset; 196 if (fit_image_get_data_size(fit, node, &len)) 197 return -ENOENT; 198 199 load_ptr = (load_addr + align_len) & ~align_len; 200 #if defined(CONFIG_ARCH_ROCKCHIP) 201 if ((load_ptr & 0xffff0000) == CONFIG_ROCKCHIP_IRAM_START_ADDR) 202 load_ptr = (ulong)memalign(ARCH_DMA_MINALIGN, len); 203 #endif 204 length = len; 205 206 overhead = get_aligned_image_overhead(info, offset); 207 nr_sectors = get_aligned_image_size(info, length, offset); 208 209 if (info->read(info, 210 sector + get_aligned_image_offset(info, offset), 211 nr_sectors, (void *)load_ptr) != nr_sectors) 212 return -EIO; 213 214 debug("External data: dst=%lx, offset=%x, size=%lx\n", 215 load_ptr, offset, (unsigned long)length); 216 src = (void *)load_ptr + overhead; 217 } else { 218 /* Embedded data */ 219 if (fit_image_get_data(fit, node, &data, &length)) { 220 puts("Cannot get image data/size\n"); 221 return -ENOENT; 222 } 223 debug("Embedded data: dst=%lx, size=%lx\n", load_addr, 224 (unsigned long)length); 225 src = (void *)data; 226 } 227 228 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS 229 board_fit_image_post_process(&src, &length); 230 #endif 231 232 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && 233 IS_ENABLED(CONFIG_SPL_GZIP) && 234 image_comp == IH_COMP_GZIP && 235 type == IH_TYPE_KERNEL) { 236 size = length; 237 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN, 238 src, &size)) { 239 puts("Uncompressing error\n"); 240 return -EIO; 241 } 242 length = size; 243 } else { 244 memcpy((void *)load_addr, src, length); 245 } 246 247 if (image_info) { 248 image_info->load_addr = load_addr; 249 image_info->size = length; 250 image_info->entry_point = fdt_getprop_u32(fit, node, "entry"); 251 } 252 253 return 0; 254 } 255 256 static int spl_fit_append_fdt(struct spl_image_info *spl_image, 257 struct spl_load_info *info, ulong sector, 258 void *fit, int images, ulong base_offset) 259 { 260 struct spl_image_info image_info; 261 int node, ret; 262 263 /* Figure out which device tree the board wants to use */ 264 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0); 265 if (node < 0) { 266 debug("%s: cannot find FDT node\n", __func__); 267 return node; 268 } 269 270 /* 271 * Read the device tree and place it after the image. 272 * Align the destination address to ARCH_DMA_MINALIGN. 273 */ 274 image_info.load_addr = spl_image->load_addr + spl_image->size; 275 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 276 &image_info); 277 278 if (ret < 0) 279 return ret; 280 281 /* Make the load-address of the FDT available for the SPL framework */ 282 spl_image->fdt_addr = (void *)image_info.load_addr; 283 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 284 /* Try to make space, so we can inject details on the loadables */ 285 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192); 286 #endif 287 288 return ret; 289 } 290 291 static int spl_fit_record_loadable(const void *fit, int images, int index, 292 void *blob, struct spl_image_info *image) 293 { 294 int ret = 0; 295 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 296 char *name; 297 int node; 298 299 ret = spl_fit_get_image_name(fit, images, "loadables", 300 index, &name); 301 if (ret < 0) 302 return ret; 303 304 node = spl_fit_get_image_node(fit, images, "loadables", index); 305 306 ret = fdt_record_loadable(blob, index, name, image->load_addr, 307 image->size, image->entry_point, 308 fdt_getprop(fit, node, "type", NULL), 309 fdt_getprop(fit, node, "os", NULL)); 310 #endif 311 return ret; 312 } 313 314 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os) 315 { 316 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 317 return -ENOTSUPP; 318 #else 319 return fit_image_get_os(fit, noffset, os); 320 #endif 321 } 322 323 int spl_load_simple_fit(struct spl_image_info *spl_image, 324 struct spl_load_info *info, ulong sector, void *fit) 325 { 326 int sectors; 327 ulong size; 328 unsigned long count; 329 struct spl_image_info image_info; 330 int node = -1; 331 int images, ret; 332 int base_offset, align_len = ARCH_DMA_MINALIGN - 1; 333 int index = 0; 334 335 /* 336 * For FIT with external data, figure out where the external images 337 * start. This is the base for the data-offset properties in each 338 * image. 339 */ 340 size = fdt_totalsize(fit); 341 size = (size + 3) & ~3; 342 base_offset = (size + 3) & ~3; 343 344 /* 345 * So far we only have one block of data from the FIT. Read the entire 346 * thing, including that first block, placing it so it finishes before 347 * where we will load the image. 348 * 349 * Note that we will load the image such that its first byte will be 350 * at the load address. Since that byte may be part-way through a 351 * block, we may load the image up to one block before the load 352 * address. So take account of that here by subtracting an addition 353 * block length from the FIT start position. 354 * 355 * In fact the FIT has its own load address, but we assume it cannot 356 * be before CONFIG_SYS_TEXT_BASE. 357 * 358 * For FIT with data embedded, data is loaded as part of FIT image. 359 * For FIT with external data, data is not loaded in this step. 360 */ 361 fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len - 362 align_len) & ~align_len); 363 sectors = get_aligned_image_size(info, size, 0); 364 count = info->read(info, sector, sectors, fit); 365 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n", 366 sector, sectors, fit, count); 367 if (count == 0) 368 return -EIO; 369 370 /* find the node holding the images information */ 371 images = fdt_path_offset(fit, FIT_IMAGES_PATH); 372 if (images < 0) { 373 debug("%s: Cannot find /images node: %d\n", __func__, images); 374 return -1; 375 } 376 377 /* 378 * Find the U-Boot image using the following search order: 379 * - start at 'firmware' (e.g. an ARM Trusted Firmware) 380 * - fall back 'kernel' (e.g. a Falcon-mode OS boot 381 * - fall back to using the first 'loadables' entry 382 */ 383 if (node < 0) 384 node = spl_fit_get_image_node(fit, images, "firmware", 0); 385 #ifdef CONFIG_SPL_OS_BOOT 386 if (node < 0) 387 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0); 388 #endif 389 if (node < 0) { 390 debug("could not find firmware image, trying loadables...\n"); 391 node = spl_fit_get_image_node(fit, images, "loadables", 0); 392 /* 393 * If we pick the U-Boot image from "loadables", start at 394 * the second image when later loading additional images. 395 */ 396 index = 1; 397 } 398 if (node < 0) { 399 debug("%s: Cannot find u-boot image node: %d\n", 400 __func__, node); 401 return -1; 402 } 403 404 /* Load the image and set up the spl_image structure */ 405 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 406 spl_image); 407 if (ret) 408 return ret; 409 410 /* 411 * For backward compatibility, we treat the first node that is 412 * as a U-Boot image, if no OS-type has been declared. 413 */ 414 if (!spl_fit_image_get_os(fit, node, &spl_image->os)) 415 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os)); 416 #if !defined(CONFIG_SPL_OS_BOOT) 417 else 418 spl_image->os = IH_OS_U_BOOT; 419 #endif 420 421 /* 422 * Booting a next-stage U-Boot may require us to append the FDT. 423 * We allow this to fail, as the U-Boot image might embed its FDT. 424 */ 425 if (spl_image->os == IH_OS_U_BOOT) 426 spl_fit_append_fdt(spl_image, info, sector, fit, 427 images, base_offset); 428 429 /* Now check if there are more images for us to load */ 430 for (; ; index++) { 431 uint8_t os_type = IH_OS_INVALID; 432 433 node = spl_fit_get_image_node(fit, images, "loadables", index); 434 if (node < 0) 435 break; 436 437 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 438 &image_info); 439 if (ret < 0) 440 continue; 441 442 if (!spl_fit_image_get_os(fit, node, &os_type)) 443 debug("Loadable is %s\n", genimg_get_os_name(os_type)); 444 445 if (os_type == IH_OS_U_BOOT) { 446 spl_fit_append_fdt(&image_info, info, sector, 447 fit, images, base_offset); 448 spl_image->fdt_addr = image_info.fdt_addr; 449 } 450 451 /* 452 * If the "firmware" image did not provide an entry point, 453 * use the first valid entry point from the loadables. 454 */ 455 if (spl_image->entry_point == FDT_ERROR && 456 image_info.entry_point != FDT_ERROR) 457 spl_image->entry_point = image_info.entry_point; 458 459 /* Record our loadables into the FDT */ 460 if (spl_image->fdt_addr) 461 spl_fit_record_loadable(fit, images, index, 462 spl_image->fdt_addr, 463 &image_info); 464 } 465 466 /* 467 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's 468 * Makefile will set it to 0 and it will end up as the entry point 469 * here. What it actually means is: use the load address. 470 */ 471 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0) 472 spl_image->entry_point = spl_image->load_addr; 473 474 return 0; 475 } 476