RFmxEVDO_CfgFrequencyReference

NI-RFmx EV-DO 2.5 Help

Edition Date: June 2018

Part Number: 375769F-01

»View Product Info
Download Help (Windows Only)

int32 __stdcall RFmxEVDO_CfgFrequencyReference (niRFmxInstrHandle instrumentHandle, char channelName[], char frequencyReferenceSource[], float64 frequencyReferenceFrequency);

Purpose

Configures the Reference Clock and the frequency reference source.

This function is a wrapper over the NI-RFmx Instruments API, and calls the RFmxInstr_CfgFrequencyReference function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxEVDO_Initialize function.
channelName char[] Set this parameter to "" (empty string) or NULL.
frequencyReferenceSource char[] Specifies the frequency reference source.
RFMXEVDO_VAL_ONBOARD_CLOCK_STR (OnboardClock)

NI 5663/5663E: The RFmx driver locks the NI 5663/5663E to the NI 5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the NI 5652 to the NI 5622 CLK IN terminal. On versions of the NI 5663/5663E that lack a REF OUT2 connector on the NI 5652, connect the REF IN/OUT connector on the NI 5652 to the NI 5622 CLK IN terminal.

NI 5665: The RFmx driver locks the NI 5665 to the NI 5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the NI 5653 to the NI 5622CLK IN terminal.

NI 5668R: Lock the NI 5668R to the NI 5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the NI 5606 to the CLK IN connector on the NI 5624R.

NI 5644R/5645R/5646R: The RFmx driver locks the device to its onboard clock.

RFMXEVDO_VAL_REF_IN_STR (RefIn)

NI 5663/5663E: Connect the external signal to the NI 5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the NI 5652 to the NI 5622 CLK IN terminal.

NI 5665: Connect the external signal to the NI 5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the NI 5653 to the NI 5622 CLK IN connector. If your external clock signal frequency is set to a frequency other than 10 MHz, set the frequencyReferenceFrequency parameter according to the frequency of your external clock signal.

NI 5668R: Connect the external signal to the NI 5653 REF IN connector. Connect the LO2 OUT on the NI 5606 to the CLK IN connector on the NI 5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the frequencyReferenceFrequency parameter according to the frequency of your external clock signal.

NI 5644R/5645R/5646R: The RFmx driver locks the device to the signal at the external REF IN connector.

RFMXEVDO_VAL_PXI_CLK_STR(PXI_Clk)

NI 5668R: Lock the NI 5653 to the PXI backplane clock. Connect the NI 5606 LO2 OUT to the LO2 IN connector on the NI 5624R.

NI 5644R/5645R/5646R, NI 5663/5663E/5665: The RFmx driver locks these devices to the PXI backplane clock.

RFMXEVDO_VAL_CLK_IN_STR (ClkIn)

NI 5663/5663E: The RFmx driver locks the NI 5663/5663E to an external 10 MHz signal. Connect the external signal to the NI 5622 CLK IN connector, and connect the NI 5622 CLK OUT connector to the REF IN/OUT connector on the NI 5652.

NI 5665: The RFmx driver locks the NI 5665 to an external 100 MHz signal. Connect the external signal to the NI 5622 CLK IN connector, and connect the NI 5622 CLK OUT connector to the REF IN connector on the NI 5653. Set the frequencyReferenceFrequency parameter to 100 MHz.

NI 5668R: Lock the NI 5668R to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the NI 5624R, and connect the NI 5624R CLK OUT connector to the REF IN connector on the NI 5653. Set the frequencyReferenceFrequency parameter to 100 MHz.

NI 5644R/5645R/5646R: This configuration does not apply to the NI 5644R/5645R/5646R.

frequencyReferenceFrequency float64 Specifies the Reference Clock rate when you set the frequencyReferenceSource parameter to RFMXEVDO_VAL_CLK_IN_STR or RFMXEVDO_VAL_REF_IN_STR. This value is expressed in Hz.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxEVDO_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful