Convert CONFIG_SYS_FLASH_CFI_WIDTH to Kconfig
[platform/kernel/u-boot.git] / tools / rkcommon.h
index 3d64516..49b6df3 100644 (file)
@@ -1,8 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  * (C) Copyright 2015 Google,  Inc
  * Written by Simon Glass <sjg@chromium.org>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #ifndef _RKCOMMON_H
 
 enum {
        RK_BLK_SIZE             = 512,
+       RK_SIZE_ALIGN           = 2048,
        RK_INIT_OFFSET          = 4,
        RK_MAX_BOOT_SIZE        = 512 << 10,
        RK_SPL_HDR_START        = RK_INIT_OFFSET * RK_BLK_SIZE,
        RK_SPL_HDR_SIZE         = 4,
-       RK_SPL_START            = RK_SPL_HDR_START + RK_SPL_HDR_SIZE,
-       RK_IMAGE_HEADER_LEN     = RK_SPL_START,
 };
 
 /**
  * rkcommon_check_params() - check params
  *
- * @return 0 if OK, -1 if ERROR.
+ * Return: 0 if OK, -1 if ERROR.
  */
 int rkcommon_check_params(struct image_tool_params *params);
 
@@ -34,19 +32,6 @@ int rkcommon_check_params(struct image_tool_params *params);
 const char *rkcommon_get_spl_hdr(struct image_tool_params *params);
 
 /**
- * rkcommon_get_spl_hdr_padto8() - check if we need to pad to 8 bytes
- *
- * Rockchip's bootrom starts execution right after the SPL header (i.e.
- * at offset 4), but we can not reasonably align the test section of
- * an AArch64 SPL at 4 bytes (as this would break natural alignment
- * and any embedded constants might cause an alignment exception, which
- * is illegal in privileged modes).
- *
- * Padding is (for now) assumed to occur with a single AArch64 'nop'.
- */
-const bool rkcommon_get_spl_hdr_padto8(struct image_tool_params *params);
-
-/**
  * rkcommon_get_spl_size() - get spl size for a Rockchip boot image
  *
  * Different chip may have different sram size. And if we want to jump
@@ -62,11 +47,28 @@ int rkcommon_get_spl_size(struct image_tool_params *params);
  * This sets up a 2KB header which can be interpreted by the Rockchip boot ROM.
  *
  * @buf:       Pointer to header place (must be at least 2KB in size)
- * @file_size: Size of the file we want the boot ROM to load, in bytes
- * @return 0 if OK, -ENOSPC if too large
  */
-int rkcommon_set_header(void *buf, uint file_size,
-                       struct image_tool_params *params);
+void rkcommon_set_header(void *buf,  struct stat *sbuf,  int ifd,
+                        struct image_tool_params *params);
+
+/**
+ * rkcommon_verify_header() - verify the header for a Rockchip boot image
+ *
+ * @buf:       Pointer to the image file
+ * @file_size: Size of entire bootable image file (incl. all padding)
+ * Return: 0 if OK
+ */
+int rkcommon_verify_header(unsigned char *buf, int size,
+                          struct image_tool_params *params);
+
+/**
+ * rkcommon_print_header() - print the header for a Rockchip boot image
+ *
+ * This prints the header, spl_name and whether this is a SD/MMC or SPI image.
+ *
+ * @buf:       Pointer to the image (can be a read-only file-mapping)
+ */
+void rkcommon_print_header(const void *buf);
 
 /**
  * rkcommon_need_rc4_spl() - check if rc4 encoded spl is required
@@ -74,7 +76,7 @@ int rkcommon_set_header(void *buf, uint file_size,
  * Some socs cannot disable the rc4-encryption of the spl binary.
  * rc4 encryption is disabled normally except on socs that cannot
  * handle unencrypted binaries.
- * @return true or false depending on rc4 being required.
+ * Return: true or false depending on rc4 being required.
  */
 bool rkcommon_need_rc4_spl(struct image_tool_params *params);
 
@@ -96,8 +98,10 @@ void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size);
  * @params:     Pointer to the tool params structure
  * @tparams:    Pointer tot the image type structure (for setting
  *              the header and header_size)
+ *
+ * Return: 0 (always)
  */
-void rkcommon_vrec_header(struct image_tool_params *params,
-                         struct image_type_params *tparams);
+int rkcommon_vrec_header(struct image_tool_params *params,
+                        struct image_type_params *tparams);
 
 #endif