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