GtDio6xRealTimeCompareSetJumpPipelineMask

Applies To

GX5961, GX5964, File

Purpose

Sets the Real Time Compare jump pipeline mask depth.

Syntax

GtDio6xRealTimeCompareSetJumpPipelineMask (nHandle, dwDepth, 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.

     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.

dwDepth

DWORD

Sets the Real Time Compare jump pipeline mask depth.

pnStatus

PSHORT

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

Comments

This function returns the pipeline mask depth. The sequence jump logic includes a pass/fail condition. The pass/fail condition is the combination of all the valid channel comparator results and the condition enable flag for the current pattern. The condition enable flags are set using the GtDio6xWriteVectorTestFlagsMemory API. This pass/fail condition is then inserted in a 32 bit pipeline. The contents of the pipeline are ANDED with the contents of the pipeline mask to generate a pass/fail flag that the sequencer can jump on. Bit 0 is the mask for the first bit in the pipeline and bit 31 is the mask for the last bit in the pipeline. If no bits are set, raw error is used for jumping, counting burst errors and logging errors in the error address memory.

E.g. to set the pipeline depth to 8 then you would set bit 7to a 1 (hex 80).

Example

The following example sets the Real Time Compare jump pipeline mask depth to 4, and returns the jump pipeline mask depth:

 

SHORT nStatus;

DWORD dwDepth;

 

GtDio6xRealTimeCompareSetJumpPipelineMask (nHandle, 0x10, &nStatus);

GtDio6xRealTimeCompareGetJumpPipelineMask (nHandle, &dwDepth, &nStatus);

 

See Also

GtDio6xSequencerGetRecordParameters, GtDio6xStepSetRecordMode, GtDio6xReadRecordMemory, GtDio6xReadVectorMemory, GtDio6xWriteVectorMemory, GtDio6xGetErrorString