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>
26 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
28 #define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask))
29 #define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a) - 1)
31 #define IH_ARCH_DEFAULT IH_ARCH_INVALID
33 /* Information about a file that needs to be placed into the FIT */
35 struct content_info *next;
36 int type; /* File type (IH_TYPE_...) */
41 * This structure defines all such variables those are initialized by
42 * mkimage and dumpimage main core and need to be referred by image
43 * type specific functions
45 struct image_tool_params {
67 const char *outfile; /* Output filename */
68 const char *keydir; /* Directory holding private keys */
69 const char *keydest; /* Destination .dtb for public key */
70 const char *comment; /* Comment to add to signature node */
71 int require_keys; /* 1 to mark signing keys as 'required' */
72 int file_size; /* Total size of output file */
73 int orig_file_size; /* Original size for file before padding */
74 bool auto_its; /* Automatically create the .its file */
75 int fit_image_type; /* Image type to put into the FIT */
76 char *fit_ramdisk; /* Ramdisk file to include */
77 struct content_info *content_head; /* List of files to include */
78 struct content_info *content_tail;
79 bool external_data; /* Store data outside the FIT */
80 bool quiet; /* Don't output text in normal operation */
81 unsigned int external_offset; /* Add padding to external data */
82 const char *engine_id; /* Engine to use for signing */
86 * image type specific variables and callback functions
88 struct image_type_params {
89 /* name is an identification tag string for added support */
92 * header size is local to the specific image type to be supported,
93 * mkimage core treats this as number of bytes
96 /* Image type header pointer */
99 * There are several arguments that are passed on the command line
100 * and are registered as flags in image_tool_params structure.
101 * This callback function can be used to check the passed arguments
102 * are in-lined with the image type to be supported
104 * Returns 1 if parameter check is successful
106 int (*check_params) (struct image_tool_params *);
108 * This function is used by list command (i.e. mkimage -l <filename>)
109 * image type verification code must be put here
111 * Returns 0 if image header verification is successful
112 * otherwise, returns respective negative error codes
114 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
115 /* Prints image information abstracting from image header */
116 void (*print_header) (const void *);
118 * The header or image contents need to be set as per image type to
119 * be generated using this callback function.
120 * further output file post processing (for ex. checksum calculation,
121 * padding bytes etc..) can also be done in this callback function.
123 void (*set_header) (void *, struct stat *, int,
124 struct image_tool_params *);
126 * This function is used by the command to retrieve a component
127 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
129 * Thus the code to extract a file from an image must be put here.
131 * Returns 0 if the file was successfully retrieved from the image,
132 * or a negative value on error.
134 int (*extract_subimage)(void *, struct image_tool_params *);
136 * Some image generation support for ex (default image type) supports
137 * more than one type_ids, this callback function is used to check
138 * whether input (-T <image_type>) is supported by registered image
139 * generation/list low level code
141 int (*check_image_type) (uint8_t);
142 /* This callback function will be executed if fflag is defined */
143 int (*fflag_handle) (struct image_tool_params *);
145 * This callback function will be executed for variable size record
146 * It is expected to build this header in memory and return its length
147 * and a pointer to it by using image_type_params.header_size and
148 * image_type_params.hdr. The return value shall indicate if an
149 * additional padding should be used when copying the data image
150 * by returning the padding length.
152 int (*vrec_header) (struct image_tool_params *,
153 struct image_type_params *);
157 * imagetool_get_type() - find the image type params for a given image type
159 * It scans all registers image type supports
160 * checks the input type for each supported image type
163 * returns respective image_type_params pointer if success
164 * if input type_id is not supported by any of image_type_support
167 struct image_type_params *imagetool_get_type(int type);
170 * imagetool_verify_print_header() - verifies the image header
172 * Scan registered image types and verify the image_header for each
173 * supported image type. If verification is successful, this prints
174 * the respective header.
176 * @return 0 on success, negative if input image format does not match with
177 * any of supported image types
179 int imagetool_verify_print_header(
182 struct image_type_params *tparams,
183 struct image_tool_params *params);
186 * imagetool_verify_print_header_by_type() - verifies the image header
188 * Verify the image_header for the image type given by tparams.
189 * If verification is successful, this prints the respective header.
190 * @ptr: pointer the the image header
191 * @sbuf: stat information about the file pointed to by ptr
192 * @tparams: image type parameters
193 * @params: mkimage parameters
195 * @return 0 on success, negative if input image format does not match with
196 * the given image type
198 int imagetool_verify_print_header_by_type(
201 struct image_type_params *tparams,
202 struct image_tool_params *params);
205 * imagetool_save_subimage - store data into a file
206 * @file_name: name of the destination file
207 * @file_data: data to be written
208 * @file_len: the amount of data to store
210 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
211 * into the file name by file_name.
214 * zero in case of success or a negative value if fail.
216 int imagetool_save_subimage(
217 const char *file_name,
222 * imagetool_get_filesize() - Utility function to obtain the size of a file
224 * This function prints a message if an error occurs, showing the error that
227 * @params: mkimage parameters
228 * @fname: filename to check
229 * @return size of file, or -ve value on error
231 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
234 * imagetool_get_source_date() - Get timestamp for build output.
236 * Gets a timestamp for embedding it in a build output. If set
237 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
238 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
241 * @cmdname: command name
242 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
243 * @return timestamp based on SOURCE_DATE_EPOCH
245 time_t imagetool_get_source_date(
250 * There is a c file associated with supported image type low level code
251 * for ex. default_image.c, fit_image.c
255 void pbl_load_uboot(int fd, struct image_tool_params *mparams);
256 int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
257 int imx8image_copy_image(int fd, struct image_tool_params *mparams);
258 int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
259 int rockchip_copy_image(int fd, struct image_tool_params *mparams);
261 #define ___cat(a, b) a ## b
262 #define __cat(a, b) ___cat(a, b)
264 /* we need some special handling for this host tool running eventually on
265 * Darwin. The Mach-O section handling is a bit different than ELF section
266 * handling. The differnces in detail are:
267 * a) we have segments which have sections
268 * b) we need a API call to get the respective section symbols */
269 #if defined(__MACH__)
270 #include <mach-o/getsect.h>
272 #define INIT_SECTION(name) do { \
273 unsigned long name ## _len; \
274 char *__cat(pstart_, name) = getsectdata("__TEXT", \
275 #name, &__cat(name, _len)); \
276 char *__cat(pstop_, name) = __cat(pstart_, name) + \
278 __cat(__start_, name) = (void *)__cat(pstart_, name); \
279 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
281 #define SECTION(name) __attribute__((section("__TEXT, " #name)))
283 struct image_type_params **__start_image_type, **__stop_image_type;
285 #define INIT_SECTION(name) /* no-op for ELF */
286 #define SECTION(name) __attribute__((section(#name)))
288 /* We construct a table of pointers in an ELF section (pointers generally
289 * go unpadded by gcc). ld creates boundary syms for us. */
290 extern struct image_type_params *__start_image_type[], *__stop_image_type[];
291 #endif /* __MACH__ */
294 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
295 # define __used __attribute__((__unused__))
297 # define __used __attribute__((__used__))
301 #define U_BOOT_IMAGE_TYPE( \
315 static struct image_type_params __cat(image_type_, _id) = \
318 .header_size = _header_size, \
320 .check_params = _check_params, \
321 .verify_header = _verify_header, \
322 .print_header = _print_header, \
323 .set_header = _set_header, \
324 .extract_subimage = _extract_subimage, \
325 .check_image_type = _check_image_type, \
326 .fflag_handle = _fflag_handle, \
327 .vrec_header = _vrec_header \
329 static struct image_type_params *SECTION(image_type) __used \
330 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
332 #endif /* _IMAGETOOL_H_ */