GXFPGA Functions List

The following list is a summary of functions available for the GX3700:

Driver Functions	Description
General Functions
GxFpgaInitialize	Initializes the driver for the board at the specified slot number using HW. The function returns a handle that can be used with other GXFPGA functions to program the board.
GxFpgaInitializeVisa	Initializes the driver for the specified slot using VISA. The function returns a handle that can be used with other GXFPGA functions to program the board.
GxFpgaReset	Resets the GX3700 interface FPGA and User FPGA to their default state.
GxFpgaGetBoardSummary	Returns the board summary.
GxFpgaGetBoardType	Returns the board type.
GxFpgaGetDriverSummary	Returns the driver's name and version.
GxFpgaGetErrorString	Returns the error string associated with the specified error number.
GxFpgaPanel	Opens the instrument panel dialog used to interactively control the board.
FPGA Settings Functions
GxFpgaGetEepromSummary	Returns the timestamp and filename of the last FPGA configuration written to EEPROM.
GxFpgaGetExpansionBoardID	Returns the current Expansion Board ID.
GxFpgaLoad	Loads the volatile FPGA or the nonvolatile EEPROM with FPGA configuration data in the form of SVF or RPD files respectively.
GxFpgaLoadFromEeprom	Loads the FPGA with the contents of the EEPROM.
GxFpgaLoadStatus	Returns the progress of the last asynchronous load in percentage.
GxFpgaLoadStatusMessage	Returns a string describes the current load progress of the last asynchronous load.
GxFpgaRead	Reads the specified number of data elements from the User’s FPGA specified BAR memory.
GxFpgaReadRegister	Reads a 32-bit User’s FPGA register.
GxFpgaWrite	Writes the specified number of data elements to the User’s FPGA specified BAR memory.
GxFpgaWriteRegister	Writes a buffer of 32-bit double words to the User’s FPGA’s register space.
Event (Interrupt) Functions
GxFpgaSetEvent	Enables or disables an event handler.
GxFpgaDiscardEvents	Clears the events queue.
GxFpgaWaitOnEvent	Waits until event received or timeout occurred.
DMA Functions
GxFpgaDmaFreeMemory	Free the DMA block of continues physical memory that was previously allocated when the user called GxFpgaDmaTransfer API.
GxFpgaDmaGetTransferStatus	Returns the DMA transfer status register.
GxFpgaDmaTransfer	Transfers a block of data using DMA.
Upgrade firmware functions
GxFpgaUpgradeFirmware	Upgrades the board’s firmware.
GxFpgaUpgradeFirmwareStatus	Monitor the firmware upgrade process.
General purpose Waveform Analysis functions
GxFpgaWaveformCalculateAmplitude		Calculate waveform data minimum, maximum, or average amplitude in the specified array range.
GxFpgaWaveformCalculateTiming		Calculate the waveform’s rise time. Fall time, and width in the specified array start and end index.

GXFPGA Functions List

Driver Functions

Description

General Functions

Initializes the driver for the board at the specified slot number using HW. The function returns a handle that can be used with other GXFPGA functions to program the board.

Initializes the driver for the specified slot using VISA. The function returns a handle that can be used with other GXFPGA functions to program the board.

Resets the GX3700 interface FPGA and User FPGA to their default state.

Returns the board summary.

Returns the board type.

Returns the driver's name and version.

Returns the error string associated with the specified error number.

Opens the instrument panel dialog used to interactively control the board.

FPGA Settings Functions

Returns the timestamp and filename of the last FPGA configuration written to EEPROM.

Returns the current Expansion Board ID.

Loads the volatile FPGA or the nonvolatile EEPROM with FPGA configuration data in the form of SVF or RPD files respectively.

Loads the FPGA with the contents of the EEPROM.

Returns the progress of the last asynchronous load in percentage.

Returns a string describes the current load progress of the last asynchronous load.

Reads the specified number of data elements from the User’s FPGA specified BAR memory.

Reads a 32-bit User’s FPGA register.

Writes the specified number of data elements to the User’s FPGA specified BAR memory.

Writes a buffer of 32-bit double words to the User’s FPGA’s register space.

Event (Interrupt) Functions

Enables or disables an event handler.

Clears the events queue.

Waits until event received or timeout occurred.

DMA Functions

Free the DMA block of continues physical memory that was previously allocated when the user called GxFpgaDmaTransfer API.

Returns the DMA transfer status register.

Transfers a block of data using DMA.

Upgrade firmware functions

Upgrades the board’s firmware.

Monitor the firmware upgrade process.

General purpose Waveform Analysis functions

Calculate waveform data minimum, maximum, or average amplitude in the specified array range.

Calculate the waveform’s rise time. Fall time, and width in the specified array start and end index.