xuartps.h File Reference

Data Structures
struct	XUartPs_Config
struct	XUartPsFormat
struct	XUartPs

Macros
#define	XUartPs_GetChannelStatus(InstancePtr)    Xil_In32(((InstancePtr)->Config.BaseAddress) + (u32)XUARTPS_SR_OFFSET)
#define	XUartPs_GetModeControl(InstancePtr)   Xil_In32(((InstancePtr)->Config.BaseAddress) + (u32)XUARTPS_CR_OFFSET)
#define	XUartPs_SetModeControl(InstancePtr, RegisterValue)
#define	XUartPs_EnableUart(InstancePtr)
#define	XUartPs_DisableUart(InstancePtr)
#define	XUartPs_IsTransmitEmpty(InstancePtr)
Configuration options
#define	XUARTPS_OPTION_SET_BREAK   0x0080U
Channel Operational Mode
The UART can operate in one of four modes: Normal, Local Loopback, Remote Loopback, or automatic echo.
Data format values
These constants specify the data format that the driver supports. The data format includes the number of data bits, the number of stop bits and parity.
Callback events
These constants specify the handler events that an application can handle using its specific handler function. Note that these constants are not bit mask, so only one event can be passed to an application at a time.

Typedefs
typedef void(*	XUartPs_Handler) (void *CallBackRef, u32 Event, u32 EventData)

Functions
XUartPs_Config *	XUartPs_LookupConfig (u16 DeviceId)
s32	XUartPs_CfgInitialize (XUartPs *InstancePtr, XUartPs_Config *Config, u32 EffectiveAddr)
u32	XUartPs_Send (XUartPs *InstancePtr, u8 *BufferPtr, u32 NumBytes)
u32	XUartPs_Recv (XUartPs *InstancePtr, u8 *BufferPtr, u32 NumBytes)
s32	XUartPs_SetBaudRate (XUartPs *InstancePtr, u32 BaudRate)
void	XUartPs_SetOptions (XUartPs *InstancePtr, u16 Options)
u16	XUartPs_GetOptions (XUartPs *InstancePtr)
void	XUartPs_SetFifoThreshold (XUartPs *InstancePtr, u8 TriggerLevel)
u8	XUartPs_GetFifoThreshold (XUartPs *InstancePtr)
u16	XUartPs_GetModemStatus (XUartPs *InstancePtr)
u32	XUartPs_IsSending (XUartPs *InstancePtr)
u8	XUartPs_GetOperMode (XUartPs *InstancePtr)
void	XUartPs_SetOperMode (XUartPs *InstancePtr, u8 OperationMode)
u8	XUartPs_GetFlowDelay (XUartPs *InstancePtr)
void	XUartPs_SetFlowDelay (XUartPs *InstancePtr, u8 FlowDelayValue)
u8	XUartPs_GetRecvTimeout (XUartPs *InstancePtr)
void	XUartPs_SetRecvTimeout (XUartPs *InstancePtr, u8 RecvTimeout)
s32	XUartPs_SetDataFormat (XUartPs *InstancePtr, XUartPsFormat *FormatPtr)
void	XUartPs_GetDataFormat (XUartPs *InstancePtr, XUartPsFormat *FormatPtr)
u32	XUartPs_GetInterruptMask (XUartPs *InstancePtr)
void	XUartPs_SetInterruptMask (XUartPs *InstancePtr, u32 Mask)
void	XUartPs_InterruptHandler (XUartPs *InstancePtr)
void	XUartPs_SetHandler (XUartPs *InstancePtr, XUartPs_Handler FuncPtr, void *CallBackRef)
s32	XUartPs_SelfTest (XUartPs *InstancePtr)