xilplmi
Vitis Drivers API Documentation
xplmi_defs.h File Reference

Overview

This file contains the xilplmi API IDs.

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 support for get secure communication status command pre 10/19/24 Added XPLMI_HEADER_LEN_5 and XPLMI_HEADER_LEN_6 macros pre 01/13/25 Added command to set access status of DDRMC main registers

 

Macros

#define XPLMI_FEATURES_CMD_ID   (0U)
 command id for features More...
 
#define XPLMI_MASK_POLL_CMD_ID   (1U)
 command id for mask poll More...
 
#define XPLMI_MASK_WRITE_CMD_ID   (2U)
 command id for mask write More...
 
#define XPLMI_WRITE_CMD_ID   (3U)
 command id for write More...
 
#define XPLMI_DELAY_CMD_ID   (4U)
 command id for delay More...
 
#define XPLMI_DMA_WRITE_CMD_ID   (5U)
 command id for DMA write More...
 
#define XPLMI_MASK_POLL64_CMD_ID   (6U)
 command id for mask poll 64 More...
 
#define XPLMI_MASK_WRITE64_CMD_ID   (7U)
 command id for mask write 64 More...
 
#define XPLMI_WRITE64_CMD_ID   (8U)
 command id for write 64 More...
 
#define XPLMI_DMA_XFER_CMD_ID   (9U)
 command id for DMA transfer More...
 
#define XPLMI_INIT_SEQ_CMD_ID   (10U)
 command id for Init sequence More...
 
#define XPLMI_CFI_READ_CMD_ID   (11U)
 command id for CFI read More...
 
#define XPLMI_SET_CMD_ID   (12U)
 command id for set More...
 
#define XPLMI_WRITE_KEYHOLE_CMD_ID   (13U)
 command id for write keyhole More...
 
#define XPLMI_SSIT_SYNC_SLAVES_CMD_ID   (14U)
 command id for SSIT slaves sync More...
 
#define XPLMI_SSIT_SYNC_MASTER_CMD_ID   (15U)
 command id for SSIT master sync More...
 
#define XPLMI_SSIT_WAIT_SLAVES_CMD_ID   (16U)
 command id for SSIT slaves wait More...
 
#define XPLMI_NOP_CMD_ID   (17U)
 command id for NOP More...
 
#define XPLMI_GET_DEVICE_CMD_ID   (18U)
 command id for get device More...
 
#define XPLMI_EVENT_LOGGING_CMD_ID   (19U)
 command id for event logging More...
 
#define XPLMI_SET_BOARD_CMD_ID   (20U)
 command id for set board More...
 
#define XPLMI_GET_BOARD_CMD_ID   (21U)
 command id for get board More...
 
#define XPLMI_SET_WDT_PARAM_CMD_ID   (22U)
 command id for set WDT param More...
 
#define XPLMI_LOG_STR_CMD_ID   (23U)
 command id for Log str More...
 
#define XPLMI_LOG_ADDR_CMD_ID   (24U)
 command id for Log address More...
 
#define XPLMI_MARKER_CMD_ID   (25U)
 command id for marker More...
 
#define XPLMI_PROC_CMD_ID   (26U)
 command id for proc More...
 
#define XPLMI_BEGIN_CMD_ID   (27U)
 command id for begin More...
 
#define XPLMI_END_CMD_ID   (28U)
 command id for end More...
 
#define XPLMI_BREAK_CMD_ID   (29U)
 command id for break More...
 
#define XPLMI_OT_CHECK_CMD_ID   (30U)
 command id for OT check More...
 
#define XPLMI_PSM_SEQUENCE_CMD_ID   (31U)
 command id for PSM sequence More...
 
#define XPLMI_INPLACE_PLM_UPDATE_CMD_ID   (32U)
 command id for inplace plm update More...
 
#define XPLMI_SCATTER_WRITE_CMD_ID   (33U)
 command id for scatter write More...
 
#define XPLMI_SCATTER_WRITE2_CMD_ID   (34U)
 command id for scatter write 2 More...
 
#define XPLMI_TAMPER_TRIGGER_CMD_ID   (35U)
 command id for tamper trigger More...
 
#define XPLMI_SET_FIPS_MASK_CMD_ID   (36U)
 command id for FIPS mask More...
 
#define XPLMI_SET_IPI_ACCESS_CMD_ID   (37U)
 command id for set ipi access More...
 
#define XPLMI_RUN_PROC_CMD_ID   (38U)
 command id for run proc More...
 
#define XPLMI_LIST_SET_CMD_ID   (39U)
 command id for list set More...
 
#define XPLMI_LIST_WRITE_CMD_ID   (40U)
 command id for list write More...
 
#define XPLMI_LIST_MASK_WRITE_CMD_ID   (41U)
 command id for list mask write More...
 
#define XPLMI_LIST_MASK_POLL_CMD_ID   (42U)
 command id for list mask poll More...
 
#define XPLMI_CONFIG_SECCOMM_CMD_ID   (43U)
 command id for secure communication configuration More...
 
#define XPLMI_GETSECCOMM_STATUS_CMD_ID   (45U)
 command id to get secure communication status More...
 
#define XPLMI_DDRMC_MAINREG_STS_SET_CMD_ID   (46U)
 command id to get secure communication status More...
 
#define XPLMI_CDO_END_CMD_ID   (0xFFU)
 command id for CDO end More...
 
#define XPLMI_HEADER_LEN_0   (0U)
 Header Length 0. More...
 
#define XPLMI_HEADER_LEN_1   (1U)
 Header Length 1. More...
 
#define XPLMI_HEADER_LEN_2   (2U)
 Header Length 2. More...
 
#define XPLMI_HEADER_LEN_3   (3U)
 Header Length 3. More...
 
#define XPLMI_HEADER_LEN_4   (4U)
 Header Length 4. More...
 
#define XPLMI_HEADER_LEN_5   (5U)
 Header Length 5. More...
 
#define XPLMI_HEADER_LEN_6   (6U)
 Header Length 6. More...
 
#define XPLMI_KEY_SIZE_WORDS   (8U)
 Key size in words. More...
 
#define XPLMI_KEY_SIZE_BYTES   (32U)
 Key size in bytes. More...
 

Macro Definition Documentation

#define XPLMI_BEGIN_CMD_ID   (27U)

command id for begin

#define XPLMI_BREAK_CMD_ID   (29U)

command id for break

#define XPLMI_CDO_END_CMD_ID   (0xFFU)

command id for CDO end

#define XPLMI_CFI_READ_CMD_ID   (11U)

command id for CFI read

#define XPLMI_CONFIG_SECCOMM_CMD_ID   (43U)

command id for secure communication configuration

Referenced by XPlmi_ConfigSecureComm().

#define XPLMI_DDRMC_MAINREG_STS_SET_CMD_ID   (46U)

command id to get secure communication status

Referenced by XPlmi_SetDDRMCMainRegSts().

#define XPLMI_DELAY_CMD_ID   (4U)

command id for delay

#define XPLMI_DMA_WRITE_CMD_ID   (5U)

command id for DMA write

#define XPLMI_DMA_XFER_CMD_ID   (9U)

command id for DMA transfer

#define XPLMI_END_CMD_ID   (28U)

command id for end

#define XPLMI_EVENT_LOGGING_CMD_ID   (19U)

command id for event logging

Referenced by XPlmi_EventLogging().

#define XPLMI_FEATURES_CMD_ID   (0U)

command id for features

#define XPLMI_GET_BOARD_CMD_ID   (21U)

command id for get board

Referenced by XPlmi_GetBoard().

#define XPLMI_GET_DEVICE_CMD_ID   (18U)

command id for get device

Referenced by XPlmi_GetDeviceID().

#define XPLMI_GETSECCOMM_STATUS_CMD_ID   (45U)

command id to get secure communication status

Referenced by XPlmi_GetSecureCommStatus().

#define XPLMI_HEADER_LEN_0   (0U)

Header Length 0.

Referenced by XPlmi_GetDeviceID().

#define XPLMI_HEADER_LEN_1   (1U)

Header Length 1.

Referenced by XPlmi_GetSecureCommStatus(), and XPlmi_TamperTrigger().

#define XPLMI_HEADER_LEN_2   (2U)

Header Length 2.

Referenced by XPlmi_SetDDRMCMainRegSts().

#define XPLMI_HEADER_LEN_3   (3U)

Header Length 3.

Referenced by XPlmi_ConfigSecureComm(), and XPlmi_GetBoard().

#define XPLMI_HEADER_LEN_4   (4U)

Header Length 4.

Referenced by XPlmi_EventLogging().

#define XPLMI_HEADER_LEN_5   (5U)

Header Length 5.

#define XPLMI_HEADER_LEN_6   (6U)

Header Length 6.

#define XPLMI_INIT_SEQ_CMD_ID   (10U)

command id for Init sequence

#define XPLMI_INPLACE_PLM_UPDATE_CMD_ID   (32U)

command id for inplace plm update

#define XPLMI_KEY_SIZE_BYTES   (32U)

Key size in bytes.

Referenced by XPlmi_SsitCfgSecComm().

#define XPLMI_KEY_SIZE_WORDS   (8U)

Key size in words.

#define XPLMI_LIST_MASK_POLL_CMD_ID   (42U)

command id for list mask poll

Referenced by XPlmi_ListMaskPoll().

#define XPLMI_LIST_MASK_WRITE_CMD_ID   (41U)

command id for list mask write

Referenced by XPlmi_ListMaskWrite().

#define XPLMI_LIST_SET_CMD_ID   (39U)

command id for list set

Referenced by XPlmi_ListSet().

#define XPLMI_LIST_WRITE_CMD_ID   (40U)

command id for list write

Referenced by XPlmi_ListWrite().

#define XPLMI_LOG_ADDR_CMD_ID   (24U)

command id for Log address

#define XPLMI_LOG_STR_CMD_ID   (23U)

command id for Log str

#define XPLMI_MARKER_CMD_ID   (25U)

command id for marker

#define XPLMI_MASK_POLL64_CMD_ID   (6U)

command id for mask poll 64

#define XPLMI_MASK_POLL_CMD_ID   (1U)

command id for mask poll

#define XPLMI_MASK_WRITE64_CMD_ID   (7U)

command id for mask write 64

#define XPLMI_MASK_WRITE_CMD_ID   (2U)

command id for mask write

#define XPLMI_NOP_CMD_ID   (17U)

command id for NOP

#define XPLMI_OT_CHECK_CMD_ID   (30U)

command id for OT check

#define XPLMI_PROC_CMD_ID   (26U)

command id for proc

#define XPLMI_PSM_SEQUENCE_CMD_ID   (31U)

command id for PSM sequence

Referenced by XPlmi_PsmSequence().

#define XPLMI_RUN_PROC_CMD_ID   (38U)

command id for run proc

Referenced by XPlmi_RunProc().

#define XPLMI_SCATTER_WRITE2_CMD_ID   (34U)

command id for scatter write 2

Referenced by XPlmi_ScatterWrite2().

#define XPLMI_SCATTER_WRITE_CMD_ID   (33U)

command id for scatter write

Referenced by XPlmi_ScatterWrite().

#define XPLMI_SET_BOARD_CMD_ID   (20U)

command id for set board

#define XPLMI_SET_CMD_ID   (12U)

command id for set

#define XPLMI_SET_FIPS_MASK_CMD_ID   (36U)

command id for FIPS mask

Referenced by XPlmi_SetFipsKatMask().

#define XPLMI_SET_IPI_ACCESS_CMD_ID   (37U)

command id for set ipi access

#define XPLMI_SET_WDT_PARAM_CMD_ID   (22U)

command id for set WDT param

#define XPLMI_SSIT_SYNC_MASTER_CMD_ID   (15U)

command id for SSIT master sync

Referenced by XPlmi_SsitSyncMaster().

#define XPLMI_SSIT_SYNC_SLAVES_CMD_ID   (14U)

command id for SSIT slaves sync

Referenced by XPlmi_SsitSyncSlaves().

#define XPLMI_SSIT_WAIT_SLAVES_CMD_ID   (16U)

command id for SSIT slaves wait

Referenced by XPlmi_SsitWaitSlaves().

#define XPLMI_TAMPER_TRIGGER_CMD_ID   (35U)

command id for tamper trigger

Referenced by XPlmi_TamperTrigger().

#define XPLMI_WRITE64_CMD_ID   (8U)

command id for write 64

#define XPLMI_WRITE_CMD_ID   (3U)

command id for write

#define XPLMI_WRITE_KEYHOLE_CMD_ID   (13U)

command id for write keyhole