xref: /openbmc/u-boot/tools/imagetool.h (revision 747778cf)
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>
19 #include <sys/types.h>
20 #include <time.h>
21 #include <unistd.h>
22 #include <u-boot/sha1.h>
23 
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 /* 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 
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;
46 	int iflag;
47 	int lflag;
48 	int pflag;
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;
64 	const char *outfile;	/* Output filename */
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' */
69 	int file_size;		/* Total size of output file */
70 	int orig_file_size;	/* Original size for file before padding */
71 	bool auto_its;		/* Automatically create the .its file */
72 	int fit_image_type;	/* Image type to put into the FIT */
73 	char *fit_ramdisk;	/* Ramdisk file to include */
74 	struct content_info *content_head;	/* List of files to include */
75 	struct content_info *content_tail;
76 	bool external_data;	/* Store data outside the FIT */
77 	bool quiet;		/* Don't output text in normal operation */
78 	unsigned int external_offset;	/* Add padding to external data */
79 	const char *engine_id;	/* Engine to use for signing */
80 };
81 
82 /*
83  * image type specific variables and callback functions
84  */
85 struct image_type_params {
86 	/* name is an identification tag string for added support */
87 	char *name;
88 	/*
89 	 * header size is local to the specific image type to be supported,
90 	 * mkimage core treats this as number of bytes
91 	 */
92 	uint32_t header_size;
93 	/* Image type header pointer */
94 	void *hdr;
95 	/*
96 	 * There are several arguments that are passed on the command line
97 	 * and are registered as flags in image_tool_params structure.
98 	 * This callback function can be used to check the passed arguments
99 	 * are in-lined with the image type to be supported
100 	 *
101 	 * Returns 1 if parameter check is successful
102 	 */
103 	int (*check_params) (struct image_tool_params *);
104 	/*
105 	 * This function is used by list command (i.e. mkimage -l <filename>)
106 	 * image type verification code must be put here
107 	 *
108 	 * Returns 0 if image header verification is successful
109 	 * otherwise, returns respective negative error codes
110 	 */
111 	int (*verify_header) (unsigned char *, int, struct image_tool_params *);
112 	/* Prints image information abstracting from image header */
113 	void (*print_header) (const void *);
114 	/*
115 	 * The header or image contents need to be set as per image type to
116 	 * be generated using this callback function.
117 	 * further output file post processing (for ex. checksum calculation,
118 	 * padding bytes etc..) can also be done in this callback function.
119 	 */
120 	void (*set_header) (void *, struct stat *, int,
121 					struct image_tool_params *);
122 	/*
123 	 * This function is used by the command to retrieve a component
124 	 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
125 	 * <sub-image-name>).
126 	 * Thus the code to extract a file from an image must be put here.
127 	 *
128 	 * Returns 0 if the file was successfully retrieved from the image,
129 	 * or a negative value on error.
130 	 */
131 	int (*extract_subimage)(void *, struct image_tool_params *);
132 	/*
133 	 * Some image generation support for ex (default image type) supports
134 	 * more than one type_ids, this callback function is used to check
135 	 * whether input (-T <image_type>) is supported by registered image
136 	 * generation/list low level code
137 	 */
138 	int (*check_image_type) (uint8_t);
139 	/* This callback function will be executed if fflag is defined */
140 	int (*fflag_handle) (struct image_tool_params *);
141 	/*
142 	 * This callback function will be executed for variable size record
143 	 * It is expected to build this header in memory and return its length
144 	 * and a pointer to it by using image_type_params.header_size and
145 	 * image_type_params.hdr. The return value shall indicate if an
146 	 * additional padding should be used when copying the data image
147 	 * by returning the padding length.
148 	 */
149 	int (*vrec_header) (struct image_tool_params *,
150 		struct image_type_params *);
151 };
152 
153 /**
154  * imagetool_get_type() - find the image type params for a given image type
155  *
156  * It scans all registers image type supports
157  * checks the input type for each supported image type
158  *
159  * if successful,
160  *     returns respective image_type_params pointer if success
161  * if input type_id is not supported by any of image_type_support
162  *     returns NULL
163  */
164 struct image_type_params *imagetool_get_type(int type);
165 
166 /*
167  * imagetool_verify_print_header() - verifies the image header
168  *
169  * Scan registered image types and verify the image_header for each
170  * supported image type. If verification is successful, this prints
171  * the respective header.
172  *
173  * @return 0 on success, negative if input image format does not match with
174  * any of supported image types
175  */
176 int imagetool_verify_print_header(
177 	void *ptr,
178 	struct stat *sbuf,
179 	struct image_type_params *tparams,
180 	struct image_tool_params *params);
181 
182 /**
183  * imagetool_save_subimage - store data into a file
184  * @file_name: name of the destination file
185  * @file_data: data to be written
186  * @file_len: the amount of data to store
187  *
188  * imagetool_save_subimage() store file_len bytes of data pointed by file_data
189  * into the file name by file_name.
190  *
191  * returns:
192  *     zero in case of success or a negative value if fail.
193  */
194 int imagetool_save_subimage(
195 	const char *file_name,
196 	ulong file_data,
197 	ulong file_len);
198 
199 /**
200  * imagetool_get_filesize() - Utility function to obtain the size of a file
201  *
202  * This function prints a message if an error occurs, showing the error that
203  * was obtained.
204  *
205  * @params:	mkimage parameters
206  * @fname:	filename to check
207  * @return size of file, or -ve value on error
208  */
209 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
210 
211 /**
212  * imagetool_get_source_date() - Get timestamp for build output.
213  *
214  * Gets a timestamp for embedding it in a build output. If set
215  * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
216  * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
217  * 0.
218  *
219  * @params:	mkimage parameters
220  * @fallback:	timestamp to use if SOURCE_DATE_EPOCH isn't set
221  * @return timestamp based on SOURCE_DATE_EPOCH
222  */
223 time_t imagetool_get_source_date(
224 	struct image_tool_params *params,
225 	time_t fallback);
226 
227 /*
228  * There is a c file associated with supported image type low level code
229  * for ex. default_image.c, fit_image.c
230  */
231 
232 
233 void pbl_load_uboot(int fd, struct image_tool_params *mparams);
234 
235 #define ___cat(a, b) a ## b
236 #define __cat(a, b) ___cat(a, b)
237 
238 /* we need some special handling for this host tool running eventually on
239  * Darwin. The Mach-O section handling is a bit different than ELF section
240  * handling. The differnces in detail are:
241  *  a) we have segments which have sections
242  *  b) we need a API call to get the respective section symbols */
243 #if defined(__MACH__)
244 #include <mach-o/getsect.h>
245 
246 #define INIT_SECTION(name)  do {					\
247 		unsigned long name ## _len;				\
248 		char *__cat(pstart_, name) = getsectdata("__TEXT",	\
249 			#name, &__cat(name, _len));			\
250 		char *__cat(pstop_, name) = __cat(pstart_, name) +	\
251 			__cat(name, _len);				\
252 		__cat(__start_, name) = (void *)__cat(pstart_, name);	\
253 		__cat(__stop_, name) = (void *)__cat(pstop_, name);	\
254 	} while (0)
255 #define SECTION(name)   __attribute__((section("__TEXT, " #name)))
256 
257 struct image_type_params **__start_image_type, **__stop_image_type;
258 #else
259 #define INIT_SECTION(name) /* no-op for ELF */
260 #define SECTION(name)   __attribute__((section(#name)))
261 
262 /* We construct a table of pointers in an ELF section (pointers generally
263  * go unpadded by gcc).  ld creates boundary syms for us. */
264 extern struct image_type_params *__start_image_type[], *__stop_image_type[];
265 #endif /* __MACH__ */
266 
267 #if !defined(__used)
268 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
269 #  define __used			__attribute__((__unused__))
270 # else
271 #  define __used			__attribute__((__used__))
272 # endif
273 #endif
274 
275 #define U_BOOT_IMAGE_TYPE( \
276 		_id, \
277 		_name, \
278 		_header_size, \
279 		_header, \
280 		_check_params, \
281 		_verify_header, \
282 		_print_header, \
283 		_set_header, \
284 		_extract_subimage, \
285 		_check_image_type, \
286 		_fflag_handle, \
287 		_vrec_header \
288 	) \
289 	static struct image_type_params __cat(image_type_, _id) = \
290 	{ \
291 		.name = _name, \
292 		.header_size = _header_size, \
293 		.hdr = _header, \
294 		.check_params = _check_params, \
295 		.verify_header = _verify_header, \
296 		.print_header = _print_header, \
297 		.set_header = _set_header, \
298 		.extract_subimage = _extract_subimage, \
299 		.check_image_type = _check_image_type, \
300 		.fflag_handle = _fflag_handle, \
301 		.vrec_header = _vrec_header \
302 	}; \
303 	static struct image_type_params *SECTION(image_type) __used \
304 		__cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
305 
306 #endif /* _IMAGETOOL_H_ */
307