tools/rkcommon.h

   1 /*
   2  * (C) Copyright 2015 Google,  Inc
   3  * Written by Simon Glass <sjg@chromium.org>
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #ifndef _RKCOMMON_H
   9 #define _RKCOMMON_H
  10
  11 enum {
  12         RK_BLK_SIZE             = 512,
  13         RK_INIT_SIZE_ALIGN      = 2048,
  14         RK_INIT_OFFSET          = 4,
  15         RK_MAX_BOOT_SIZE        = 512 << 10,
  16         RK_SPL_HDR_START        = RK_INIT_OFFSET * RK_BLK_SIZE,
  17         RK_SPL_HDR_SIZE         = 4,
  18         RK_SPL_START            = RK_SPL_HDR_START + RK_SPL_HDR_SIZE,
  19         RK_IMAGE_HEADER_LEN     = RK_SPL_START,
  20 };
  21
  22 /**
  23  * rkcommon_check_params() - check params
  24  *
  25  * @return 0 if OK, -1 if ERROR.
  26  */
  27 int rkcommon_check_params(struct image_tool_params *params);
  28
  29 /**
  30  * rkcommon_get_spl_hdr() - get 4-bytes spl hdr for a Rockchip boot image
  31  *
  32  * Rockchip's bootrom requires the spl loader to start with a 4-bytes
  33  * header. The content of this header depends on the chip type.
  34  */
  35 const char *rkcommon_get_spl_hdr(struct image_tool_params *params);
  36
  37 /**
  38  * rkcommon_get_spl_size() - get spl size for a Rockchip boot image
  39  *
  40  * Different chip may have different sram size. And if we want to jump
  41  * back to the bootrom after spl, we may need to reserve some sram space
  42  * for the bootrom.
  43  * The spl loader size should be sram size minus reserved size(if needed)
  44  */
  45 int rkcommon_get_spl_size(struct image_tool_params *params);
  46
  47 /**
  48  * rkcommon_set_header() - set up the header for a Rockchip boot image
  49  *
  50  * This sets up a 2KB header which can be interpreted by the Rockchip boot ROM.
  51  *
  52  * @buf:        Pointer to header place (must be at least 2KB in size)
  53  * @file_size:  Size of the file we want the boot ROM to load, in bytes
  54  * @return 0 if OK, -ENOSPC if too large
  55  */
  56 int rkcommon_set_header(void *buf, uint file_size,
  57                         struct image_tool_params *params);
  58
  59 /**
  60  * rkcommon_verify_header() - verify the header for a Rockchip boot image
  61  *
  62  * @buf:        Pointer to the image file
  63  * @file_size:  Size of entire bootable image file (incl. all padding)
  64  * @return 0 if OK
  65  */
  66 int rkcommon_verify_header(unsigned char *buf, int size,
  67                            struct image_tool_params *params);
  68
  69 /**
  70  * rkcommon_print_header() - print the header for a Rockchip boot image
  71  *
  72  * This prints the header, spl_name and whether this is a SD/MMC or SPI image.
  73  *
  74  * @buf:        Pointer to the image (can be a read-only file-mapping)
  75  */
  76 void rkcommon_print_header(const void *buf);
  77
  78 /**
  79  * rkcommon_need_rc4_spl() - check if rc4 encoded spl is required
  80  *
  81  * Some socs cannot disable the rc4-encryption of the spl binary.
  82  * rc4 encryption is disabled normally except on socs that cannot
  83  * handle unencrypted binaries.
  84  * @return true or false depending on rc4 being required.
  85  */
  86 bool rkcommon_need_rc4_spl(struct image_tool_params *params);
  87
  88 /**
  89  * rkcommon_rc4_encode_spl() - encode the spl binary
  90  *
  91  * Encrypts the SPL binary using the generic rc4 key as required
  92  * by some socs.
  93  *
  94  * @buf:        Pointer to the SPL data (header and SPL binary)
  95  * @offset:     offset inside buf to start at
  96  * @size:       number of bytes to encode
  97  */
  98 void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size);
  99
 100 /**
 101  * rkcommon_vrec_header() - allocate memory for the header
 102  *
 103  * @params:     Pointer to the tool params structure
 104  * @tparams:    Pointer tot the image type structure (for setting
 105  *              the header and header_size)
 106  * @alignment:  Alignment (a power of two) that the image should be
 107  *              padded to (e.g. 512 if we want to align with SD/MMC
 108  *              blocksizes or 2048 for the SPI format)
 109  *
 110  * @return bytes of padding required/added (does not include the header_size)
 111  */
 112 int rkcommon_vrec_header(struct image_tool_params *params,
 113                          struct image_type_params *tparams,
 114                          unsigned int alignment);
 115
 116 #endif