osd: osd_selftest_example.c File Reference

| osd Xilinx SDK Drivers API Documentation

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

Macros | Functions | Variables
osd_selftest_example.c File Reference

## Overview

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

Note
  None.

MODIFICATION HISTORY:

    Ver   Who    Date     Changes

    4.0   adk    02/18/14 First Release

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

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

## Variables
XOsd | OsdInst
| Instance of the OSD Device. More...

## Macro Definition Documentation

#define XOSD_DEVICE_ID XPAR_OSD_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 XOSD_DEVICE_ID, and XOsdSelfTestExample().

int XOsdSelfTestExample | ( | u16 | DeviceId | ) |

This function does a minimal test on the OSD driver.

Parameters

  DeviceId | is an ID of OSD core or device.

Returns
  - XST_SUCCESS if successful.
  - XST_FAILURE if unsuccessful.

Note
  None.

References XOsd_Config::BaseAddress, XOsd_CfgInitialize(), XOsd_LookupConfig(), and XOsd_SelfTest().

Referenced by main().

## Variable Documentation

XOsd OsdInst

Instance of the OSD Device.