xilpdi
Vitis Drivers API Documentation
xilpdi.c File Reference

Overview

This is the C file which contains APIs for reading PDI image.

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 28/08/2019 Added APIs for retrieving delay load and delay handoff params 1.02 bsv 29/11/2019 Added support for smap bus width word in partial pdis vnsl 26/02/2020 Added support to read DPA CM Enable field in meta headers vnsl 01/03/2020 Added support to read PufHeader from Meta Headers and partition headers vnsl 12/04/2020 Added support to read BootHdr Auth Enable field in boot header 1.03 bsv 07/29/2020 Updated function headers kpt 07/30/2020 Added check to validate number of images bm 09/29/2020 Code cleanup kpt 10/19/2020 Added support to validate checksum of image headers and partition headers 1.04 td 11/23/2020 Coverity Warning Fixes bm 02/12/2021 Updated logic to use BootHdr directly from PMC RAM ma 03/24/2021 Redirect XilPdi prints to XilLoader 1.05 bm 07/08/2021 Code cleanup bsv 08/17/2021 Code clean up 1.06 kpt 12/13/2021 Replaced Xil_SecureMemCpy with Xil_SMemCpy kpt 02/01/2022 Updated XilPdi_ReadBootHdr prototype 1.07 skd 04/21/2022 Misra-C violation Rule 14.3 fixed bsv 07/06/2022 Added API to read Optional data from Metaheader bsv 07/08/2022 Code changes related to Optional data in IHT bm 07/13/2022 Added compatibility check for In-Place PLM Update 1.08 ng 11/11/2022 Updated doxygen comments dd 03/16/2023 Misra-C violation Rule 17.8 fixed dd 03/28/2023 Updated doxygen comments ng 03/30/2023 Updated algorithm and return values in doxygen comments sk 05/31/2023 Updated Xilpdi_ReadImgHdrTbl to use MetaHdrOfst from MetaHdr structure am 07/03/2023 Updated XilPdi_ReadIhtAndOptionalData to store partition hashes dd 09/08/2023 Misra-C violation Rule 12.1 fixed har 02/16/2024 Modified XilPdi_SearchOptionalData as non-static function am 03/02/2024 Updated MH optimization changes to XilPdi_StoreDigestTable sk 03/13/2024 Fixed doxygen comments format 1.10 ng 04/30/2024 Fixed doxygen grouping ng 07/02/2024 Removed dependency on xilplmi library kpt 10/25/2024 Add SMAP_BUS_WIDTH_LENGTH while calculationg optional data start address 1.11 kpt 11/05/2024 Add XilPdi_ReadOptionalData to read optional data pre 12/09/2024 use PMC RAM for PDI instance instead of PPU1 RAM

 

Functions

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...
 
int XilPdi_ValidateImgHdrTbl (const XilPdi_ImgHdrTbl *ImgHdrTbl)
 This function checks the fields of the Image Header Table and validates them. More...
 
int XilPdi_ValidatePrtnHdr (const XilPdi_PrtnHdr *PrtnHdr)
 This function validates the Partition Header. 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_ReadIhtAndOptionalData (XilPdi_MetaHdr *MetaHdrPtr, u8 PdiType)
 This function reads IHT and optional data in Image Header Table. More...
 
int XilPdi_ReadOptionalData (XilPdi_MetaHdr *MetaHdrPtr, u8 PdiType)
 This function reads optional data in Image Header Table. 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...
 
XilPdi_PrtnHashInfoXilPdi_IsPrtnHashPresent (u32 PrtnNum, u32 HashTableSize)
 This function checks if partition hash is present. 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_VerifyPrtnHdrs (const XilPdi_MetaHdr *MetaHdrPtr)
 This function verifies Partition Headers. More...
 
int XilPdi_VerifyImgHdrs (const XilPdi_MetaHdr *MetaHdrPtr)
 This function verifies Image headers. More...