Overview

This is the header file which contains definitions for the ipi manager.

MODIFICATION HISTORY:

Ver   Who  Date        Changes
----- ---- -------- -------------------------------------------------------
1.00  ma   10/09/2018 Initial release
1.01  kc   04/09/2019 Added code to register/enable/disable interrupts
      kc   05/21/2019 Updated IPI error code to response buffer
      ma   08/01/2019 Added LPD init code
      rv   02/04/2020 Set the 1st element of response array always to status
      bsv  02/13/2020 XilPlmi generic commands should not be supported
                      via IPI
      ma   02/21/2020 Added code to allow event logging command via IPI
      ma   02/28/2020 Added code to disallow EM commands over IPI
      bsv  03/09/2020 Added code to support CDO features command
      ma   03/19/2020 Added features command for EM module
      bsv  04/04/2020 Code clean up
1.02  bsv  06/02/2020 Added code to support GET BOARD command and disallow
                      SET BOARD command via IPI
      bm   10/14/2020 Code clean up
1.03  ma   03/04/2021 Added IPI secure related defines
      bsv  04/16/2021 Added provision to store Subsystem Id in XilPlmi
1.04  ma   08/09/2021 Added IPI_PMC_IMR register define
1.05  skd  04/21/2022 Misra-C violation Rule 8.7 fixed
      skg  06/20/2022 Misra-C violation Rule 8.13 fixed
      bm   07/06/2022 Refactor versal and versal_net code
      bm   07/18/2022 Shutdown modules gracefully during update
1.08  bm   06/23/2023 Added IPI access permissions validation
1.09  bm   02/23/2024 Ack In-Place PLM Update request after complete restore
1.10  sk   05/07/2024 Added declaration for get ipi instance function
      ma   09/23/2024 Added support for PSM to PLM IPI event handler
1.11  gam  01/07/2025 Created dummy IPI APIs in case of no IPI instance to
                      fix plm build issue with XilSEM.
      pre  03/02/2025 Modified IPIdispatchhandler for external linkage

Note

Functions
int	XPlmi_ValidateIpiCmd (XPlmi_Cmd *Cmd, u32 SrcIndex)
	This function checks whether the Cmd passed is supported via IPI mechanism or not. More...

int	XPlmi_IpiWrite (u32 DestCpuMask, const u32 *MsgPtr, u32 MsgLen, u8 Type)
	This function writes an IPI message or a response to destination CPU. More...

int	XPlmi_IpiRead (u32 SrcCpuMask, u32 *MsgPtr, u32 MsgLen, u8 Type)
	This function reads an IPI message or response from source CPU. More...

int	XPlmi_IpiTrigger (u32 DestCpuMask)
	This function triggers the IPI interrupt to destination CPU. More...

int	XPlmi_IpiPollForAck (u32 DestCpuMask, u32 TimeOutCount)
	This function polls for IPI acknowledgment from destination CPU. More...

Overview

Functions