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

Overview

Demonstrates XUartNs550 driver self-test functionality.

This file contains a design example using the Uart 16450/550 driver (XUartNs550) and hardware device using polled mode.

MODIFICATION HISTORY:

Ver   Who  Date     Changes


1.00a sv 10/07/05 Created for Test App integration 2.00a ktn 10/20/09 Updated to use HAL processor APIs and minor modifications as per coding guidelines. 3.4 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/09/23 Added SDT support. 3.14 vlt 12/18/25 Update Doxygen comments to include SDT flow details. 3.15 vn 09/09/26 Align Doxygen comments with AMD standards

#include "xparameters.h"
#include "xuartns550.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 XUARTNS550_BASEADDRESS   XPAR_XUARTNS550_0_BASEADDR
 UART base address. More...
 

Functions

int UartNs550SelfTestExample (UINTPTR BaseAddress)
 Performs a minimal self-test on the UartNs550 device. More...
 
int main (void)
 Calls the UartNs550 self test example. More...
 

Variables

XUartNs550 UartNs550
 Instance of the UART Device. More...
 

Macro Definition Documentation

#define XUARTNS550_BASEADDRESS   XPAR_XUARTNS550_0_BASEADDR

UART base address.

Referenced by main().

Function Documentation

int main ( void  )

Calls the UartNs550 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 UartNs550SelfTestExample(), and XUARTNS550_BASEADDRESS.

int UartNs550SelfTestExample ( UINTPTR  BaseAddress)

Performs a minimal self-test on the UartNs550 device.

This is a design example that tests the device and driver.

This function illustrates how to use the XUartNs550 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 XUartNs550_Initialize(), and XUartNs550_SelfTest().

Referenced by main().

Variable Documentation

XUartNs550 UartNs550

Instance of the UART Device.