| uartlite Vitis Drivers API Documentation

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

Functions
xuartlite_selftest_example.c File Reference

## Overview

This file contains a design example using the UartLite driver (XUartLite) and hardware device.

Note

None

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

## Functions
int | UartLiteSelfTestExample (u16 DeviceId)
| This function does a minimal test on the UartLite device and driver as a design example. More...
int | main (void)
| Main function to call the example. More...

## Function Documentation

int main | ( | void |  | ) |

Main function to call the example.

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

Returns
  XST_SUCCESS if successful, otherwise XST_FAILURE.

Note
  None.

References UartLiteSelfTestExample().

int UartLiteSelfTestExample | ( | u16 | DeviceId | ) |

This function does a minimal test on the UartLite device and driver as a design example.

The purpose of this function is to illustrate how to use the XUartLite component.

Parameters

  DeviceId | is the XPAR_<uartlite_instance>_DEVICE_ID value from xparameters.h.

Returns
  XST_SUCCESS if successful, otherwise XST_FAILURE.

Note
  None.

References XUartLite_Initialize(), and XUartLite_SelfTest().

Referenced by main().