Platform specific helper APIs in Xilsecure client

Functions
int	XSecure_UpdateHnicCryptoStatus (XSecure_ClientInstance *InstancePtr, XSecure_CryptoStatusOp CryptoStatusOp, u32 CryptoMask)
	This function sends IPI request to set crypto status bit of HNIC. More...
int	XSecure_UpdateCpm5NCryptoStatus (XSecure_ClientInstance *InstancePtr, XSecure_CryptoStatusOp CryptoStatusOp, u32 CryptoMask)
	This function sends IPI request to set crypto status bit of of CPM 5N. More...
int	XSecure_UpdatePcideCryptoStatus (XSecure_ClientInstance *InstancePtr, XSecure_CryptoStatusOp CryptoStatusOp, u32 CryptoMask)
	This function sends IPI request to set crypto status bit of PCIDE. More...
int	XSecure_UpdatePkiCryptoStatus (XSecure_ClientInstance *InstancePtr, XSecure_CryptoStatusOp CryptoStatusOp, u32 CryptoMask)
	This function sends IPI request to set crypto status bit of PKI. More...
int	XSecure_KeyUnwrap (XSecure_ClientInstance *InstancePtr, XSecure_KeyWrapData *KeyWrapData)
	This function sends IPI request to unwrap the wrapped AES key. More...
int	XSecure_ReleaseRsaKey (XSecure_ClientInstance *InstancePtr)
	This function releases the RSA key that is in use. More...

Function Documentation

int XSecure_KeyUnwrap	(	XSecure_ClientInstance *	InstancePtr,
		XSecure_KeyWrapData *	KeyWrapData
	)

This function sends IPI request to unwrap the wrapped AES key.

Parameters

InstancePtr	Pointer to the client instance
KeyWrapData	Pointer to the XSecure_KeyWrapData instance

Returns

• XST_SUCCESS On Success
• XST_INVALID_PARAM If any input parameter is invalid.
• XST_FAILURE If there is a failure

Send an IPI request to the PLM by using the CDO command to call XSecure_KeyUnwrapIpi API and returns the status of the IPI response.

References XSECURE_API_KEY_UNWRAP, and XSecure_ProcessMailbox().

int XSecure_ReleaseRsaKey

(

XSecure_ClientInstance *

InstancePtr

)

This function releases the RSA key that is in use.

Parameters

InstancePtr

Pointer to the client instance

Returns

• XST_SUCCESS On Success
• XST_INVALID_PARAM If any input parameter is invalid.
• XST_FAILURE If there is a failure

Send an IPI request to the PLM by using the CDO command to call XSecure_RsaDestroyKeyInUse API and returns the status of the IPI response.

References XSECURE_API_RSA_RELEASE_KEY, and XSecure_ProcessMailbox().

int XSecure_UpdateCpm5NCryptoStatus	(	XSecure_ClientInstance *	InstancePtr,
		XSecure_CryptoStatusOp	CryptoStatusOp,
		u32	CryptoMask
	)

This function sends IPI request to set crypto status bit of of CPM 5N.

Parameters

InstancePtr	Pointer to the client instance
CryptoStatusOp	Operation to set or clear crypto status bit
CryptoMask	Mask to set or clear crypto status bit

Returns

• XST_SUCCESS On Success
• XST_FAILURE On failure

References XSECURE_API_UPDATE_CPM5N_CRYPTO_STATUS.

int XSecure_UpdateHnicCryptoStatus	(	XSecure_ClientInstance *	InstancePtr,
		XSecure_CryptoStatusOp	CryptoStatusOp,
		u32	CryptoMask
	)

This function sends IPI request to set crypto status bit of HNIC.

Parameters

InstancePtr	Pointer to the client instance
CryptoStatusOp	Operation to set or clear crypto status bit
CryptoMask	Mask to set or clear crypto status bit

Returns

• XST_SUCCESS On Success
• XST_FAILURE On failure

References XSECURE_API_UPDATE_HNIC_CRYPTO_STATUS.

int XSecure_UpdatePcideCryptoStatus	(	XSecure_ClientInstance *	InstancePtr,
		XSecure_CryptoStatusOp	CryptoStatusOp,
		u32	CryptoMask
	)

This function sends IPI request to set crypto status bit of PCIDE.

Parameters

InstancePtr	Pointer to the client instance
CryptoStatusOp	Operation to set or clear crypto status bit
CryptoMask	Mask to set or clear crypto status bit

Returns

• XST_SUCCESS On Success
• XST_FAILURE On failure

References XSECURE_API_UPDATE_PCIDE_CRYPTO_STATUS.

int XSecure_UpdatePkiCryptoStatus	(	XSecure_ClientInstance *	InstancePtr,
		XSecure_CryptoStatusOp	CryptoStatusOp,
		u32	CryptoMask
	)

This function sends IPI request to set crypto status bit of PKI.

Parameters

InstancePtr	Pointer to the client instance
CryptoStatusOp	Operation to set or clear crypto status bit
CryptoMask	Mask to set or clear crypto status bit

Returns

• XST_SUCCESS On Success
• XST_FAILURE On failure

References XSECURE_API_UPDATE_PKI_CRYPTO_STATUS.