X<DUT>_Initialize - 2021.2 English

Vitis High-Level Synthesis User Guide (UG1399)

Document ID
UG1399
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

Syntax

int X<DUT>_Initialize(X<DUT> *InstancePtr, u16 DeviceId);
int X<DUT>_Initialize(X<DUT> *InstancePtr, const char* InstanceName);

Description

int X<DUT>_Initialize(X<DUT> *InstancePtr, u16 DeviceId): For use on standalone systems, initialize a device. This API will write a proper value to InstancePtr which then can be used in other APIs. Xilinx recommends calling this API to initialize a device except when an MMU is used in the system, in which case refer to function X<DUT>_CfgInitialize.

int X<DUT>_Initialize(X<DUT> *InstancePtr, const char* InstanceName): For use on Linux systems, initialize a specifically named uio device. Create up to five memory mappings and assign the slave base addresses by mmap, utilizing the uio device information in sysfs.

InstancePtr
A pointer to the device instance.
DeviceId
Device ID as defined in xparameters.h.
InstanceName
The name of the uio device.

Return

XST_SUCCESS indicates success, otherwise fail.