4 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
6 * SPDX-License-Identifier: GPL-2.0+
12 #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 IH_ARCH_DEFAULT IH_ARCH_INVALID
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
35 struct image_tool_params {
57 const char *outfile; /* Output filename */
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' */
62 int file_size; /* Total size of output file */
63 int orig_file_size; /* Original size for file before padding */
64 bool auto_its; /* Automatically create the .its file */
65 int fit_image_type; /* Image type to put into the FIT */
69 * image type specific variables and callback functions
71 struct image_type_params {
72 /* name is an identification tag string for added support */
75 * header size is local to the specific image type to be supported,
76 * mkimage core treats this as number of bytes
79 /* Image type header pointer */
82 * There are several arguments that are passed on the command line
83 * and are registered as flags in image_tool_params structure.
84 * This callback function can be used to check the passed arguments
85 * are in-lined with the image type to be supported
87 * Returns 1 if parameter check is successful
89 int (*check_params) (struct image_tool_params *);
91 * This function is used by list command (i.e. mkimage -l <filename>)
92 * image type verification code must be put here
94 * Returns 0 if image header verification is successful
95 * otherwise, returns respective negative error codes
97 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
98 /* Prints image information abstracting from image header */
99 void (*print_header) (const void *);
101 * The header or image contents need to be set as per image type to
102 * be generated using this callback function.
103 * further output file post processing (for ex. checksum calculation,
104 * padding bytes etc..) can also be done in this callback function.
106 void (*set_header) (void *, struct stat *, int,
107 struct image_tool_params *);
109 * This function is used by the command to retrieve a component
110 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
112 * Thus the code to extract a file from an image must be put here.
114 * Returns 0 if the file was successfully retrieved from the image,
115 * or a negative value on error.
117 int (*extract_subimage)(void *, struct image_tool_params *);
119 * Some image generation support for ex (default image type) supports
120 * more than one type_ids, this callback function is used to check
121 * whether input (-T <image_type>) is supported by registered image
122 * generation/list low level code
124 int (*check_image_type) (uint8_t);
125 /* This callback function will be executed if fflag is defined */
126 int (*fflag_handle) (struct image_tool_params *);
128 * This callback function will be executed for variable size record
129 * It is expected to build this header in memory and return its length
130 * and a pointer to it by using image_type_params.header_size and
131 * image_type_params.hdr. The return value shall indicate if an
132 * additional padding should be used when copying the data image
133 * by returning the padding length.
135 int (*vrec_header) (struct image_tool_params *,
136 struct image_type_params *);
140 * imagetool_get_type() - find the image type params for a given image type
142 * It scans all registers image type supports
143 * checks the input type for each supported image type
146 * returns respective image_type_params pointer if success
147 * if input type_id is not supported by any of image_type_support
150 struct image_type_params *imagetool_get_type(int type);
153 * imagetool_verify_print_header() - verifies the image header
155 * Scan registered image types and verify the image_header for each
156 * supported image type. If verification is successful, this prints
157 * the respective header.
159 * @return 0 on success, negative if input image format does not match with
160 * any of supported image types
162 int imagetool_verify_print_header(
165 struct image_type_params *tparams,
166 struct image_tool_params *params);
169 * imagetool_save_subimage - store data into a file
170 * @file_name: name of the destination file
171 * @file_data: data to be written
172 * @file_len: the amount of data to store
174 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
175 * into the file name by file_name.
178 * zero in case of success or a negative value if fail.
180 int imagetool_save_subimage(
181 const char *file_name,
186 * imagetool_get_filesize() - Utility function to obtain the size of a file
188 * This function prints a message if an error occurs, showing the error that
191 * @params: mkimage parameters
192 * @fname: filename to check
193 * @return size of file, or -ve value on error
195 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
198 * There is a c file associated with supported image type low level code
199 * for ex. default_image.c, fit_image.c
203 void pbl_load_uboot(int fd, struct image_tool_params *mparams);
205 #define ___cat(a, b) a ## b
206 #define __cat(a, b) ___cat(a, b)
208 /* we need some special handling for this host tool running eventually on
209 * Darwin. The Mach-O section handling is a bit different than ELF section
210 * handling. The differnces in detail are:
211 * a) we have segments which have sections
212 * b) we need a API call to get the respective section symbols */
213 #if defined(__MACH__)
214 #include <mach-o/getsect.h>
216 #define INIT_SECTION(name) do { \
217 unsigned long name ## _len; \
218 char *__cat(pstart_, name) = getsectdata("__TEXT", \
219 #name, &__cat(name, _len)); \
220 char *__cat(pstop_, name) = __cat(pstart_, name) + \
222 __cat(__start_, name) = (void *)__cat(pstart_, name); \
223 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
225 #define SECTION(name) __attribute__((section("__TEXT, " #name)))
227 struct image_type_params **__start_image_type, **__stop_image_type;
229 #define INIT_SECTION(name) /* no-op for ELF */
230 #define SECTION(name) __attribute__((section(#name)))
232 /* We construct a table of pointers in an ELF section (pointers generally
233 * go unpadded by gcc). ld creates boundary syms for us. */
234 extern struct image_type_params *__start_image_type[], *__stop_image_type[];
235 #endif /* __MACH__ */
238 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
239 # define __used __attribute__((__unused__))
241 # define __used __attribute__((__used__))
245 #define U_BOOT_IMAGE_TYPE( \
259 static struct image_type_params __cat(image_type_, _id) = \
262 .header_size = _header_size, \
264 .check_params = _check_params, \
265 .verify_header = _verify_header, \
266 .print_header = _print_header, \
267 .set_header = _set_header, \
268 .extract_subimage = _extract_subimage, \
269 .check_image_type = _check_image_type, \
270 .fflag_handle = _fflag_handle, \
271 .vrec_header = _vrec_header \
273 static struct image_type_params *SECTION(image_type) __used \
274 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
276 #endif /* _IMAGETOOL_H_ */