blob: 2801ea9e9f9607198edc15029208f6aadc8d14bc [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
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070024#include "fdt_host.h"
25
26#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
27
Kever Yangc738adb2020-03-30 11:56:17 +080028#define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask))
29#define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a) - 1)
30
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070031#define IH_ARCH_DEFAULT IH_ARCH_INVALID
32
Simon Glassfb4cce02016-02-22 22:55:52 -070033/* Information about a file that needs to be placed into the FIT */
34struct content_info {
35 struct content_info *next;
36 int type; /* File type (IH_TYPE_...) */
37 const char *fname;
38};
39
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070040/*
41 * This structure defines all such variables those are initialized by
42 * mkimage and dumpimage main core and need to be referred by image
43 * type specific functions
44 */
45struct image_tool_params {
46 int dflag;
47 int eflag;
48 int fflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070049 int iflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070050 int lflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070051 int pflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070052 int vflag;
53 int xflag;
54 int skipcpy;
55 int os;
56 int arch;
57 int type;
58 int comp;
59 char *dtc;
60 unsigned int addr;
61 unsigned int ep;
62 char *imagename;
63 char *imagename2;
64 char *datafile;
65 char *imagefile;
66 char *cmdname;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070067 const char *outfile; /* Output filename */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070068 const char *keydir; /* Directory holding private keys */
69 const char *keydest; /* Destination .dtb for public key */
70 const char *comment; /* Comment to add to signature node */
71 int require_keys; /* 1 to mark signing keys as 'required' */
Simon Glass92a655c2015-06-23 15:39:12 -060072 int file_size; /* Total size of output file */
Simon Glass1b99e5b2015-08-30 16:55:23 -060073 int orig_file_size; /* Original size for file before padding */
Simon Glass8e35bb02016-02-22 22:55:51 -070074 bool auto_its; /* Automatically create the .its file */
Simon Glassd505a092016-02-22 22:55:48 -070075 int fit_image_type; /* Image type to put into the FIT */
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +010076 char *fit_ramdisk; /* Ramdisk file to include */
Simon Glassfb4cce02016-02-22 22:55:52 -070077 struct content_info *content_head; /* List of files to include */
78 struct content_info *content_tail;
Simon Glass722ebc82016-02-22 22:55:53 -070079 bool external_data; /* Store data outside the FIT */
Simon Glassbd6e1422016-05-01 13:55:38 -060080 bool quiet; /* Don't output text in normal operation */
Teddy Reedf8f91072016-06-09 19:38:02 -070081 unsigned int external_offset; /* Add padding to external data */
Kever Yangebfe6112020-03-30 11:56:24 +080082 int bl_len; /* Block length in byte for external data */
George McCollisterf1ca1fd2017-01-06 13:14:17 -060083 const char *engine_id; /* Engine to use for signing */
Simon Glass152b2462020-07-09 18:39:43 -060084 bool reset_timestamp; /* Reset the timestamp on an existing image */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070085};
86
87/*
88 * image type specific variables and callback functions
89 */
90struct image_type_params {
91 /* name is an identification tag string for added support */
92 char *name;
93 /*
94 * header size is local to the specific image type to be supported,
95 * mkimage core treats this as number of bytes
96 */
97 uint32_t header_size;
98 /* Image type header pointer */
99 void *hdr;
100 /*
101 * There are several arguments that are passed on the command line
102 * and are registered as flags in image_tool_params structure.
103 * This callback function can be used to check the passed arguments
104 * are in-lined with the image type to be supported
105 *
106 * Returns 1 if parameter check is successful
107 */
108 int (*check_params) (struct image_tool_params *);
109 /*
110 * This function is used by list command (i.e. mkimage -l <filename>)
111 * image type verification code must be put here
112 *
113 * Returns 0 if image header verification is successful
114 * otherwise, returns respective negative error codes
115 */
116 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
117 /* Prints image information abstracting from image header */
118 void (*print_header) (const void *);
119 /*
120 * The header or image contents need to be set as per image type to
121 * be generated using this callback function.
122 * further output file post processing (for ex. checksum calculation,
123 * padding bytes etc..) can also be done in this callback function.
124 */
125 void (*set_header) (void *, struct stat *, int,
126 struct image_tool_params *);
127 /*
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200128 * This function is used by the command to retrieve a component
Tyler Hickse157a112020-10-26 10:40:24 -0500129 * (sub-image) from the image (i.e. dumpimage -p <position>
130 * -o <component-outfile> <image>). Thus the code to extract a file
131 * from an image must be put here.
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700132 *
133 * Returns 0 if the file was successfully retrieved from the image,
134 * or a negative value on error.
135 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200136 int (*extract_subimage)(void *, struct image_tool_params *);
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700137 /*
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700138 * Some image generation support for ex (default image type) supports
139 * more than one type_ids, this callback function is used to check
140 * whether input (-T <image_type>) is supported by registered image
141 * generation/list low level code
142 */
143 int (*check_image_type) (uint8_t);
144 /* This callback function will be executed if fflag is defined */
145 int (*fflag_handle) (struct image_tool_params *);
146 /*
147 * This callback function will be executed for variable size record
148 * It is expected to build this header in memory and return its length
149 * and a pointer to it by using image_type_params.header_size and
150 * image_type_params.hdr. The return value shall indicate if an
151 * additional padding should be used when copying the data image
152 * by returning the padding length.
153 */
154 int (*vrec_header) (struct image_tool_params *,
155 struct image_type_params *);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700156};
157
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200158/**
159 * imagetool_get_type() - find the image type params for a given image type
160 *
161 * It scans all registers image type supports
162 * checks the input type for each supported image type
163 *
164 * if successful,
165 * returns respective image_type_params pointer if success
166 * if input type_id is not supported by any of image_type_support
167 * returns NULL
168 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200169struct image_type_params *imagetool_get_type(int type);
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200170
171/*
172 * imagetool_verify_print_header() - verifies the image header
173 *
174 * Scan registered image types and verify the image_header for each
175 * supported image type. If verification is successful, this prints
176 * the respective header.
177 *
178 * @return 0 on success, negative if input image format does not match with
179 * any of supported image types
180 */
181int imagetool_verify_print_header(
182 void *ptr,
183 struct stat *sbuf,
184 struct image_type_params *tparams,
185 struct image_tool_params *params);
186
Jordan Handd32aa3c2019-03-05 14:47:56 -0800187/*
188 * imagetool_verify_print_header_by_type() - verifies the image header
189 *
190 * Verify the image_header for the image type given by tparams.
191 * If verification is successful, this prints the respective header.
192 * @ptr: pointer the the image header
193 * @sbuf: stat information about the file pointed to by ptr
194 * @tparams: image type parameters
195 * @params: mkimage parameters
196 *
197 * @return 0 on success, negative if input image format does not match with
198 * the given image type
199 */
200int imagetool_verify_print_header_by_type(
201 void *ptr,
202 struct stat *sbuf,
203 struct image_type_params *tparams,
204 struct image_tool_params *params);
205
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200206/**
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200207 * imagetool_save_subimage - store data into a file
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200208 * @file_name: name of the destination file
209 * @file_data: data to be written
210 * @file_len: the amount of data to store
211 *
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200212 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200213 * into the file name by file_name.
214 *
215 * returns:
216 * zero in case of success or a negative value if fail.
217 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200218int imagetool_save_subimage(
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200219 const char *file_name,
220 ulong file_data,
221 ulong file_len);
222
Simon Glass3837ce62016-02-22 22:55:49 -0700223/**
224 * imagetool_get_filesize() - Utility function to obtain the size of a file
225 *
226 * This function prints a message if an error occurs, showing the error that
227 * was obtained.
228 *
229 * @params: mkimage parameters
230 * @fname: filename to check
231 * @return size of file, or -ve value on error
232 */
233int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
234
Vagrant Cascadian58470842016-06-16 12:28:40 -0700235/**
236 * imagetool_get_source_date() - Get timestamp for build output.
237 *
238 * Gets a timestamp for embedding it in a build output. If set
239 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
240 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
241 * 0.
242 *
Alex Kiernan87925df2018-06-20 20:10:51 +0000243 * @cmdname: command name
Vagrant Cascadian58470842016-06-16 12:28:40 -0700244 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
245 * @return timestamp based on SOURCE_DATE_EPOCH
246 */
247time_t imagetool_get_source_date(
Alex Kiernan87925df2018-06-20 20:10:51 +0000248 const char *cmdname,
Vagrant Cascadian58470842016-06-16 12:28:40 -0700249 time_t fallback);
250
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700251/*
252 * There is a c file associated with supported image type low level code
253 * for ex. default_image.c, fit_image.c
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700254 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200255
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700256
257void pbl_load_uboot(int fd, struct image_tool_params *mparams);
Alexander Graf6915dcf2018-04-13 14:18:52 +0200258int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
Peng Fana2b96ec2018-10-16 04:50:30 +0000259int imx8image_copy_image(int fd, struct image_tool_params *mparams);
Peng Fan6609c262018-11-20 10:19:36 +0000260int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
Jeffy Cheneea6cd82019-12-27 11:24:41 +0800261int rockchip_copy_image(int fd, struct image_tool_params *mparams);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700262
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100263#define ___cat(a, b) a ## b
264#define __cat(a, b) ___cat(a, b)
265
266/* we need some special handling for this host tool running eventually on
267 * Darwin. The Mach-O section handling is a bit different than ELF section
268 * handling. The differnces in detail are:
269 * a) we have segments which have sections
270 * b) we need a API call to get the respective section symbols */
271#if defined(__MACH__)
272#include <mach-o/getsect.h>
273
274#define INIT_SECTION(name) do { \
275 unsigned long name ## _len; \
Jessica Clarke3b142042021-03-20 20:43:05 +0000276 char *__cat(pstart_, name) = getsectdata("__DATA", \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100277 #name, &__cat(name, _len)); \
278 char *__cat(pstop_, name) = __cat(pstart_, name) + \
279 __cat(name, _len); \
280 __cat(__start_, name) = (void *)__cat(pstart_, name); \
281 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
282 } while (0)
Jessica Clarke3b142042021-03-20 20:43:05 +0000283#define SECTION(name) __attribute__((section("__DATA, " #name)))
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100284
285struct image_type_params **__start_image_type, **__stop_image_type;
286#else
287#define INIT_SECTION(name) /* no-op for ELF */
288#define SECTION(name) __attribute__((section(#name)))
289
290/* We construct a table of pointers in an ELF section (pointers generally
291 * go unpadded by gcc). ld creates boundary syms for us. */
292extern struct image_type_params *__start_image_type[], *__stop_image_type[];
293#endif /* __MACH__ */
294
295#if !defined(__used)
296# if __GNUC__ == 3 && __GNUC_MINOR__ < 3
297# define __used __attribute__((__unused__))
298# else
299# define __used __attribute__((__used__))
300# endif
301#endif
302
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200303#define U_BOOT_IMAGE_TYPE( \
304 _id, \
305 _name, \
306 _header_size, \
307 _header, \
308 _check_params, \
309 _verify_header, \
310 _print_header, \
311 _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200312 _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200313 _check_image_type, \
314 _fflag_handle, \
315 _vrec_header \
316 ) \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100317 static struct image_type_params __cat(image_type_, _id) = \
318 { \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200319 .name = _name, \
320 .header_size = _header_size, \
321 .hdr = _header, \
322 .check_params = _check_params, \
323 .verify_header = _verify_header, \
324 .print_header = _print_header, \
325 .set_header = _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200326 .extract_subimage = _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200327 .check_image_type = _check_image_type, \
328 .fflag_handle = _fflag_handle, \
329 .vrec_header = _vrec_header \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100330 }; \
331 static struct image_type_params *SECTION(image_type) __used \
332 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200333
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700334#endif /* _IMAGETOOL_H_ */