blob: a766aa2ae91f72129f55061fd9c7449c163e2cbc [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
Massimo Pegorerb93a6522023-01-05 10:31:09 +010042/* FIT auto generation modes */
43enum af_mode {
44 AF_OFF = 0, /* Needs .its or existing FIT to be provided */
45 AF_HASHED_IMG, /* Auto FIT with crc32 hashed images subnodes */
46 AF_SIGNED_IMG, /* Auto FIT with signed images subnodes */
47 AF_SIGNED_CONF, /* Auto FIT with sha1 images and signed configs */
48};
49
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070050/*
51 * This structure defines all such variables those are initialized by
52 * mkimage and dumpimage main core and need to be referred by image
53 * type specific functions
54 */
55struct image_tool_params {
56 int dflag;
57 int eflag;
58 int fflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070059 int iflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070060 int lflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070061 int pflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070062 int vflag;
63 int xflag;
Icenowy Zhengc2d08f02021-10-14 20:53:04 -050064 int Aflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070065 int skipcpy;
66 int os;
67 int arch;
68 int type;
69 int comp;
70 char *dtc;
71 unsigned int addr;
72 unsigned int ep;
73 char *imagename;
74 char *imagename2;
75 char *datafile;
76 char *imagefile;
77 char *cmdname;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070078 const char *outfile; /* Output filename */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070079 const char *keydir; /* Directory holding private keys */
80 const char *keydest; /* Destination .dtb for public key */
Alexandru Gagniuc36bfcb62021-02-19 12:45:17 -060081 const char *keyfile; /* Filename of private or public key */
Sean Anderson87b0af92022-05-16 16:11:08 -040082 const char *keyname; /* Key name "hint" */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070083 const char *comment; /* Comment to add to signature node */
Jan Kiszka32a711d2022-02-05 13:19:36 +010084 /* Algorithm name to use for hashing/signing or NULL to use the one
85 * specified in the its */
86 const char *algo_name;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070087 int require_keys; /* 1 to mark signing keys as 'required' */
Simon Glass92a655c2015-06-23 15:39:12 -060088 int file_size; /* Total size of output file */
Simon Glass1b99e5b2015-08-30 16:55:23 -060089 int orig_file_size; /* Original size for file before padding */
Massimo Pegorerb93a6522023-01-05 10:31:09 +010090 enum af_mode auto_fit; /* Automatically create the FIT */
Simon Glassd505a092016-02-22 22:55:48 -070091 int fit_image_type; /* Image type to put into the FIT */
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +010092 char *fit_ramdisk; /* Ramdisk file to include */
Simon Glassfb4cce02016-02-22 22:55:52 -070093 struct content_info *content_head; /* List of files to include */
94 struct content_info *content_tail;
Simon Glass722ebc82016-02-22 22:55:53 -070095 bool external_data; /* Store data outside the FIT */
Simon Glassbd6e1422016-05-01 13:55:38 -060096 bool quiet; /* Don't output text in normal operation */
Teddy Reedf8f91072016-06-09 19:38:02 -070097 unsigned int external_offset; /* Add padding to external data */
Kever Yangebfe6112020-03-30 11:56:24 +080098 int bl_len; /* Block length in byte for external data */
George McCollisterf1ca1fd2017-01-06 13:14:17 -060099 const char *engine_id; /* Engine to use for signing */
Simon Glass152b2462020-07-09 18:39:43 -0600100 bool reset_timestamp; /* Reset the timestamp on an existing image */
Simon Glass2d2384b2021-11-12 12:28:13 -0700101 struct image_summary summary; /* results of signing process */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700102};
103
104/*
105 * image type specific variables and callback functions
106 */
107struct image_type_params {
108 /* name is an identification tag string for added support */
109 char *name;
110 /*
111 * header size is local to the specific image type to be supported,
112 * mkimage core treats this as number of bytes
113 */
114 uint32_t header_size;
115 /* Image type header pointer */
116 void *hdr;
117 /*
118 * There are several arguments that are passed on the command line
119 * and are registered as flags in image_tool_params structure.
120 * This callback function can be used to check the passed arguments
121 * are in-lined with the image type to be supported
122 *
123 * Returns 1 if parameter check is successful
124 */
125 int (*check_params) (struct image_tool_params *);
126 /*
127 * This function is used by list command (i.e. mkimage -l <filename>)
128 * image type verification code must be put here
129 *
130 * Returns 0 if image header verification is successful
131 * otherwise, returns respective negative error codes
132 */
133 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
134 /* Prints image information abstracting from image header */
Pali Rohár2972d7d2023-03-29 21:25:54 +0200135 void (*print_header) (const void *, struct image_tool_params *);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700136 /*
137 * The header or image contents need to be set as per image type to
138 * be generated using this callback function.
139 * further output file post processing (for ex. checksum calculation,
140 * padding bytes etc..) can also be done in this callback function.
141 */
142 void (*set_header) (void *, struct stat *, int,
143 struct image_tool_params *);
144 /*
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200145 * This function is used by the command to retrieve a component
Tyler Hickse157a112020-10-26 10:40:24 -0500146 * (sub-image) from the image (i.e. dumpimage -p <position>
147 * -o <component-outfile> <image>). Thus the code to extract a file
148 * from an image must be put here.
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700149 *
150 * Returns 0 if the file was successfully retrieved from the image,
151 * or a negative value on error.
152 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200153 int (*extract_subimage)(void *, struct image_tool_params *);
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700154 /*
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700155 * Some image generation support for ex (default image type) supports
156 * more than one type_ids, this callback function is used to check
157 * whether input (-T <image_type>) is supported by registered image
158 * generation/list low level code
159 */
160 int (*check_image_type) (uint8_t);
161 /* This callback function will be executed if fflag is defined */
162 int (*fflag_handle) (struct image_tool_params *);
163 /*
164 * This callback function will be executed for variable size record
165 * It is expected to build this header in memory and return its length
166 * and a pointer to it by using image_type_params.header_size and
167 * image_type_params.hdr. The return value shall indicate if an
168 * additional padding should be used when copying the data image
169 * by returning the padding length.
170 */
171 int (*vrec_header) (struct image_tool_params *,
172 struct image_type_params *);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700173};
174
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200175/**
176 * imagetool_get_type() - find the image type params for a given image type
177 *
178 * It scans all registers image type supports
179 * checks the input type for each supported image type
180 *
181 * if successful,
182 * returns respective image_type_params pointer if success
183 * if input type_id is not supported by any of image_type_support
184 * returns NULL
185 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200186struct image_type_params *imagetool_get_type(int type);
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200187
188/*
189 * imagetool_verify_print_header() - verifies the image header
190 *
Jordan Handd32aa3c2019-03-05 14:47:56 -0800191 * Verify the image_header for the image type given by tparams.
Pali Rohár11f29d42022-02-13 01:09:46 +0100192 * If tparams is NULL then scan registered image types and verify the
193 * image_header for each supported image type.
Jordan Handd32aa3c2019-03-05 14:47:56 -0800194 * If verification is successful, this prints the respective header.
195 * @ptr: pointer the the image header
196 * @sbuf: stat information about the file pointed to by ptr
Pali Rohár11f29d42022-02-13 01:09:46 +0100197 * @tparams: image type parameters or NULL
Jordan Handd32aa3c2019-03-05 14:47:56 -0800198 * @params: mkimage parameters
199 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100200 * Return: 0 on success, negative if input image format does not match with
Jordan Handd32aa3c2019-03-05 14:47:56 -0800201 * the given image type
202 */
Pali Rohár11f29d42022-02-13 01:09:46 +0100203int imagetool_verify_print_header(
Jordan Handd32aa3c2019-03-05 14:47:56 -0800204 void *ptr,
205 struct stat *sbuf,
206 struct image_type_params *tparams,
207 struct image_tool_params *params);
208
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200209/**
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200210 * imagetool_save_subimage - store data into a file
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200211 * @file_name: name of the destination file
212 * @file_data: data to be written
213 * @file_len: the amount of data to store
214 *
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200215 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200216 * into the file name by file_name.
217 *
218 * returns:
219 * zero in case of success or a negative value if fail.
220 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200221int imagetool_save_subimage(
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200222 const char *file_name,
223 ulong file_data,
224 ulong file_len);
225
Simon Glass3837ce62016-02-22 22:55:49 -0700226/**
227 * imagetool_get_filesize() - Utility function to obtain the size of a file
228 *
229 * This function prints a message if an error occurs, showing the error that
230 * was obtained.
231 *
232 * @params: mkimage parameters
233 * @fname: filename to check
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100234 * Return: size of file, or -ve value on error
Simon Glass3837ce62016-02-22 22:55:49 -0700235 */
236int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
237
Vagrant Cascadian58470842016-06-16 12:28:40 -0700238/**
239 * imagetool_get_source_date() - Get timestamp for build output.
240 *
241 * Gets a timestamp for embedding it in a build output. If set
242 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
243 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
244 * 0.
245 *
Alex Kiernan87925df2018-06-20 20:10:51 +0000246 * @cmdname: command name
Vagrant Cascadian58470842016-06-16 12:28:40 -0700247 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100248 * Return: timestamp based on SOURCE_DATE_EPOCH
Vagrant Cascadian58470842016-06-16 12:28:40 -0700249 */
250time_t imagetool_get_source_date(
Alex Kiernan87925df2018-06-20 20:10:51 +0000251 const char *cmdname,
Vagrant Cascadian58470842016-06-16 12:28:40 -0700252 time_t fallback);
253
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700254/*
255 * There is a c file associated with supported image type low level code
256 * for ex. default_image.c, fit_image.c
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700257 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200258
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700259
260void pbl_load_uboot(int fd, struct image_tool_params *mparams);
Alexander Graf6915dcf2018-04-13 14:18:52 +0200261int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
Peng Fana2b96ec2018-10-16 04:50:30 +0000262int imx8image_copy_image(int fd, struct image_tool_params *mparams);
Peng Fan6609c262018-11-20 10:19:36 +0000263int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
Jeffy Cheneea6cd82019-12-27 11:24:41 +0800264int rockchip_copy_image(int fd, struct image_tool_params *mparams);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700265
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100266#define ___cat(a, b) a ## b
267#define __cat(a, b) ___cat(a, b)
268
269/* we need some special handling for this host tool running eventually on
270 * Darwin. The Mach-O section handling is a bit different than ELF section
271 * handling. The differnces in detail are:
272 * a) we have segments which have sections
273 * b) we need a API call to get the respective section symbols */
274#if defined(__MACH__)
275#include <mach-o/getsect.h>
Sergey V. Lobanov54ee4162022-01-25 02:29:44 +0300276#include <mach-o/dyld.h>
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100277
278#define INIT_SECTION(name) do { \
279 unsigned long name ## _len; \
Jessica Clarke3b142042021-03-20 20:43:05 +0000280 char *__cat(pstart_, name) = getsectdata("__DATA", \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100281 #name, &__cat(name, _len)); \
Sergey V. Lobanov54ee4162022-01-25 02:29:44 +0300282 __cat(pstart_, name) += _dyld_get_image_vmaddr_slide(0);\
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100283 char *__cat(pstop_, name) = __cat(pstart_, name) + \
284 __cat(name, _len); \
285 __cat(__start_, name) = (void *)__cat(pstart_, name); \
286 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
287 } while (0)
Jessica Clarke3b142042021-03-20 20:43:05 +0000288#define SECTION(name) __attribute__((section("__DATA, " #name)))
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100289
290struct image_type_params **__start_image_type, **__stop_image_type;
291#else
292#define INIT_SECTION(name) /* no-op for ELF */
293#define SECTION(name) __attribute__((section(#name)))
294
295/* We construct a table of pointers in an ELF section (pointers generally
296 * go unpadded by gcc). ld creates boundary syms for us. */
297extern struct image_type_params *__start_image_type[], *__stop_image_type[];
298#endif /* __MACH__ */
299
300#if !defined(__used)
301# if __GNUC__ == 3 && __GNUC_MINOR__ < 3
302# define __used __attribute__((__unused__))
303# else
304# define __used __attribute__((__used__))
305# endif
306#endif
307
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200308#define U_BOOT_IMAGE_TYPE( \
309 _id, \
310 _name, \
311 _header_size, \
312 _header, \
313 _check_params, \
314 _verify_header, \
315 _print_header, \
316 _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200317 _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200318 _check_image_type, \
319 _fflag_handle, \
320 _vrec_header \
321 ) \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100322 static struct image_type_params __cat(image_type_, _id) = \
323 { \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200324 .name = _name, \
325 .header_size = _header_size, \
326 .hdr = _header, \
327 .check_params = _check_params, \
328 .verify_header = _verify_header, \
329 .print_header = _print_header, \
330 .set_header = _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200331 .extract_subimage = _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200332 .check_image_type = _check_image_type, \
333 .fflag_handle = _fflag_handle, \
334 .vrec_header = _vrec_header \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100335 }; \
336 static struct image_type_params *SECTION(image_type) __used \
337 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200338
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700339#endif /* _IMAGETOOL_H_ */