u-boot/include/image.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
5  * (C) Copyright 2000-2005
8  * NOTE: This header file defines an interface to U-Boot. Including
10  * use of U-Boot, and does *not* fall under the heading of "derived
48 #include <asm/u-boot.h>
152 	IH_OS_OPENBSD,			/* OpenBSD	*/
193 	IH_ARCH_I386,			/* Intel x86	*/
203 	IH_ARCH_NIOS,			/* Nios-32	*/
205 	IH_ARCH_NIOS2,			/* Nios-II	*/
210 	IH_ARCH_NDS32,			/* ANDES Technology - NDS32  */
216 	IH_ARCH_RISCV,			/* RISC-V */
225  *	provided by U-Boot; it is expected that (if they behave
226  *	well) you can continue to work in U-Boot after return from
231  *	drivers, set up the MMU, etc. - this means, that you cannot
232  *	expect to re-enter U-Boot except by resetting the CPU.
236  * "Multi-File Images" contain several images, typically an OS
243  *	"Multi-File Images" start with a list of image sizes, each
248  *	a multiple of 4 bytes - except for the last file).
251  *	U-Boot or FPGA images) which usually will be programmed to
255  *	U-Boot's command interpreter; this feature is especially
256  *	useful when you configure U-Boot to use a real shell (hush)
269 	IH_TYPE_MULTI,			/* Multi-File Image		*/
286 	IH_TYPE_X86_SETUP,		/* x86 setup.bin Image		*/
287 	IH_TYPE_LPC32XXIMAGE,		/* x86 setup.bin Image		*/
299 	IH_TYPE_PMMC,            /* TI Power Management Micro-Controller Firmware */
331 #define ROUND(a, b)		(((a) + (b) - 1) & ~((b) - 1))
389 	void		*fit_hdr_setup;	/* x86 setup FIT image header */
390 	const char	*fit_uname_setup; /* x86 setup subimage node name */
391 	int		fit_noffset_setup;/* x86 setup subimage node offset */
484  * genimg_get_os_short_name() - get the short name for an OS
494  * genimg_get_arch_short_name() - get the short name for an architecture
504  * genimg_get_type_short_name() - get the short name for an image type
514  * genimg_get_comp_short_name() - get the short name for a compression method
522  * genimg_get_cat_name() - Get the name of an item in a category
531  * genimg_get_cat_short_name() - Get the short name of an item in a category
540  * genimg_get_cat_count() - Get the number of items in a category
548  * genimg_get_cat_desc() - Get the description of a category
602  * boot_get_loadable - routine to load a list of binaries to memory
613  *   loadables = "linux_kernel", "fdt-2";
630  * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
642  *			name (e.g. "conf-1") or NULL to use the default. On
648  * @return node offset of base image, or -ve error code on error
655  * fit_image_load() - load an image from a FIT
670  *			name (e.g. "conf-1") or NULL to use the default. On
682  * @return node offset of image, or -ve error code on error
691  * fit_get_node_from_config() - Look up an image a FIT by type
693  * This looks in the selected conf- node (images->fit_uname_cfg) for a
705  *	conf-1 {
711  * that conf-1 is the chosen configuration.
745 		return uimage_to_cpu(hdr->ih_##f); \
758 		return hdr->ih_##f; \  in image_get_hdr_l()
767 	return (char *)hdr->ih_name;
776  * image_get_data - get image payload start address
781  * images it points to the null terminated table of sub-images sizes.
803 		hdr->ih_##f = cpu_to_uimage(val); \
816 		hdr->ih_##f = val; \  in image_set_hdr_l()
871 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"  in image_check_target_arch()
903  * bootz_setup() - Extract stat and size of a Linux xImage
918  * @force_reloc: Ignore image->ep field, always place image to RAM start
935 #define FIT_IGNORE_PROP		"uboot-ignore"
940 #define FIT_DATA_POSITION_PROP	"data-position"
941 #define FIT_DATA_OFFSET_PROP	"data-offset"
942 #define FIT_DATA_SIZE_PROP	"data-size"
977  * fit_get_end - get FIT image size
989  * fit_get_end - get FIT image end
998  * fit_get_name - get FIT node name
1037  * fit_add_verification_data() - add verification data to FIT image nodes
1076  * fit_conf_get_prop_node() - Get node refered to by a configuration
1081  * The conf- nodes contain references to other nodes, using properties
1118 # define gd_fdt_blob()		(gd->fdt_blob)
1138 	int required_keynode;		/* Node offset of key to use: -1=any */
1153 # include <u-boot/rsa-checksum.h>
1173 	 * sign() - calculate and return signature for given input data
1187 	 * @return: 0, on success, -ve on error
1194 	 * add_verify_data() - Add verification information to FDT
1197 	 * verification at run-time. The information added depends on the
1202 	 * @return: 0, on success, -ve on error
1207 	 * verify() - Verify a signature against some data
1214 	 * @return 0 if verified, -ve on error
1229  * image_get_checksum_algo() - Look up a checksum algorithm
1237  * image_get_crypto_algo() - Look up a cryptosystem algorithm
1245  * image_get_padding_algo() - Look up a padding algorithm
1253  * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
1271  * fit_image_check_sig() - Check a single image signature node
1280  *			-1 then any signature will do.
1289  * fit_region_make_list() - Make a list of regions to hash
1321 				"- must reset board to recover!\n", \
1345  * board_fit_config_name_match() - Check for a matching board name
1353  * @return 0 if this device tree should be used, non-zero to try the next
1360  * board_fit_image_post_process() - Do any post-process on FIT binary data
1365  * into the FIT creation (i.e. the binary blobs would have been pre-processed
1376 #define FDT_ERROR	((ulong)(-1))
1381  * fit_find_config_node() - Find the node for the best DTB in a FIT image
1390  * @return the node if found, -ve otherwise
1404 	 * handler() - Process a loaded image