blob: 71471420f9c4e218337ff0ee51514607274c816f [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
28#define IH_ARCH_DEFAULT IH_ARCH_INVALID
29
Simon Glassfb4cce02016-02-22 22:55:52 -070030/* Information about a file that needs to be placed into the FIT */
31struct content_info {
32 struct content_info *next;
33 int type; /* File type (IH_TYPE_...) */
34 const char *fname;
35};
36
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070037/*
38 * This structure defines all such variables those are initialized by
39 * mkimage and dumpimage main core and need to be referred by image
40 * type specific functions
41 */
42struct image_tool_params {
43 int dflag;
44 int eflag;
45 int fflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070046 int iflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070047 int lflag;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070048 int pflag;
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070049 int vflag;
50 int xflag;
51 int skipcpy;
52 int os;
53 int arch;
54 int type;
55 int comp;
56 char *dtc;
57 unsigned int addr;
58 unsigned int ep;
59 char *imagename;
60 char *imagename2;
61 char *datafile;
62 char *imagefile;
63 char *cmdname;
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -070064 const char *outfile; /* Output filename */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070065 const char *keydir; /* Directory holding private keys */
66 const char *keydest; /* Destination .dtb for public key */
67 const char *comment; /* Comment to add to signature node */
68 int require_keys; /* 1 to mark signing keys as 'required' */
Simon Glass92a655c2015-06-23 15:39:12 -060069 int file_size; /* Total size of output file */
Simon Glass1b99e5b2015-08-30 16:55:23 -060070 int orig_file_size; /* Original size for file before padding */
Simon Glass8e35bb02016-02-22 22:55:51 -070071 bool auto_its; /* Automatically create the .its file */
Simon Glassd505a092016-02-22 22:55:48 -070072 int fit_image_type; /* Image type to put into the FIT */
Tomeu Vizoso0f7c6cd2016-11-04 14:22:15 +010073 char *fit_ramdisk; /* Ramdisk file to include */
Simon Glassfb4cce02016-02-22 22:55:52 -070074 struct content_info *content_head; /* List of files to include */
75 struct content_info *content_tail;
Simon Glass722ebc82016-02-22 22:55:53 -070076 bool external_data; /* Store data outside the FIT */
Simon Glassbd6e1422016-05-01 13:55:38 -060077 bool quiet; /* Don't output text in normal operation */
Teddy Reedf8f91072016-06-09 19:38:02 -070078 unsigned int external_offset; /* Add padding to external data */
George McCollisterf1ca1fd2017-01-06 13:14:17 -060079 const char *engine_id; /* Engine to use for signing */
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -070080};
81
82/*
83 * image type specific variables and callback functions
84 */
85struct image_type_params {
86 /* name is an identification tag string for added support */
87 char *name;
88 /*
89 * header size is local to the specific image type to be supported,
90 * mkimage core treats this as number of bytes
91 */
92 uint32_t header_size;
93 /* Image type header pointer */
94 void *hdr;
95 /*
96 * There are several arguments that are passed on the command line
97 * and are registered as flags in image_tool_params structure.
98 * This callback function can be used to check the passed arguments
99 * are in-lined with the image type to be supported
100 *
101 * Returns 1 if parameter check is successful
102 */
103 int (*check_params) (struct image_tool_params *);
104 /*
105 * This function is used by list command (i.e. mkimage -l <filename>)
106 * image type verification code must be put here
107 *
108 * Returns 0 if image header verification is successful
109 * otherwise, returns respective negative error codes
110 */
111 int (*verify_header) (unsigned char *, int, struct image_tool_params *);
112 /* Prints image information abstracting from image header */
113 void (*print_header) (const void *);
114 /*
115 * The header or image contents need to be set as per image type to
116 * be generated using this callback function.
117 * further output file post processing (for ex. checksum calculation,
118 * padding bytes etc..) can also be done in this callback function.
119 */
120 void (*set_header) (void *, struct stat *, int,
121 struct image_tool_params *);
122 /*
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200123 * This function is used by the command to retrieve a component
124 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
125 * <sub-image-name>).
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700126 * Thus the code to extract a file from an image must be put here.
127 *
128 * Returns 0 if the file was successfully retrieved from the image,
129 * or a negative value on error.
130 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200131 int (*extract_subimage)(void *, struct image_tool_params *);
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -0700132 /*
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700133 * Some image generation support for ex (default image type) supports
134 * more than one type_ids, this callback function is used to check
135 * whether input (-T <image_type>) is supported by registered image
136 * generation/list low level code
137 */
138 int (*check_image_type) (uint8_t);
139 /* This callback function will be executed if fflag is defined */
140 int (*fflag_handle) (struct image_tool_params *);
141 /*
142 * This callback function will be executed for variable size record
143 * It is expected to build this header in memory and return its length
144 * and a pointer to it by using image_type_params.header_size and
145 * image_type_params.hdr. The return value shall indicate if an
146 * additional padding should be used when copying the data image
147 * by returning the padding length.
148 */
149 int (*vrec_header) (struct image_tool_params *,
150 struct image_type_params *);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700151};
152
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200153/**
154 * imagetool_get_type() - find the image type params for a given image type
155 *
156 * It scans all registers image type supports
157 * checks the input type for each supported image type
158 *
159 * if successful,
160 * returns respective image_type_params pointer if success
161 * if input type_id is not supported by any of image_type_support
162 * returns NULL
163 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200164struct image_type_params *imagetool_get_type(int type);
Guilherme Maciel Ferreira0ca66912015-01-15 02:48:05 -0200165
166/*
167 * imagetool_verify_print_header() - verifies the image header
168 *
169 * Scan registered image types and verify the image_header for each
170 * supported image type. If verification is successful, this prints
171 * the respective header.
172 *
173 * @return 0 on success, negative if input image format does not match with
174 * any of supported image types
175 */
176int imagetool_verify_print_header(
177 void *ptr,
178 struct stat *sbuf,
179 struct image_type_params *tparams,
180 struct image_tool_params *params);
181
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200182/**
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200183 * imagetool_save_subimage - store data into a file
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200184 * @file_name: name of the destination file
185 * @file_data: data to be written
186 * @file_len: the amount of data to store
187 *
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200188 * imagetool_save_subimage() store file_len bytes of data pointed by file_data
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200189 * into the file name by file_name.
190 *
191 * returns:
192 * zero in case of success or a negative value if fail.
193 */
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200194int imagetool_save_subimage(
Guilherme Maciel Ferreira067d1562015-01-15 02:48:06 -0200195 const char *file_name,
196 ulong file_data,
197 ulong file_len);
198
Simon Glass3837ce62016-02-22 22:55:49 -0700199/**
200 * imagetool_get_filesize() - Utility function to obtain the size of a file
201 *
202 * This function prints a message if an error occurs, showing the error that
203 * was obtained.
204 *
205 * @params: mkimage parameters
206 * @fname: filename to check
207 * @return size of file, or -ve value on error
208 */
209int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
210
Vagrant Cascadian58470842016-06-16 12:28:40 -0700211/**
212 * imagetool_get_source_date() - Get timestamp for build output.
213 *
214 * Gets a timestamp for embedding it in a build output. If set
215 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
216 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
217 * 0.
218 *
Alex Kiernan87925df2018-06-20 20:10:51 +0000219 * @cmdname: command name
Vagrant Cascadian58470842016-06-16 12:28:40 -0700220 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
221 * @return timestamp based on SOURCE_DATE_EPOCH
222 */
223time_t imagetool_get_source_date(
Alex Kiernan87925df2018-06-20 20:10:51 +0000224 const char *cmdname,
Vagrant Cascadian58470842016-06-16 12:28:40 -0700225 time_t fallback);
226
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700227/*
228 * There is a c file associated with supported image type low level code
229 * for ex. default_image.c, fit_image.c
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700230 */
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200231
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700232
233void pbl_load_uboot(int fd, struct image_tool_params *mparams);
Alexander Graf6915dcf2018-04-13 14:18:52 +0200234int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
Peng Fana2b96ec2018-10-16 04:50:30 +0000235int imx8image_copy_image(int fd, struct image_tool_params *mparams);
Peng Fan6609c262018-11-20 10:19:36 +0000236int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700237
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100238#define ___cat(a, b) a ## b
239#define __cat(a, b) ___cat(a, b)
240
241/* we need some special handling for this host tool running eventually on
242 * Darwin. The Mach-O section handling is a bit different than ELF section
243 * handling. The differnces in detail are:
244 * a) we have segments which have sections
245 * b) we need a API call to get the respective section symbols */
246#if defined(__MACH__)
247#include <mach-o/getsect.h>
248
249#define INIT_SECTION(name) do { \
250 unsigned long name ## _len; \
251 char *__cat(pstart_, name) = getsectdata("__TEXT", \
252 #name, &__cat(name, _len)); \
253 char *__cat(pstop_, name) = __cat(pstart_, name) + \
254 __cat(name, _len); \
255 __cat(__start_, name) = (void *)__cat(pstart_, name); \
256 __cat(__stop_, name) = (void *)__cat(pstop_, name); \
257 } while (0)
258#define SECTION(name) __attribute__((section("__TEXT, " #name)))
259
260struct image_type_params **__start_image_type, **__stop_image_type;
261#else
262#define INIT_SECTION(name) /* no-op for ELF */
263#define SECTION(name) __attribute__((section(#name)))
264
265/* We construct a table of pointers in an ELF section (pointers generally
266 * go unpadded by gcc). ld creates boundary syms for us. */
267extern struct image_type_params *__start_image_type[], *__stop_image_type[];
268#endif /* __MACH__ */
269
270#if !defined(__used)
271# if __GNUC__ == 3 && __GNUC_MINOR__ < 3
272# define __used __attribute__((__unused__))
273# else
274# define __used __attribute__((__used__))
275# endif
276#endif
277
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200278#define U_BOOT_IMAGE_TYPE( \
279 _id, \
280 _name, \
281 _header_size, \
282 _header, \
283 _check_params, \
284 _verify_header, \
285 _print_header, \
286 _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200287 _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200288 _check_image_type, \
289 _fflag_handle, \
290 _vrec_header \
291 ) \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100292 static struct image_type_params __cat(image_type_, _id) = \
293 { \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200294 .name = _name, \
295 .header_size = _header_size, \
296 .hdr = _header, \
297 .check_params = _check_params, \
298 .verify_header = _verify_header, \
299 .print_header = _print_header, \
300 .set_header = _set_header, \
Guilherme Maciel Ferreira67f946c2015-01-15 02:54:41 -0200301 .extract_subimage = _extract_subimage, \
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200302 .check_image_type = _check_image_type, \
303 .fflag_handle = _fflag_handle, \
304 .vrec_header = _vrec_header \
Andreas Bießmann1fddd7b2015-02-09 00:06:10 +0100305 }; \
306 static struct image_type_params *SECTION(image_type) __used \
307 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200308
Guilherme Maciel Ferreiraf86ed6a2013-12-01 12:43:10 -0700309#endif /* _IMAGETOOL_H_ */