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