[people/ms/u-boot.git] / tools / imagetool.h

/*
 * (C) Copyright 2013
 *
 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef _IMAGETOOL_H_
#define _IMAGETOOL_H_

#include "os_support.h"
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
#include <u-boot/sha1.h>

#include "fdt_host.h"

#define ARRAY_SIZE(x)		(sizeof(x) / sizeof((x)[0]))

#define IH_ARCH_DEFAULT		IH_ARCH_INVALID

/* Information about a file that needs to be placed into the FIT */
struct content_info {
	struct content_info *next;
	int type;		/* File type (IH_TYPE_...) */
	const char *fname;
};

/*
 * This structure defines all such variables those are initialized by
 * mkimage and dumpimage main core and need to be referred by image
 * type specific functions
 */
struct image_tool_params {
	int dflag;
	int eflag;
	int fflag;
	int iflag;
	int lflag;
	int pflag;
	int vflag;
	int xflag;
	int skipcpy;
	int os;
	int arch;
	int type;
	int comp;
	char *dtc;
	unsigned int addr;
	unsigned int ep;
	char *imagename;
	char *imagename2;
	char *datafile;
	char *imagefile;
	char *cmdname;
	const char *outfile;	/* Output filename */
	const char *keydir;	/* Directory holding private keys */
	const char *keydest;	/* Destination .dtb for public key */
	const char *comment;	/* Comment to add to signature node */
	int require_keys;	/* 1 to mark signing keys as 'required' */
	int file_size;		/* Total size of output file */
	int orig_file_size;	/* Original size for file before padding */
	bool auto_its;		/* Automatically create the .its file */
	int fit_image_type;	/* Image type to put into the FIT */
	struct content_info *content_head;	/* List of files to include */
	struct content_info *content_tail;
};

/*
 * image type specific variables and callback functions
 */
struct image_type_params {
	/* name is an identification tag string for added support */
	char *name;
	/*
	 * header size is local to the specific image type to be supported,
	 * mkimage core treats this as number of bytes
	 */
	uint32_t header_size;
	/* Image type header pointer */
	void *hdr;
	/*
	 * There are several arguments that are passed on the command line
	 * and are registered as flags in image_tool_params structure.
	 * This callback function can be used to check the passed arguments
	 * are in-lined with the image type to be supported
	 *
	 * Returns 1 if parameter check is successful
	 */
	int (*check_params) (struct image_tool_params *);
	/*
	 * This function is used by list command (i.e. mkimage -l <filename>)
	 * image type verification code must be put here
	 *
	 * Returns 0 if image header verification is successful
	 * otherwise, returns respective negative error codes
	 */
	int (*verify_header) (unsigned char *, int, struct image_tool_params *);
	/* Prints image information abstracting from image header */
	void (*print_header) (const void *);
	/*
	 * The header or image contents need to be set as per image type to
	 * be generated using this callback function.
	 * further output file post processing (for ex. checksum calculation,
	 * padding bytes etc..) can also be done in this callback function.
	 */
	void (*set_header) (void *, struct stat *, int,
					struct image_tool_params *);
	/*
	 * This function is used by the command to retrieve a component
	 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
	 * <sub-image-name>).
	 * Thus the code to extract a file from an image must be put here.
	 *
	 * Returns 0 if the file was successfully retrieved from the image,
	 * or a negative value on error.
	 */
	int (*extract_subimage)(void *, struct image_tool_params *);
	/*
	 * Some image generation support for ex (default image type) supports
	 * more than one type_ids, this callback function is used to check
	 * whether input (-T <image_type>) is supported by registered image
	 * generation/list low level code
	 */
	int (*check_image_type) (uint8_t);
	/* This callback function will be executed if fflag is defined */
	int (*fflag_handle) (struct image_tool_params *);
	/*
	 * This callback function will be executed for variable size record
	 * It is expected to build this header in memory and return its length
	 * and a pointer to it by using image_type_params.header_size and
	 * image_type_params.hdr. The return value shall indicate if an
	 * additional padding should be used when copying the data image
	 * by returning the padding length.
	 */
	int (*vrec_header) (struct image_tool_params *,
		struct image_type_params *);
};

/**
 * imagetool_get_type() - find the image type params for a given image type
 *
 * It scans all registers image type supports
 * checks the input type for each supported image type
 *
 * if successful,
 *     returns respective image_type_params pointer if success
 * if input type_id is not supported by any of image_type_support
 *     returns NULL
 */
struct image_type_params *imagetool_get_type(int type);

/*
 * imagetool_verify_print_header() - verifies the image header
 *
 * Scan registered image types and verify the image_header for each
 * supported image type. If verification is successful, this prints
 * the respective header.
 *
 * @return 0 on success, negative if input image format does not match with
 * any of supported image types
 */
int imagetool_verify_print_header(
	void *ptr,
	struct stat *sbuf,
	struct image_type_params *tparams,
	struct image_tool_params *params);

/**
 * imagetool_save_subimage - store data into a file
 * @file_name: name of the destination file
 * @file_data: data to be written
 * @file_len: the amount of data to store
 *
 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
 * into the file name by file_name.
 *
 * returns:
 *     zero in case of success or a negative value if fail.
 */
int imagetool_save_subimage(
	const char *file_name,
	ulong file_data,
	ulong file_len);

/**
 * imagetool_get_filesize() - Utility function to obtain the size of a file
 *
 * This function prints a message if an error occurs, showing the error that
 * was obtained.
 *
 * @params:	mkimage parameters
 * @fname:	filename to check
 * @return size of file, or -ve value on error
 */
int imagetool_get_filesize(struct image_tool_params *params, const char *fname);

/*
 * There is a c file associated with supported image type low level code
 * for ex. default_image.c, fit_image.c
 */


void pbl_load_uboot(int fd, struct image_tool_params *mparams);

#define ___cat(a, b) a ## b
#define __cat(a, b) ___cat(a, b)

/* we need some special handling for this host tool running eventually on
 * Darwin. The Mach-O section handling is a bit different than ELF section
 * handling. The differnces in detail are:
 *  a) we have segments which have sections
 *  b) we need a API call to get the respective section symbols */
#if defined(__MACH__)
#include <mach-o/getsect.h>

#define INIT_SECTION(name)  do {					\
		unsigned long name ## _len;				\
		char *__cat(pstart_, name) = getsectdata("__TEXT",	\
			#name, &__cat(name, _len));			\
		char *__cat(pstop_, name) = __cat(pstart_, name) +	\
			__cat(name, _len);				\
		__cat(__start_, name) = (void *)__cat(pstart_, name);	\
		__cat(__stop_, name) = (void *)__cat(pstop_, name);	\
	} while (0)
#define SECTION(name)   __attribute__((section("__TEXT, " #name)))

struct image_type_params **__start_image_type, **__stop_image_type;
#else
#define INIT_SECTION(name) /* no-op for ELF */
#define SECTION(name)   __attribute__((section(#name)))

/* We construct a table of pointers in an ELF section (pointers generally
 * go unpadded by gcc).  ld creates boundary syms for us. */
extern struct image_type_params *__start_image_type[], *__stop_image_type[];
#endif /* __MACH__ */

#if !defined(__used)
# if __GNUC__ == 3 && __GNUC_MINOR__ < 3
#  define __used			__attribute__((__unused__))
# else
#  define __used			__attribute__((__used__))
# endif
#endif

#define U_BOOT_IMAGE_TYPE( \
		_id, \
		_name, \
		_header_size, \
		_header, \
		_check_params, \
		_verify_header, \
		_print_header, \
		_set_header, \
		_extract_subimage, \
		_check_image_type, \
		_fflag_handle, \
		_vrec_header \
	) \
	static struct image_type_params __cat(image_type_, _id) = \
	{ \
		.name = _name, \
		.header_size = _header_size, \
		.hdr = _header, \
		.check_params = _check_params, \
		.verify_header = _verify_header, \
		.print_header = _print_header, \
		.set_header = _set_header, \
		.extract_subimage = _extract_subimage, \
		.check_image_type = _check_image_type, \
		.fflag_handle = _fflag_handle, \
		.vrec_header = _vrec_header \
	}; \
	static struct image_type_params *SECTION(image_type) __used \
		__cat(image_type_ptr_, _id) = &__cat(image_type_, _id)

#endif /* _IMAGETOOL_H_ */
Commit	Line	Data
f86ed6a8 GMF	1	/*
	2	* (C) Copyright 2013
	3	*
	4	* Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
	5	*
	6	* SPDX-License-Identifier: GPL-2.0+
	7	*/
	8
	9	#ifndef _IMAGETOOL_H_
	10	#define _IMAGETOOL_H_
	11
	12	#include "os_support.h"
	13	#include <errno.h>
	14	#include <fcntl.h>
	15	#include <stdio.h>
	16	#include <stdlib.h>
	17	#include <string.h>
	18	#include <sys/stat.h>
26e355d1	19	#include <sys/types.h>
f86ed6a8 GMF	20	#include <time.h>
f86ed6a8 GMF	21	#include <unistd.h>
2b9912e6	22	#include <u-boot/sha1.h>
a93648d1	23
f86ed6a8 GMF	24	#include "fdt_host.h"
	25
	26	#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
	27
	28	#define IH_ARCH_DEFAULT IH_ARCH_INVALID
	29
fb4cce0f SG	30	/* Information about a file that needs to be placed into the FIT */
	31	struct content_info {
	32	struct content_info *next;
	33	int type; /* File type (IH_TYPE_...) */
	34	const char *fname;
	35	};
	36
f86ed6a8 GMF	37	/*
	38	* This structure defines all such variables those are initialized by
	39	* mkimage and dumpimage main core and need to be referred by image
	40	* type specific functions
	41	*/
	42	struct image_tool_params {
	43	int dflag;
	44	int eflag;
	45	int fflag;
a804b5ce	46	int iflag;
f86ed6a8	47	int lflag;
a804b5ce	48	int pflag;
f86ed6a8 GMF	49	int vflag;
	50	int xflag;
	51	int skipcpy;
	52	int os;
	53	int arch;
	54	int type;
	55	int comp;
	56	char *dtc;
	57	unsigned int addr;
	58	unsigned int ep;
	59	char *imagename;
	60	char *imagename2;
	61	char *datafile;
	62	char *imagefile;
	63	char *cmdname;
a804b5ce	64	const char outfile; / Output filename */
f86ed6a8 GMF	65	const char keydir; / Directory holding private keys */
	66	const char keydest; / Destination .dtb for public key */
	67	const char comment; / Comment to add to signature node */
	68	int require_keys; /* 1 to mark signing keys as 'required' */
92a655c3	69	int file_size; /* Total size of output file */
1b99e5bb	70	int orig_file_size; /* Original size for file before padding */
8e35bb07	71	bool auto_its; /* Automatically create the .its file */
d505a09c	72	int fit_image_type; /* Image type to put into the FIT */
fb4cce0f SG	73	struct content_info content_head; / List of files to include */
fb4cce0f SG	74	struct content_info *content_tail;
f86ed6a8 GMF	75	};
	76
	77	/*
	78	* image type specific variables and callback functions
	79	*/
	80	struct image_type_params {
	81	/* name is an identification tag string for added support */
	82	char *name;
	83	/*
	84	* header size is local to the specific image type to be supported,
	85	* mkimage core treats this as number of bytes
	86	*/
	87	uint32_t header_size;
	88	/* Image type header pointer */
	89	void *hdr;
	90	/*
	91	* There are several arguments that are passed on the command line
	92	* and are registered as flags in image_tool_params structure.
	93	* This callback function can be used to check the passed arguments
	94	* are in-lined with the image type to be supported
	95	*
	96	* Returns 1 if parameter check is successful
	97	*/
	98	int (check_params) (struct image_tool_params );
	99	/*
	100	* This function is used by list command (i.e. mkimage -l <filename>)
	101	* image type verification code must be put here
	102	*
	103	* Returns 0 if image header verification is successful
	104	* otherwise, returns respective negative error codes
	105	*/
	106	int (verify_header) (unsigned char , int, struct image_tool_params *);
	107	/* Prints image information abstracting from image header */
	108	void (print_header) (const void );
	109	/*
	110	* The header or image contents need to be set as per image type to
	111	* be generated using this callback function.
	112	* further output file post processing (for ex. checksum calculation,
	113	* padding bytes etc..) can also be done in this callback function.
	114	*/
	115	void (set_header) (void , struct stat *, int,
	116	struct image_tool_params *);
a804b5ce	117	/*
67f946cd GMF	118	* This function is used by the command to retrieve a component
	119	* (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
	120	* <sub-image-name>).
a804b5ce GMF	121	* Thus the code to extract a file from an image must be put here.
	122	*
	123	* Returns 0 if the file was successfully retrieved from the image,
	124	* or a negative value on error.
	125	*/
67f946cd	126	int (extract_subimage)(void , struct image_tool_params *);
f86ed6a8 GMF	127	/*
	128	* Some image generation support for ex (default image type) supports
	129	* more than one type_ids, this callback function is used to check
	130	* whether input (-T <image_type>) is supported by registered image
	131	* generation/list low level code
	132	*/
	133	int (*check_image_type) (uint8_t);
	134	/* This callback function will be executed if fflag is defined */
	135	int (fflag_handle) (struct image_tool_params );
	136	/*
	137	* This callback function will be executed for variable size record
	138	* It is expected to build this header in memory and return its length
	139	* and a pointer to it by using image_type_params.header_size and
	140	* image_type_params.hdr. The return value shall indicate if an
	141	* additional padding should be used when copying the data image
	142	* by returning the padding length.
	143	*/
	144	int (vrec_header) (struct image_tool_params ,
	145	struct image_type_params *);
f86ed6a8 GMF	146	};
f86ed6a8 GMF	147
0ca6691c GMF	148	/**
	149	* imagetool_get_type() - find the image type params for a given image type
	150	*
	151	* It scans all registers image type supports
	152	* checks the input type for each supported image type
	153	*
	154	* if successful,
	155	* returns respective image_type_params pointer if success
	156	* if input type_id is not supported by any of image_type_support
	157	* returns NULL
	158	*/
a93648d1	159	struct image_type_params *imagetool_get_type(int type);
0ca6691c GMF	160
	161	/*
	162	* imagetool_verify_print_header() - verifies the image header
	163	*
	164	* Scan registered image types and verify the image_header for each
	165	* supported image type. If verification is successful, this prints
	166	* the respective header.
	167	*
	168	* @return 0 on success, negative if input image format does not match with
	169	* any of supported image types
	170	*/
	171	int imagetool_verify_print_header(
	172	void *ptr,
	173	struct stat *sbuf,
	174	struct image_type_params *tparams,
	175	struct image_tool_params *params);
	176
067d1560	177	/**
67f946cd	178	* imagetool_save_subimage - store data into a file
067d1560 GMF	179	* @file_name: name of the destination file
	180	* @file_data: data to be written
	181	* @file_len: the amount of data to store
	182	*
67f946cd	183	* imagetool_save_subimage() store file_len bytes of data pointed by file_data
067d1560 GMF	184	* into the file name by file_name.
	185	*
	186	* returns:
	187	* zero in case of success or a negative value if fail.
	188	*/
67f946cd	189	int imagetool_save_subimage(
067d1560 GMF	190	const char *file_name,
	191	ulong file_data,
	192	ulong file_len);
	193
3837ce65 SG	194	/**
	195	* imagetool_get_filesize() - Utility function to obtain the size of a file
	196	*
	197	* This function prints a message if an error occurs, showing the error that
	198	* was obtained.
	199	*
	200	* @params: mkimage parameters
	201	* @fname: filename to check
	202	* @return size of file, or -ve value on error
	203	*/
	204	int imagetool_get_filesize(struct image_tool_params params, const char fname);
	205
f86ed6a8 GMF	206	/*
	207	* There is a c file associated with supported image type low level code
	208	* for ex. default_image.c, fit_image.c
f86ed6a8	209	*/
a93648d1	210
f86ed6a8 GMF	211
	212	void pbl_load_uboot(int fd, struct image_tool_params *mparams);
	213
1fddd7b6 AB	214	#define ___cat(a, b) a ## b
	215	#define __cat(a, b) ___cat(a, b)
	216
	217	/* we need some special handling for this host tool running eventually on
	218	* Darwin. The Mach-O section handling is a bit different than ELF section
	219	* handling. The differnces in detail are:
	220	* a) we have segments which have sections
	221	* b) we need a API call to get the respective section symbols */
	222	#if defined(__MACH__)
	223	#include <mach-o/getsect.h>
	224
	225	#define INIT_SECTION(name) do { \
	226	unsigned long name ## _len; \
	227	char *__cat(pstart_, name) = getsectdata("__TEXT", \
	228	#name, &__cat(name, _len)); \
	229	char *__cat(pstop_, name) = __cat(pstart_, name) + \
	230	__cat(name, _len); \
	231	__cat(__start_, name) = (void *)__cat(pstart_, name); \
	232	__cat(__stop_, name) = (void *)__cat(pstop_, name); \
	233	} while (0)
	234	#define SECTION(name) __attribute__((section("__TEXT, " #name)))
	235
	236	struct image_type_params __start_image_type, __stop_image_type;
	237	#else
	238	#define INIT_SECTION(name) /* no-op for ELF */
	239	#define SECTION(name) __attribute__((section(#name)))
	240
	241	/* We construct a table of pointers in an ELF section (pointers generally
	242	* go unpadded by gcc). ld creates boundary syms for us. */
	243	extern struct image_type_params __start_image_type[], __stop_image_type[];
	244	#endif /* __MACH__ */
	245
	246	#if !defined(__used)
	247	# if __GNUC__ == 3 && __GNUC_MINOR__ < 3
	248	# define __used __attribute__((__unused__))
	249	# else
	250	# define __used __attribute__((__used__))
	251	# endif
	252	#endif
	253
a93648d1 GMF	254	#define U_BOOT_IMAGE_TYPE( \
	255	_id, \
	256	_name, \
	257	_header_size, \
	258	_header, \
	259	_check_params, \
	260	_verify_header, \
	261	_print_header, \
	262	_set_header, \
67f946cd	263	_extract_subimage, \
a93648d1 GMF	264	_check_image_type, \
	265	_fflag_handle, \
	266	_vrec_header \
	267	) \
1fddd7b6 AB	268	static struct image_type_params __cat(image_type_, _id) = \
1fddd7b6 AB	269	{ \
a93648d1 GMF	270	.name = _name, \
	271	.header_size = _header_size, \
	272	.hdr = _header, \
	273	.check_params = _check_params, \
	274	.verify_header = _verify_header, \
	275	.print_header = _print_header, \
	276	.set_header = _set_header, \
67f946cd	277	.extract_subimage = _extract_subimage, \
a93648d1 GMF	278	.check_image_type = _check_image_type, \
	279	.fflag_handle = _fflag_handle, \
	280	.vrec_header = _vrec_header \
1fddd7b6 AB	281	}; \
	282	static struct image_type_params *SECTION(image_type) __used \
	283	__cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
a93648d1	284
f86ed6a8	285	#endif /* _IMAGETOOL_H_ */