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 bool external_data = false; 178 179 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) { 180 if (fit_image_get_comp(fit, node, &image_comp)) 181 puts("Cannot get image compression format.\n"); 182 else 183 debug("%s ", genimg_get_comp_name(image_comp)); 184 185 if (fit_image_get_type(fit, node, &type)) 186 puts("Cannot get image type.\n"); 187 else 188 debug("%s ", genimg_get_type_name(type)); 189 } 190 191 if (fit_image_get_load(fit, node, &load_addr)) 192 load_addr = image_info->load_addr; 193 194 if (!fit_image_get_data_position(fit, node, &offset)) { 195 external_data = true; 196 } else if (!fit_image_get_data_offset(fit, node, &offset)) { 197 offset += base_offset; 198 external_data = true; 199 } 200 201 if (external_data) { 202 /* External data */ 203 if (fit_image_get_data_size(fit, node, &len)) 204 return -ENOENT; 205 206 load_ptr = (load_addr + align_len) & ~align_len; 207 #if defined(CONFIG_ARCH_ROCKCHIP) 208 if ((load_ptr < CONFIG_SYS_SDRAM_BASE) || 209 (load_ptr >= CONFIG_SYS_SDRAM_BASE + SDRAM_MAX_SIZE)) 210 load_ptr = (ulong)memalign(ARCH_DMA_MINALIGN, len); 211 #endif 212 length = len; 213 214 overhead = get_aligned_image_overhead(info, offset); 215 nr_sectors = get_aligned_image_size(info, length, offset); 216 217 if (info->read(info, 218 sector + get_aligned_image_offset(info, offset), 219 nr_sectors, (void *)load_ptr) != nr_sectors) 220 return -EIO; 221 222 debug("External data: dst=%lx, offset=%x, size=%lx\n", 223 load_ptr, offset, (unsigned long)length); 224 src = (void *)load_ptr + overhead; 225 } else { 226 /* Embedded data */ 227 if (fit_image_get_data(fit, node, &data, &length)) { 228 puts("Cannot get image data/size\n"); 229 return -ENOENT; 230 } 231 debug("Embedded data: dst=%lx, size=%lx\n", load_addr, 232 (unsigned long)length); 233 src = (void *)data; 234 } 235 236 #ifdef CONFIG_SPL_FIT_SIGNATURE 237 printf("## Checking hash(es) for Image %s ... ", 238 fit_get_name(fit, node, NULL)); 239 #ifdef CONFIG_FIT_SPL_PRINT 240 printf("\n"); 241 fit_image_print(fit, node, ""); 242 #endif 243 if (!fit_image_verify_with_data(fit, node, 244 src, length)) 245 return -EPERM; 246 puts("OK\n"); 247 #endif 248 249 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS 250 board_fit_image_post_process(&src, &length); 251 #endif 252 253 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && 254 IS_ENABLED(CONFIG_SPL_GZIP) && 255 image_comp == IH_COMP_GZIP && 256 type == IH_TYPE_KERNEL) { 257 size = length; 258 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN, 259 src, &size)) { 260 puts("Uncompressing error\n"); 261 return -EIO; 262 } 263 length = size; 264 } else { 265 memcpy((void *)load_addr, src, length); 266 } 267 268 if (image_info) { 269 image_info->load_addr = load_addr; 270 image_info->size = length; 271 image_info->entry_point = fdt_getprop_u32(fit, node, "entry"); 272 } 273 274 return 0; 275 } 276 277 static int spl_fit_append_fdt(struct spl_image_info *spl_image, 278 struct spl_load_info *info, ulong sector, 279 void *fit, int images, ulong base_offset) 280 { 281 struct spl_image_info image_info; 282 int node, ret; 283 284 /* Figure out which device tree the board wants to use */ 285 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0); 286 if (node < 0) { 287 debug("%s: cannot find FDT node\n", __func__); 288 return node; 289 } 290 291 /* 292 * Read the device tree and place it after the image. 293 * Align the destination address to ARCH_DMA_MINALIGN. 294 */ 295 image_info.load_addr = spl_image->load_addr + spl_image->size; 296 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 297 &image_info); 298 299 if (ret < 0) 300 return ret; 301 302 /* Make the load-address of the FDT available for the SPL framework */ 303 spl_image->fdt_addr = (void *)image_info.load_addr; 304 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 305 /* Try to make space, so we can inject details on the loadables */ 306 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192); 307 #endif 308 309 return ret; 310 } 311 312 static int spl_fit_record_loadable(const void *fit, int images, int index, 313 void *blob, struct spl_image_info *image) 314 { 315 int ret = 0; 316 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 317 char *name; 318 int node; 319 320 ret = spl_fit_get_image_name(fit, images, "loadables", 321 index, &name); 322 if (ret < 0) 323 return ret; 324 325 node = spl_fit_get_image_node(fit, images, "loadables", index); 326 327 ret = fdt_record_loadable(blob, index, name, image->load_addr, 328 image->size, image->entry_point, 329 fdt_getprop(fit, node, "type", NULL), 330 fdt_getprop(fit, node, "os", NULL)); 331 #endif 332 return ret; 333 } 334 335 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os) 336 { 337 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 338 return -ENOTSUPP; 339 #else 340 return fit_image_get_os(fit, noffset, os); 341 #endif 342 } 343 344 int spl_load_simple_fit(struct spl_image_info *spl_image, 345 struct spl_load_info *info, ulong sector, void *fit) 346 { 347 int sectors; 348 ulong size; 349 unsigned long count; 350 struct spl_image_info image_info; 351 int node = -1; 352 int images, ret; 353 int base_offset, align_len = ARCH_DMA_MINALIGN - 1; 354 int index = 0; 355 356 /* 357 * For FIT with external data, figure out where the external images 358 * start. This is the base for the data-offset properties in each 359 * image. 360 */ 361 size = fdt_totalsize(fit); 362 size = FIT_ALIGN(size); 363 base_offset = FIT_ALIGN(size); 364 365 /* 366 * So far we only have one block of data from the FIT. Read the entire 367 * thing, including that first block, placing it so it finishes before 368 * where we will load the image. 369 * 370 * Note that we will load the image such that its first byte will be 371 * at the load address. Since that byte may be part-way through a 372 * block, we may load the image up to one block before the load 373 * address. So take account of that here by subtracting an addition 374 * block length from the FIT start position. 375 * 376 * In fact the FIT has its own load address, but we assume it cannot 377 * be before CONFIG_SYS_TEXT_BASE. 378 * 379 * For FIT with data embedded, data is loaded as part of FIT image. 380 * For FIT with external data, data is not loaded in this step. 381 */ 382 fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len - 383 align_len) & ~align_len); 384 sectors = get_aligned_image_size(info, size, 0); 385 count = info->read(info, sector, sectors, fit); 386 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n", 387 sector, sectors, fit, count); 388 if (count == 0) 389 return -EIO; 390 391 /* find the node holding the images information */ 392 images = fdt_path_offset(fit, FIT_IMAGES_PATH); 393 if (images < 0) { 394 debug("%s: Cannot find /images node: %d\n", __func__, images); 395 return -1; 396 } 397 398 /* verify the configure node by keys, if required */ 399 #ifdef CONFIG_SPL_FIT_SIGNATURE 400 int conf_noffset; 401 402 conf_noffset = fit_conf_get_node(fit, NULL); 403 if (conf_noffset > 0) { 404 ret = fit_config_verify(fit, conf_noffset); 405 if (ret) { 406 printf("fit verify configure failed, ret=%d\n", ret); 407 return ret; 408 } 409 printf("\n"); 410 } 411 #endif 412 413 /* 414 * Find the U-Boot image using the following search order: 415 * - start at 'firmware' (e.g. an ARM Trusted Firmware) 416 * - fall back 'kernel' (e.g. a Falcon-mode OS boot 417 * - fall back to using the first 'loadables' entry 418 */ 419 if (node < 0) 420 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP, 421 0); 422 #ifdef CONFIG_SPL_OS_BOOT 423 if (node < 0) 424 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0); 425 #endif 426 if (node < 0) { 427 debug("could not find firmware image, trying loadables...\n"); 428 node = spl_fit_get_image_node(fit, images, "loadables", 0); 429 /* 430 * If we pick the U-Boot image from "loadables", start at 431 * the second image when later loading additional images. 432 */ 433 index = 1; 434 } 435 if (node < 0) { 436 debug("%s: Cannot find u-boot image node: %d\n", 437 __func__, node); 438 return -1; 439 } 440 441 /* Load the image and set up the spl_image structure */ 442 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 443 spl_image); 444 if (ret) 445 return ret; 446 447 /* 448 * For backward compatibility, we treat the first node that is 449 * as a U-Boot image, if no OS-type has been declared. 450 */ 451 if (!spl_fit_image_get_os(fit, node, &spl_image->os)) 452 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os)); 453 #if !defined(CONFIG_SPL_OS_BOOT) 454 else 455 spl_image->os = IH_OS_U_BOOT; 456 #endif 457 458 /* 459 * Booting a next-stage U-Boot may require us to append the FDT. 460 * We allow this to fail, as the U-Boot image might embed its FDT. 461 */ 462 if (spl_image->os == IH_OS_U_BOOT) 463 spl_fit_append_fdt(spl_image, info, sector, fit, 464 images, base_offset); 465 466 /* Now check if there are more images for us to load */ 467 for (; ; index++) { 468 uint8_t os_type = IH_OS_INVALID; 469 470 node = spl_fit_get_image_node(fit, images, "loadables", index); 471 if (node < 0) 472 break; 473 474 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 475 &image_info); 476 if (ret < 0) 477 continue; 478 479 if (!spl_fit_image_get_os(fit, node, &os_type)) 480 debug("Loadable is %s\n", genimg_get_os_name(os_type)); 481 482 if (os_type == IH_OS_U_BOOT) { 483 spl_fit_append_fdt(&image_info, info, sector, 484 fit, images, base_offset); 485 spl_image->fdt_addr = image_info.fdt_addr; 486 } 487 488 /* 489 * If the "firmware" image did not provide an entry point, 490 * use the first valid entry point from the loadables. 491 */ 492 if (spl_image->entry_point == FDT_ERROR && 493 image_info.entry_point != FDT_ERROR) 494 spl_image->entry_point = image_info.entry_point; 495 496 /* Record our loadables into the FDT */ 497 if (spl_image->fdt_addr) 498 spl_fit_record_loadable(fit, images, index, 499 spl_image->fdt_addr, 500 &image_info); 501 } 502 503 /* 504 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's 505 * Makefile will set it to 0 and it will end up as the entry point 506 * here. What it actually means is: use the load address. 507 */ 508 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0) 509 spl_image->entry_point = spl_image->load_addr; 510 511 return 0; 512 } 513