 |
xilpdi
Vitis Drivers API Documentation
|
|
xilpdi
Vitis Drivers API Documentation
|
This is the header file which contains definitions for the PDI.
MODIFICATION HISTORY:
Ver Who Date Changes
----- ---- -------- -------------------------------------------------------
1.00 kc 12/21/2017 Initial release
1.01 bsv 04/08/2019 Added support for secondary boot device parameters
bsv 07/30/2019 Renamed XilPdi_ReadAndValidateImgHdrTbl to
XilPdi_ReadImgHdrTbl
rm 08/28/2019 Added APIs for retrieving delay load and delay handoff
params
1.02 bsv 11/29/2019 Added support for smap bus width word in partial pdis
vnsl 02/26/2020 Added support to read DPA CM Enable field in meta headers
vnsl 03/01/2020 Added support to read PufHeader from Meta Headers and
partition headers
vnsl 04/12/2020 Added support to read BootHdr Auth Enable field in
boot header
1.03 skd 07/14/2020 Function pointer DeviceCopy prototype changed
1.04 bsv 07/29/2020 Added UID, parent ID, function ID and copy to memory
address
kpt 07/30/2020 Added maximum limit for number of images
td 08/19/2020 Fixed MISRA C violations Rule 10.3
bsv 10/13/2020 Code clean up
kpt 10/19/2020 Added support to validate checksum of image headers and
partition headers
1.05 td 11/23/2020 Coverity Warning Fixes
ma 01/08/2021 Changed maximum number of entries possible for ATF
har 02/01/2021 Added API to get PLM encryption key source
bm 02/12/2021 Updated logic to use BootHdr directly from PMC RAM
har 03/17/2021 Removed XilPdi_IsBhdrAuthEnable
ma 03/24/2021 Redirect XilPdi prints to XilLoader
ma 03/24/2021 Change ImgName to u8 to print max characters of
PDI image names
har 03/31/2021 Added PdiId in XilPdi_ImgHdrTbl structure
1.06 td 07/08/2021 Fix doxygen warnings
bsv 08/16/2021 Code clean up
bm 08/24/2021 Added Extract Metaheader support
kpt 09/18/2021 Fixed SW-BP-REDUNDANCY in
XilPdi_IsDpaCmEnable
1.07 kpt 02/01/2022 Updated XilPdi_ReadBootHdr prototype
1.08 bsv 07/06/2022 Added API to read OptionaData from Metaheader
bm 07/06/2022 Refactor versal and versal_net code
bsv 07/08/2022 Code changes related to Optional data in IHT
bm 07/13/2022 Added compatibility check for In-Place PLM Update
bm 09/13/2022 Reduce maximum number of partitions and images
1.09 har 11/17/2022 Removed macros for bh_auth attribute in Bootheader
ng 11/23/2022 Added macros to replace magic numbers in
XilPdi_ValidateChecksum
kal 01/05/2023 Added PcrInfo attribute in XilPdi_ImgHdr
sk 02/22/2023 Added Bit MASK for EoPDI SYNC logic
dd 03/16/2023 Misra-C violation Rule 17.8 fixed
sk 05/18/2023 Deprecate copy to memory feature
am 07/03/2023 Added macros related to IHT OP data
dd 08/11/2023 Updated doxygen comments
kpt 12/04/2023 Move XilPdi_BootHdr to platform specific files
am 03/02/2024 Added IsAuthOptimized variable in XilPdi_MetaHdr structure
1.11 kpt 11/05/2024 Add XilPdi_ReadOptionalData to read optional data
pre 12/09/2024 use PMC RAM for Metaheader instead of PPU1 RAMData Structures | |
| struct | XilPdi_ImgHdr |
| Maximum size of IHT Optional data is 15,872B(16KB-128Word) More... | |
| struct | XilPdi_PrtnHashInfo |
| Partition hash entry information. More... | |
| struct | XilPdi_MetaHdr |
| Structure of the image header which contains information of image header table and partition headers. More... | |
| struct | XilPdi_PrtnEntry |
| Structure corresponding to each partition entry. More... | |
| struct | XilPdi_ATFHandoffParams |
| Structure for handoff parameters to ARM Trusted Firmware (ATF) More... | |
XilPdi Definitions | |
| #define | XIH_MIN_PRTNS (1U) |
| #define | XIH_MIN_IMGS (1U) |
| #define | XIH_BH_IMAGE_IDENT (0x584C4E58U) |
| Boot header identification string. More... | |
| #define | XIH_BH_IMAGE_IDENT_OFFSET (0x14U) |
| #define | XIH_BH_AES_KEYSRC_OFFSET (0x08U) |
| Boot header Key source field. More... | |
| #define | XIH_BH_IMG_ATTRB_OFFSET (0x24U) |
| #define | SMAP_BUS_WIDTH_LENGTH (16U) |
| SMAP bus width macros. More... | |
| #define | SMAP_BUS_WIDTH_WORD_LEN (4U) |
| #define | SMAP_BUS_WIDTH_8_WORD1 (0xDD000000U) |
| #define | SMAP_BUS_WIDTH_16_WORD1 (0x00DD0000U) |
| #define | SMAP_BUS_WIDTH_32_WORD1 (0x000000DDU) |
| #define | XIH_IHT_LEN (128U) |
| Defines for length of the headers. More... | |
| #define | XIH_IH_LEN (64U) |
| #define | XIH_PH_LEN (128U) |
| #define | XIH_PRTN_WORD_LEN (0x4U) |
| #define | XIH_PRTN_WORD_LEN_SHIFT (0x2U) |
| #define | XIH_IHT_ATTR_PUFHD_MASK (0xC000U) |
| IHT attributes. More... | |
| #define | XIH_IHT_ATTR_PUFHD_SHIFT (14U) |
| #define | XIH_IHT_ATTR_DPA_CM_MASK (0x3000U) |
| #define | XIH_IHT_ATTR_DPA_CM_SHIFT (12U) |
| #define | XIH_IHT_ATTR_BYPS_MASK (0x1U) |
| IDCODE checks bypass. More... | |
| #define | XIH_IHT_ATTR_BYPS_ID_CODE_MASK (0x30000U) |
| Check [17:16] bits to bypass ID Code. More... | |
| #define | XIH_IHT_ATTR_EOPDI_SYNC_SHIFT (18U) |
| #define | XIH_IHT_ATTR_EOPDI_SYNC_MASK XPLMI_BIT(XIH_IHT_ATTR_EOPDI_SYNC_SHIFT) |
| #define | XIH_IHT_EXT_IDCODE_MASK (0x3FU) |
| #define | XIH_IHT_VERSION_OFFSET (0x0U) |
| #define | XIH_IHT_IDENT_STRING_OFFSET (0x28U) |
| #define | XIH_IHT_PPDI_IDENT_VAL (0x50504449U) |
| #define | XIH_IHT_FPDI_IDENT_VAL (0x46504449U) |
| #define | XIH_PH_ATTRB_DPA_CM_EN_MASK (0x18000000U) |
| Prtn Attribute fields. More... | |
| #define | XIH_PH_ATTRB_DPA_CM_EN_SHIFT (27U) |
| #define | XIH_PH_ATTRB_PRTN_TYPE_MASK (0x7000000U) |
| #define | XIH_PH_ATTRB_PRTN_OWNER_MASK (0x30000U) |
| #define | XIH_PH_ATTRB_PUFHD_MASK (0xC000U) |
| #define | XIH_PH_ATTRB_CHECKSUM_MASK (0x3000U) |
| #define | XIH_PH_ATTRB_DSTN_CPU_MASK (0x0F00U) |
| #define | XIH_PH_ATTRB_TARGET_EL_MASK (0x0006U) |
| #define | XIH_PH_ATTRB_TZ_SECURE_MASK (0x0001U) |
| #define | XIH_PH_ATTRB_PUFHD_SHIFT (14U) |
| #define | XIH_PH_ATTRB_PRTN_TYPE_RSVD (0x0000000U) |
| Prtn Attribute Values. More... | |
| #define | XIH_PH_ATTRB_PRTN_TYPE_ELF (0x1000000U) |
| #define | XIH_PH_ATTRB_PRTN_TYPE_CDO (0x2000000U) |
| #define | XIH_PH_ATTRB_PRTN_TYPE_CFI_GSC_UNMASK (0x7000000U) |
| #define | XIH_PH_ATTRB_PRTN_OWNER_PLM (0x00000U) |
| #define | XIH_PH_ATTRB_HASH_SHA3 (0x3000U) |
| #define | XILPDI_MAX_ENTRIES_FOR_ATF (6U) |
| Number of entries possible in ATF: 2 cores * 3 (EL2 non-secure, EL1 secure and EL1 non-secure) More... | |
| #define | XILPDI_ERR_IHT_CHECKSUM (0x1) |
| Errors during XilPdi processing. More... | |
| #define | XILPDI_ERR_NO_OF_PRTNS (0x2) |
| #define | XILPDI_ERR_ZERO_LENGTH (0x4) |
| #define | XILPDI_ERR_TOTAL_LENGTH (0x5) |
| #define | XILPDI_ERR_PRTN_TYPE (0x6) |
| #define | XILPDI_ERR_NO_OF_IMGS (0x7) |
| #define | XILPDI_ERR_IH_CHECKSUM (0x40) |
| #define | XILPDI_ERR_PH_CHECKSUM (0x80) |
| #define | XILPDI_ERR_OPTIONAL_DATA_CHECKSUM_FAILED (0x70) |
| #define | XILPDI_ERR_NO_VALID_OPTIONAL_DATA (0x71) |
| #define | XILPDI_ERR_INVALID_DIGEST_TABLE_SIZE (0x72) |
| #define | XILPDI_ERR_OVER_FLOW_OPTIONAL_DATA (0x73) |
| #define | XILPDI_ERR_OVER_FLOW_OPTIONAL_DATA_AT_DATA_ID_3 (0x74) |
| #define | XILPDI_IH_ATTRIB_DELAY_LOAD_SHIFT (0x7U) |
| Image Header Attributes. More... | |
| #define | XILPDI_IH_ATTRIB_DELAY_LOAD_MASK (0X00000080U) |
| #define | XILPDI_IH_ATTRIB_DELAY_HANDOFF_SHIFT (0x8U) |
| #define | XILPDI_IH_ATTRIB_DELAY_HANDOFF_MASK (0X00000100U) |
| #define | XILPDI_IMG_NAME_ARRAY_SIZE (16U) |
| Array size for image name. More... | |
| #define | XILPDI_CHECKSUM_MIN_BUF_LEN (0X2U) |
| Minimum buffer length for checksum. More... | |
| #define | XILPDI_INVERT_CHECKSUM (0xFFFFFFFFU) |
| Invert checksum. More... | |
| #define | XILPDI_PARTITION_HASH_DATA_ID (3U) |
| Partition hash data Id. More... | |
| #define | XIH_PMC_RAM_IHT_OP_DATA_STORE_ADDR (0xF201D200U) |
| Common address of storing partition hashes for both versal and versal_net. More... | |
| #define | XILPDI_OPTIONAL_DATA_WORD_LEN (4U) |
| Optional data attributes. More... | |
| #define | XILPDI_OPTIONAL_DATA_DOUBLE_WORD_LEN (2U * XILPDI_OPTIONAL_DATA_WORD_LEN) |
| #define | XIH_OPT_DATA_HDR_ID_MASK (0xFFFFU) |
| #define | XIH_OPT_DATA_HDR_LEN_MASK (0xFFFF0000U) |
| #define | XIH_OPT_DATA_LEN_SHIFT (16U) |
| #define | XIPLDI_SHA3_HASH_SIZE_IN_BYTES (48U) |
| #define | XILPDI_OPTIONAL_DATA_ID_3_MAX_SIZE_2K_BYTES (0x800U) |
| #define | XILPDI_OPTIONAL_DATA_MAX_SIZE_16K_BYTES (0x3E00U) |
| Maximum size of IHT Optional data for Data Id 3 is 2KB. More... | |
| #define | XilPdi_Printf(...) |
| #define | XILPDI_PMCRAM_IHT_COPY_ADDR (0xF2004120U) /* IHT Optional data cannot exceed 16 KB */ |
| #define | XILPDI_PMCRAM_IHT_DATA_ADDR (XILPDI_PMCRAM_IHT_COPY_ADDR + XIH_IHT_LEN) |
| #define | XILPDI_WORD_LEN_SHIFT (2U) |
| int | XilPdi_ValidatePrtnHdr (const XilPdi_PrtnHdr *PrtnHdr) |
| This function validates the Partition Header. More... | |
| int | XilPdi_ValidateImgHdrTbl (const XilPdi_ImgHdrTbl *ImgHdrTbl) |
| This function checks the fields of the Image Header Table and validates them. More... | |
| void | XilPdi_ReadBootHdr (const XilPdi_BootHdr **BootHdrPtr) |
| This function reads the boot header. More... | |
| int | XilPdi_ReadImgHdrTbl (XilPdi_MetaHdr *MetaHdrPtr) |
| This function Reads the Image Header Table. More... | |
| int | XilPdi_VerifyImgHdrs (const XilPdi_MetaHdr *MetaHdrPtr) |
| This function verifies Image headers. More... | |
| int | XilPdi_VerifyPrtnHdrs (const XilPdi_MetaHdr *MetaHdrPtr) |
| This function verifies Partition Headers. More... | |
| int | XilPdi_ReadImgHdrs (const XilPdi_MetaHdr *MetaHdrPtr) |
| This function reads the Image Headers. More... | |
| int | XilPdi_ReadPrtnHdrs (const XilPdi_MetaHdr *MetaHdrPtr) |
| This function reads the Partition Headers. More... | |
| int | XilPdi_ReadIhtAndOptionalData (XilPdi_MetaHdr *MetaHdrPtr, u8 PdiType) |
| This function reads IHT and optional data in Image Header Table. More... | |
| int | XilPdi_ValidateChecksum (const void *Buffer, u32 Length) |
| This function is used to validate the word checksum for the Image Header table and Partition Headers. More... | |
| XilPdi_PrtnHashInfo * | XilPdi_IsPrtnHashPresent (u32 PrtnNum, u32 HashTableSize) |
| This function checks if partition hash is present. More... | |
| int | XilPdi_StoreDigestTable (XilPdi_MetaHdr *MetaHdrPtr) |
| This function stores digest table for given data Id. More... | |
| u64 | XilPdi_SearchOptionalData (u64 StartAddress, u64 EndAddress, u32 DataId) |
| This function search offset of optional data address. More... | |
| int | XilPdi_ReadOptionalData (XilPdi_MetaHdr *MetaHdrPtr, u8 PdiType) |
| This function reads optional data in Image Header Table. More... | |
| #define SMAP_BUS_WIDTH_LENGTH (16U) |
SMAP bus width macros.
Referenced by XilPdi_ReadImgHdrTbl(), and XilPdi_ReadOptionalData().
| #define XIH_BH_AES_KEYSRC_OFFSET (0x08U) |
Boot header Key source field.
| #define XIH_BH_IMAGE_IDENT (0x584C4E58U) |
Boot header identification string.
XLNX pattern
| #define XIH_IHT_ATTR_BYPS_ID_CODE_MASK (0x30000U) |
Check [17:16] bits to bypass ID Code.
| #define XIH_IHT_ATTR_BYPS_MASK (0x1U) |
IDCODE checks bypass.
| #define XIH_IHT_ATTR_PUFHD_MASK (0xC000U) |
IHT attributes.
| #define XIH_IHT_LEN (128U) |
Defines for length of the headers.
Referenced by XilPdi_ReadIhtAndOptionalData(), XilPdi_ReadImgHdrTbl(), XilPdi_ReadOptionalData(), and XilPdi_ValidateImgHdrTbl().
| #define XIH_PH_ATTRB_DPA_CM_EN_MASK (0x18000000U) |
Prtn Attribute fields.
| #define XIH_PH_ATTRB_PRTN_TYPE_RSVD (0x0000000U) |
Prtn Attribute Values.
Referenced by XilPdi_ValidatePrtnHdr().
| #define XIH_PMC_RAM_IHT_OP_DATA_STORE_ADDR (0xF201D200U) |
Common address of storing partition hashes for both versal and versal_net.
Referenced by XilPdi_IsPrtnHashPresent(), XilPdi_ReadIhtAndOptionalData(), and XilPdi_StoreDigestTable().
| #define XILPDI_CHECKSUM_MIN_BUF_LEN (0X2U) |
Minimum buffer length for checksum.
Referenced by XilPdi_ValidateChecksum().
| #define XILPDI_ERR_IHT_CHECKSUM (0x1) |
Errors during XilPdi processing.
Referenced by XilPdi_ValidateImgHdrTbl().
| #define XILPDI_IH_ATTRIB_DELAY_LOAD_SHIFT (0x7U) |
Image Header Attributes.
| #define XILPDI_IMG_NAME_ARRAY_SIZE (16U) |
Array size for image name.
| #define XILPDI_INVERT_CHECKSUM (0xFFFFFFFFU) |
Invert checksum.
Referenced by XilPdi_ValidateChecksum().
| #define XILPDI_MAX_ENTRIES_FOR_ATF (6U) |
Number of entries possible in ATF: 2 cores * 3 (EL2 non-secure, EL1 secure and EL1 non-secure)
| #define XILPDI_OPTIONAL_DATA_MAX_SIZE_16K_BYTES (0x3E00U) |
Maximum size of IHT Optional data for Data Id 3 is 2KB.
Referenced by XilPdi_ReadOptionalData().
| #define XILPDI_OPTIONAL_DATA_WORD_LEN (4U) |
Optional data attributes.
Referenced by XilPdi_StoreDigestTable().
| #define XILPDI_PARTITION_HASH_DATA_ID (3U) |
Partition hash data Id.
Referenced by XilPdi_StoreDigestTable().