1 /* SPDX-License-Identifier: GPL-2.0+ */
5 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
11 #include "os_support.h"
19 #include <sys/types.h>
22 #include <u-boot/sha1.h>
28 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
30 #define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask))
31 #define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a) - 1)
33 #define IH_ARCH_DEFAULT IH_ARCH_INVALID
35 /* Information about a file that needs to be placed into the FIT */
37 struct content_info *next;
38 int type; /* File type (IH_TYPE_...) */
43 * This structure defines all such variables those are initialized by
44 * mkimage and dumpimage main core and need to be referred by image
45 * type specific functions
47 struct image_tool_params {
70 const char *outfile; /* Output filename */
71 const char *keydir; /* Directory holding private keys */
72 const char *keydest; /* Destination .dtb for public key */
73 const char *keyfile; /* Filename of private or public key */
74 const char *comment; /* Comment to add to signature node */
75 /* Algorithm name to use for hashing/signing or NULL to use the one
76 * specified in the its */
77 const char *algo_name;
78 int require_keys; /* 1 to mark signing keys as 'required' */
79 int file_size; /* Total size of output file */
80 int orig_file_size; /* Original size for file before padding */
81 bool auto_its; /* Automatically create the .its file */
82 int fit_image_type; /* Image type to put into the FIT */
83 char *fit_ramdisk; /* Ramdisk file to include */
84 struct content_info *content_head; /* List of files to include */
85 struct content_info *content_tail;
86 bool external_data; /* Store data outside the FIT */
87 bool quiet; /* Don't output text in normal operation */
88 unsigned int external_offset; /* Add padding to external data */
89 int bl_len; /* Block length in byte for external data */
90 const char *engine_id; /* Engine to use for signing */
91 bool reset_timestamp; /* Reset the timestamp on an existing image */
92 struct image_summary summary; /* results of signing process */
96 * image type specific variables and callback functions
98 struct image_type_params {
99 /* name is an identification tag string for added support */
102 * header size is local to the specific image type to be supported,
103 * mkimage core treats this as number of bytes
105 uint32_t header_size;
106 /* Image type header pointer */
109 * There are several arguments that are passed on the command line
110 * and are registered as flags in image_tool_params structure.
111 * This callback function can be used to check the passed arguments
112 * are in-lined with the image type to be supported
114 * Returns 1 if parameter check is successful
116 int (*check_params) (struct image_tool_params *);
118 * This function is used by list command (i.e. mkimage -l <filename>)
119 * image type verification code must be put here
121 * Returns 0 if image header verification is successful
122 * otherwise, returns respective negative error codes
124 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
125 /* Prints image information abstracting from image header */
126 void (*print_header) (const void *);
128 * The header or image contents need to be set as per image type to
129 * be generated using this callback function.
130 * further output file post processing (for ex. checksum calculation,
131 * padding bytes etc..) can also be done in this callback function.
133 void (*set_header) (void *, struct stat *, int,
134 struct image_tool_params *);
136 * This function is used by the command to retrieve a component
137 * (sub-image) from the image (i.e. dumpimage -p <position>
138 * -o <component-outfile> <image>). Thus the code to extract a file
139 * from an image must be put here.
141 * Returns 0 if the file was successfully retrieved from the image,
142 * or a negative value on error.
144 int (*extract_subimage)(void *, struct image_tool_params *);
146 * Some image generation support for ex (default image type) supports
147 * more than one type_ids, this callback function is used to check
148 * whether input (-T <image_type>) is supported by registered image
149 * generation/list low level code
151 int (*check_image_type) (uint8_t);
152 /* This callback function will be executed if fflag is defined */
153 int (*fflag_handle) (struct image_tool_params *);
155 * This callback function will be executed for variable size record
156 * It is expected to build this header in memory and return its length
157 * and a pointer to it by using image_type_params.header_size and
158 * image_type_params.hdr. The return value shall indicate if an
159 * additional padding should be used when copying the data image
160 * by returning the padding length.
162 int (*vrec_header) (struct image_tool_params *,
163 struct image_type_params *);
167 * imagetool_get_type() - find the image type params for a given image type
169 * It scans all registers image type supports
170 * checks the input type for each supported image type
173 * returns respective image_type_params pointer if success
174 * if input type_id is not supported by any of image_type_support
177 struct image_type_params *imagetool_get_type(int type);
180 * imagetool_verify_print_header() - verifies the image header
182 * Verify the image_header for the image type given by tparams.
183 * If tparams is NULL then scan registered image types and verify the
184 * image_header for each supported image type.
185 * If verification is successful, this prints the respective header.
186 * @ptr: pointer the the image header
187 * @sbuf: stat information about the file pointed to by ptr
188 * @tparams: image type parameters or NULL
189 * @params: mkimage parameters
191 * Return: 0 on success, negative if input image format does not match with
192 * the given image type
194 int imagetool_verify_print_header(
197 struct image_type_params *tparams,
198 struct image_tool_params *params);
201 * imagetool_save_subimage - store data into a file
202 * @file_name: name of the destination file
203 * @file_data: data to be written
204 * @file_len: the amount of data to store
206 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
207 * into the file name by file_name.
210 * zero in case of success or a negative value if fail.
212 int imagetool_save_subimage(
213 const char *file_name,
218 * imagetool_get_filesize() - Utility function to obtain the size of a file
220 * This function prints a message if an error occurs, showing the error that
223 * @params: mkimage parameters
224 * @fname: filename to check
225 * Return: size of file, or -ve value on error
227 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
230 * imagetool_get_source_date() - Get timestamp for build output.
232 * Gets a timestamp for embedding it in a build output. If set
233 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
234 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
237 * @cmdname: command name
238 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
239 * Return: timestamp based on SOURCE_DATE_EPOCH
241 time_t imagetool_get_source_date(
246 * There is a c file associated with supported image type low level code
247 * for ex. default_image.c, fit_image.c
251 void pbl_load_uboot(int fd, struct image_tool_params *mparams);
252 int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
253 int imx8image_copy_image(int fd, struct image_tool_params *mparams);
254 int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
255 int rockchip_copy_image(int fd, struct image_tool_params *mparams);
257 #define ___cat(a, b) a ## b
258 #define __cat(a, b) ___cat(a, b)
260 /* we need some special handling for this host tool running eventually on
261 * Darwin. The Mach-O section handling is a bit different than ELF section
262 * handling. The differnces in detail are:
263 * a) we have segments which have sections
264 * b) we need a API call to get the respective section symbols */
265 #if defined(__MACH__)
266 #include <mach-o/getsect.h>
267 #include <mach-o/dyld.h>
269 #define INIT_SECTION(name) do { \
270 unsigned long name ## _len; \
271 char *__cat(pstart_, name) = getsectdata("__DATA", \
272 #name, &__cat(name, _len)); \
273 __cat(pstart_, name) += _dyld_get_image_vmaddr_slide(0);\
274 char *__cat(pstop_, name) = __cat(pstart_, name) + \
276 __cat(__start_, name) = (void *)__cat(pstart_, name); \
277 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
279 #define SECTION(name) __attribute__((section("__DATA, " #name)))
281 struct image_type_params **__start_image_type, **__stop_image_type;
283 #define INIT_SECTION(name) /* no-op for ELF */
284 #define SECTION(name) __attribute__((section(#name)))
286 /* We construct a table of pointers in an ELF section (pointers generally
287 * go unpadded by gcc). ld creates boundary syms for us. */
288 extern struct image_type_params *__start_image_type[], *__stop_image_type[];
289 #endif /* __MACH__ */
292 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
293 # define __used __attribute__((__unused__))
295 # define __used __attribute__((__used__))
299 #define U_BOOT_IMAGE_TYPE( \
313 static struct image_type_params __cat(image_type_, _id) = \
316 .header_size = _header_size, \
318 .check_params = _check_params, \
319 .verify_header = _verify_header, \
320 .print_header = _print_header, \
321 .set_header = _set_header, \
322 .extract_subimage = _extract_subimage, \
323 .check_image_type = _check_image_type, \
324 .fflag_handle = _fflag_handle, \
325 .vrec_header = _vrec_header \
327 static struct image_type_params *SECTION(image_type) __used \
328 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
330 #endif /* _IMAGETOOL_H_ */