xilnvm
Vitis Drivers API Documentation
client/xnvm_efuseclient.h File Reference

Overview

This file Contains the client function prototypes, defines and macros for the eFUSE programming and read.

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.0 kal 07/29/21 Initial release kpt 08/27/21 Added client API's to support puf helper data efuse programming kpt 03/16/22 Removed IPI related code and added mailbox support 3.1 skg 10/04/22 Added SlrIndex Constants 3.2 vss 09/19/23 Fixed MISRA-C Rule 2.5 violaion 3.3 ng 11/22/2023 Fixed doxygen grouping

 

Macros

#define XNVM_SLR_INDEX_SHIFT   (6U)
 < Slr index shift constant More...
 
#define XNVM_SLR_INDEX_0   (0U)
 SLR Index 0. More...
 
#define XNVM_SLR_INDEX_1   (1U)
 SLR Index 1. More...
 
#define XNVM_SLR_INDEX_2   (2U)
 SLR Index 2. More...
 
#define XNVM_SLR_INDEX_3   (3U)
 SLR Index 3. More...
 
#define XNVM_WORD_LEN   (4U)
 Word length. More...
 

Functions

int XNvm_EfuseWrite (const XNvm_ClientInstance *InstancePtr, const u64 DataAddr)
 This function sends IPI request to program eFuses with user provided data. More...
 
int XNvm_EfuseWriteIVs (const XNvm_ClientInstance *InstancePtr, const u64 IvAddr, const u32 EnvDisFlag)
 This function sends IPI request to program IV eFuses with user provided data. More...
 
int XNvm_EfuseRevokePpk (const XNvm_ClientInstance *InstancePtr, const XNvm_PpkType PpkRevoke, const u32 EnvDisFlag)
 This function sends IPI request to program PPK_INVLD eFuse requested by the user. More...
 
int XNvm_EfuseWriteRevocationId (const XNvm_ClientInstance *InstancePtr, const u32 RevokeId, const u32 EnvDisFlag)
 This function sends IPI request to program revoke id eFuses requested by the user. More...
 
int XNvm_EfuseWriteUserFuses (const XNvm_ClientInstance *InstancePtr, const u64 UserFuseAddr, const u32 EnvDisFlag)
 This function sends IPI request to program User eFuses requested by the user. More...
 
int XNvm_EfuseReadIv (const XNvm_ClientInstance *InstancePtr, const u64 IvAddr, const XNvm_IvType IvType)
 This function sends IPI request to read IV eFuses requested by the user. More...
 
int XNvm_EfuseReadRevocationId (const XNvm_ClientInstance *InstancePtr, const u64 RevokeIdAddr, const XNvm_RevocationId RevokeIdNum)
 This function sends IPI request to read Revocation ID eFuses requested by the user. More...
 
int XNvm_EfuseReadUserFuses (const XNvm_ClientInstance *InstancePtr, const u64 UserFuseAddr)
 This function sends IPI request to read User eFuses requested by the user. More...
 
int XNvm_EfuseReadMiscCtrlBits (const XNvm_ClientInstance *InstancePtr, const u64 MiscCtrlBits)
 This function sends IPI request to read MiscCtrlBits requested by the user. More...
 
int XNvm_EfuseReadSecCtrlBits (const XNvm_ClientInstance *InstancePtr, const u64 SecCtrlBits)
 This function sends IPI request to read SecCtrlBits requested by the user. More...
 
int XNvm_EfuseReadSecMisc1Bits (const XNvm_ClientInstance *InstancePtr, const u64 SecMisc1Bits)
 This function sends IPI request to read SecMisc1Bits requested by the user. More...
 
int XNvm_EfuseReadBootEnvCtrlBits (const XNvm_ClientInstance *InstancePtr, const u64 BootEnvCtrlBits)
 This function sends IPI request to read BootEnvCtrlBits requested by the user. More...
 
int XNvm_EfuseReadPufSecCtrlBits (const XNvm_ClientInstance *InstancePtr, const u64 PufSecCtrlBits)
 This function sends IPI request to read PufSecCtrlBits requested by the user. More...
 
int XNvm_EfuseReadOffchipRevokeId (const XNvm_ClientInstance *InstancePtr, const u64 OffChidIdAddr, const XNvm_OffchipId OffChipIdNum)
 This function sends IPI request to read OffChip ID eFuses requested by the user. More...
 
int XNvm_EfuseReadPpkHash (const XNvm_ClientInstance *InstancePtr, const u64 PpkHashAddr, const XNvm_PpkType PpkHashType)
 This function sends IPI request to read PpkHash requested by the user. More...
 
int XNvm_EfuseReadDecOnly (const XNvm_ClientInstance *InstancePtr, const u64 DecOnlyAddr)
 This function sends IPI request to read DecEfuseOnly eFuses requested by the user. More...
 
int XNvm_EfuseReadDna (const XNvm_ClientInstance *InstancePtr, const u64 DnaAddr)
 This function sends IPI request to read DNA eFuses requested by the user. More...
 
int XNvm_EfuseWritePuf (const XNvm_ClientInstance *InstancePtr, const u64 PufHdAddr)
 This function sends IPI request to program Puf helper data requested by the user. More...
 
int XNvm_EfuseReadPuf (const XNvm_ClientInstance *InstancePtr, const u64 PufHdAddr)
 This function sends IPI request to read Puf helper data requested by the user. More...