uartlite: xuartlite.h File Reference

| uartlite Xilinx SDK Drivers API Documentation

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

Data Structures | Typedefs | Functions
xuartlite.h File Reference

## Data Structures
struct | XUartLite_Stats
| Statistics for the XUartLite driver. More...
struct | XUartLite_Buffer
| The following data type is used to manage the buffers that are handled when sending and receiving data in the interrupt mode. More...
struct | XUartLite_Config
| This typedef contains configuration information for the device. More...
struct | XUartLite
| The XUartLite driver instance data. More...

## Typedefs
typedef void(* | XUartLite_Handler )(void *CallBackRef, unsigned int ByteCount)
| Callback function. More...

## Functions
int | XUartLite_Initialize (XUartLite *InstancePtr, u16 DeviceId)
| Initialize a XUartLite instance. More...
int | XUartLite_CfgInitialize (XUartLite *InstancePtr, XUartLite_Config *Config, UINTPTR EffectiveAddr)
| Initialize a XUartLite instance. More...
void | XUartLite_ResetFifos (XUartLite *InstancePtr)
| This function resets the FIFOs, both transmit and receive, of the UART such that they are emptied. More...
unsigned int | XUartLite_Send (XUartLite *InstancePtr, u8 *DataBufferPtr, unsigned int NumBytes)
| This functions sends the specified buffer of data using the UART in either polled or interrupt driven modes. More...
unsigned int | XUartLite_Recv (XUartLite *InstancePtr, u8 *DataBufferPtr, unsigned int NumBytes)
| This function will attempt to receive a specified number of bytes of data from the UART and store it into the specified buffer. More...
int | XUartLite_IsSending (XUartLite *InstancePtr)
| This function determines if the specified UART is sending data. More...
void | XUartLite_GetStats (XUartLite *InstancePtr, XUartLite_Stats *StatsPtr)
| Returns a snapshot of the current statistics in the structure specified. More...
void | XUartLite_ClearStats (XUartLite *InstancePtr)
| This function zeros the statistics for the given instance. More...
int | XUartLite_SelfTest (XUartLite *InstancePtr)
| Runs a self-test on the device hardware. More...
void | XUartLite_EnableInterrupt (XUartLite *InstancePtr)
| This function enables the UART interrupt such that an interrupt will occur when data is received or data has been transmitted. More...
void | XUartLite_DisableInterrupt (XUartLite *InstancePtr)
| This function disables the UART interrupt. More...
void | XUartLite_SetRecvHandler (XUartLite *InstancePtr, XUartLite_Handler FuncPtr, void *CallBackRef)
| This function sets the handler that will be called when an event (interrupt) occurs in the driver. More...
void | XUartLite_SetSendHandler (XUartLite *InstancePtr, XUartLite_Handler FuncPtr, void *CallBackRef)
| This function sets the handler that will be called when an event (interrupt) occurs in the driver. More...
void | XUartLite_InterruptHandler (XUartLite *InstancePtr)
| This function is the interrupt handler for the UART lite driver. More...