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