xilplmi
Vitis Drivers API Documentation
xplmi_client.h File Reference

Overview

This file Contains the client function prototypes, defines and macros.

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.00 dd 01/09/24 Initial release pre 07/10/24 Added support for configure secure communication command pre 09/30/24 Added XPlmi_GetSecureCommStatus API pre 01/13/25 Added client API for command to set access status of DDRMC main registers

 

Macros

#define XPLMI_SLR_INDEX_SHIFT   (6U)
 < shift constant to place slr id More...
 
#define XPLMI_SLR_INDEX_0   (0U)
 SLR Index 0. More...
 
#define XPLMI_SLR_INDEX_1   (1U)
 SLR Index 1. More...
 
#define XPLMI_SLR_INDEX_2   (2U)
 SLR Index 2. More...
 
#define XPLMI_SLR_INDEX_3   (3U)
 SLR Index 3. More...
 

Functions

int XPlmi_GetDeviceID (XPlmi_ClientInstance *InstancePtr, XLoader_DeviceIdCode *DeviceIdCode)
 This function sends IPI request to provides Get device id. More...
 
int XPlmi_GetBoard (XPlmi_ClientInstance *InstancePtr, u64 Addr, u32 Size, u32 *ResponseLength)
 This function sends IPI request to Get board. More...
 
int XPlmi_TamperTrigger (XPlmi_ClientInstance *InstancePtr, u32 TamperResponse)
 This function sends IPI request to Tamper Trigger. More...
 
int XPlmi_EventLogging (XPlmi_ClientInstance *InstancePtr, u32 sub_cmd, u64 Addr, u32 Len)
 This function sends IPI request to Event Logging. More...
 
int XPlmi_ConfigSecureComm (XPlmi_ClientInstance *InstancePtr, XPlmi_SsitSecComm *SsitSecCommDataPtr)
 This function sends IPI request to configure secure communication. More...
 
int XPlmi_GetSecureCommStatus (XPlmi_ClientInstance *InstancePtr, u32 SlrIndex, u32 *SecCommStatus)
 This function sends IPI request to get secure communication status. More...
 
int XPlmi_SetDDRMCMainRegSts (XPlmi_ClientInstance *InstancePtr, u32 DDRMCNum, u32 RegSts)
 This function sends IPI request to set DDRMC main registers status command. More...
 
int XPlmi_InputSlrIndex (XPlmi_ClientInstance *InstancePtr, u32 SlrIndex)
 Adds the SLR Index. More...
 

Macro Definition Documentation

#define XPLMI_SLR_INDEX_0   (0U)

SLR Index 0.

#define XPLMI_SLR_INDEX_1   (1U)

SLR Index 1.

#define XPLMI_SLR_INDEX_2   (2U)

SLR Index 2.

#define XPLMI_SLR_INDEX_3   (3U)

SLR Index 3.

Referenced by XPlmi_InputSlrIndex().

#define XPLMI_SLR_INDEX_SHIFT   (6U)

< shift constant to place slr id

SlrIndexs constants

Referenced by XPlmi_EventLogging(), and XPlmi_SendIpiCmdToSlaveSlr().