Marvin GX2472 Release note

GX2472
Two Channel 70MS/s
Waveform Digitizer
Driver Manual
Revision 1.2, Ma 2007
GEOTEST
MARVIN TEST SYSTEMS, INC.

Safety and Handling
Each product shipped b Geotest is carefull inspected and tested prior to shipping. The
shipping box provides protection during shipment, and can be used for storage of both the
hardware and the software when the are not in use.
The circuit boards are extremel delicate and require care in handling and installation. Do not
remove the boards from their protective plastic coverings or from the shipping box until ou
are read to install the boards into our computer.
If a board is removed from the computer for an reason, be sure to store it in its original
shipping box. Do not store boards on top of workbenches or other areas where the might be
susceptible to damage or exposure to strong electromagnetic or electrostatic fields. Store
circuit boards in protective anti-electrostatic wrapping and awa from electromagnetic fields.
Be sure to make a single cop of the software diskette for installation. Store the original
diskette in a safe place awa from electromagnetic or electrostatic fields. Return compact
disks (CD) to their protective case or sleeve and store in the original shipping box or other
suitable location.
Warranty
Geotest products are warranted against defects in materials and workmanship for a period of
12 months. Software products and accessories are warranted for 3 months, unless covered
b software support or maintenance agreement. Geotest shall repair or replace (at its
discretion) an defective product during the stated warrant period. The software warrant
includes an revisions or new versions released during the warrant period. Revisions and
new versions ma be covered b a software support agreement. If ou need to return a
board, please contact Geotest Customer Technical Services Department via
http://www.geotestinc.com/magic - the Geotest on-line support s stem.
If You Need Help
Visit our web site at http://www.geotestinc.com for more information about Geotest products,
services and support options. Our web site contains sections describing support options and
application notes, as well as a download area for downloading patches, example, patches
and new or revised instrument drivers. To submit a support issue including suggestion, bug
report or question please use the following link: http://www.geotestinc.com/magic
You can also use Geotest technical support phone line [phone]. This service is
available between 7:30 AM and 5:30 PM Pacific Standard Time.
Disclaimer
In no event shall Geotest or an of its representatives be liable for an consequential
damages whatsoever (including unlimited damages for loss of business profits, business
interruption, loss of business information, or an other losses) arising out of the use of or
inabilit to use this product, even if Geotest has been advised of the possibilit for such
damages.
Copyright
Cop right  2003-2007 b Geotest, Marvin Test S stems, Inc. All rights reserved. No part of
this document can be reproduced, stored in a retrieval s stem, or transmitted, in an form or
b an means, electronic, mechanical, photocop ing, recording, or otherwise, without the
prior written consent of Geotest.
Trademarks
ATEasyGeotest – MTS Inc.
C++ Builder, Borland C++, Pascal and Delphi Borland Corpora
tion
Microsoft Developer Studio, Microsoft Visual C++, Microsoft Visual Ba
sic,, .NET, Windows 95, 98, NT, ME, 2000 and XP
Microsoft Corpora
tion
All other trademarks are the propert of their respective owners.

TAB E OF CONTENTS
Safet and Handling.................................................................................................................1
Warrant ..................................................................................................................................1
If You Need Help......................................................................................................................1
Disclaimer................................................................................................................................1
Cop right..................................................................................................................................1
Trademarks..............................................................................................................................1
Introduction .............................................................................................................................. 4
1 GX2472 driver package ......................................................................................................... 5
1.1 Installation ....................................................................................................................... 5
1.2 Uninstalling the low level driver ....................................................................................... 5
1.3 “Manual” installation of the low level driver ..................................................................... 5
2 GX2472 DLL functions. .......................................................................................................... 7
2.1 gx2472_AutoCalibrate (vi, mode, displa Time) .............................................................. 7
2.2 gx2472_CheckTestStatus (vi, testStatus) ....................................................................... 7
2.3 gx2472_close( vi ) ........................................................................................................... 7
2.4 gx2472_CodeToVoltage (vi, ADCCode, voltage) ............................................................ 8
2.5 gx2472_ConnectCard(vi , positveInputConnection, negativeInputConnection ) ............. 8
2.6 gx2472_error_message( vi, statusCode, errorMessage ) ............................................... 8
2.7 gx2472_FindInstruments( buslist, devicelist, count ) ...................................................... 9
2.8 gx2472_GetActiveChannel( vi , channel ) ....................................................................... 9
2.9 gx2472_GetAddressCounter(vi, addresscounter ) .......................................................... 9
2.10 gx2472_GetCardConnection(vi, positiveInputConnection, negativeInputConnection )
............................................................................................................................................ 10
2.11 gx2472_GetCardId(vi , id ) .......................................................................................... 10
2.12 gx2472_GetClockDivider (vi, clockDivider) ................................................................. 10
2.13 gx2472_GetClockSource (vi, clockSource) ................................................................. 10
2.14 gx2472_GetDCOffsetLimitVoltages (vi, positiveVoltage, negativeVoltage) ................ 11
2.15 gx2472_GetDCOffsetVoltage(vi , voltage ) ................................................................. 11
2.16 gx2472_GetFilter (vi, filterStatus) ............................................................................... 11
2.17 gx2472_GetGainCalCode (vi, gainCalibrationCode) .................................................. 11
2.18 gx2472_GetInputVoltage (vi, voltage, code, averages, timeOut) ................................ 11
2.19 gx2472_GetLoopMode (vi, loopMode) ........................................................................ 12
2.20 gx2472_GetOffsetCalDacCode(ci, code) .................................................................... 12
2.21 gx2472_GetRange (vi, range) ..................................................................................... 12
2.22 gx2472_GetSampleDivider (vi, sampleDivider) .......................................................... 12
2.23 gx2472_GetSoftwareTriggerStatus(vi, triggerstatus ) ................................................. 12
2.24 gx2472_GetTriggerInput (vi, triggerSource, triggerMode) ........................................... 13
2.25 gx2472_init( resourcediscription , IDQuer , reset, vi ) ............................................... 13
2.26 gx2472_Memor Test (vi, level, errorAddress) ............................................................ 14
2.27 gx2472_ReadAdcResults (vi, startPosition, samples, buffer, includeStatusBits) ........ 14
2.28 gx2472_ReadEEPROM(vi , eeaddress , data) ........................................................... 14
2.29 gx2472_ReadInstrumentMemor (vi, data ) ................................................................. 14
2.30 gx2472_ReadInstrumentMemor Arra (vi , length , buf32, dataInterpretation ) ........... 15
2.31 gx2472_ReadRegister(vi, address, data ) ................................................................... 15
2.32 gx2472_reset(vi ) ........................................................................................................ 15
2.33 gx2472_revision_quer ( vi, driverRev, instrRev ) ....................................................... 15
2.34 gx2472_self_test( vi, testResult, errorMessage ) ........................................................ 16
2.35 gx2472_SetActiveChannel(vi , channel ) .................................................................... 16
2.36 gx2472_SetAddressCounter (vi, addressCounterPosition) ......................................... 16
2.37 gx2472_SetClockDivider(vi , clockdivider ) ................................................................. 16
2.38 gx2472_SetClockOutputEnable(vi, enable ) ............................................................... 17
2.39 gx2472_SetClockSource(vi, clocksource ) .................................................................. 17
2.40 gx2472_SetDCOffsetCode(vi , code, connect ) .......................................................... 17
2.41 gx2472_SetDCOffsetVoltage(vi, voltage, connect ) .................................................... 17
2.42 gx2472_SetDCOffsetLimitVoltages(vi , posvolt , negvolt ) .......................................... 18
2.43 gx2472_SetFilter(vi , filter ) ......................................................................................... 18
2.44 gx2472_SetGainCalCode (vi, code) ........................................................................... 18
DUAL 70MSPS WAVEFORM DIGITIZER
2

2.45 gx2472_SetLockMode(vi , lock ) ................................................................................. 19
2.46 gx2472_SetLoopMode (vi, loopMode) ........................................................................ 19
2.47 gx2472_SetOffsetCalCode(vi, code) .......................................................................... 19
2.48 gx2472_SetRange(vi , range ) .................................................................................... 19
2.49 gx2472_SetSampleDivider (vi, sampleDividerValue) .................................................. 20
2.50 gx2472_SetSoftwareTriggerStatus(vi , triggerstatus ) ................................................ 20
2.51 gx2472_SetTriggerInput(vi , triggersource , triggermode ) .......................................... 20
2.52 gx2472_WriteCardId(vi , id ) ....................................................................................... 21
2.53 gx2472_WriteEEPROM(vi , eeaddress , data ) ........................................................... 21
2.54 gx2472_WriteId(vi , id ) ............................................................................................... 21
2.55 gx2472_WriteInstrumentMemor (vi , data ) ................................................................ 21
2.56 gx2472_WriteInstrumentMemor Arra (vi , length , buffer ) ......................................... 22
2.57 gx2472_WriteRegister(vi , addrress, data ) ................................................................. 22
3 Status codes ........................................................................................................................ 23
DUAL 70MSPS WAVEFORM DIGITIZER
3

Introduction
The GX2472 is a 70MHz dual channel Waveform Digitizer. For software development and
integration in a PXI s stem, the card is provided with a software driver, utilit software, a
demo program for LabView and a calibration tool.
The main part of the GX2472 driver consisst of a Windows d namic link librar , the
gx2472.DLL
For Labview users the driver also includes a LabView librar with the gx2472.dll driver
functions.
This manual describes the functions of the gx2472.dll.
DUAL 70MSPS WAVEFORM DIGITIZER
4

1 GX2472 driver package
The driver includes the following items:
1) A low level driver for direct communication;
2) The user mode driver, gx2472.dll;
3) A Labview librar , gx2472.llb
4) A LabWindows driver (function tree) gx2472.fp including the source file gx2472.c and
the header file gx2472.h. For basic programmers a GX2472.bas file is included.
The following low level drivers can be installed:
1) A kernel mode pxi driver, gx2472.s s;
2) VISA based driver which requires the installation of VISA which is available from
National Instruments.
1.1 Installation
Install the GX2472 Driver Software before the hardware is placed in the s stem.
Place the installation CD in the CD-ROM. If the installation program does not start
automaticall , run the program setup.exe (placed in the root of the CD-ROM).
If the software is installed on a Windows NT based operating s stem (Win2000, WinNT,
WinXP), ou should have Administrator rights.
The PXI Kernel Driver cannot be installed on Windows95 or Windows NT. This selection will
be disabled if one of these operating s stems is detected.
After installation shutdown the computer and place the GX2472 in the s stem. After turning
on the computer the operation s stem should automaticall detect the new hardware and
install the low level driver.
1.2 Uninstalling the low level driver
Before switching from the low-level driver to the VISA based driver, uninstall the current low-
level driver
For uninstalling the low level driver, perform the following steps:
1. Start the Device Manager
2. Select the “GX2472 PXI driver” and uninstall the driver;
3. Go to the Windows inf-director (e.g. Windows\inf, hidden director ).
4. Delete the gx2472_xxxx.inf file. The addition of xxxx indicates the Windows Operation
S stem version.
5. If installed with the pxi kernel mode driver, go the Windows sub-director
S stem\Drivers (e.g. C:\Windows\S stem\Drivers).
6. Delete the gx2472.s s file.
1.3 “Manual” installation of the low level driver
1. Cop the corresponding inf-file to the Windows Inf-subdirector (e.g. C:\Windows\inf).
The inf-files can be found in the following directories of the CD-ROM:
For Visa installation:
Director : \Driver\Visa
Windows9x “gx2472_9x.inf”
WindowsNT4 “gx2472_nt4.inf”
Windows2000 “gx2472_nt5.inf”
WindowsXP “gx2472_nt5.inf”
DUAL 70MSPS WAVEFORM DIGITIZER
5

For the PXI kernel mode driver installation:
Director : \Driver\Kernel
Windows98 “gx2472.inf”
Windows2000 “gx2472.inf”
WindowsXP “gx2472.inf”
The inf-subdirector is a hidden director .
2. If the pxi kernel mode driver is installed, cop also the gx2472.s s file. This file can be
found in the director \Drivers\Kernel\Winxx, where xx indicates the operating s stem.
Cop this file to the Windows sub-director \S stem\Drivers (e.g.
C:\Windows\S stem\Drivers);
3. Turn the s stem off and place the GX2472 in the s stem;
4. Turn the s stem on and reboot the host computer;
5. The operation s stem should detect new hardware;
Be sure driver signing is set to Ignore or Warn, when installing the GX2472 pxi kernel driver
on a Win2000 or WinXP s stem.
If the “Add new hardware” wizard doesn't start or something went wrong during installation,
start the Device Manager. Select the device (normall marked with a question mark, if the
driver could not be loaded) and select properties. Then install/reinstall the driver.
DUAL 70MSPS WAVEFORM DIGITIZER
6

2 GX2472 DLL functions.
This chapter describes the functions of the dll. Each function and its parameters are
described in a table. The following parameter t pes are used:
Type Details
unsigned long 4-b te (32 bit) unsigned long
double 8-b te floating point
unsigned long* reference variable (pointer) to a 4-b te (32 bit) unsigned long
double* reference variable (pointer) to a 8-b te floating point
All functions use the standard calling conventions (stdcall or WINAPI). Ever function returns
the ViStatus (t pe: 32-bit integer). A negative value corresponds to an error. After a
successful completion the return status is VI_SUCCESS, which corresponds to a 0. Possible
status codes can be found in Chapter 3.
2.1 gx2472_AutoCalibrate (vi, mode, displayTime)
Description:
This function performs an auto calibration procedure. The input DC-offset should alread be
calibrated. The calibration voltages can be monitored on the negative input of the module’s
two channels.
Parameters:
Name Type Direction Description Value
vi unsigned long in Instrument Handle 0 to 2^32
mode unsigned long in mode 0 no monitoring
1 monitor at neg. input
displa Time double in displa time time to displa voltage at
negative input
2.2 gx2472_CheckTestStatus (vi, testStatus)
Description:
This function returns the test status. It will return a 1 if the memor address counter passes
the maximum address counter value (read ). Bit 0 represents channel A, bit 1 channel B.
Parameters:
Name Type Direction Description Value
vi unsigned long in Instrument Handle 0 to 2^32
testStatus unsigned long* out Test Status 0 A & B not read
1 Channel A read
2 Channel B read
3 A & B read
2.3 gx2472_close( vi )
Description:
Close the card session. All resources belonging to the card will be released.
Parameters:
Name Type Direction Description Value
vi unsigned long in Instrument Handle 0 to 2^32
DUAL 70MSPS WAVEFORM DIGITIZER
7

2.4 gx2472_CodeToVoltage (vi, ADCCode, voltage)
Description:
This function converts an ADC Code to the corresponding voltage.
Parameters:
Name Type Direction Description Value
vi unsigned long in Instrument Handle 0 to 2^32
ADCCode unsigned long in mode 0 to 2^32
voltage double* out voltage corresponding voltage
2.5 gx2472_ConnectCard(vi , positveInputConnection,
negativeInputConnection )
Description:
This function connects/disconnects the input rela s. There are 4 rela s for each input. Each
rela can be controlled with a bit:
•Bit 1 (value 1 Hex) : Input rela ;
•Bit 2 (value 2 Hex) : 50 Ohm rela ;
•Bit 3 (value 4 Hex) : 50 Ohm DC rela , this bit controls the positive and negative
channel simultaneousl ;
•Bit 4 (value 8 Hex) : Ground rela , connect input to ground.
Parameters:
Name Type Direction Description Value
vi unsigned long in Instrument Handle 0 to 2^32
positiveInputConnection unsigned long in positive input see description
negativeInputConnection unsigned long in negative input see description
2.6 gx2472_error_message( vi, statusCode, errorMessage )
Description:
Get the text string corresponding the statusCode. ErrorMessag should be at least have a size
of 255.
Parameters:
Name Type Direction Description Value
vi unsigned
long
in Instrument Handle 0 to 2^32
statusCode unsigned
long
in The status code returned b a
gx2472 driver function
0 to 2^32
errorMessage char* out The error message string
gx2472_error_query( vi, errorCode, Message )
Description:
Error Quer is not supported b this instrument. This function onl exists for compliance with
the VXI Plug and Pla specifications.
It returns a defined value VI_WARN_NSUP_ERROR_QUERY.
DUAL 70MSPS WAVEFORM DIGITIZER
8