Convert CONFIG_BOARD_COMMON to Kconfig
[platform/kernel/u-boot.git] / tools / fit_common.h
index b8d8438..920a16a 100644 (file)
@@ -1,7 +1,6 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * (C) Copyright 2014
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef _FIT_COMMON_H_
 #include "mkimage.h"
 #include <image.h>
 
+/**
+ * Verify the format of FIT header pointed to by ptr
+ *
+ * @ptr: image header to be verified
+ * @image_size: size of while image
+ * @params: mkimage parameters
+ * Return: 0 if OK, -1 on error
+ */
 int fit_verify_header(unsigned char *ptr, int image_size,
                        struct image_tool_params *params);
 
@@ -25,9 +32,34 @@ int fit_check_image_types(uint8_t type);
  * @blobp:     Returns pointer to FDT blob
  * @sbuf:      File status information is stored here
  * @delete_on_error:   true to delete the file if we get an error
- * @return 0 if OK, -1 on error.
+ * @read_only: true to open in read-only mode
+ * Return: 0 if OK, -1 on error.
  */
 int mmap_fdt(const char *cmdname, const char *fname, size_t size_inc,
-            void **blobp, struct stat *sbuf, bool delete_on_error);
+            void **blobp, struct stat *sbuf, bool delete_on_error,
+            bool read_only);
+
+/**
+ * copyfile() - Copy a file
+ *
+ * This uses read()/write() to copy file @src to file @dst
+ *
+ * If @dst exists, it is overwritten and truncated to the correct size.
+ *
+ * @src: Filename to read from
+ * @dst: Filename to write to
+ * @return 0 if OK, -1 on error
+ */
+int copyfile(const char *src, const char *dst);
+
+/**
+ * summary_show() - Show summary information about the signing process
+ *
+ * @summary: Summary info to show
+ * @imagefile: Filename of the output image
+ * @keydest: Filename where the key information is written (NULL if none)
+ */
+void summary_show(struct image_summary *summary, const char *imagefile,
+                 const char *keydest);
 
 #endif /* _FIT_COMMON_H_ */