f54809cd57864f8312b378afd513d5470e359ae1
[platform/kernel/u-boot.git] / tools / imagetool.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2013
4  *
5  * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
6  */
7
8 #ifndef _IMAGETOOL_H_
9 #define _IMAGETOOL_H_
10
11 #include "os_support.h"
12 #include <errno.h>
13 #include <fcntl.h>
14 #include <stdbool.h>
15 #include <stdio.h>
16 #include <stdlib.h>
17 #include <string.h>
18 #include <sys/stat.h>
19 #include <sys/types.h>
20 #include <time.h>
21 #include <unistd.h>
22 #include <u-boot/sha1.h>
23
24 #include "fdt_host.h"
25
26 #define ARRAY_SIZE(x)           (sizeof(x) / sizeof((x)[0]))
27
28 #define __ALIGN_MASK(x, mask)   (((x) + (mask)) & ~(mask))
29 #define ALIGN(x, a)             __ALIGN_MASK((x), (typeof(x))(a) - 1)
30
31 #define IH_ARCH_DEFAULT         IH_ARCH_INVALID
32
33 /* Information about a file that needs to be placed into the FIT */
34 struct content_info {
35         struct content_info *next;
36         int type;               /* File type (IH_TYPE_...) */
37         const char *fname;
38 };
39
40 /*
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
44  */
45 struct image_tool_params {
46         int dflag;
47         int eflag;
48         int fflag;
49         int iflag;
50         int lflag;
51         int pflag;
52         int vflag;
53         int xflag;
54         int skipcpy;
55         int os;
56         int arch;
57         int type;
58         int comp;
59         char *dtc;
60         unsigned int addr;
61         unsigned int ep;
62         char *imagename;
63         char *imagename2;
64         char *datafile;
65         char *imagefile;
66         char *cmdname;
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         int bl_len;             /* Block length in byte for external data */
83         const char *engine_id;  /* Engine to use for signing */
84 };
85
86 /*
87  * image type specific variables and callback functions
88  */
89 struct image_type_params {
90         /* name is an identification tag string for added support */
91         char *name;
92         /*
93          * header size is local to the specific image type to be supported,
94          * mkimage core treats this as number of bytes
95          */
96         uint32_t header_size;
97         /* Image type header pointer */
98         void *hdr;
99         /*
100          * There are several arguments that are passed on the command line
101          * and are registered as flags in image_tool_params structure.
102          * This callback function can be used to check the passed arguments
103          * are in-lined with the image type to be supported
104          *
105          * Returns 1 if parameter check is successful
106          */
107         int (*check_params) (struct image_tool_params *);
108         /*
109          * This function is used by list command (i.e. mkimage -l <filename>)
110          * image type verification code must be put here
111          *
112          * Returns 0 if image header verification is successful
113          * otherwise, returns respective negative error codes
114          */
115         int (*verify_header) (unsigned char *, int, struct image_tool_params *);
116         /* Prints image information abstracting from image header */
117         void (*print_header) (const void *);
118         /*
119          * The header or image contents need to be set as per image type to
120          * be generated using this callback function.
121          * further output file post processing (for ex. checksum calculation,
122          * padding bytes etc..) can also be done in this callback function.
123          */
124         void (*set_header) (void *, struct stat *, int,
125                                         struct image_tool_params *);
126         /*
127          * This function is used by the command to retrieve a component
128          * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
129          * <sub-image-name>).
130          * Thus the code to extract a file from an image must be put here.
131          *
132          * Returns 0 if the file was successfully retrieved from the image,
133          * or a negative value on error.
134          */
135         int (*extract_subimage)(void *, struct image_tool_params *);
136         /*
137          * Some image generation support for ex (default image type) supports
138          * more than one type_ids, this callback function is used to check
139          * whether input (-T <image_type>) is supported by registered image
140          * generation/list low level code
141          */
142         int (*check_image_type) (uint8_t);
143         /* This callback function will be executed if fflag is defined */
144         int (*fflag_handle) (struct image_tool_params *);
145         /*
146          * This callback function will be executed for variable size record
147          * It is expected to build this header in memory and return its length
148          * and a pointer to it by using image_type_params.header_size and
149          * image_type_params.hdr. The return value shall indicate if an
150          * additional padding should be used when copying the data image
151          * by returning the padding length.
152          */
153         int (*vrec_header) (struct image_tool_params *,
154                 struct image_type_params *);
155 };
156
157 /**
158  * imagetool_get_type() - find the image type params for a given image type
159  *
160  * It scans all registers image type supports
161  * checks the input type for each supported image type
162  *
163  * if successful,
164  *     returns respective image_type_params pointer if success
165  * if input type_id is not supported by any of image_type_support
166  *     returns NULL
167  */
168 struct image_type_params *imagetool_get_type(int type);
169
170 /*
171  * imagetool_verify_print_header() - verifies the image header
172  *
173  * Scan registered image types and verify the image_header for each
174  * supported image type. If verification is successful, this prints
175  * the respective header.
176  *
177  * @return 0 on success, negative if input image format does not match with
178  * any of supported image types
179  */
180 int imagetool_verify_print_header(
181         void *ptr,
182         struct stat *sbuf,
183         struct image_type_params *tparams,
184         struct image_tool_params *params);
185
186 /*
187  * imagetool_verify_print_header_by_type() - verifies the image header
188  *
189  * Verify the image_header for the image type given by tparams.
190  * If verification is successful, this prints the respective header.
191  * @ptr: pointer the the image header
192  * @sbuf: stat information about the file pointed to by ptr
193  * @tparams: image type parameters
194  * @params: mkimage parameters
195  *
196  * @return 0 on success, negative if input image format does not match with
197  * the given image type
198  */
199 int imagetool_verify_print_header_by_type(
200         void *ptr,
201         struct stat *sbuf,
202         struct image_type_params *tparams,
203         struct image_tool_params *params);
204
205 /**
206  * imagetool_save_subimage - store data into a file
207  * @file_name: name of the destination file
208  * @file_data: data to be written
209  * @file_len: the amount of data to store
210  *
211  * imagetool_save_subimage() store file_len bytes of data pointed by file_data
212  * into the file name by file_name.
213  *
214  * returns:
215  *     zero in case of success or a negative value if fail.
216  */
217 int imagetool_save_subimage(
218         const char *file_name,
219         ulong file_data,
220         ulong file_len);
221
222 /**
223  * imagetool_get_filesize() - Utility function to obtain the size of a file
224  *
225  * This function prints a message if an error occurs, showing the error that
226  * was obtained.
227  *
228  * @params:     mkimage parameters
229  * @fname:      filename to check
230  * @return size of file, or -ve value on error
231  */
232 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
233
234 /**
235  * imagetool_get_source_date() - Get timestamp for build output.
236  *
237  * Gets a timestamp for embedding it in a build output. If set
238  * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
239  * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
240  * 0.
241  *
242  * @cmdname:    command name
243  * @fallback:   timestamp to use if SOURCE_DATE_EPOCH isn't set
244  * @return timestamp based on SOURCE_DATE_EPOCH
245  */
246 time_t imagetool_get_source_date(
247         const char *cmdname,
248         time_t fallback);
249
250 /*
251  * There is a c file associated with supported image type low level code
252  * for ex. default_image.c, fit_image.c
253  */
254
255
256 void pbl_load_uboot(int fd, struct image_tool_params *mparams);
257 int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
258 int imx8image_copy_image(int fd, struct image_tool_params *mparams);
259 int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
260 int rockchip_copy_image(int fd, struct image_tool_params *mparams);
261
262 #define ___cat(a, b) a ## b
263 #define __cat(a, b) ___cat(a, b)
264
265 /* we need some special handling for this host tool running eventually on
266  * Darwin. The Mach-O section handling is a bit different than ELF section
267  * handling. The differnces in detail are:
268  *  a) we have segments which have sections
269  *  b) we need a API call to get the respective section symbols */
270 #if defined(__MACH__)
271 #include <mach-o/getsect.h>
272
273 #define INIT_SECTION(name)  do {                                        \
274                 unsigned long name ## _len;                             \
275                 char *__cat(pstart_, name) = getsectdata("__TEXT",      \
276                         #name, &__cat(name, _len));                     \
277                 char *__cat(pstop_, name) = __cat(pstart_, name) +      \
278                         __cat(name, _len);                              \
279                 __cat(__start_, name) = (void *)__cat(pstart_, name);   \
280                 __cat(__stop_, name) = (void *)__cat(pstop_, name);     \
281         } while (0)
282 #define SECTION(name)   __attribute__((section("__TEXT, " #name)))
283
284 struct image_type_params **__start_image_type, **__stop_image_type;
285 #else
286 #define INIT_SECTION(name) /* no-op for ELF */
287 #define SECTION(name)   __attribute__((section(#name)))
288
289 /* We construct a table of pointers in an ELF section (pointers generally
290  * go unpadded by gcc).  ld creates boundary syms for us. */
291 extern struct image_type_params *__start_image_type[], *__stop_image_type[];
292 #endif /* __MACH__ */
293
294 #if !defined(__used)
295 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
296 #  define __used                        __attribute__((__unused__))
297 # else
298 #  define __used                        __attribute__((__used__))
299 # endif
300 #endif
301
302 #define U_BOOT_IMAGE_TYPE( \
303                 _id, \
304                 _name, \
305                 _header_size, \
306                 _header, \
307                 _check_params, \
308                 _verify_header, \
309                 _print_header, \
310                 _set_header, \
311                 _extract_subimage, \
312                 _check_image_type, \
313                 _fflag_handle, \
314                 _vrec_header \
315         ) \
316         static struct image_type_params __cat(image_type_, _id) = \
317         { \
318                 .name = _name, \
319                 .header_size = _header_size, \
320                 .hdr = _header, \
321                 .check_params = _check_params, \
322                 .verify_header = _verify_header, \
323                 .print_header = _print_header, \
324                 .set_header = _set_header, \
325                 .extract_subimage = _extract_subimage, \
326                 .check_image_type = _check_image_type, \
327                 .fflag_handle = _fflag_handle, \
328                 .vrec_header = _vrec_header \
329         }; \
330         static struct image_type_params *SECTION(image_type) __used \
331                 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
332
333 #endif /* _IMAGETOOL_H_ */