u-boot/include/image.h

4  * (C) Copyright 2000-2005
7  * SPDX-License-Identifier:	GPL-2.0+
9  * NOTE: This header file defines an interface to U-Boot. Including
11  * use of U-Boot, and does *not* fall under the heading of "derived
44 #include <asm/u-boot.h>
158 	IH_OS_OP_TEE,			/* OP-TEE	*/
183 	IH_ARCH_NIOS,			/* Nios-32	*/
185 	IH_ARCH_NIOS2,			/* Nios-II	*/
190 	IH_ARCH_NDS32,			/* ANDES Technology - NDS32  */
196 	IH_ARCH_RISCV,			/* RISC-V */
205  *	provided by U-Boot; it is expected that (if they behave
206  *	well) you can continue to work in U-Boot after return from
211  *	drivers, set up the MMU, etc. - this means, that you cannot
212  *	expect to re-enter U-Boot except by resetting the CPU.
216  * "Multi-File Images" contain several images, typically an OS
223  *	"Multi-File Images" start with a list of image sizes, each
228  *	a multiple of 4 bytes - except for the last file).
231  *	U-Boot or FPGA images) which usually will be programmed to
235  *	U-Boot's command interpreter; this feature is especially
236  *	useful when you configure U-Boot to use a real shell (hush)
248 	IH_TYPE_MULTI,			/* Multi-File Image		*/
272 	IH_TYPE_ZYNQMPIMAGE,		/* Xilinx ZynqMP Boot Image */
277 	IH_TYPE_PMMC,            /* TI Power Management Micro-Controller Firmware */
278 	IH_TYPE_RKNAND,			/* Rockchip NAND Boot Image	*/
305 #define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))
461  * genimg_get_os_short_name() - get the short name for an OS
471  * genimg_get_arch_short_name() - get the short name for an architecture
481  * genimg_get_type_short_name() - get the short name for an image type
491  * genimg_get_comp_short_name() - get the short name for a compression method
499  * genimg_get_cat_name() - Get the name of an item in a category
508  * genimg_get_cat_short_name() - Get the short name of an item in a category
517  * genimg_get_cat_count() - Get the number of items in a category
525  * genimg_get_cat_desc() - Get the description of a category
579  * boot_get_loadable - routine to load a list of binaries to memory
607  * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
625  * @return node offset of base image, or -ve error code on error
632  * fit_image_load() - load an image from a FIT
659  * @return node offset of image, or -ve error code on error
673  * fit_get_node_from_config() - Look up an image a FIT by type
675  * This looks in the selected conf@ node (images->fit_uname_cfg) for a
735 		return uimage_to_cpu(hdr->ih_##f); \
756 		return hdr->ih_##f; \
765 	return (char *)hdr->ih_name;
774  * image_get_data - get image payload start address
779  * images it points to the null terminated table of sub-images sizes.
801 		hdr->ih_##f = cpu_to_uimage(val); \
814 		hdr->ih_##f = val; \  in image_set_hdr_l()
863 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"  in image_check_target_arch()
895  * bootz_setup() - Extract stat and size of a Linux xImage
916 #define FIT_IGNORE_PROP		"uboot-ignore"
921 #define FIT_DATA_POSITION_PROP	"data-position"
922 #define FIT_DATA_OFFSET_PROP	"data-offset"
923 #define FIT_DATA_SIZE_PROP	"data-size"
936 #define FIT_ROLLBACK_PROP	"rollback-index"
958 #define FIT_ALIGN(x)		(((x)+IMAGE_ALIGN_SIZE-1)&~(IMAGE_ALIGN_SIZE-1))
975  * fit_get_end - get FIT image size
987  * fit_get_end - get FIT image end
996  * fit_get_name - get FIT node name
1043  * fit_add_verification_data() - add verification data to FIT image nodes
1088  * fit_conf_get_prop_node() - Get node refered to by a configuration
1136 # define gd_fdt_blob()		(gd->ufdt_blob)
1138 # define gd_fdt_blob()		(gd->fdt_blob)
1159 	int required_keynode;		/* Node offset of key to use: -1=any */
1174 # include <u-boot/rsa-checksum.h>
1194 	 * sign() - calculate and return signature for given input data
1208 	 * @return: 0, on success, -ve on error
1215 	 * add_verify_data() - Add verification information to FDT
1218 	 * verification at run-time. The information added depends on the
1223 	 * @return: 0, on success, -ve on error
1228 	 * verify() - Verify a signature against some data
1235 	 * @return 0 if verified, -ve on error
1250  * image_get_checksum_algo() - Look up a checksum algorithm
1258  * image_get_crypto_algo() - Look up a cryptosystem algorithm
1266  * image_get_padding_algo() - Look up a padding algorithm
1274  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1292  * fit_image_check_sig() - Check a single image signature node
1301  *			-1 then any signature will do.
1310  * fit_region_make_list() - Make a list of regions to hash
1342 				"- must reset board to recover!\n", \
1381 /** android_image_load - Load an Android Image from storage.
1412  * board_fit_config_name_match() - Check for a matching board name
1420  * @return 0 if this device tree should be used, non-zero to try the next
1427  * board_fit_image_post_process() - Do any post-process on FIT binary data
1432  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1440  * @spec: special data. SPL: struct spl_load_info info, U-Boot: NULL.
1449 #define FDT_ERROR	((ulong)(-1))
1454  * fit_find_config_node() - Find the node for the best DTB in a FIT image
1463  * @return the node if found, -ve otherwise
1477 	 * handler() - Process a loaded image