| mbox Vitis Drivers API Documentation

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

- Data Structures
- Data Fields

Data Fields
XMbox Struct Reference
Overview

The XMbox driver instance data. More...

## Data Fields
XMbox_Config | Config
| Configuration data, includes base address. More...
u32 | IsReady
| Device is initialized and ready. More...

## Detailed Description

The XMbox driver instance data.

The user is required to allocate a variable of this type for every mbox device in the system. A pointer to a variable of this type is then passed to the driver API functions.

## Field Documentation

XMbox_Config XMbox::Config

Configuration data, includes base address.

Referenced by MailboxExample(), XMbox_CfgInitialize(), XMbox_ClearInterrupt(), XMbox_Flush(), XMbox_GetInterruptEnable(), XMbox_GetInterruptStatus(), XMbox_GetStatus(), XMbox_IsEmpty(), XMbox_IsFull(), XMbox_Read(), XMbox_ReadBlocking(), XMbox_ResetFifos(), XMbox_SetInterruptEnable(), XMbox_SetReceiveThreshold(), XMbox_SetSendThreshold(), XMbox_Write(), and XMbox_WriteBlocking().

u32 XMbox::IsReady

Device is initialized and ready.

Referenced by XMbox_CfgInitialize().