uartlite
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
xuartlite.h File Reference
#include "xil_types.h"
#include "xil_assert.h"
#include "xstatus.h"

Data Structures

struct  XUartLite_Stats
 Statistics for the XUartLite driver. More...
 
struct  XUartLite_Buffer
 Buffer descriptor for send and receive operations. More...
 
struct  XUartLite_Config
 Holds configuration information for the UART Lite device. More...
 
struct  XUartLite
 Driver instance data for the UART Lite. More...
 

Typedefs

typedef void(* XUartLite_Handler )(void *CallBackRef, unsigned int ByteCount)
 Defines the callback function type for send and receive operations. More...
 

Functions

int XUartLite_Initialize (XUartLite *InstancePtr, UINTPTR BaseAddress)
 Initializes a XUartLite instance. More...
 
XUartLite_Config * XUartLite_LookupConfig (UINTPTR BaseAddress)
 Looks up the device configuration based on the unique device ID or base address. More...
 
int XUartLite_CfgInitialize (XUartLite *InstancePtr, XUartLite_Config *Config, UINTPTR EffectiveAddr)
 Initializes a XUartLite instance. More...
 
void XUartLite_ResetFifos (XUartLite *InstancePtr)
 Resets the FIFOs, both transmit and receive, of the UART. More...
 
unsigned int XUartLite_Send (XUartLite *InstancePtr, u8 *DataBufferPtr, unsigned int NumBytes)
 Sends the specified buffer of data using the UART. More...
 
unsigned int XUartLite_Recv (XUartLite *InstancePtr, u8 *DataBufferPtr, unsigned int NumBytes)
 Receives a specified number of bytes of data from the UART. More...
 
int XUartLite_IsSending (XUartLite *InstancePtr)
 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)
 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)
 Enables the UART interrupt. More...
 
void XUartLite_DisableInterrupt (XUartLite *InstancePtr)
 Disables the UART interrupt. More...
 
void XUartLite_SetRecvHandler (XUartLite *InstancePtr, XUartLite_Handler FuncPtr, void *CallBackRef)
 Sets the receive callback handler. More...
 
void XUartLite_SetSendHandler (XUartLite *InstancePtr, XUartLite_Handler FuncPtr, void *CallBackRef)
 Sets the send callback handler. More...
 
void XUartLite_InterruptHandler (XUartLite *InstancePtr)
 Handles interrupts for the UART Lite driver. More...