blob: 5169b0245dadb43f97d99e2e671803b13fee8b8b [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -07002/*
3 * (C) Copyright 2013
4 *
5 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -07006 */
7
8#ifndef _IMAGETOOL_H_
9#define _IMAGETOOL_H_
10
11#include "os_support.h"
12#include <errno.h>
13#include <fcntl.h>
Masahiro Yamadad2bf1152018-01-21 19:19:15 +090014#include <stdbool.h>
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070015#include <stdio.h>
16#include <stdlib.h>
17#include <string.h>
18#include <sys/stat.h>
Jörg Krause26e355d2015-04-22 21:36:22 +020019#include <sys/types.h>
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070020#include <time.h>
21#include <unistd.h>
Jeroen Hofstee2b9912e2014-06-12 22:27:12 +020022#include <u-boot/sha1.h>
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -020023
Simon Glass2d2384b2021-11-12 12:28:13 -070024#include <image.h>
25
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070026#include "fdt_host.h"
27
28#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
29
Kever Yangc738adb2020-03-30 11:56:17 +080030#define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask))
31#define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a) - 1)
32
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070033#define IH_ARCH_DEFAULT IH_ARCH_INVALID
34
Simon Glassfb4cce02016-02-22 22:55:52 -070035/* Information about a file that needs to be placed into the FIT */
36struct content_info {
37 struct content_info *next;
38 int type; /* File type (IH_TYPE_...) */
39 const char *fname;
40};
41
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070042/*
43 * This structure defines all such variables those are initialized by
44 * mkimage and dumpimage main core and need to be referred by image
45 * type specific functions
46 */
47struct image_tool_params {
48 int dflag;
49 int eflag;
50 int fflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070051 int iflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070052 int lflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070053 int pflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070054 int vflag;
55 int xflag;
56 int skipcpy;
57 int os;
58 int arch;
59 int type;
60 int comp;
61 char *dtc;
62 unsigned int addr;
63 unsigned int ep;
64 char *imagename;
65 char *imagename2;
66 char *datafile;
67 char *imagefile;
68 char *cmdname;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070069 const char *outfile; /* Output filename */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070070 const char *keydir; /* Directory holding private keys */
71 const char *keydest; /* Destination .dtb for public key */
Alexandru Gagniuc36bfcb62021-02-19 12:45:17 -060072 const char *keyfile; /* Filename of private or public key */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070073 const char *comment; /* Comment to add to signature node */
Jan Kiszka32a711d2022-02-05 13:19:36 +010074 /* Algorithm name to use for hashing/signing or NULL to use the one
75 * specified in the its */
76 const char *algo_name;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070077 int require_keys; /* 1 to mark signing keys as 'required' */
Simon Glass92a655c2015-06-23 15:39:12 -060078 int file_size; /* Total size of output file */
Simon Glass1b99e5b2015-08-30 16:55:23 -060079 int orig_file_size; /* Original size for file before padding */
Simon Glass8e35bb02016-02-22 22:55:51 -070080 bool auto_its; /* Automatically create the .its file */
Simon Glassd505a092016-02-22 22:55:48 -070081 int fit_image_type; /* Image type to put into the FIT */
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +010082 char *fit_ramdisk; /* Ramdisk file to include */
Simon Glassfb4cce02016-02-22 22:55:52 -070083 struct content_info *content_head; /* List of files to include */
84 struct content_info *content_tail;
Simon Glass722ebc82016-02-22 22:55:53 -070085 bool external_data; /* Store data outside the FIT */
Simon Glassbd6e1422016-05-01 13:55:38 -060086 bool quiet; /* Don't output text in normal operation */
Teddy Reedf8f91072016-06-09 19:38:02 -070087 unsigned int external_offset; /* Add padding to external data */
Kever Yangebfe6112020-03-30 11:56:24 +080088 int bl_len; /* Block length in byte for external data */
George McCollisterf1ca1fd2017-01-06 13:14:17 -060089 const char *engine_id; /* Engine to use for signing */
Simon Glass152b2462020-07-09 18:39:43 -060090 bool reset_timestamp; /* Reset the timestamp on an existing image */
Simon Glass2d2384b2021-11-12 12:28:13 -070091 struct image_summary summary; /* results of signing process */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070092};
93
94/*
95 * image type specific variables and callback functions
96 */
97struct image_type_params {
98 /* name is an identification tag string for added support */
99 char *name;
100 /*
101 * header size is local to the specific image type to be supported,
102 * mkimage core treats this as number of bytes
103 */
104 uint32_t header_size;
105 /* Image type header pointer */
106 void *hdr;
107 /*
108 * There are several arguments that are passed on the command line
109 * and are registered as flags in image_tool_params structure.
110 * This callback function can be used to check the passed arguments
111 * are in-lined with the image type to be supported
112 *
113 * Returns 1 if parameter check is successful
114 */
115 int (*check_params) (struct image_tool_params *);
116 /*
117 * This function is used by list command (i.e. mkimage -l <filename>)
118 * image type verification code must be put here
119 *
120 * Returns 0 if image header verification is successful
121 * otherwise, returns respective negative error codes
122 */
123 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
124 /* Prints image information abstracting from image header */
125 void (*print_header) (const void *);
126 /*
127 * The header or image contents need to be set as per image type to
128 * be generated using this callback function.
129 * further output file post processing (for ex. checksum calculation,
130 * padding bytes etc..) can also be done in this callback function.
131 */
132 void (*set_header) (void *, struct stat *, int,
133 struct image_tool_params *);
134 /*
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200135 * This function is used by the command to retrieve a component
Tyler Hickse157a112020-10-26 10:40:24 -0500136 * (sub-image) from the image (i.e. dumpimage -p <position>
137 * -o <component-outfile> <image>). Thus the code to extract a file
138 * from an image must be put here.
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700139 *
140 * Returns 0 if the file was successfully retrieved from the image,
141 * or a negative value on error.
142 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200143 int (*extract_subimage)(void *, struct image_tool_params *);
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700144 /*
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700145 * Some image generation support for ex (default image type) supports
146 * more than one type_ids, this callback function is used to check
147 * whether input (-T <image_type>) is supported by registered image
148 * generation/list low level code
149 */
150 int (*check_image_type) (uint8_t);
151 /* This callback function will be executed if fflag is defined */
152 int (*fflag_handle) (struct image_tool_params *);
153 /*
154 * This callback function will be executed for variable size record
155 * It is expected to build this header in memory and return its length
156 * and a pointer to it by using image_type_params.header_size and
157 * image_type_params.hdr. The return value shall indicate if an
158 * additional padding should be used when copying the data image
159 * by returning the padding length.
160 */
161 int (*vrec_header) (struct image_tool_params *,
162 struct image_type_params *);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700163};
164
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200165/**
166 * imagetool_get_type() - find the image type params for a given image type
167 *
168 * It scans all registers image type supports
169 * checks the input type for each supported image type
170 *
171 * if successful,
172 * returns respective image_type_params pointer if success
173 * if input type_id is not supported by any of image_type_support
174 * returns NULL
175 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200176struct image_type_params *imagetool_get_type(int type);
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200177
178/*
179 * imagetool_verify_print_header() - verifies the image header
180 *
Jordan Handd32aa3c2019-03-05 14:47:56 -0800181 * Verify the image_header for the image type given by tparams.
Pali Rohár11f29d42022-02-13 01:09:46 +0100182 * If tparams is NULL then scan registered image types and verify the
183 * image_header for each supported image type.
Jordan Handd32aa3c2019-03-05 14:47:56 -0800184 * If verification is successful, this prints the respective header.
185 * @ptr: pointer the the image header
186 * @sbuf: stat information about the file pointed to by ptr
Pali Rohár11f29d42022-02-13 01:09:46 +0100187 * @tparams: image type parameters or NULL
Jordan Handd32aa3c2019-03-05 14:47:56 -0800188 * @params: mkimage parameters
189 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100190 * Return: 0 on success, negative if input image format does not match with
Jordan Handd32aa3c2019-03-05 14:47:56 -0800191 * the given image type
192 */
Pali Rohár11f29d42022-02-13 01:09:46 +0100193int imagetool_verify_print_header(
Jordan Handd32aa3c2019-03-05 14:47:56 -0800194 void *ptr,
195 struct stat *sbuf,
196 struct image_type_params *tparams,
197 struct image_tool_params *params);
198
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200199/**
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200200 * imagetool_save_subimage - store data into a file
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200201 * @file_name: name of the destination file
202 * @file_data: data to be written
203 * @file_len: the amount of data to store
204 *
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200205 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200206 * into the file name by file_name.
207 *
208 * returns:
209 * zero in case of success or a negative value if fail.
210 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200211int imagetool_save_subimage(
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200212 const char *file_name,
213 ulong file_data,
214 ulong file_len);
215
Simon Glass3837ce62016-02-22 22:55:49 -0700216/**
217 * imagetool_get_filesize() - Utility function to obtain the size of a file
218 *
219 * This function prints a message if an error occurs, showing the error that
220 * was obtained.
221 *
222 * @params: mkimage parameters
223 * @fname: filename to check
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100224 * Return: size of file, or -ve value on error
Simon Glass3837ce62016-02-22 22:55:49 -0700225 */
226int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
227
Vagrant Cascadian58470842016-06-16 12:28:40 -0700228/**
229 * imagetool_get_source_date() - Get timestamp for build output.
230 *
231 * Gets a timestamp for embedding it in a build output. If set
232 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
233 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
234 * 0.
235 *
Alex Kiernan87925df2018-06-20 20:10:51 +0000236 * @cmdname: command name
Vagrant Cascadian58470842016-06-16 12:28:40 -0700237 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100238 * Return: timestamp based on SOURCE_DATE_EPOCH
Vagrant Cascadian58470842016-06-16 12:28:40 -0700239 */
240time_t imagetool_get_source_date(
Alex Kiernan87925df2018-06-20 20:10:51 +0000241 const char *cmdname,
Vagrant Cascadian58470842016-06-16 12:28:40 -0700242 time_t fallback);
243
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700244/*
245 * There is a c file associated with supported image type low level code
246 * for ex. default_image.c, fit_image.c
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700247 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200248
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700249
250void pbl_load_uboot(int fd, struct image_tool_params *mparams);
Alexander Graf6915dcf2018-04-13 14:18:52 +0200251int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
Peng Fana2b96ec2018-10-16 04:50:30 +0000252int imx8image_copy_image(int fd, struct image_tool_params *mparams);
Peng Fan6609c262018-11-20 10:19:36 +0000253int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
Jeffy Cheneea6cd82019-12-27 11:24:41 +0800254int rockchip_copy_image(int fd, struct image_tool_params *mparams);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700255
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100256#define ___cat(a, b) a ## b
257#define __cat(a, b) ___cat(a, b)
258
259/* we need some special handling for this host tool running eventually on
260 * Darwin. The Mach-O section handling is a bit different than ELF section
261 * handling. The differnces in detail are:
262 * a) we have segments which have sections
263 * b) we need a API call to get the respective section symbols */
264#if defined(__MACH__)
265#include <mach-o/getsect.h>
Sergey V. Lobanov54ee4162022-01-25 02:29:44 +0300266#include <mach-o/dyld.h>
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100267
268#define INIT_SECTION(name) do { \
269 unsigned long name ## _len; \
Jessica Clarke3b142042021-03-20 20:43:05 +0000270 char *__cat(pstart_, name) = getsectdata("__DATA", \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100271 #name, &__cat(name, _len)); \
Sergey V. Lobanov54ee4162022-01-25 02:29:44 +0300272 __cat(pstart_, name) += _dyld_get_image_vmaddr_slide(0);\
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100273 char *__cat(pstop_, name) = __cat(pstart_, name) + \
274 __cat(name, _len); \
275 __cat(__start_, name) = (void *)__cat(pstart_, name); \
276 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
277 } while (0)
Jessica Clarke3b142042021-03-20 20:43:05 +0000278#define SECTION(name) __attribute__((section("__DATA, " #name)))
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100279
280struct image_type_params **__start_image_type, **__stop_image_type;
281#else
282#define INIT_SECTION(name) /* no-op for ELF */
283#define SECTION(name) __attribute__((section(#name)))
284
285/* We construct a table of pointers in an ELF section (pointers generally
286 * go unpadded by gcc). ld creates boundary syms for us. */
287extern struct image_type_params *__start_image_type[], *__stop_image_type[];
288#endif /* __MACH__ */
289
290#if !defined(__used)
291# if __GNUC__ == 3 && __GNUC_MINOR__ < 3
292# define __used __attribute__((__unused__))
293# else
294# define __used __attribute__((__used__))
295# endif
296#endif
297
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200298#define U_BOOT_IMAGE_TYPE( \
299 _id, \
300 _name, \
301 _header_size, \
302 _header, \
303 _check_params, \
304 _verify_header, \
305 _print_header, \
306 _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200307 _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200308 _check_image_type, \
309 _fflag_handle, \
310 _vrec_header \
311 ) \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100312 static struct image_type_params __cat(image_type_, _id) = \
313 { \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200314 .name = _name, \
315 .header_size = _header_size, \
316 .hdr = _header, \
317 .check_params = _check_params, \
318 .verify_header = _verify_header, \
319 .print_header = _print_header, \
320 .set_header = _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200321 .extract_subimage = _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200322 .check_image_type = _check_image_type, \
323 .fflag_handle = _fflag_handle, \
324 .vrec_header = _vrec_header \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100325 }; \
326 static struct image_type_params *SECTION(image_type) __used \
327 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200328
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700329#endif /* _IMAGETOOL_H_ */