]>
Commit | Line | Data |
---|---|---|
f86ed6a8 GMF |
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> | |
d2bf1152 | 15 | #include <stdbool.h> |
f86ed6a8 GMF |
16 | #include <stdio.h> |
17 | #include <stdlib.h> | |
18 | #include <string.h> | |
19 | #include <sys/stat.h> | |
26e355d1 | 20 | #include <sys/types.h> |
f86ed6a8 GMF |
21 | #include <time.h> |
22 | #include <unistd.h> | |
2b9912e6 | 23 | #include <u-boot/sha1.h> |
a93648d1 | 24 | |
f86ed6a8 GMF |
25 | #include "fdt_host.h" |
26 | ||
27 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) | |
28 | ||
29 | #define IH_ARCH_DEFAULT IH_ARCH_INVALID | |
30 | ||
fb4cce0f SG |
31 | /* Information about a file that needs to be placed into the FIT */ |
32 | struct content_info { | |
33 | struct content_info *next; | |
34 | int type; /* File type (IH_TYPE_...) */ | |
35 | const char *fname; | |
36 | }; | |
37 | ||
f86ed6a8 GMF |
38 | /* |
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 | |
42 | */ | |
43 | struct image_tool_params { | |
44 | int dflag; | |
45 | int eflag; | |
46 | int fflag; | |
a804b5ce | 47 | int iflag; |
f86ed6a8 | 48 | int lflag; |
a804b5ce | 49 | int pflag; |
f86ed6a8 GMF |
50 | int vflag; |
51 | int xflag; | |
52 | int skipcpy; | |
53 | int os; | |
54 | int arch; | |
55 | int type; | |
56 | int comp; | |
57 | char *dtc; | |
58 | unsigned int addr; | |
59 | unsigned int ep; | |
60 | char *imagename; | |
61 | char *imagename2; | |
62 | char *datafile; | |
63 | char *imagefile; | |
64 | char *cmdname; | |
a804b5ce | 65 | const char *outfile; /* Output filename */ |
f86ed6a8 GMF |
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' */ | |
92a655c3 | 70 | int file_size; /* Total size of output file */ |
1b99e5bb | 71 | int orig_file_size; /* Original size for file before padding */ |
8e35bb07 | 72 | bool auto_its; /* Automatically create the .its file */ |
d505a09c | 73 | int fit_image_type; /* Image type to put into the FIT */ |
0f7c6cdc | 74 | char *fit_ramdisk; /* Ramdisk file to include */ |
fb4cce0f SG |
75 | struct content_info *content_head; /* List of files to include */ |
76 | struct content_info *content_tail; | |
722ebc8f | 77 | bool external_data; /* Store data outside the FIT */ |
bd6e1420 | 78 | bool quiet; /* Don't output text in normal operation */ |
f8f9107d | 79 | unsigned int external_offset; /* Add padding to external data */ |
f1ca1fde | 80 | const char *engine_id; /* Engine to use for signing */ |
f86ed6a8 GMF |
81 | }; |
82 | ||
83 | /* | |
84 | * image type specific variables and callback functions | |
85 | */ | |
86 | struct image_type_params { | |
87 | /* name is an identification tag string for added support */ | |
88 | char *name; | |
89 | /* | |
90 | * header size is local to the specific image type to be supported, | |
91 | * mkimage core treats this as number of bytes | |
92 | */ | |
93 | uint32_t header_size; | |
94 | /* Image type header pointer */ | |
95 | void *hdr; | |
96 | /* | |
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 | |
101 | * | |
102 | * Returns 1 if parameter check is successful | |
103 | */ | |
104 | int (*check_params) (struct image_tool_params *); | |
105 | /* | |
106 | * This function is used by list command (i.e. mkimage -l <filename>) | |
107 | * image type verification code must be put here | |
108 | * | |
109 | * Returns 0 if image header verification is successful | |
110 | * otherwise, returns respective negative error codes | |
111 | */ | |
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 *); | |
115 | /* | |
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. | |
120 | */ | |
121 | void (*set_header) (void *, struct stat *, int, | |
122 | struct image_tool_params *); | |
a804b5ce | 123 | /* |
67f946cd GMF |
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> | |
126 | * <sub-image-name>). | |
a804b5ce GMF |
127 | * Thus the code to extract a file from an image must be put here. |
128 | * | |
129 | * Returns 0 if the file was successfully retrieved from the image, | |
130 | * or a negative value on error. | |
131 | */ | |
67f946cd | 132 | int (*extract_subimage)(void *, struct image_tool_params *); |
f86ed6a8 GMF |
133 | /* |
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 | |
138 | */ | |
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 *); | |
142 | /* | |
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. | |
149 | */ | |
150 | int (*vrec_header) (struct image_tool_params *, | |
151 | struct image_type_params *); | |
f86ed6a8 GMF |
152 | }; |
153 | ||
0ca6691c GMF |
154 | /** |
155 | * imagetool_get_type() - find the image type params for a given image type | |
156 | * | |
157 | * It scans all registers image type supports | |
158 | * checks the input type for each supported image type | |
159 | * | |
160 | * if successful, | |
161 | * returns respective image_type_params pointer if success | |
162 | * if input type_id is not supported by any of image_type_support | |
163 | * returns NULL | |
164 | */ | |
a93648d1 | 165 | struct image_type_params *imagetool_get_type(int type); |
0ca6691c GMF |
166 | |
167 | /* | |
168 | * imagetool_verify_print_header() - verifies the image header | |
169 | * | |
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. | |
173 | * | |
174 | * @return 0 on success, negative if input image format does not match with | |
175 | * any of supported image types | |
176 | */ | |
177 | int imagetool_verify_print_header( | |
178 | void *ptr, | |
179 | struct stat *sbuf, | |
180 | struct image_type_params *tparams, | |
181 | struct image_tool_params *params); | |
182 | ||
067d1560 | 183 | /** |
67f946cd | 184 | * imagetool_save_subimage - store data into a file |
067d1560 GMF |
185 | * @file_name: name of the destination file |
186 | * @file_data: data to be written | |
187 | * @file_len: the amount of data to store | |
188 | * | |
67f946cd | 189 | * imagetool_save_subimage() store file_len bytes of data pointed by file_data |
067d1560 GMF |
190 | * into the file name by file_name. |
191 | * | |
192 | * returns: | |
193 | * zero in case of success or a negative value if fail. | |
194 | */ | |
67f946cd | 195 | int imagetool_save_subimage( |
067d1560 GMF |
196 | const char *file_name, |
197 | ulong file_data, | |
198 | ulong file_len); | |
199 | ||
3837ce65 SG |
200 | /** |
201 | * imagetool_get_filesize() - Utility function to obtain the size of a file | |
202 | * | |
203 | * This function prints a message if an error occurs, showing the error that | |
204 | * was obtained. | |
205 | * | |
206 | * @params: mkimage parameters | |
207 | * @fname: filename to check | |
208 | * @return size of file, or -ve value on error | |
209 | */ | |
210 | int imagetool_get_filesize(struct image_tool_params *params, const char *fname); | |
211 | ||
5847084f VC |
212 | /** |
213 | * imagetool_get_source_date() - Get timestamp for build output. | |
214 | * | |
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 | |
218 | * 0. | |
219 | * | |
220 | * @params: mkimage parameters | |
221 | * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set | |
222 | * @return timestamp based on SOURCE_DATE_EPOCH | |
223 | */ | |
224 | time_t imagetool_get_source_date( | |
225 | struct image_tool_params *params, | |
226 | time_t fallback); | |
227 | ||
f86ed6a8 GMF |
228 | /* |
229 | * There is a c file associated with supported image type low level code | |
230 | * for ex. default_image.c, fit_image.c | |
f86ed6a8 | 231 | */ |
a93648d1 | 232 | |
f86ed6a8 GMF |
233 | |
234 | void pbl_load_uboot(int fd, struct image_tool_params *mparams); | |
235 | ||
1fddd7b6 AB |
236 | #define ___cat(a, b) a ## b |
237 | #define __cat(a, b) ___cat(a, b) | |
238 | ||
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> | |
246 | ||
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) + \ | |
252 | __cat(name, _len); \ | |
253 | __cat(__start_, name) = (void *)__cat(pstart_, name); \ | |
254 | __cat(__stop_, name) = (void *)__cat(pstop_, name); \ | |
255 | } while (0) | |
256 | #define SECTION(name) __attribute__((section("__TEXT, " #name))) | |
257 | ||
258 | struct image_type_params **__start_image_type, **__stop_image_type; | |
259 | #else | |
260 | #define INIT_SECTION(name) /* no-op for ELF */ | |
261 | #define SECTION(name) __attribute__((section(#name))) | |
262 | ||
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__ */ | |
267 | ||
268 | #if !defined(__used) | |
269 | # if __GNUC__ == 3 && __GNUC_MINOR__ < 3 | |
270 | # define __used __attribute__((__unused__)) | |
271 | # else | |
272 | # define __used __attribute__((__used__)) | |
273 | # endif | |
274 | #endif | |
275 | ||
a93648d1 GMF |
276 | #define U_BOOT_IMAGE_TYPE( \ |
277 | _id, \ | |
278 | _name, \ | |
279 | _header_size, \ | |
280 | _header, \ | |
281 | _check_params, \ | |
282 | _verify_header, \ | |
283 | _print_header, \ | |
284 | _set_header, \ | |
67f946cd | 285 | _extract_subimage, \ |
a93648d1 GMF |
286 | _check_image_type, \ |
287 | _fflag_handle, \ | |
288 | _vrec_header \ | |
289 | ) \ | |
1fddd7b6 AB |
290 | static struct image_type_params __cat(image_type_, _id) = \ |
291 | { \ | |
a93648d1 GMF |
292 | .name = _name, \ |
293 | .header_size = _header_size, \ | |
294 | .hdr = _header, \ | |
295 | .check_params = _check_params, \ | |
296 | .verify_header = _verify_header, \ | |
297 | .print_header = _print_header, \ | |
298 | .set_header = _set_header, \ | |
67f946cd | 299 | .extract_subimage = _extract_subimage, \ |
a93648d1 GMF |
300 | .check_image_type = _check_image_type, \ |
301 | .fflag_handle = _fflag_handle, \ | |
302 | .vrec_header = _vrec_header \ | |
1fddd7b6 AB |
303 | }; \ |
304 | static struct image_type_params *SECTION(image_type) __used \ | |
305 | __cat(image_type_ptr_, _id) = &__cat(image_type_, _id) | |
a93648d1 | 306 | |
f86ed6a8 | 307 | #endif /* _IMAGETOOL_H_ */ |