mbox: xmbox.c File Reference

| mbox Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Functions
xmbox.c File Reference

## Functions
int | XMbox_CfgInitialize (XMbox *InstancePtr, XMbox_Config *ConfigPtr, UINTPTR EffectiveAddress)
| Initializes a specific mailbox. More...
int | XMbox_Read (XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesRecvdPtr)
| Reads requested bytes from the mailbox referenced by InstancePtr,into the buffer pointed to by the provided pointer. More...
void | XMbox_ReadBlocking (XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)
| Reads requested bytes from the mailbox referenced by InstancePtr,into the buffer pointed to by the provided pointer. More...
int | XMbox_Write (XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes, u32 *BytesSentPtr)
| Writes the requested bytes from the buffer pointed to by the provided pointer into the mailbox referenced by InstancePtr.The number of bytes must be a multiple of 4 (bytes). More...
void | XMbox_WriteBlocking (XMbox *InstancePtr, u32 *BufferPtr, u32 RequestedBytes)
| Writes the requested bytes from the buffer pointed to by the provided pointer into the mailbox referenced by InstancePtr. More...
u32 | XMbox_IsEmpty (XMbox *InstancePtr)
| Checks to see if there is data available to be read. More...
u32 | XMbox_IsFull (XMbox *InstancePtr)
| Checks to see if there is room in the write FIFO. More...
int | XMbox_Flush (XMbox *InstancePtr)
| Resets the mailbox FIFOs by emptying the READ FIFO and making sure the Error Status is zero. More...
void | XMbox_ResetFifos (XMbox *InstancePtr)
| Resets the mailbox FIFOs by clearing the READ and WRITE FIFOs using the hardware control register for memory mapped IO. More...
void | XMbox_SetInterruptEnable (XMbox *InstancePtr, u32 Mask)
| Sets the interrupt enable register for this mailbox. More...
u32 | XMbox_GetInterruptEnable (XMbox *InstancePtr)
| Retrieves the interrupt enable for the mailbox. More...
u32 | XMbox_GetInterruptStatus (XMbox *InstancePtr)
| Retrieve the interrupt status for the mailbox. More...
void | XMbox_ClearInterrupt (XMbox *InstancePtr, u32 Mask)
| Clears pending interrupts with the provided mask. More...
void | XMbox_SetSendThreshold (XMbox *InstancePtr, u32 Value)
| Sets the Send Interrupt Threshold. More...
void | XMbox_SetReceiveThreshold (XMbox *InstancePtr, u32 Value)
| Set the Receive Interrupt Threshold. More...
u32 | XMbox_GetStatus (XMbox *InstancePtr)
| Returns Status register contents. More...