tools/imagetool.h

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