]>
git.ipfire.org Git - people/ms/u-boot.git/blob - tools/imagetool.h
4 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
6 * SPDX-License-Identifier: GPL-2.0+
12 #include "os_support.h"
20 #include <sys/types.h>
23 #include <u-boot/sha1.h>
27 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
29 #define IH_ARCH_DEFAULT IH_ARCH_INVALID
31 /* Information about a file that needs to be placed into the FIT */
33 struct content_info
*next
;
34 int type
; /* File type (IH_TYPE_...) */
39 * This structure defines all such variables those are initialized by
40 * mkimage and dumpimage main core and need to be referred by image
41 * type specific functions
43 struct image_tool_params
{
65 const char *outfile
; /* Output filename */
66 const char *keydir
; /* Directory holding private keys */
67 const char *keydest
; /* Destination .dtb for public key */
68 const char *comment
; /* Comment to add to signature node */
69 int require_keys
; /* 1 to mark signing keys as 'required' */
70 int file_size
; /* Total size of output file */
71 int orig_file_size
; /* Original size for file before padding */
72 bool auto_its
; /* Automatically create the .its file */
73 int fit_image_type
; /* Image type to put into the FIT */
74 char *fit_ramdisk
; /* Ramdisk file to include */
75 struct content_info
*content_head
; /* List of files to include */
76 struct content_info
*content_tail
;
77 bool external_data
; /* Store data outside the FIT */
78 bool quiet
; /* Don't output text in normal operation */
79 unsigned int external_offset
; /* Add padding to external data */
80 const char *engine_id
; /* Engine to use for signing */
84 * image type specific variables and callback functions
86 struct image_type_params
{
87 /* name is an identification tag string for added support */
90 * header size is local to the specific image type to be supported,
91 * mkimage core treats this as number of bytes
94 /* Image type header pointer */
97 * There are several arguments that are passed on the command line
98 * and are registered as flags in image_tool_params structure.
99 * This callback function can be used to check the passed arguments
100 * are in-lined with the image type to be supported
102 * Returns 1 if parameter check is successful
104 int (*check_params
) (struct image_tool_params
*);
106 * This function is used by list command (i.e. mkimage -l <filename>)
107 * image type verification code must be put here
109 * Returns 0 if image header verification is successful
110 * otherwise, returns respective negative error codes
112 int (*verify_header
) (unsigned char *, int, struct image_tool_params
*);
113 /* Prints image information abstracting from image header */
114 void (*print_header
) (const void *);
116 * The header or image contents need to be set as per image type to
117 * be generated using this callback function.
118 * further output file post processing (for ex. checksum calculation,
119 * padding bytes etc..) can also be done in this callback function.
121 void (*set_header
) (void *, struct stat
*, int,
122 struct image_tool_params
*);
124 * This function is used by the command to retrieve a component
125 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
127 * Thus the code to extract a file from an image must be put here.
129 * Returns 0 if the file was successfully retrieved from the image,
130 * or a negative value on error.
132 int (*extract_subimage
)(void *, struct image_tool_params
*);
134 * Some image generation support for ex (default image type) supports
135 * more than one type_ids, this callback function is used to check
136 * whether input (-T <image_type>) is supported by registered image
137 * generation/list low level code
139 int (*check_image_type
) (uint8_t);
140 /* This callback function will be executed if fflag is defined */
141 int (*fflag_handle
) (struct image_tool_params
*);
143 * This callback function will be executed for variable size record
144 * It is expected to build this header in memory and return its length
145 * and a pointer to it by using image_type_params.header_size and
146 * image_type_params.hdr. The return value shall indicate if an
147 * additional padding should be used when copying the data image
148 * by returning the padding length.
150 int (*vrec_header
) (struct image_tool_params
*,
151 struct image_type_params
*);
155 * imagetool_get_type() - find the image type params for a given image type
157 * It scans all registers image type supports
158 * checks the input type for each supported image type
161 * returns respective image_type_params pointer if success
162 * if input type_id is not supported by any of image_type_support
165 struct image_type_params
*imagetool_get_type(int type
);
168 * imagetool_verify_print_header() - verifies the image header
170 * Scan registered image types and verify the image_header for each
171 * supported image type. If verification is successful, this prints
172 * the respective header.
174 * @return 0 on success, negative if input image format does not match with
175 * any of supported image types
177 int imagetool_verify_print_header(
180 struct image_type_params
*tparams
,
181 struct image_tool_params
*params
);
184 * imagetool_save_subimage - store data into a file
185 * @file_name: name of the destination file
186 * @file_data: data to be written
187 * @file_len: the amount of data to store
189 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
190 * into the file name by file_name.
193 * zero in case of success or a negative value if fail.
195 int imagetool_save_subimage(
196 const char *file_name
,
201 * imagetool_get_filesize() - Utility function to obtain the size of a file
203 * This function prints a message if an error occurs, showing the error that
206 * @params: mkimage parameters
207 * @fname: filename to check
208 * @return size of file, or -ve value on error
210 int imagetool_get_filesize(struct image_tool_params
*params
, const char *fname
);
213 * imagetool_get_source_date() - Get timestamp for build output.
215 * Gets a timestamp for embedding it in a build output. If set
216 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
217 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
220 * @params: mkimage parameters
221 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
222 * @return timestamp based on SOURCE_DATE_EPOCH
224 time_t imagetool_get_source_date(
225 struct image_tool_params
*params
,
229 * There is a c file associated with supported image type low level code
230 * for ex. default_image.c, fit_image.c
234 void pbl_load_uboot(int fd
, struct image_tool_params
*mparams
);
236 #define ___cat(a, b) a ## b
237 #define __cat(a, b) ___cat(a, b)
239 /* we need some special handling for this host tool running eventually on
240 * Darwin. The Mach-O section handling is a bit different than ELF section
241 * handling. The differnces in detail are:
242 * a) we have segments which have sections
243 * b) we need a API call to get the respective section symbols */
244 #if defined(__MACH__)
245 #include <mach-o/getsect.h>
247 #define INIT_SECTION(name) do { \
248 unsigned long name ## _len; \
249 char *__cat(pstart_, name) = getsectdata("__TEXT", \
250 #name, &__cat(name, _len)); \
251 char *__cat(pstop_, name) = __cat(pstart_, name) + \
253 __cat(__start_, name) = (void *)__cat(pstart_, name); \
254 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
256 #define SECTION(name) __attribute__((section("__TEXT, " #name)))
258 struct image_type_params
**__start_image_type
, **__stop_image_type
;
260 #define INIT_SECTION(name) /* no-op for ELF */
261 #define SECTION(name) __attribute__((section(#name)))
263 /* We construct a table of pointers in an ELF section (pointers generally
264 * go unpadded by gcc). ld creates boundary syms for us. */
265 extern struct image_type_params
*__start_image_type
[], *__stop_image_type
[];
266 #endif /* __MACH__ */
269 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
270 # define __used __attribute__((__unused__))
272 # define __used __attribute__((__used__))
276 #define U_BOOT_IMAGE_TYPE( \
290 static struct image_type_params __cat(image_type_, _id) = \
293 .header_size = _header_size, \
295 .check_params = _check_params, \
296 .verify_header = _verify_header, \
297 .print_header = _print_header, \
298 .set_header = _set_header, \
299 .extract_subimage = _extract_subimage, \
300 .check_image_type = _check_image_type, \
301 .fflag_handle = _fflag_handle, \
302 .vrec_header = _vrec_header \
304 static struct image_type_params *SECTION(image_type) __used \
305 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
307 #endif /* _IMAGETOOL_H_ */