GtDio6xStepGetTimingSetIndex

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the phase and window settings of a timing set group of a Step when in indexed timing mode.

Syntax

GtDio6xStepGetTimingSetIndex (nHandle, lStep, pnTimingSet, 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.

lStep
LONG
Step Number to access 0-4095.
pnTimingSet
PSHORT
Used to get the timing set that is applied to a particular Step (0-255).
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

Each Timing Set Index sequence step contains one or four signal groups. Each signal group contains four settings:

Each Step points to a particular timing set in the index Timing Set Memory. The Timing Set Memory contains 256 timing set groups, each Timing Set memory index is compos of four pairs of timing sets signals for a total of 16 as follows:

Phase Assert 0
First pair of Phase and Window in the specified Timing Set Memory Index
Phase Return 0
Window Open 0
Window Close 0
Phase Assert 1
Second pair of Phase and Window in the specified Timing Set Memory Index
Phase Return 1
Window Open 1
Window Close 1
Phase Assert 2
Third pair of Phase and Window in the specified Timing Set Memory Index
Phase Return 2
Window Open 2
Window Close 2
Phase Assert 3
Fourth pair of Phase and Window in the specified Timing Set Memory Index
Phase Return 3
Window Open 3
Window Close 3

The phase and window signals are programmed in master clock edges (rising and falling), i.e., 1/2 the master clock period.  For example, if the master clock is set to 500 MHz, then a setting of 5 would be: 5 * (1/2 (2ns)) = 5ns.

With a master clock of 100 MHz it would be: 5 * (1/2 (10ns)) = 25ns.

This function is used when the Domain is in the indexed Timing Mode. In the indexed timing mode, each Step points to a particular timing set in the indexed Timing Memory. The Timing Set Memory contains 256 timing set groups. Each timing set group contains four Phases and for Windows.

Example

The following example gets Step 5 timing set:

 

SHORT nTimingSet;

SHORT nStatus;

 

GtDio6xStepGetTimingSetIndex(nHandle, 5, &nTimingSet, &nStatus);

 

See Also

GtDio6xStepSetTimingSetIndex, GtDio6xTimingSetMemoryWriteData, GtDio6xTimingSetMemoryReadData, GtDio6xGetErrorString