138 lines
4.7 KiB
C
138 lines
4.7 KiB
C
/******************************************************************************
|
|
* Copyright (c) 2012 - 2020 Xilinx, Inc. All rights reserved.
|
|
* SPDX-License-Identifier: MIT
|
|
******************************************************************************/
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* @file image_mover.h
|
|
*
|
|
* This file contains the interface for moving the image from FLASH to OCM
|
|
|
|
*
|
|
* <pre>
|
|
* MODIFICATION HISTORY:
|
|
*
|
|
* Ver Who Date Changes
|
|
* ----- ---- -------- -------------------------------------------------------
|
|
* 1.00a jz 03/04/11 Initial release
|
|
* 2.00a jz 06/04/11 partition header expands to 12 words
|
|
* 5.00a kc 07/30/13 Added defines for image header information
|
|
* 8.00a kc 01/16/13 Added defines for partition owner attribute
|
|
* 9.0 vns 03/21/22 Deleted GetImageHeaderAndSignature() and added
|
|
* GetNAuthImageHeader()
|
|
* </pre>
|
|
*
|
|
* @note
|
|
*
|
|
******************************************************************************/
|
|
#ifndef ___IMAGE_MOVER_H___
|
|
#define ___IMAGE_MOVER_H___
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/***************************** Include Files *********************************/
|
|
#include "fsbl.h"
|
|
|
|
/************************** Constant Definitions *****************************/
|
|
#define PARTITION_NUMBER_SHIFT 24
|
|
#define MAX_PARTITION_NUMBER (0xE)
|
|
|
|
/* Boot Image Header defines */
|
|
#define IMAGE_HDR_OFFSET 0x098 /* Start of image header table */
|
|
#define IMAGE_PHDR_OFFSET 0x09C /* Start of partition headers */
|
|
#define IMAGE_HEADER_SIZE (64)
|
|
#define IMAGE_HEADER_TABLE_SIZE (64)
|
|
#define TOTAL_PARTITION_HEADER_SIZE (MAX_PARTITION_NUMBER * IMAGE_HEADER_SIZE)
|
|
#define TOTAL_IMAGE_HEADER_SIZE (MAX_PARTITION_NUMBER * IMAGE_HEADER_SIZE)
|
|
#define TOTAL_HEADER_SIZE (IMAGE_HEADER_TABLE_SIZE + \
|
|
TOTAL_IMAGE_HEADER_SIZE + \
|
|
TOTAL_PARTITION_HEADER_SIZE + 64)
|
|
|
|
/* Partition Header defines */
|
|
#define PARTITION_IMAGE_WORD_LEN_OFFSET 0x00 /* Word length of image */
|
|
#define PARTITION_DATA_WORD_LEN_OFFSET 0x04 /* Word length of data */
|
|
#define PARTITION_WORD_LEN_OFFSET 0x08 /* Word length of partition */
|
|
#define PARTITION_LOAD_ADDRESS_OFFSET 0x0C /* Load addr in DDR */
|
|
#define PARTITION_EXEC_ADDRESS_OFFSET 0x10 /* Addr to start executing */
|
|
#define PARTITION_ADDR_OFFSET 0x14 /* Partition word offset */
|
|
#define PARTITION_ATTRIBUTE_OFFSET 0x18 /* Partition type */
|
|
#define PARTITION_HDR_CHECKSUM_OFFSET 0x3C /* Header Checksum offset */
|
|
#define PARTITION_HDR_CHECKSUM_WORD_COUNT 0xF /* Checksum word count */
|
|
#define PARTITION_HDR_WORD_COUNT 0x10 /* Header word len */
|
|
#define PARTITION_HDR_TOTAL_LEN 0x40 /* One partition hdr length*/
|
|
|
|
/* Attribute word defines */
|
|
#define ATTRIBUTE_IMAGE_TYPE_MASK 0xF0 /* Destination Device type */
|
|
#define ATTRIBUTE_PS_IMAGE_MASK 0x10 /* Code partition */
|
|
#define ATTRIBUTE_PL_IMAGE_MASK 0x20 /* Bit stream partition */
|
|
#define ATTRIBUTE_CHECKSUM_TYPE_MASK 0x7000 /* Checksum Type */
|
|
#define ATTRIBUTE_RSA_PRESENT_MASK 0x8000 /* RSA Signature Present */
|
|
#define ATTRIBUTE_PARTITION_OWNER_MASK 0x30000 /* Partition Owner */
|
|
|
|
#define ATTRIBUTE_PARTITION_OWNER_FSBL 0x00000 /* FSBL Partition Owner */
|
|
|
|
|
|
/**************************** Type Definitions *******************************/
|
|
typedef u32 (*ImageMoverType)( u32 SourceAddress,
|
|
u32 DestinationAddress,
|
|
u32 LengthBytes);
|
|
|
|
typedef struct StructPartHeader {
|
|
u32 ImageWordLen; /* 0x0 */
|
|
u32 DataWordLen; /* 0x4 */
|
|
u32 PartitionWordLen; /* 0x8 */
|
|
u32 LoadAddr; /* 0xC */
|
|
u32 ExecAddr; /* 0x10 */
|
|
u32 PartitionStart; /* 0x14 */
|
|
u32 PartitionAttr; /* 0x18 */
|
|
u32 SectionCount; /* 0x1C */
|
|
u32 CheckSumOffset; /* 0x20 */
|
|
u32 Pads1[1];
|
|
u32 ACOffset; /* 0x28 */
|
|
u32 Pads2[4];
|
|
u32 CheckSum; /* 0x3C */
|
|
}PartHeader;
|
|
|
|
struct HeaderArray {
|
|
u32 Fields[16];
|
|
};
|
|
|
|
|
|
/***************** Macros (Inline Functions) Definitions *********************/
|
|
#define MoverIn32 Xil_In32
|
|
#define MoverOut32 Xil_Out32
|
|
|
|
/************************** Function Prototypes ******************************/
|
|
u32 LoadBootImage(void);
|
|
u32 GetPartitionHeaderInfo(u32 ImageBaseAddress);
|
|
u32 PartitionMove(u32 ImageBaseAddress, PartHeader *Header);
|
|
u32 ValidatePartitionHeaderChecksum(struct HeaderArray *H);
|
|
u32 GetPartitionHeaderStartAddr(u32 ImageAddress, u32 *Offset);
|
|
u32 GetNAuthImageHeader(u32 ImageAddress);
|
|
u32 GetFsblLength(u32 ImageAddress, u32 *FsblLength);
|
|
u32 LoadPartitionsHeaderInfo(u32 PartHeaderOffset, PartHeader *Header);
|
|
u32 IsEmptyHeader(struct HeaderArray *H);
|
|
u32 IsLastPartition(struct HeaderArray *H);
|
|
void HeaderDump(PartHeader *Header);
|
|
u32 GetPartitionCount(PartHeader *Header);
|
|
u32 ValidateHeader(PartHeader *Header);
|
|
u32 DecryptPartition(u32 StartAddr, u32 DataLength, u32 ImageLength);
|
|
|
|
/************************** Variable Definitions *****************************/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#endif /* ___IMAGE_MOVER_H___ */
|
|
|
|
|
|
|
|
|