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