GtDio6xSequencerGetFreqSynth

Applies To

GX5961, GX5964, File

Purpose

Returns the frequency of the synthesizer clock (on board PLL).

Syntax

GtDio6xSequencerGetFreqSynth (nHandle, pdFreq, pnRefSource, pdRefFreq, 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.

pdFreq
PDOUBLE
Returns the synthesizer frequency within the range of 40 MHz to 500 MHz (40-500).
pnRefSource
PSHORT
Used to return the Frequency Synthesizer source as follows:

0.  GTDIO6X_FSR_SOURCE_INT: Internal 500 MHz clock.

1.    GTDIO6X_FSR_SOURCE_AUX0: External AUX0 channel as clock source.

2.    GTDIO6X_FSR_SOURCE_AUX1: External AUX1 channel as clock source.

3.    GTDIO6X_FSR_SOURCE_AUX2: External AUX2 channel as clock source.

4.    GTDIO6X_FSR_SOURCE_AUX3: External AUX3 channel as clock source.

5.    GTDIO6X_FSR_SOURCE_AUX4: External AUX4 channel as clock source.

6.    GTDIO6X_FSR_SOURCE_AUX5: External AUX5 channel as clock source.

7.    GTDIO6X_FSR_SOURCE_AUX6: External AUX6 channel as clock source.

8.    GTDIO6X_FSR_SOURCE_AUX7: External AUX7 channel as clock source.

9.    GTDIO6X_FSR_SOURCE_AUX8: External AUX8 channel as clock source.

10.  GTDIO6X_FSR_SOURCE_AUX9: External AUX9 channel as clock source.

11.  GTDIO6X_FSR_SOURCE_AUX10: External AUX10 channel as clock source.

12.  GTDIO6X_FSR_SOURCE_AUX11: External AUX11 channel as clock source.

13.  GTDIO6X_FSR_SOURCE_PXI10: PXI 10MHz clock as clock source.

pdRefFreq
PDOUBLE
Returns the synthesizer reference clock frequency within a range of 5 MHz-80 MHz (5-80).
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The frequency synthesizer can be used as the "Master Clock" source, the "System Clock" source or it can simply be output through any of the front panel AUX signals.

 Programming the frequency synthesizer consists of three settings:

1.     Output Frequency.

2.     Reference Source.

3.     Reference Frequency.

The output frequency can be from 40 to 500 MHz, a value of zero disables the frequency synthesizer. The reference source can be set to an internal 20 MHz clock, the PXICLK10 signal or any of the front panel AUX signals. The reference frequency is only required if the reference source is set to one of the AUX signals.  The "Internal" reference is a fixed 20 MHz, the PXICLK10 is a fixed 10 MHz.  This value is required in order to determine the feedback divider values for the frequency generator.

Example

The following example sets the frequency synthesizer settings to a frequency of 50 MHz, a Reference of Auxiliary channel 3 and a Reference Frequency of 80 MHz, and returns the settings:

 

SHORT nStatus;

SHORT nReference;

DOUBLE dFrequency, dReferenceFrequency;

 

GtDio6xSequencerSetFreqSynth(nHandle, 50, GTDIO6X_FSR_SOURCE_AUX3, 80, &nStatus);

GtDio6xSequencerGetFreqSynth(nHandle, &dFrequency, &nReferenceSource, &dReferenceFrequency, &nStatus);

 

See Also

GtDio6xSequencerArm, GtDio6xSequencerArmIdleStep, GtDio6xSequencerHalt, GtDio6xSequencerReset GtDio6xSequencerResume, GtDio6xSequencerRun, GtDio6xSequencerRunEx,GtDio6xSequencerRunIdleStep, GtDio6xSequencerSetBurstCount, GtDio6xSequencerSetChannelsCompareTrigger, GtDio6xSequencerSetRunCompletionMode,  GtDio6xSequencerSetFreqSynth, GtDio6xSequencerSetHaltMode, GtDio6xSequencerSetIdleStep, GtDio6xSequencerSetLoopCounterMode, GtDio6xSequencerSetMasterClockSource, GtDio6xSequencerSetRecordOffset, GtDio6xSequencerSetRecordParameters, GtDio6xSequencerSetStopMode, GtDio6xSequencerSetSyncPulseSource, GtDio6xSequencerSetSyncPulseParameters, GtDio6xSequencerSetSystemClockExternal,  GtDio6xSequencerSetSystemClockSource, GtDio6xSequencerStop, GtDio6xGetErrorString