1/* 2 * (C) Copyright 2013 3 * 4 * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com> 5 * 6 * SPDX-License-Identifier: GPL-2.0+ 7 */ 8 9#ifndef _IMAGETOOL_H_ 10#define _IMAGETOOL_H_ 11 12#include "os_support.h" 13#include <errno.h> 14#include <fcntl.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 "fdt_host.h" 25 26#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 27 28#define IH_ARCH_DEFAULT IH_ARCH_INVALID 29 30/* 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 37/* 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; 46 int iflag; 47 int lflag; 48 int pflag; 49 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; 64 const char *outfile; /* Output filename */ 65 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' */ 69 int file_size; /* Total size of output file */ 70 int orig_file_size; /* Original size for file before padding */ 71 bool auto_its; /* Automatically create the .its file */ 72 int fit_image_type; /* Image type to put into the FIT */ 73 struct content_info *content_head; /* List of files to include */ 74 struct content_info *content_tail; 75 bool external_data; /* Store data outside the FIT */ 76 bool quiet; /* Don't output text in normal operation */ 77 unsigned int external_offset; /* Add padding to external data */ 78}; 79 80/* 81 * image type specific variables and callback functions 82 */ 83struct image_type_params { 84 /* name is an identification tag string for added support */ 85 char *name; 86 /* 87 * header size is local to the specific image type to be supported, 88 * mkimage core treats this as number of bytes 89 */ 90 uint32_t header_size; 91 /* Image type header pointer */ 92 void *hdr; 93 /* 94 * There are several arguments that are passed on the command line 95 * and are registered as flags in image_tool_params structure. 96 * This callback function can be used to check the passed arguments 97 * are in-lined with the image type to be supported 98 * 99 * Returns 1 if parameter check is successful 100 */ 101 int (*check_params) (struct image_tool_params *); 102 /* 103 * This function is used by list command (i.e. mkimage -l <filename>) 104 * image type verification code must be put here 105 * 106 * Returns 0 if image header verification is successful 107 * otherwise, returns respective negative error codes 108 */ 109 int (*verify_header) (unsigned char *, int, struct image_tool_params *); 110 /* Prints image information abstracting from image header */ 111 void (*print_header) (const void *); 112 /* 113 * The header or image contents need to be set as per image type to 114 * be generated using this callback function. 115 * further output file post processing (for ex. checksum calculation, 116 * padding bytes etc..) can also be done in this callback function. 117 */ 118 void (*set_header) (void *, struct stat *, int, 119 struct image_tool_params *); 120 /* 121 * This function is used by the command to retrieve a component 122 * (sub-image) from the image (i.e. dumpimage -i <image> -p <position> 123 * <sub-image-name>). 124 * Thus the code to extract a file from an image must be put here. 125 * 126 * Returns 0 if the file was successfully retrieved from the image, 127 * or a negative value on error. 128 */ 129 int (*extract_subimage)(void *, struct image_tool_params *); 130 /* 131 * Some image generation support for ex (default image type) supports 132 * more than one type_ids, this callback function is used to check 133 * whether input (-T <image_type>) is supported by registered image 134 * generation/list low level code 135 */ 136 int (*check_image_type) (uint8_t); 137 /* This callback function will be executed if fflag is defined */ 138 int (*fflag_handle) (struct image_tool_params *); 139 /* 140 * This callback function will be executed for variable size record 141 * It is expected to build this header in memory and return its length 142 * and a pointer to it by using image_type_params.header_size and 143 * image_type_params.hdr. The return value shall indicate if an 144 * additional padding should be used when copying the data image 145 * by returning the padding length. 146 */ 147 int (*vrec_header) (struct image_tool_params *, 148 struct image_type_params *); 149}; 150 151/** 152 * imagetool_get_type() - find the image type params for a given image type 153 * 154 * It scans all registers image type supports 155 * checks the input type for each supported image type 156 * 157 * if successful, 158 * returns respective image_type_params pointer if success 159 * if input type_id is not supported by any of image_type_support 160 * returns NULL 161 */ 162struct image_type_params *imagetool_get_type(int type); 163 164/* 165 * imagetool_verify_print_header() - verifies the image header 166 * 167 * Scan registered image types and verify the image_header for each 168 * supported image type. If verification is successful, this prints 169 * the respective header. 170 * 171 * @return 0 on success, negative if input image format does not match with 172 * any of supported image types 173 */ 174int imagetool_verify_print_header( 175 void *ptr, 176 struct stat *sbuf, 177 struct image_type_params *tparams, 178 struct image_tool_params *params); 179 180/** 181 * imagetool_save_subimage - store data into a file 182 * @file_name: name of the destination file 183 * @file_data: data to be written 184 * @file_len: the amount of data to store 185 * 186 * imagetool_save_subimage() store file_len bytes of data pointed by file_data 187 * into the file name by file_name. 188 * 189 * returns: 190 * zero in case of success or a negative value if fail. 191 */ 192int imagetool_save_subimage( 193 const char *file_name, 194 ulong file_data, 195 ulong file_len); 196 197/** 198 * imagetool_get_filesize() - Utility function to obtain the size of a file 199 * 200 * This function prints a message if an error occurs, showing the error that 201 * was obtained. 202 * 203 * @params: mkimage parameters 204 * @fname: filename to check 205 * @return size of file, or -ve value on error 206 */ 207int imagetool_get_filesize(struct image_tool_params *params, const char *fname); 208 209/** 210 * imagetool_get_source_date() - Get timestamp for build output. 211 * 212 * Gets a timestamp for embedding it in a build output. If set 213 * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints 214 * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns 215 * 0. 216 * 217 * @params: mkimage parameters 218 * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set 219 * @return timestamp based on SOURCE_DATE_EPOCH 220 */ 221time_t imagetool_get_source_date( 222 struct image_tool_params *params, 223 time_t fallback); 224 225/* 226 * There is a c file associated with supported image type low level code 227 * for ex. default_image.c, fit_image.c 228 */ 229 230 231void pbl_load_uboot(int fd, struct image_tool_params *mparams); 232 233#define ___cat(a, b) a ## b 234#define __cat(a, b) ___cat(a, b) 235 236/* we need some special handling for this host tool running eventually on 237 * Darwin. The Mach-O section handling is a bit different than ELF section 238 * handling. The differnces in detail are: 239 * a) we have segments which have sections 240 * b) we need a API call to get the respective section symbols */ 241#if defined(__MACH__) 242#include <mach-o/getsect.h> 243 244#define INIT_SECTION(name) do { \ 245 unsigned long name ## _len; \ 246 char *__cat(pstart_, name) = getsectdata("__TEXT", \ 247 #name, &__cat(name, _len)); \ 248 char *__cat(pstop_, name) = __cat(pstart_, name) + \ 249 __cat(name, _len); \ 250 __cat(__start_, name) = (void *)__cat(pstart_, name); \ 251 __cat(__stop_, name) = (void *)__cat(pstop_, name); \ 252 } while (0) 253#define SECTION(name) __attribute__((section("__TEXT, " #name))) 254 255struct image_type_params **__start_image_type, **__stop_image_type; 256#else 257#define INIT_SECTION(name) /* no-op for ELF */ 258#define SECTION(name) __attribute__((section(#name))) 259 260/* We construct a table of pointers in an ELF section (pointers generally 261 * go unpadded by gcc). ld creates boundary syms for us. */ 262extern struct image_type_params *__start_image_type[], *__stop_image_type[]; 263#endif /* __MACH__ */ 264 265#if !defined(__used) 266# if __GNUC__ == 3 && __GNUC_MINOR__ < 3 267# define __used __attribute__((__unused__)) 268# else 269# define __used __attribute__((__used__)) 270# endif 271#endif 272 273#define U_BOOT_IMAGE_TYPE( \ 274 _id, \ 275 _name, \ 276 _header_size, \ 277 _header, \ 278 _check_params, \ 279 _verify_header, \ 280 _print_header, \ 281 _set_header, \ 282 _extract_subimage, \ 283 _check_image_type, \ 284 _fflag_handle, \ 285 _vrec_header \ 286 ) \ 287 static struct image_type_params __cat(image_type_, _id) = \ 288 { \ 289 .name = _name, \ 290 .header_size = _header_size, \ 291 .hdr = _header, \ 292 .check_params = _check_params, \ 293 .verify_header = _verify_header, \ 294 .print_header = _print_header, \ 295 .set_header = _set_header, \ 296 .extract_subimage = _extract_subimage, \ 297 .check_image_type = _check_image_type, \ 298 .fflag_handle = _fflag_handle, \ 299 .vrec_header = _vrec_header \ 300 }; \ 301 static struct image_type_params *SECTION(image_type) __used \ 302 __cat(image_type_ptr_, _id) = &__cat(image_type_, _id) 303 304#endif /* _IMAGETOOL_H_ */ 305