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