| cframe Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

Macros | Functions
Overview

## Macros
#define | XCFRAME_HW_H_
| Prevent circular inclusions by using protection macros. More...

## Functions
s32 | XCframe_SelfTest (const XCframe *InstancePtr)
| This function runs a self-test on the driver and hardware device. More...
XCframe_Config * | XCframe_LookupConfig (u16 DeviceId)
| XCframe_LookupConfig returns a reference to an XCframe_Config structure based on the unique device id, DeviceId. More...

## Macro Definition Documentation

#define XCFRAME_HW_H_

Prevent circular inclusions by using protection macros.

## Function Documentation

XCframe_Config* XCframe_LookupConfig | ( | u16 | DeviceId | ) |

XCframe_LookupConfig returns a reference to an XCframe_Config structure based on the unique device id, DeviceId.

The return value will refer to an entry in the device configuration table defined in the xcframe_g.c file.

Parameters

  DeviceId | is the unique device ID of the device for the lookup operation.

Returns
  CfgPtr is a reference to a config record in the configuration table (in xcframe_g.c) corresponding to DeviceId, or NULL if no match is found.

Note
  None.

s32 XCframe_SelfTest | ( | const XCframe * | InstancePtr | ) |

This function runs a self-test on the driver and hardware device.

Parameters

  InstancePtr | is a pointer to the XCframe instance.

Returns
  - XST_SUCCESS if the self-test passed.
  - XST_FAILURE otherwise.

Note
  None.