[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

/*
 * 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 */
};

/*
 * 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);

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