ADM-XRC SDK 2.3.0 User Guide (Linux)
© Copyright 2001-2003 Alpha Data
ADMXRC2 interface functions
The ADMXRC2 interface can be divided into the following function groups:
Group | Consists of... |
Initialization |
ADMXRC2_CloseCard ADMXRC2_OpenCard ADMXRC2_OpenCardByIndex |
Information |
ADMXRC2_GetBankInfo ADMXRC2_GetCardInfo ADMXRC2_GetSpaceInfo ADMXRC2_GetVersionInfo |
FPGA configuration |
ADMXRC2_ConfigureFromBuffer ADMXRC2_ConfigureFromBufferDMA ADMXRC2_ConfigureFromFile ADMXRC2_ConfigureFromFileDMA ADMXRC2_LoadBitstream ADMXRC2_UnloadBitstream |
Clock generation |
ADMXRC2_SetClockRate |
Data transfer |
ADMXRC2_BuildDMAModeWord ADMXRC2_DoDMA ADMXRC2_DoDMAImmediate ADMXRC2_MapDirectMaster ADMXRC2_Read ADMXRC2_ReadConfig ADMXRC2_SetupDMA ADMXRC2_SyncDirectMaster ADMXRC2_UnsetupDMA ADMXRC2_Write ADMXRC2_WriteConfig |
Interrupt handling |
ADMXRC2_CancelWaitForInterrupt ADMXRC2_WaitForInterrupt |
Error handling |
ADMXRC2_GetStatusString ADMXRC2_InstallErrorHandler ADMXRC2_StatusToString |
ADMXRC2 interface structures
This section describes the composite datatypes of the ADMXRC2 interface.
Name | Purpose |
ADMXRC2_BANK_INFO | Information about a bank of memory |
ADMXRC2_BUFFERMAP | Contains a physical page map of an application buffer |
ADMXRC2_CARD_INFO | Information about a card |
ADMXRC2_SPACE_INFO | Information about local bus region |
ADMXRC2_VERSION_INFO | Information about the API and driver version |
ADMXRC2 interface types
This section describes the atomic datatypes of the ADMXRC2 interface.
Name | Purpose |
ADMXRC2_CARDID | A value that identifies a particular card in a system |
ADMXRC2_DMADESC | A DMA descriptor, identifying a locked application buffer |
ADMXRC2_DMADIR | A value that indicates in which direction a DMA transfer should transfer data |
ADMXRC2_ERROR_HANDLER | A pointer to an application-defined error handler function |
ADMXRC2_FPGA_TYPE | A value representing the type of an FPGA fitted to a card |
ADMXRC2_HANDLE | A handle to an ADM-XRC series card |
ADMXRC2_IMAGE | A FPGA bitstream image, containing SelectMap data |
ADMXRC2_IOWIDTH | A value that specifies the byte width of IO and DMA transfers |
ADMXRC2_STATUS | A value that indicates the success or failure of a call to an API function |
ADMXRC2_SYNCMODE | A value specifying what kind of memory coherency synchronisation to perform |