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

Overview

Demonstrates a self-test using the UartLite driver.

MODIFICATION HISTORY:

Ver   Who  Date  Changes


1.00a ecm 01/25/04 First Release. 1.00a sv 06/13/05 Minor changes to comply to Doxygen and Coding guidelines 2.00a ktn 10/20/09 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 "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...
 

Functions

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

Variables

XUartLite UartLite
 Instance of the UartLite device. More...
 

Macro Definition Documentation

#define XUARTLITE_BASEADDRESS   XPAR_XUARTLITE_0_BASEADDR

UartLite base address.

Referenced by main().

Function Documentation

int main ( void  )

Calls the UartLite self-test example.

This function is not included if the example is generated from the TestAppGen test tool.

Returns
XST_SUCCESS if successful, otherwise XST_FAILURE.

References UartLiteSelfTestExample(), and XUARTLITE_BASEADDRESS.

int UartLiteSelfTestExample ( 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.

Parameters
[in]BaseAddressBase address of the device.
Returns
XST_SUCCESS if successful, otherwise XST_FAILURE.
Note
In XSCT/classic flow, DeviceId is used to look up the device configuration.

References XUartLite_Initialize(), and XUartLite_SelfTest().

Referenced by main().

Variable Documentation

XUartLite UartLite

Instance of the UartLite device.