uartlite
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
xuartlite_polled_example.c File Reference

Overview

Demonstrates the UartLite driver in polled mode.

Note
A physical loopback must be provided such that data which is transmitted is received.

MODIFICATION HISTORY:

Ver   Who  Date  Changes


1.00a jhl 02/13/02 First release 1.00a sv 06/13/05 Minor changes to comply to Doxygen and coding guidelines 2.00a ktn 10/20/09 Updated this example to wait for valid data in receive fifo instead of Tx fifo empty to update receive buffer and minor changes as per coding guidelines. 3.2 ms 01/23/17 Added xil_printf statement in main function to ensure that "Successfully ran" and "Failed" strings are available in all examples. This is a fix for CR-965028. 3.9 gm 07/08/23 Added SDT support 3.13 vlt 12/18/25 Update Doxygen comments to include SDT flow details. 3.14 vn 09/09/26 Align Doxygen comments with AMD standards

#include "xparameters.h"
#include "xstatus.h"
#include "xuartlite.h"
#include "xil_printf.h"

Macros

Device parameters

The following constants map to the XPAR parameters created in the xparameters.h file.

They are defined here such that a user can easily change all the needed parameters in one place.

#define XUARTLITE_BASEADDRESS   XPAR_XUARTLITE_0_BASEADDR
 UartLite base address. More...
 
Buffer size

This constant must be 16 bytes or less since this is a single threaded non-interrupt driven example such that the entire buffer fits into the transmit and receive FIFOs of the UartLite.

#define TEST_BUFFER_SIZE   16
 Length of the send and receive buffers. More...
 

Functions

int UartLitePolledExample (UINTPTR BaseAddress)
 Performs a minimal test on the UartLite device and driver. More...
 
int main (void)
 Calls the UartLite polled example. More...
 

Variables

XUartLite UartLite
 Instance of the UartLite device. More...
 
u8 SendBuffer [TEST_BUFFER_SIZE]
 Buffer for transmitting data. More...
 
u8 RecvBuffer [TEST_BUFFER_SIZE]
 Buffer for receiving data. More...
 

Macro Definition Documentation

#define TEST_BUFFER_SIZE   16

Length of the send and receive buffers.

Referenced by UartLitePolledExample().

#define XUARTLITE_BASEADDRESS   XPAR_XUARTLITE_0_BASEADDR

UartLite base address.

Referenced by main().

Function Documentation

int main ( void  )

Calls the UartLite polled example.

Returns
XST_SUCCESS if successful, otherwise XST_FAILURE.

References UartLitePolledExample(), and XUARTLITE_BASEADDRESS.

int UartLitePolledExample ( UINTPTR  BaseAddress)

Performs a minimal test on the UartLite device and driver.

This function is a design example that illustrates how to use the XUartLite component.

This function sends data and expects to receive the data through the UartLite such that a physical loopback must be done with the transmit and receive signals of the UartLite.

This function polls the UartLite and does not require the use of interrupts.

Parameters
[in]BaseAddressBase address of the device.
Returns
XST_SUCCESS if successful, XST_FAILURE if unsuccessful.
Note
- In XSCT/classic flow, DeviceId is used to look up the device configuration.
  • This function calls the UartLite driver functions in a blocking mode such that if the transmit data does not loopback to the receive, this function may not return.

References RecvBuffer, SendBuffer, TEST_BUFFER_SIZE, XUartLite_Initialize(), XUartLite_Recv(), XUartLite_SelfTest(), and XUartLite_Send().

Referenced by main().

Variable Documentation

u8 RecvBuffer[TEST_BUFFER_SIZE]

Buffer for receiving data.

u8 SendBuffer[TEST_BUFFER_SIZE]

Buffer for transmitting data.

XUartLite UartLite

Instance of the UartLite device.