Merge branch 'master' of git://git.denx.de/u-boot-spi
[platform/kernel/u-boot.git] / tools / imagetool.h
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>
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 IH_ARCH_DEFAULT         IH_ARCH_INVALID
29
30 /* Information about a file that needs to be placed into the FIT */
31 struct content_info {
32         struct content_info *next;
33         int type;               /* File type (IH_TYPE_...) */
34         const char *fname;
35 };
36
37 /*
38  * This structure defines all such variables those are initialized by
39  * mkimage and dumpimage main core and need to be referred by image
40  * type specific functions
41  */
42 struct image_tool_params {
43         int dflag;
44         int eflag;
45         int fflag;
46         int iflag;
47         int lflag;
48         int pflag;
49         int vflag;
50         int xflag;
51         int skipcpy;
52         int os;
53         int arch;
54         int type;
55         int comp;
56         char *dtc;
57         unsigned int addr;
58         unsigned int ep;
59         char *imagename;
60         char *imagename2;
61         char *datafile;
62         char *imagefile;
63         char *cmdname;
64         const char *outfile;    /* Output filename */
65         const char *keydir;     /* Directory holding private keys */
66         const char *keydest;    /* Destination .dtb for public key */
67         const char *comment;    /* Comment to add to signature node */
68         int require_keys;       /* 1 to mark signing keys as 'required' */
69         int file_size;          /* Total size of output file */
70         int orig_file_size;     /* Original size for file before padding */
71         bool auto_its;          /* Automatically create the .its file */
72         int fit_image_type;     /* Image type to put into the FIT */
73         struct content_info *content_head;      /* List of files to include */
74         struct content_info *content_tail;
75         bool external_data;     /* Store data outside the FIT */
76 };
77
78 /*
79  * image type specific variables and callback functions
80  */
81 struct image_type_params {
82         /* name is an identification tag string for added support */
83         char *name;
84         /*
85          * header size is local to the specific image type to be supported,
86          * mkimage core treats this as number of bytes
87          */
88         uint32_t header_size;
89         /* Image type header pointer */
90         void *hdr;
91         /*
92          * There are several arguments that are passed on the command line
93          * and are registered as flags in image_tool_params structure.
94          * This callback function can be used to check the passed arguments
95          * are in-lined with the image type to be supported
96          *
97          * Returns 1 if parameter check is successful
98          */
99         int (*check_params) (struct image_tool_params *);
100         /*
101          * This function is used by list command (i.e. mkimage -l <filename>)
102          * image type verification code must be put here
103          *
104          * Returns 0 if image header verification is successful
105          * otherwise, returns respective negative error codes
106          */
107         int (*verify_header) (unsigned char *, int, struct image_tool_params *);
108         /* Prints image information abstracting from image header */
109         void (*print_header) (const void *);
110         /*
111          * The header or image contents need to be set as per image type to
112          * be generated using this callback function.
113          * further output file post processing (for ex. checksum calculation,
114          * padding bytes etc..) can also be done in this callback function.
115          */
116         void (*set_header) (void *, struct stat *, int,
117                                         struct image_tool_params *);
118         /*
119          * This function is used by the command to retrieve a component
120          * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
121          * <sub-image-name>).
122          * Thus the code to extract a file from an image must be put here.
123          *
124          * Returns 0 if the file was successfully retrieved from the image,
125          * or a negative value on error.
126          */
127         int (*extract_subimage)(void *, struct image_tool_params *);
128         /*
129          * Some image generation support for ex (default image type) supports
130          * more than one type_ids, this callback function is used to check
131          * whether input (-T <image_type>) is supported by registered image
132          * generation/list low level code
133          */
134         int (*check_image_type) (uint8_t);
135         /* This callback function will be executed if fflag is defined */
136         int (*fflag_handle) (struct image_tool_params *);
137         /*
138          * This callback function will be executed for variable size record
139          * It is expected to build this header in memory and return its length
140          * and a pointer to it by using image_type_params.header_size and
141          * image_type_params.hdr. The return value shall indicate if an
142          * additional padding should be used when copying the data image
143          * by returning the padding length.
144          */
145         int (*vrec_header) (struct image_tool_params *,
146                 struct image_type_params *);
147 };
148
149 /**
150  * imagetool_get_type() - find the image type params for a given image type
151  *
152  * It scans all registers image type supports
153  * checks the input type for each supported image type
154  *
155  * if successful,
156  *     returns respective image_type_params pointer if success
157  * if input type_id is not supported by any of image_type_support
158  *     returns NULL
159  */
160 struct image_type_params *imagetool_get_type(int type);
161
162 /*
163  * imagetool_verify_print_header() - verifies the image header
164  *
165  * Scan registered image types and verify the image_header for each
166  * supported image type. If verification is successful, this prints
167  * the respective header.
168  *
169  * @return 0 on success, negative if input image format does not match with
170  * any of supported image types
171  */
172 int imagetool_verify_print_header(
173         void *ptr,
174         struct stat *sbuf,
175         struct image_type_params *tparams,
176         struct image_tool_params *params);
177
178 /**
179  * imagetool_save_subimage - store data into a file
180  * @file_name: name of the destination file
181  * @file_data: data to be written
182  * @file_len: the amount of data to store
183  *
184  * imagetool_save_subimage() store file_len bytes of data pointed by file_data
185  * into the file name by file_name.
186  *
187  * returns:
188  *     zero in case of success or a negative value if fail.
189  */
190 int imagetool_save_subimage(
191         const char *file_name,
192         ulong file_data,
193         ulong file_len);
194
195 /**
196  * imagetool_get_filesize() - Utility function to obtain the size of a file
197  *
198  * This function prints a message if an error occurs, showing the error that
199  * was obtained.
200  *
201  * @params:     mkimage parameters
202  * @fname:      filename to check
203  * @return size of file, or -ve value on error
204  */
205 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
206
207 /*
208  * There is a c file associated with supported image type low level code
209  * for ex. default_image.c, fit_image.c
210  */
211
212
213 void pbl_load_uboot(int fd, struct image_tool_params *mparams);
214
215 #define ___cat(a, b) a ## b
216 #define __cat(a, b) ___cat(a, b)
217
218 /* we need some special handling for this host tool running eventually on
219  * Darwin. The Mach-O section handling is a bit different than ELF section
220  * handling. The differnces in detail are:
221  *  a) we have segments which have sections
222  *  b) we need a API call to get the respective section symbols */
223 #if defined(__MACH__)
224 #include <mach-o/getsect.h>
225
226 #define INIT_SECTION(name)  do {                                        \
227                 unsigned long name ## _len;                             \
228                 char *__cat(pstart_, name) = getsectdata("__TEXT",      \
229                         #name, &__cat(name, _len));                     \
230                 char *__cat(pstop_, name) = __cat(pstart_, name) +      \
231                         __cat(name, _len);                              \
232                 __cat(__start_, name) = (void *)__cat(pstart_, name);   \
233                 __cat(__stop_, name) = (void *)__cat(pstop_, name);     \
234         } while (0)
235 #define SECTION(name)   __attribute__((section("__TEXT, " #name)))
236
237 struct image_type_params **__start_image_type, **__stop_image_type;
238 #else
239 #define INIT_SECTION(name) /* no-op for ELF */
240 #define SECTION(name)   __attribute__((section(#name)))
241
242 /* We construct a table of pointers in an ELF section (pointers generally
243  * go unpadded by gcc).  ld creates boundary syms for us. */
244 extern struct image_type_params *__start_image_type[], *__stop_image_type[];
245 #endif /* __MACH__ */
246
247 #if !defined(__used)
248 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
249 #  define __used                        __attribute__((__unused__))
250 # else
251 #  define __used                        __attribute__((__used__))
252 # endif
253 #endif
254
255 #define U_BOOT_IMAGE_TYPE( \
256                 _id, \
257                 _name, \
258                 _header_size, \
259                 _header, \
260                 _check_params, \
261                 _verify_header, \
262                 _print_header, \
263                 _set_header, \
264                 _extract_subimage, \
265                 _check_image_type, \
266                 _fflag_handle, \
267                 _vrec_header \
268         ) \
269         static struct image_type_params __cat(image_type_, _id) = \
270         { \
271                 .name = _name, \
272                 .header_size = _header_size, \
273                 .hdr = _header, \
274                 .check_params = _check_params, \
275                 .verify_header = _verify_header, \
276                 .print_header = _print_header, \
277                 .set_header = _set_header, \
278                 .extract_subimage = _extract_subimage, \
279                 .check_image_type = _check_image_type, \
280                 .fflag_handle = _fflag_handle, \
281                 .vrec_header = _vrec_header \
282         }; \
283         static struct image_type_params *SECTION(image_type) __used \
284                 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
285
286 #endif /* _IMAGETOOL_H_ */