xloader_mailbox.h File Reference

Overview

This file contains declarations of xilmailbox generic interface APIs.

MODIFICATION HISTORY:

Ver   Who  Date     Changes



1.00  dd   01/09/24 Initial release
      har  03/05/24 Fixed doxygen warnings
1.01  pre  08/21/24 Added SlrIndex in XLoader_ClientInstance structure
1.02  obs  02/18/25 Fixed IPI message length

Macros
#define	XILLOADER_MODULE_ID   (7U)
	Module id for xilloader. 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	XLOADER_TARGET_IPI_INT_MASK   (0x00000002U)
	Target PMC IPI interrupt mask. More...
#define	XLOADER_MODULE_ID_SHIFT   (8U)
	Module id shift. More...
#define	XLOADER_PAYLOAD_LEN_SHIFT   (16U)
	Length shift mask. More...
#define	XILLOADER_MODULE_ID_MASK   ((u32)XILLOADER_MODULE_ID << XLOADER_MODULE_ID_SHIFT)
	Module id mask. More...
#define	XLOADER_SHARED_MEM_SIZE   (160U)
	Max size of shared memory used to store the CDO command. More...

Functions
int	XLoader_ProcessMailbox (XLoader_ClientInstance *ClientPtr, u32 *MsgPtr, u32 MsgLen)
	This function sends IPI request to the target module and gets the response from it. More...
int	XLoader_ClientInit (XLoader_ClientInstance *const InstancePtr, XMailbox *const MailboxPtr)
	This function sets the instance of mailbox. More...