xplmi_util.c File Reference

Overview

This file which contains the code which interfaces with the CRP.

MODIFICATION HISTORY:

Ver   Who  Date        Changes



1.00  kc   02/21/2017 Initial release
1.01  bsv  04/18/2019 Added support for NPI readback and CFI readback
      kc   04/26/2019 Updated Delay and Poll timeout based on timers
      rm   06/27/2019 Added APIs for safety register writes
      vnsl 07/19/2019 Added XPlmi_MemCmp API to check for PPK and SPK integrity
1.02  bsv  02/17/2020 Added 64-bit / 128-bit safety write APIs for xilsem
      bsv  04/04/2020 Code clean up
1.03  kc   06/22/2020 Minor updates to PrintArray for better display
      kc   08/17/2020 Added redundancy checks to XPlmi_MemCmp
      bsv  09/04/2020 Added checks to validate input params for XPlmi_Strcat
                      and XPlmi_Strcpy
      bm   10/14/2020 Code clean up
      td   10/19/2020 MISRA C Fixes
1.04  bsv  11/05/2020 Added prints while polling in UtilPoll APIs
      td   11/23/2020 MISRA C Rule 17.8 Fixes
      bm   02/16/2021 Renamed print functions used in XPlmi_PrintArray
      bm   03/04/2021 Add VerifyAddrRange API
      bm   03/17/2021 Mark reserved address region as invalid in
                      VerifyAddrRange API
1.05  td   07/08/2021 Fix doxygen warnings
      bsv  07/16/2021 Fix doxygen warnings
      bsv  08/02/2021 Code clean up to reduce size
      bsv  09/05/2021 Disable prints in slave boot modes in case of error
1.06  bm   07/06/2022 Refactor versal and versal_net code
      bm   07/24/2022 Set PlmLiveStatus during boot time
1.07  ng   11/11/2022 Updated doxygen comments
      bm   01/03/2023 Notify Other SLRs about Secure Lockdown
      ng   03/12/2023 Fixed Coverity warnings
      ng   03/30/2023 Updated algorithm and return values in doxygen comments
1.08  sd   02/19/2025 Added multiboot store and restore APIs for platforms
                      with A/B firmware
      sd   03/17/2025 Added multiboot clear API for platforms with A/B firmware

Functions
void	XPlmi_UtilRMW (u32 RegAddr, u32 Mask, u32 Value)
	This function will Read, Modify and Write to a register. More...
int	XPlmi_UtilPoll (u32 RegAddr, u32 Mask, u32 ExpectedValue, u32 TimeOutInUs, void(*ClearHandler)(void))
	This function polls a register till the masked bits are set to expected value or till timeout occurs. More...
int	XPlmi_UtilPoll64 (u64 RegAddr, u32 Mask, u32 ExpectedValue, u32 TimeOutInUs)
	This function polls a 64 bit address till the masked bits are set to expected value or till timeout occurs. More...
int	XPlmi_UtilPollForMask (u32 RegAddr, u32 Mask, u32 TimeOutInUs)
	This function polls a 64 bit register till the masked bits are set to expected value or till timeout occurs. More...
int	XPlmi_UtilPollForMask64 (u32 HighAddr, u32 LowAddr, u32 Mask, u32 TimeOutInUs)
	This function polls a 64 bit register till the masked bits are set to expected value or till timeout occurs. More...
void	XPlmi_UtilWrite64 (u32 HighAddr, u32 LowAddr, u32 Value)
	This function writes to a 64 bit address. More...
void	XPlmi_PrintArray (u16 DebugType, const u64 BufAddr, u32 Len, const char *Str)
	This function is used to print the entire array in bytes as specified by the debug type. More...
int	XPlmi_UtilPollNs (u32 RegAddr, u32 Mask, u32 ExpectedValue, u64 TimeOutInNs, void(*ClearHandler)(void))
	This function polls a register till the masked bits are set to expected value or till timeout occurs. More...
void	XPlmi_StoreMultiboot (void)
	This is a placeholder function used in case the feature is disabled. More...
void	XPlmi_RestoreMultiboot (void)
	This is a placeholder function used in case the feature is disabled. More...
void	XPlmi_ClearMultiboot (void)
	This is a placeholder function used in case the feature is disabled. More...