| cfupmc Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

Macros | Functions
Overview

## Macros
#define | XCFUPMC_HW_H_
| Prevent circular inclusions by using protection macros. More...
#define | XCfupmc_In32 Xil_In32
| Input operation. More...
#define | XCfupmc_Out32 Xil_Out32
| Output operation. More...

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

## Macro Definition Documentation

#define XCFUPMC_HW_H_

Prevent circular inclusions by using protection macros.

#define XCfupmc_In32 Xil_In32

Input operation.

#define XCfupmc_Out32 Xil_Out32

Output operation.

## Function Documentation

XCfupmc_Config* XCfupmc_LookupConfig | ( | u16 | DeviceId | ) |

XCfupmc_LookupConfig returns a reference to an XCfupmc_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 xcfupmc_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 xcfupmc_g.c) corresponding to DeviceId, or NULL if no match is found.

s32 XCfupmc_SelfTest | ( | const XCfupmc * | InstancePtr | ) |

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

Parameters

  InstancePtr | is a pointer to the XCfupmc instance.

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