xnvm_bbramclient.h File Reference

Overview

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

MODIFICATION HISTORY:

Ver   Who  Date     Changes



1.0   kal  07/05/21 Initial release
      kpt  03/16/22 Removed IPI related code and added mailbox support
3.1   skg  10/04/22 Added macro for SlrIndex shifting
      skg  10/23/22 Added In body comments for APIs
3.4   har  08/22/24 Added support for provisioning configuration limiter
3.4   ng   09/05/24 Fixed doxygen grouping

Macros
#define	XNVM_SLR_INDEX_SHIFT   (6U)
	< shift constant to place slr id 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...

Functions
int	XNvm_BbramWriteAesKey (const XNvm_ClientInstance *InstancePtr, const u64 KeyAddr, const u32 KeyLen)
	This function sends IPI request to program BBRAM AES key. More...
int	XNvm_BbramZeroize (const XNvm_ClientInstance *InstancePtr)
	This function sends IPI request to zeroize the BBRAM. More...
int	XNvm_BbramWriteUsrData (const XNvm_ClientInstance *InstancePtr, const u32 UsrData)
	This function sends IPI request to write the user data into BBRAM user data registers. More...
int	XNvm_BbramReadUsrData (const XNvm_ClientInstance *InstancePtr, const u64 OutDataAddr)
	This function sends IPI request to read the BBRAM user data. More...
int	XNvm_BbramLockUsrDataWrite (const XNvm_ClientInstance *InstancePtr)
	This function sends IPI request to lock the updates to user data written to BBRAM_8 register. More...