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_IMAGE_POST_PROCESS 237 board_fit_image_post_process(&src, &length); 238 #endif 239 240 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && 241 IS_ENABLED(CONFIG_SPL_GZIP) && 242 image_comp == IH_COMP_GZIP && 243 type == IH_TYPE_KERNEL) { 244 size = length; 245 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN, 246 src, &size)) { 247 puts("Uncompressing error\n"); 248 return -EIO; 249 } 250 length = size; 251 } else { 252 memcpy((void *)load_addr, src, length); 253 } 254 255 if (image_info) { 256 image_info->load_addr = load_addr; 257 image_info->size = length; 258 image_info->entry_point = fdt_getprop_u32(fit, node, "entry"); 259 } 260 261 return 0; 262 } 263 264 static int spl_fit_append_fdt(struct spl_image_info *spl_image, 265 struct spl_load_info *info, ulong sector, 266 void *fit, int images, ulong base_offset) 267 { 268 struct spl_image_info image_info; 269 int node, ret; 270 271 /* Figure out which device tree the board wants to use */ 272 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0); 273 if (node < 0) { 274 debug("%s: cannot find FDT node\n", __func__); 275 return node; 276 } 277 278 /* 279 * Read the device tree and place it after the image. 280 * Align the destination address to ARCH_DMA_MINALIGN. 281 */ 282 image_info.load_addr = spl_image->load_addr + spl_image->size; 283 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 284 &image_info); 285 286 if (ret < 0) 287 return ret; 288 289 /* Make the load-address of the FDT available for the SPL framework */ 290 spl_image->fdt_addr = (void *)image_info.load_addr; 291 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 292 /* Try to make space, so we can inject details on the loadables */ 293 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192); 294 #endif 295 296 return ret; 297 } 298 299 static int spl_fit_record_loadable(const void *fit, int images, int index, 300 void *blob, struct spl_image_info *image) 301 { 302 int ret = 0; 303 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 304 char *name; 305 int node; 306 307 ret = spl_fit_get_image_name(fit, images, "loadables", 308 index, &name); 309 if (ret < 0) 310 return ret; 311 312 node = spl_fit_get_image_node(fit, images, "loadables", index); 313 314 ret = fdt_record_loadable(blob, index, name, image->load_addr, 315 image->size, image->entry_point, 316 fdt_getprop(fit, node, "type", NULL), 317 fdt_getprop(fit, node, "os", NULL)); 318 #endif 319 return ret; 320 } 321 322 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os) 323 { 324 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) 325 return -ENOTSUPP; 326 #else 327 return fit_image_get_os(fit, noffset, os); 328 #endif 329 } 330 331 int spl_load_simple_fit(struct spl_image_info *spl_image, 332 struct spl_load_info *info, ulong sector, void *fit) 333 { 334 int sectors; 335 ulong size; 336 unsigned long count; 337 struct spl_image_info image_info; 338 int node = -1; 339 int images, ret; 340 int base_offset, align_len = ARCH_DMA_MINALIGN - 1; 341 int index = 0; 342 343 /* 344 * For FIT with external data, figure out where the external images 345 * start. This is the base for the data-offset properties in each 346 * image. 347 */ 348 size = fdt_totalsize(fit); 349 size = (size + 3) & ~3; 350 base_offset = (size + 3) & ~3; 351 352 /* 353 * So far we only have one block of data from the FIT. Read the entire 354 * thing, including that first block, placing it so it finishes before 355 * where we will load the image. 356 * 357 * Note that we will load the image such that its first byte will be 358 * at the load address. Since that byte may be part-way through a 359 * block, we may load the image up to one block before the load 360 * address. So take account of that here by subtracting an addition 361 * block length from the FIT start position. 362 * 363 * In fact the FIT has its own load address, but we assume it cannot 364 * be before CONFIG_SYS_TEXT_BASE. 365 * 366 * For FIT with data embedded, data is loaded as part of FIT image. 367 * For FIT with external data, data is not loaded in this step. 368 */ 369 fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len - 370 align_len) & ~align_len); 371 sectors = get_aligned_image_size(info, size, 0); 372 count = info->read(info, sector, sectors, fit); 373 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n", 374 sector, sectors, fit, count); 375 if (count == 0) 376 return -EIO; 377 378 /* find the node holding the images information */ 379 images = fdt_path_offset(fit, FIT_IMAGES_PATH); 380 if (images < 0) { 381 debug("%s: Cannot find /images node: %d\n", __func__, images); 382 return -1; 383 } 384 385 /* 386 * Find the U-Boot image using the following search order: 387 * - start at 'firmware' (e.g. an ARM Trusted Firmware) 388 * - fall back 'kernel' (e.g. a Falcon-mode OS boot 389 * - fall back to using the first 'loadables' entry 390 */ 391 if (node < 0) 392 node = spl_fit_get_image_node(fit, images, "firmware", 0); 393 #ifdef CONFIG_SPL_OS_BOOT 394 if (node < 0) 395 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0); 396 #endif 397 if (node < 0) { 398 debug("could not find firmware image, trying loadables...\n"); 399 node = spl_fit_get_image_node(fit, images, "loadables", 0); 400 /* 401 * If we pick the U-Boot image from "loadables", start at 402 * the second image when later loading additional images. 403 */ 404 index = 1; 405 } 406 if (node < 0) { 407 debug("%s: Cannot find u-boot image node: %d\n", 408 __func__, node); 409 return -1; 410 } 411 412 /* Load the image and set up the spl_image structure */ 413 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 414 spl_image); 415 if (ret) 416 return ret; 417 418 /* 419 * For backward compatibility, we treat the first node that is 420 * as a U-Boot image, if no OS-type has been declared. 421 */ 422 if (!spl_fit_image_get_os(fit, node, &spl_image->os)) 423 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os)); 424 #if !defined(CONFIG_SPL_OS_BOOT) 425 else 426 spl_image->os = IH_OS_U_BOOT; 427 #endif 428 429 /* 430 * Booting a next-stage U-Boot may require us to append the FDT. 431 * We allow this to fail, as the U-Boot image might embed its FDT. 432 */ 433 if (spl_image->os == IH_OS_U_BOOT) 434 spl_fit_append_fdt(spl_image, info, sector, fit, 435 images, base_offset); 436 437 /* Now check if there are more images for us to load */ 438 for (; ; index++) { 439 uint8_t os_type = IH_OS_INVALID; 440 441 node = spl_fit_get_image_node(fit, images, "loadables", index); 442 if (node < 0) 443 break; 444 445 ret = spl_load_fit_image(info, sector, fit, base_offset, node, 446 &image_info); 447 if (ret < 0) 448 continue; 449 450 if (!spl_fit_image_get_os(fit, node, &os_type)) 451 debug("Loadable is %s\n", genimg_get_os_name(os_type)); 452 453 if (os_type == IH_OS_U_BOOT) { 454 spl_fit_append_fdt(&image_info, info, sector, 455 fit, images, base_offset); 456 spl_image->fdt_addr = image_info.fdt_addr; 457 } 458 459 /* 460 * If the "firmware" image did not provide an entry point, 461 * use the first valid entry point from the loadables. 462 */ 463 if (spl_image->entry_point == FDT_ERROR && 464 image_info.entry_point != FDT_ERROR) 465 spl_image->entry_point = image_info.entry_point; 466 467 /* Record our loadables into the FDT */ 468 if (spl_image->fdt_addr) 469 spl_fit_record_loadable(fit, images, index, 470 spl_image->fdt_addr, 471 &image_info); 472 } 473 474 /* 475 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's 476 * Makefile will set it to 0 and it will end up as the entry point 477 * here. What it actually means is: use the load address. 478 */ 479 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0) 480 spl_image->entry_point = spl_image->load_addr; 481 482 return 0; 483 } 484