GtDio6xProbeSetParameters

Applies To

GX5961

Purpose

Programs the probe’s parameters.

Syntax

GtDio6xProbeSetParameters (nHandle, nCrcMode, nOffset, nLedEnable, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Session identifier:

     Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.

nCrcMode
SHORT
Used to specify the probe CRC mode:

0.  GTDIO6X_PROBE_CRC_DISABLE: Disable CRC capture.

1.  GTDIO6X_PROBE_CRC_RISING_EDGE on Window 4 Rising Edge.

2.  GTDIO6X_PROBE_CRC_FALLING_EDGE: Capture CRC on Window 4 Falling Edge.

nOffset
SHORT
Used to specify the amount, in terms of Master Clock Cycles, that the probe record signals have been offset.
The range of values are 0-15.
nLedEnable
SHORT
Used to specify the probe Led Enable setting.

0.  GTDIO6X_PROBE_DATA_DISABLE: Probe Data Memory is not written.

1.  GTDIO6X_PROBE_DATA_ENABLE: Probe Data Memory will be written to at the end of each vector.

pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

There are three probe parameters:

Probe parameter
 
Capture CRC Mode
The capture CRC mode allows the user to select the capture signal for the probe CRC:

0.  Disable Probe CRC Capture.

1.  Window 4 Rising Edge.

2.  Window 4 Falling Edge.

Probe Offset
The Probe offset allows the user to shift the probe record signals to accommodate system and UUT delay.
LED Active
The LED Active controls the front panel PLED signal.

Example

The following example sets the probe’s data parameters, and returns the settings:

 

SHORT nCrcMode, nOffset, nLedEnable;

 

GtDio6xProbeSetParameters(nHandle, GTDIO6X_PROBE_CRC_RISING_EDGE, GTDIO6X_PROBE_DATA_ENABLE, &nStatus);

 

GtDio6xProbeGetParameters(nHandle, &nCrcMode, &nOffset, &nLedEnable, &nStatus);

 

See Also

GtDio6xProbeGetParameters, GtDio6xProbeSetDataMode, GtDio6xProbeGetDataMode, GtDio6xWriteVectorMemory, GtDio6xReadVectorMemory, GtDio6xGetErrorString