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