XilPuf Client API

Macros
#define	XPUF_SLR_INDEX_SHIFT   (6U)
	To shift puf SLR index. More...
#define	XPUF_ADDR_HIGH_SHIFT   (32U)
	Shift value to get higher 32 bit address. More...

Functions
int	XPuf_ClientInit (XPuf_ClientInstance *const InstancePtr, XMailbox *const MailboxPtr)
	This function sets the instance of mailbox. More...
int	XPuf_Registration (const XPuf_ClientInstance *InstancePtr, const u64 DataAddr)
	This function sends IPI request for PUF registration. More...
int	XPuf_Regeneration (const XPuf_ClientInstance *InstancePtr, const u64 DataAddr)
	This function sends IPI request for PUF regeneration. More...
int	XPuf_ClearPufID (const XPuf_ClientInstance *InstancePtr)
	This function sends IPI request for PUF clear ID. More...

Macro Definition Documentation

#define XPUF_ADDR_HIGH_SHIFT   (32U)

Shift value to get higher 32 bit address.

Referenced by XPuf_Regeneration(), and XPuf_Registration().

#define XPUF_SLR_INDEX_SHIFT   (6U)

To shift puf SLR index.

Referenced by XPuf_ClearPufID(), XPuf_Regeneration(), and XPuf_Registration().

Function Documentation

int XPuf_ClearPufID

(

const XPuf_ClientInstance *

InstancePtr

)

This function sends IPI request for PUF clear ID.

Parameters

InstancePtr

Pointer to the client instance

Returns

• XST_SUCCESS if the PUF clear ID is successful
• XST_FAILURE if there is a failure

Perform input parameter validation on InstancePtr. Return XST_FAILURE if input parameters are invalid.

Send an IPI request to the PLM by using the XPuf_ClearPufID CDO command and return the status of the IPI response.

References XPuf_ProcessMailbox(), XPUF_PUF_CLEAR_PUF_ID, and XPUF_SLR_INDEX_SHIFT.

int XPuf_ClientInit	(	XPuf_ClientInstance *const	InstancePtr,
		XMailbox *const	MailboxPtr
	)

This function sets the instance of mailbox.

Parameters

InstancePtr	Pointer to the client instance
MailboxPtr	Pointer to the mailbox instance

Returns

• XST_SUCCESS On successful initialization
• XST_FAILURE On failure

Set XMailbox instance provided by the user to client library instance by validating whether provided instance is not NULL and initialized. Use XMailbox instance to initiate the communication between client and server.

int XPuf_Regeneration	(	const XPuf_ClientInstance *	InstancePtr,
		const u64	DataAddr
	)

This function sends IPI request for PUF regeneration.

Parameters

InstancePtr	Pointer to the client instance
DataAddr	Address of the data structure which includes options to configure PUF

Returns

• XST_SUCCESS if the PUF regeneration is successful
• XST_FAILURE if there is a failure

Perform input parameter validation on InstancePtr. Return XST_FAILURE if input parameters are invalid.

Send an IPI request to the PLM by using the XPuf_Regeneration CDO command and return the status of the IPI response.

References XPUF_ADDR_HIGH_SHIFT, XPuf_ProcessMailbox(), XPUF_PUF_REGENERATION, and XPUF_SLR_INDEX_SHIFT.

int XPuf_Registration	(	const XPuf_ClientInstance *	InstancePtr,
		const u64	DataAddr
	)

This function sends IPI request for PUF registration.

Parameters

InstancePtr	Pointer to the client instance
DataAddr	Address of the data structure which includes options to configure PUF

Returns

• XST_SUCCESS if the PUF registration is successful
• XST_FAILURE if there is a failure

Perform input parameter validation on InstancePtr. Return XST_FAILURE if input parameters are invalid.

Send an IPI request to the PLM by using the XPuf_Registration CDO command and return the status of the IPI response.

References XPUF_ADDR_HIGH_SHIFT, XPuf_ProcessMailbox(), XPUF_PUF_REGISTRATION, and XPUF_SLR_INDEX_SHIFT.