GtDio6xSequencerSetMasterClockSource

Applies To

GX5961, GX5964, File

Purpose

Sets the master clock source of the selected data sequencer.

Syntax

GtDio6xGtDio6xSetMasterClockSource (nHandle, nSource, 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.
nSource
SHORT
Used to set the master clock source as follows:

0.   GTDIO6X_MASTER_CLOCK_SOURCE_INTERNAL: Internal 500 MHz clock.

1.   GTDIO6X_MASTER_CLOCK_SOURCE_FREQUENCY_SYNTHESIZER: Frequency Synthesizer.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

If the Frequency Synthesizer is selected as the master clock source, use GtDio6xSequencerSetFreqSynth to set the clock parameters.

The master clock defines the resolution for the programmable timing generator signals.

The following signals have a 1/2 master clock period resolution:

●     Timing Set Phases.

●     Timing Set Windows.

●     Sequence T0CLK.

●     External System Clock Offset.

The following signals have master clock period resolution:

●     Record Offset.

●     Probe Offset.

●     Error Pulse Width.

For example, if the master clock is set to internal 500 MHz, then the following resolutions exist:

Signal
Resolution
Timing Set Phases
1nS
Timing Set Windows
1nS
T0CLK
1nS
System Clock Offset
1nS
Record Offset
2nS
Probe Offset
2nS
Error Pulse Width
2nS

If the master clock is set to frequency synthesizer at 200 MHz, then the following resolutions exist:

Signal
Resolution
Timing Set Phases
2.5nS
Timing Set Windows
2.5nS
T0CLK
2.5nS
System Clock Offset
2.5nS
Record Offset
5nS
Probe Offset
5nS
Error Pulse Width
5nS

Example

The following example sets the master clock source to the onboard 500 MHz clock, and returns the settings:

 

SHORT nSource, nStatus;

 

GtDio6xSetMaterClockSource(nHandle, GTDIO6X_MASTER_CLOCK_SOURCE_INTERNAL, &nStatus);

GtDio6xGetMaterClockSource(nHandle, &nSource, &nStatus);

 

See Also

GtDio6xSequencerGetMasterClockSource, GtDio6xSequencerGetFreqSynth, GtDio6xSequencerSetFreqSynth,  GtDio6xSequencerSetSystemClockSource, GtDio6xSequencerGetSystemClockSource, GtDio6xSequencerSetSystemClockExternal, GtDio6xSequencerGetSystemClockExternal, GtDio6xGetErrorString