Overview

This file contains declarations versal_net PLMI module.

MODIFICATION HISTORY:

Ver   Who  Date        Changes
----- ---- -------- -------------------------------------------------------
1.00  bm   07/06/2022 Initial release
      ma   07/20/2022 Rename PMC_PSM_ERR_REG_OFFSET macro
      bm   07/20/2022 Update EAM logic for In-Place PLM Update
1.01  ng   11/11/2022 Fixed doxygen file name error
      bm   01/03/2023 Remove Triggering of SSIT ERR2 from Slave SLR to
                      Master SLR
      bm   01/03/2023 Notify Other SLRs about Secure Lockdown
      sk   01/13/2023 CPM5N Link UP Event handler declaration
      dd   03/28/2023 Updated doxygen comments
      dd   09/12/2023 MISRA-C violation Rule 10.3 fixed
1.02  ma   02/29/2024 Change protection unit error actions to PRINT_TO_LOG
                      to handle restoring of the error actions after IPU
1.02  sk   08/26/2024 Updated EAM support for Versal 2VE and 2VM Devices
      sk   02/20/2025 Added defines for Versal 2VE and 2VM Devices EAM handler

Note

Macros
#define	GET_PMC_ERR_ACTION_OFFSET(Index)
	PMC error action offset. More...

#define	GET_PMC_ERR_ACTION_ADDR(PmcMask, Index)
	PMC error action address. More...

#define	GET_PMC_ERR_OUT_MASK(RegOffset)
	PMC error out mask. More...

#define	GET_PMC_POR_MASK(RegOffset)
	PMC POR mask. More...

#define	GET_PMC_IRQ_MASK(RegOffset)
	PMC IRQ mask. More...

#define	GET_PMC_SRST_MASK(RegOffset)
	PMC SRST mask. More...

Functions
XPlmi_Error_t *	XPlmi_GetErrorTable (void)
	This function provides error table pointer. More...

u8	XPlmi_GetEventIndex (XPlmi_EventType ErrorNodeType)
	This function provides event index. More...

int	XPlmi_RestrictErrActions (XPlmi_EventType NodeType, u32 RegMask, u32 ErrorAction)
	This function restricts error actions. More...

void	XPlmi_DumpErrNGicStatus (void)
	This function dumps EAM Error status registers and Gic Status registers. More...

void	XPlmi_ReconfigErrActions (void)
	This function reconfigures error actions after the update. More...

u32 *	XPlmi_GetNumErrOuts (void)
	This function provides pointer to NumErrOuts. More...

u32 *	XPlmi_GetPsmCrState (void)
	This function provides IsPsmChanged variable. More...

void	XPlmi_HandleLinkUpEvent (u32 Cpm5NPcieCdxIrStatusReg, u32 Cpm5NCdxPcieBReg, u32 ProcId)
	This function handles the CPM_NCR PCIE link up event. More...

void	XPlmi_ErrPrintToLog (u32 ErrorNodeId, u32 RegMask)
	This function is the interrupt handler for Error action "Print to Log". More...

int	XPlmi_EmDisableLpdSlcrErrors (u32 RegMaskAddr, u32 RegMask)
	This function disables the LPD SCLR error actions for the given mask. More...

int	EmEnableLpdSlcrErrAction (u32 ErrMaskRegAddr, u32 RegMask)
	This function enables the error action for the given error mask. More...

int	XPlmi_LpdSlcrEmInit (void)
	This function initializes the error actions in LPD Slcr Disables all the LPD SLCR error actions and registers default action. More...

int	XPlmi_Versal2Ve2VmSetAction (XPlmi_Cmd *Cmd)
	This function sets the error action as prescribed by the command. More...

Macro Definition Documentation

#define GET_PMC_ERR_ACTION_ADDR	(	PmcMask,
		Index
	)

Value:

((Index == 2) ? \
                        (PmcMask + ((0xFU) * XPLMI_PMC_PSM_ERR2_REG_OFFSET - \
                         ((PmcMask - PMC_GLOBAL_PMC_ERR_OUT1_MASK) / 2U))) :\
                        (PmcMask + (Index * XPLMI_PMC_PSM_ERR2_REG_OFFSET)))

PMC error action address.

#define GET_PMC_ERR_ACTION_OFFSET ( Index )

Value:

((Index == 2) ? \
                        ((0xFU) * XPLMI_PMC_PSM_ERR2_REG_OFFSET) : \
                        (Index * XPLMI_PMC_PSM_ERR2_REG_OFFSET))

PMC error action offset.

Referenced by XPlmi_EmDisable(), XPlmi_EmInit(), XPlmi_ErrorTaskHandler(), XPlmi_GenericHandler(), and XPlmi_Versal2Ve2VmEAMHandler().

#define GET_PMC_ERR_OUT_MASK ( RegOffset )

Value:

(RegOffset == 0xF0U) ? (PMC_GLOBAL_PMC_ERR_OUT3_MASK) :\

(PMC_GLOBAL_PMC_ERR_OUT1_MASK + RegOffset)

PMC error out mask.

Referenced by XPlmi_EmDisablePmcErrors().

#define GET_PMC_IRQ_MASK ( RegOffset )

Value:

(RegOffset == 0xF0U) ? (PMC_GLOBAL_PMC_IRQ3_MASK) :\

(PMC_GLOBAL_PMC_IRQ1_MASK + RegOffset)