vtc: vtc_selftest_example.c File Reference

| vtc Xilinx SDK Drivers API Documentation

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

Macros | Functions | Variables
vtc_selftest_example.c File Reference

## Overview

This file contains an example using the VTC driver to do self test on the core.

Note
  None.

    MODIFICATION HISTORY:

    Ver   Who    Date     Changes

    6.1   adk    08/23/14  First Release.

## Macros
#define | XVTC_DEVICE_ID XPAR_VTC_0_DEVICE_ID
| The following constants map to the XPAR parameters created in the xparameters.h file. More...

## Functions
int | XVtcSelfTestExample (u16 DeviceId)
| This function does a minimal test on the VTC driver. More...
int | main (void)
| Main/Entry function for self test example. More...

## Variables
XVtc | VtcInst
| Instance of the VTC core. More...

## Macro Definition Documentation

#define XVTC_DEVICE_ID XPAR_VTC_0_DEVICE_ID

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.

Referenced by main().

## Function Documentation

int main | ( | void |  | ) |

Main/Entry function for self test example.

Returns
  - XST_SUCCESS if successful.
  - XST_FAILURE if unsuccessful.

Note
  None.

References XVTC_DEVICE_ID, and XVtcSelfTestExample().

int XVtcSelfTestExample | ( | u16 | DeviceId | ) |

This function does a minimal test on the VTC driver.

Parameters

  DeviceId | is an ID of VTC core or device.

Returns
  - XST_SUCCESS if successful.
  - XST_FAILURE if unsuccessful.

Note
  None.

References XVtc_Config::BaseAddress, XVtc_CfgInitialize(), XVtc_LookupConfig(), and XVtc_SelfTest().

Referenced by main().

## Variable Documentation

XVtc VtcInst

Instance of the VTC core.