185f812c41
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
108 lines
3.1 KiB
C
108 lines
3.1 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* (C) Copyright 2015 Google, Inc
|
|
* Written by Simon Glass <sjg@chromium.org>
|
|
*/
|
|
|
|
#ifndef _RKCOMMON_H
|
|
#define _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,
|
|
};
|
|
|
|
/**
|
|
* rkcommon_check_params() - check params
|
|
*
|
|
* Return: 0 if OK, -1 if ERROR.
|
|
*/
|
|
int rkcommon_check_params(struct image_tool_params *params);
|
|
|
|
/**
|
|
* rkcommon_get_spl_hdr() - get 4-bytes spl hdr for a Rockchip boot image
|
|
*
|
|
* Rockchip's bootrom requires the spl loader to start with a 4-bytes
|
|
* header. The content of this header depends on the chip type.
|
|
*/
|
|
const char *rkcommon_get_spl_hdr(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
|
|
* back to the bootrom after spl, we may need to reserve some sram space
|
|
* for the bootrom.
|
|
* The spl loader size should be sram size minus reserved size(if needed)
|
|
*/
|
|
int rkcommon_get_spl_size(struct image_tool_params *params);
|
|
|
|
/**
|
|
* rkcommon_set_header() - set up the header for a Rockchip boot image
|
|
*
|
|
* 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)
|
|
*/
|
|
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
|
|
*
|
|
* 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.
|
|
*/
|
|
bool rkcommon_need_rc4_spl(struct image_tool_params *params);
|
|
|
|
/**
|
|
* rkcommon_rc4_encode_spl() - encode the spl binary
|
|
*
|
|
* Encrypts the SPL binary using the generic rc4 key as required
|
|
* by some socs.
|
|
*
|
|
* @buf: Pointer to the SPL data (header and SPL binary)
|
|
* @offset: offset inside buf to start at
|
|
* @size: number of bytes to encode
|
|
*/
|
|
void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size);
|
|
|
|
/**
|
|
* rkcommon_vrec_header() - allocate memory for the header
|
|
*
|
|
* @params: Pointer to the tool params structure
|
|
* @tparams: Pointer tot the image type structure (for setting
|
|
* the header and header_size)
|
|
*
|
|
* Return: 0 (always)
|
|
*/
|
|
int rkcommon_vrec_header(struct image_tool_params *params,
|
|
struct image_type_params *tparams);
|
|
|
|
#endif
|