Overview

This file contains declarations for xasu_client.c file in XilAsu library.

MODIFICATION HISTORY:

Ver   Who  Date     Changes



1.0   vns  06/04/24 Initial release
      ss   08/13/24 Changed XAsu_ClientInit function prototype and addded XAsu_ClientParams
                    structure
      yog  09/26/24 Added doxygen groupings and fixed doxygen comments.
      vns  09/30/24 Added support for asynchronous communication
      am   03/05/25 Added include for performance measurement header

Data Structures
struct	XAsu_ClientParams
	This structure contains client parameters information. More...

Macros
#define	XASU_PRIORITY_LOW 1U
	LOW priority. More...

#define	XASU_PRIORITY_HIGH 0U
	High priority. More...

Typedefs
typedef void(*	XAsuClient_ResponseHandler )(void *CallBackRefPtr, u32 Status)
	Response handler. More...

Functions
u8	XAsu_GetUniqueId (u32 Header)
	This function gets the unique ID from the provided header. More...

u32	XAsu_CreateHeader (u8 CmdId, u8 UniqueId, u8 ModuleId, u8 CommandLen)
	This function formats the command header with module ID, command ID and command length. More...

s32	XAsu_ClientInit (XMailbox *MailboxInstancePtr)
	This function initializes the client instance. More...

s32	XAsu_ValidateClientParameters (XAsu_ClientParams *ClientParamPtr)
	This function validates the input client parameters. More...

s32	XAsu_UpdateQueueBufferNSendIpi (XAsu_ClientParams ClientParam, void ReqBuffer, u32 Size, u32 Header)
	This function updates the queue buffer status to notify the request is present and generates a door bell to ASU. More...

u8	XAsu_RegCallBackNGetUniqueId (const XAsu_ClientParams ClientParamPtr, u8 RespBufferPtr, u32 Size, u8 IsFinalCall)
	This function registers callback parameters across the generated unique ID per request. More...

void	XAsu_UpdateCallBackDetails (u8 UniqueId, u8 *RespBufferPtr, u32 Size, u8 IsFinalCall)
	Updates callback details based on the provided unique ID, response buffer, size, and final call flag. More...

void *	XAsu_UpdateNGetCtx (u8 UniqueId)
	Saves the provided unique ID and returns the address of the saved context. More...

s32	XAsu_VerifyNGetUniqueIdCtx (const void Context, u8 UniqueId)
	Validates the provided context by comparing it with stored contexts to determine the appropriate multi-update calls. More...

void	XAsu_FreeCtx (void *Context)
	Frees the memory associated with the provided context. More...

Overview

Data Structures

Macros

Typedefs

Functions