Overview

This file contains declarations of xilmailbox generic interface APIs.

MODIFICATION HISTORY:

Ver Who Date Changes

1.00 dd 01/09/24 Initial release am 04/10/24 Fixed doxygen warning 1.01 pre 07/10/24 Added SLR index in client data structure 1.02 obs 02/18/25 Fixed IPI message length

Macros
#define	XILPLMI_MODULE_ID (1U)
	Module ID for xilplmi. More...

#define	PAYLOAD_ARG_CNT XIPIPSU_MAX_MSG_LEN
	1 for API ID + 5 for API arguments + 1 for reserved + 1 for CRC More...

#define	RESPONSE_ARG_CNT XIPIPSU_MAX_MSG_LEN
	1 for status + 3 for values + 3 for reserved + 1 for CRC More...

#define	XPLMI_TARGET_IPI_INT_MASK (0x00000002U)
	Target PMC IPI interrupt mask. More...

#define	XPLMI_MODULE_ID_SHIFT (8U)
	Module Id shift. More...

#define	XPLMI_PAYLOAD_LEN_SHIFT (16U)
	Length shift mask. More...

#define	XILPLMI_MODULE_ID_MASK ((u32)XILPLMI_MODULE_ID << XPLMI_MODULE_ID_SHIFT)
	Module id mask. More...

#define	XPLMI_SHARED_MEM_SIZE (160U)
	Max size of shared memory used to store the CDO command. More...

Functions
int	XPlmi_ProcessMailbox (XPlmi_ClientInstance ClientPtr, u32 MsgPtr, u32 MsgLen)
	This function sends IPI request to the target module and gets the response from it. More...

int	XPlmi_ClientInit (XPlmi_ClientInstance InstancePtr, XMailbox MailboxPtr)
	This function sets the instance of mailbox. More...

Overview

Macros

Functions