1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * (C) Copyright 2013 4 * 5 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com> 6 */ 7 8 #ifndef _IMAGETOOL_H_ 9 #define _IMAGETOOL_H_ 10 11 #include "os_support.h" 12 #include <errno.h> 13 #include <fcntl.h> 14 #include <stdbool.h> 15 #include <stdio.h> 16 #include <stdlib.h> 17 #include <string.h> 18 #include <sys/stat.h> 19 #include <sys/types.h> 20 #include <time.h> 21 #include <unistd.h> 22 #include <u-boot/sha1.h> 23 24 #include <image.h> 25 26 #include "fdt_host.h" 27 28 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 29 30 #define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask)) 31 #define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a) - 1) 32 33 #define IH_ARCH_DEFAULT IH_ARCH_INVALID 34 35 /* Information about a file that needs to be placed into the FIT */ 36 struct content_info { 37 struct content_info *next; 38 int type; /* File type (IH_TYPE_...) */ 39 const char *fname; 40 }; 41 42 /* FIT auto generation modes */ 43 enum 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 50 /* 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 */ 55 struct image_tool_params { 56 int dflag; 57 int eflag; 58 int fflag; 59 int iflag; 60 int lflag; 61 int pflag; 62 int vflag; 63 int xflag; 64 int Aflag; 65 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; 78 const char *outfile; /* Output filename */ 79 const char *keydir; /* Directory holding private keys */ 80 const char *keydest; /* Destination .dtb for public key */ 81 const char *keyfile; /* Filename of private or public key */ 82 const char *keyname; /* Key name "hint" */ 83 const char *comment; /* Comment to add to signature node */ 84 /* Algorithm name to use for hashing/signing or NULL to use the one 85 * specified in the its */ 86 const char *algo_name; 87 int require_keys; /* 1 to mark signing keys as 'required' */ 88 int file_size; /* Total size of output file */ 89 int orig_file_size; /* Original size for file before padding */ 90 enum af_mode auto_fit; /* Automatically create the FIT */ 91 int fit_image_type; /* Image type to put into the FIT */ 92 char *fit_ramdisk; /* Ramdisk file to include */ 93 struct content_info *content_head; /* List of files to include */ 94 struct content_info *content_tail; 95 bool external_data; /* Store data outside the FIT */ 96 bool quiet; /* Don't output text in normal operation */ 97 unsigned int external_offset; /* Add padding to external data */ 98 int bl_len; /* Block length in byte for external data */ 99 const char *engine_id; /* Engine to use for signing */ 100 bool reset_timestamp; /* Reset the timestamp on an existing image */ 101 struct image_summary summary; /* results of signing process */ 102 }; 103 104 /* 105 * image type specific variables and callback functions 106 */ 107 struct 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 */ 135 void (*print_header) (const void *, struct image_tool_params *); 136 /* 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 /* 145 * This function is used by the command to retrieve a component 146 * (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. 149 * 150 * Returns 0 if the file was successfully retrieved from the image, 151 * or a negative value on error. 152 */ 153 int (*extract_subimage)(void *, struct image_tool_params *); 154 /* 155 * 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 *); 173 }; 174 175 /** 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 */ 186 struct image_type_params *imagetool_get_type(int type); 187 188 /* 189 * imagetool_verify_print_header() - verifies the image header 190 * 191 * Verify the image_header for the image type given by tparams. 192 * If tparams is NULL then scan registered image types and verify the 193 * image_header for each supported image type. 194 * 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 197 * @tparams: image type parameters or NULL 198 * @params: mkimage parameters 199 * 200 * Return: 0 on success, negative if input image format does not match with 201 * the given image type 202 */ 203 int imagetool_verify_print_header( 204 void *ptr, 205 struct stat *sbuf, 206 struct image_type_params *tparams, 207 struct image_tool_params *params); 208 209 /** 210 * imagetool_save_subimage - store data into a file 211 * @file_name: name of the destination file 212 * @file_data: data to be written 213 * @file_len: the amount of data to store 214 * 215 * imagetool_save_subimage() store file_len bytes of data pointed by file_data 216 * into the file name by file_name. 217 * 218 * returns: 219 * zero in case of success or a negative value if fail. 220 */ 221 int imagetool_save_subimage( 222 const char *file_name, 223 ulong file_data, 224 ulong file_len); 225 226 /** 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 234 * Return: size of file, or -ve value on error 235 */ 236 int imagetool_get_filesize(struct image_tool_params *params, const char *fname); 237 238 /** 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 * 246 * @cmdname: command name 247 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set 248 * Return: timestamp based on SOURCE_DATE_EPOCH 249 */ 250 time_t imagetool_get_source_date( 251 const char *cmdname, 252 time_t fallback); 253 254 /* 255 * There is a c file associated with supported image type low level code 256 * for ex. default_image.c, fit_image.c 257 */ 258 259 void pbl_load_uboot(int fd, struct image_tool_params *mparams); 260 int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams); 261 int imx8image_copy_image(int fd, struct image_tool_params *mparams); 262 int imx8mimage_copy_image(int fd, struct image_tool_params *mparams); 263 int rockchip_copy_image(int fd, struct image_tool_params *mparams); 264 265 #define ___cat(a, b) a ## b 266 #define __cat(a, b) ___cat(a, b) 267 268 /* we need some special handling for this host tool running eventually on 269 * Darwin. The Mach-O section handling is a bit different than ELF section 270 * handling. The differnces in detail are: 271 * a) we have segments which have sections 272 * b) we need a API call to get the respective section symbols */ 273 #if defined(__MACH__) 274 #include <mach-o/getsect.h> 275 #include <mach-o/dyld.h> 276 277 #define INIT_SECTION(name) do { \ 278 unsigned long name ## _len; \ 279 char *__cat(pstart_, name) = getsectdata("__DATA", \ 280 #name, &__cat(name, _len)); \ 281 __cat(pstart_, name) += _dyld_get_image_vmaddr_slide(0);\ 282 char *__cat(pstop_, name) = __cat(pstart_, name) + \ 283 __cat(name, _len); \ 284 __cat(__start_, name) = (void *)__cat(pstart_, name); \ 285 __cat(__stop_, name) = (void *)__cat(pstop_, name); \ 286 } while (0) 287 #define SECTION(name) __attribute__((section("__DATA, " #name))) 288 289 struct image_type_params **__start_image_type, **__stop_image_type; 290 #else 291 #define INIT_SECTION(name) /* no-op for ELF */ 292 #define SECTION(name) __attribute__((section(#name))) 293 294 /* We construct a table of pointers in an ELF section (pointers generally 295 * go unpadded by gcc). ld creates boundary syms for us. */ 296 extern struct image_type_params *__start_image_type[], *__stop_image_type[]; 297 #endif /* __MACH__ */ 298 299 #if !defined(__used) 300 # if __GNUC__ == 3 && __GNUC_MINOR__ < 3 301 # define __used __attribute__((__unused__)) 302 # else 303 # define __used __attribute__((__used__)) 304 # endif 305 #endif 306 307 #define U_BOOT_IMAGE_TYPE( \ 308 _id, \ 309 _name, \ 310 _header_size, \ 311 _header, \ 312 _check_params, \ 313 _verify_header, \ 314 _print_header, \ 315 _set_header, \ 316 _extract_subimage, \ 317 _check_image_type, \ 318 _fflag_handle, \ 319 _vrec_header \ 320 ) \ 321 static struct image_type_params __cat(image_type_, _id) = \ 322 { \ 323 .name = _name, \ 324 .header_size = _header_size, \ 325 .hdr = _header, \ 326 .check_params = _check_params, \ 327 .verify_header = _verify_header, \ 328 .print_header = _print_header, \ 329 .set_header = _set_header, \ 330 .extract_subimage = _extract_subimage, \ 331 .check_image_type = _check_image_type, \ 332 .fflag_handle = _fflag_handle, \ 333 .vrec_header = _vrec_header \ 334 }; \ 335 static struct image_type_params *SECTION(image_type) __used \ 336 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id) 337 338 #endif /* _IMAGETOOL_H_ */ 339