tools/fit_common.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2014
   4  */
   5
   6 #ifndef _FIT_COMMON_H_
   7 #define _FIT_COMMON_H_
   8
   9 #include "imagetool.h"
  10 #include "mkimage.h"
  11 #include <image.h>
  12
  13 /**
  14  * Verify the format of FIT header pointed to by ptr
  15  *
  16  * @ptr: image header to be verified
  17  * @image_size: size of while image
  18  * @params: mkimage parameters
  19  * Return: 0 if OK, -1 on error
  20  */
  21 int fit_verify_header(unsigned char *ptr, int image_size,
  22                         struct image_tool_params *params);
  23
  24 int fit_check_image_types(uint8_t type);
  25
  26 /**
  27  * Map an FDT into memory, optionally increasing its size
  28  *
  29  * @cmdname:    Tool name (for displaying with error messages)
  30  * @fname:      Filename containing FDT
  31  * @size_inc:   Amount to increase size by (0 = leave it alone)
  32  * @blobp:      Returns pointer to FDT blob
  33  * @sbuf:       File status information is stored here
  34  * @delete_on_error:    true to delete the file if we get an error
  35  * @read_only:  true to open in read-only mode
  36  * Return: 0 if OK, -1 on error.
  37  */
  38 int mmap_fdt(const char *cmdname, const char *fname, size_t size_inc,
  39              void **blobp, struct stat *sbuf, bool delete_on_error,
  40              bool read_only);
  41
  42 /**
  43  * copyfile() - Copy a file
  44  *
  45  * This uses read()/write() to copy file @src to file @dst
  46  *
  47  * If @dst exists, it is overwritten and truncated to the correct size.
  48  *
  49  * @src: Filename to read from
  50  * @dst: Filename to write to
  51  * @return 0 if OK, -1 on error
  52  */
  53 int copyfile(const char *src, const char *dst);
  54
  55 /**
  56  * summary_show() - Show summary information about the signing process
  57  *
  58  * @summary: Summary info to show
  59  * @imagefile: Filename of the output image
  60  * @keydest: Filename where the key information is written (NULL if none)
  61  */
  62 void summary_show(struct image_summary *summary, const char *imagefile,
  63                   const char *keydest);
  64
  65 #endif /* _FIT_COMMON_H_ */