Skip to content

NI RFmx LTE Ch Configuration Functions

Dane Stull edited this page Feb 28, 2022 · 2 revisions

Ch Configuration Functions

Uplink Configuration

RFmxLTE_CfgPUSCHModulationType

int32 __stdcall RFmxLTE_CfgPUSCHModulationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 modulationType);

Purpose

Configures the modulation scheme used in the physical uplink shared channel (PUSCH) channel of the signal being measured. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
modulationType int32 Specifies the modulation scheme used in the PUSCH channel of the signal being measured.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPUSCHResourceBlocks

int32 __stdcall RFmxLTE_CfgPUSCHResourceBlocks (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 resourceBlockOffset, int32 numberOfResourceBlocks);

Purpose

Configures the start and number of resource blocks allocated for the physical uplink shared channel (PUSCH) cluster. Use "cluster<l>" or "carrier<k>" or "subblock<n>/carrier<k>/cluster<l>" as the selector string to configure this result.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, carrier number, and the cluster number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0/cluster0"
"signal::sig1/subblock0/carrier0/cluster0"
You can use the RFmxLTE_BuildClusterString) function to build the selector string.
resourceBlockOffset int32 Specifies the starting resource block number of a PUSCH cluster.
numberOfResourceBlocks int32 Specifies the number of consecutive resource blocks in a PUSCH cluster.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgNumberOfPUSCHResourceBlockClusters

int32 __stdcall RFmxLTE_CfgNumberOfPUSCHResourceBlockClusters (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfResourceBlockClusters);

Purpose

Configures the number of clusters of resource allocations. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
numberOfResourceBlockClusters int32 Specifies the number resource allocation clusters, with each cluster including one or more consecutive resource blocks. For more information about the physical uplink shared channel (PUSCH) number of clusters, refer to 5.5.2.1.1 of the 3GPP TS 36.213 specification.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubblockString

int32 __stdcall RFmxLTE_BuildSubblockString (char selectorString[], int32 subblockNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subblock string to use as the selector string with the subblock configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
subblockNumber int32 Specifies the number of subblocks that are configured in the intra-band noncontiguous carrier aggregation. Set this parameter to 1, which is the default, for single carrier and intra-band contiguous carrier aggregation.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildCarrierString

int32 __stdcall RFmxLTE_BuildCarrierString (char selectorString[], int32 carrierNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the carrier string to use as the selector string with the SEM and ACP carrier configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
carrierNumber int32 Specifies the carrier number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildClusterString

int32 __stdcall RFmxLTE_BuildClusterString (char selectorString[], int32 clusterNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates a cluster string to use as the selector string with the ModAcc cluster configuration or the fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
clusterNumber int32 Specifies the cluster number.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Downlink Configuration

RFmxLTE_CfgDownlinkChannelConfigurationMode

int32 __stdcall RFmxLTE_CfgDownlinkChannelConfigurationMode (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 channelConfigurationMode);

Purpose

Configures the downlink channel configuration mode.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
channelConfigurationMode int32 Specifies the channel configuration mode.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgDownlinkAutoChannelDetection

int32 __stdcall RFmxLTE_CfgDownlinkAutoChannelDetection (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 autoPDSCHChannelDetectionEnabled, int32 autoControlChannelPowerDetectionEnabled, int32 autoPCFICHCFIDetectionEnabled, int32 reserved);

Purpose

Configures whether the values of physical downlink shared channel (PDSCH) parameters, control channel signal powers, and physical control format indicator channel (PCFICH) CFI are configured by a user or auto-detected by the measurement. The measurement ignores this function, when you set the RFMXLTE_ATTR_LINK_DIRECTION) attribute to RFMXLTE_VAL_LINK_DIRECTION_UPLINK.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Example:
"signal::sig1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
autoPDSCHChannelDetectionEnabled int32 Specifies whether the values of the RFMXLTE_ATTR_PDSCH_RESOURCE_BLOCK_ALLOCATION) attribute, the corresponding PDSCH CW0 Modulation Type attribute, and the PDSCH Power attribute are auto-detected by the measurement or user-specified.
This parameter is not valid, when you set the RFMXLTE_ATTR_DOWNLINK_CHANNEL_CONFIGURATION_MODE) attribute to RFMXLTE_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_TEST_MODEL.
RFMXLTE_VAL_AUTO_PDSCH_CHANNEL_DETECTION_ENABLED_FALSE (0) The value of the RFMXLTE_ATTR_PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute that you specify are used for the measurement.
RFMXLTE_VAL_AUTO_PDSCH_CHANNEL_DETECTION_ENABLED_TRUE (1) The value of the RFMXLTE_ATTR_PDSCH_RESOURCE_BLOCK_ALLOCATION attribute, the corresponding values of PDSCH CW0 Modulation Type, and the PDSCH Power attribute are auto-detected and used for the measurement.
autoControlChannelPowerDetectionEnabled int32 Specifies whether the value of PSS Power, SSS Power, PBCH Power, PDCCH Power, and PCFICH Power attributes are auto-detected by the measurement or user-specified. Currently, auto-detectionPHICH Power attribute is not supported.
This parameter is not valid, when you set the RFMXLTE_ATTR_DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to RFMXLTE_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_TEST_MODEL.
RFMXLTE_VAL_AUTO_CONTROL_CHANNEL_POWER_DETECTION_ENABLED_FALSE (0) The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, PHICH Power, and PCFICH Power attributes that you specify are used for the measurement.
RFMXLTE_VAL_AUTO_CONTROL_CHANNEL_POWER_DETECTION_ENABLED_TRUE (1) The value of the PSS Power, SSS Power, PDCCH Power, PBCH Power, and PCFICH Power attributes are auto-detected and used for the measurement.
autoPCFICHCFIDetectionEnabled int32 Specifies whether the value of RFMXLTE_ATTR_PCFICH_CFI) attribute is auto-detected by the measurement or user-specified.
This parameter is not valid, when you set the RFMXLTE_ATTR_DOWNLINK_CHANNEL_CONFIGURATION_MODE attribute to RFMXLTE_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_TEST_MODEL.
RFMXLTE_VAL_AUTO_PCFICH_CFI_DETECTION_ENABLED_FALSE (0) The value of RFMXLTE_ATTR_PCFICH_CFI attribute that you specify is used for the measurement.
RFMXLTE_VAL_AUTO_PCFICH_CFI_DETECTION_ENABLED_TRUE (1) The value of RFMXLTE_ATTR_PCFICH_CFI attribute is auto-detected and used for the measurement. This value is obtained by decoding the PCFICH channel.
reserved int32 This parameter is not supported in this release and it is reserved for future enhancements.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgCellSpecificRatio

int32 __stdcall RFmxLTE_CfgCellSpecificRatio (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 cellSpecificRatio);

Purpose

Configures the cellSpecificRatio parameter. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
cellSpecificRatio int32 Specifies the ratio �b/�a for the cell-specific ratio of one, two, or four cell-specific antenna ports as described in Table 5.2-1 in section 5.2 of the 3GPP TS 36.213 Specifications. This parameter determines the power of the channel resource element (RE) in the symbols that do not contain the reference symbols.
RFMXLTE_VAL_DOWNLINK_USER_DEFINED_RATIO_P_B0 (0) Specifies a ratio of 1 for one antenna port and 5/4 for two or four antenna ports.
RFMXLTE_VAL_DOWNLINK_USER_DEFINED_RATIO_P_B1 (1) Specifies a ratio of 4/5 for one antenna port and 1 for two or four antenna ports.
RFMXLTE_VAL_DOWNLINK_USER_DEFINED_RATIO_P_B2 (2) Specifies a ratio of 3/5 for one antenna port and 3/4 for two or four antenna ports.
RFMXLTE_VAL_DOWNLINK_USER_DEFINED_RATIO_P_B3 (3) Specifies a ratio of 2/5 for one antenna port and 1/2 for two or four antenna ports.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgDownlinkSynchronizationSignal

int32 __stdcall RFmxLTE_CfgDownlinkSynchronizationSignal (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 PSSPower, float64 SSSPower);

Purpose

Configures the synchronization signal power relative to the cell-specific reference signal. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
PSSPower float64 Specifies the power of the primary synchronization signal (PSS) relative to the power of the cell-specific reference signal. This value is expressed in dB.
SSSPower float64 Specifies the power of the secondary synchronization signal (SSS) relative to the power of the cell-specific reference signal. This value is expressed in dB.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPBCH

int32 __stdcall RFmxLTE_CfgPBCH (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 PBCHPower);

Purpose

Configures the power of physical broadcast channel (PBCH) power relative to the cell-specific reference signal. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
PBCHPower float64 Specifies the power of the PBCH relative to the power of the cell-specific reference signal. This value is expressed in dB.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPDCCH

int32 __stdcall RFmxLTE_CfgPDCCH (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 PDCCHPower);

Purpose

Configures the physical downlink control channel (PDCCH) power relative to the cell-specific reference signal. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
PDCCHPower float64 Specifies the power of the PDCCH relative to the power of the cell-specific reference signal. This value is expressed in dB.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgDownlinkNumberOfSubframes

int32 __stdcall RFmxLTE_CfgDownlinkNumberOfSubframes (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfSubframes);

Purpose

Configures the number of unique subframes that are transmitted from the DUT. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
numberOfSubframes int32 Specifies the number of subframes to be configured. If you set the RFMXLTE_ATTR_DOWNLINK_CHANNEL_CONFIGURATION_MODE) attribute to RFMXLTE_VAL_DOWNLINK_CHANNEL_CONFIGURATION_MODE_TEST_MODEL, this parameter will be set to 10 for FDD and 20 for TDD by default.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPCFICH

int32 __stdcall RFmxLTE_CfgPCFICH (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 CFI, float64 power);

Purpose

Configures the CFI and power parameters of the physical control format indicator channel (PCFICH). Use "subframe<l>" or "carrier<k>" or "subblock<n>" or "subblock<n>/carrier<k>/subframe<l>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, carrier number, and subframe number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0/subframe0"
"signal::sig1/subblock0/carrier0/subframe0"
You can use the RFmxLTE_BuildSubframeString) function to build the selector string.
CFI int32 Specifies the control format indicator (CFI) carried by PCFICH. CFI is used to compute the number of OFDM symbols which will determine the size of physical downlink control channel (PDCCH) within a subframe.
power float64 Specifies the power of the PCFICH relative to the power of the cell-specific reference signal. This value is expressed in dB.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPHICH

int32 __stdcall RFmxLTE_CfgPHICH (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 resource, int32 duration, float64 power);

Purpose

Configures the resource, duration, and power parameters of the physical hybrid-ARQ indicator channel (PHICH). Use "subframe<l>" or "carrier<k>" or "subblock<n>" or "subblock<n>/carrier<k>/subframe<l>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, carrier number, and subframe number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0/subframe0"
"signal::sig1/subblock0/carrier0/subframe0"
You can use the RFmxLTE_BuildSubframeString) function to build the selector string.
resource int32 Specifies the PHICH resource value. This value is expressed in Ng. This parameter is used to calculate number of PHICH resource groups. Refer to section 6.9 of the 3GPP 36.211 specification for more information about PHICH.
duration int32 Specifies the PHICH duration.
power float64 Specifies the power of all BPSK symbols in a PHICH sequence. This value is expressed in dB.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgNumberOfPDSCHChannels

int32 __stdcall RFmxLTE_CfgNumberOfPDSCHChannels (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 numberOfPDSCHChannels);

Purpose

Configures the number of different physical downlink shared channel (PDSCH) allocations in a subframe. Use "subframe<l>" or "carrier<k>" or "subblock<n>" or "subblock<n>/carrier<k>/subframe<l>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, carrier number, and subframe number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0/subframe0"
"signal::sig1/subblock0/carrier0/subframe0"
You can use the RFmxLTE_BuildSubframeString) function to build the selector string.
numberOfPDSCHChannels int32 Specifies the number of PDSCH allocations in a subframe.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPDSCH

int32 __stdcall RFmxLTE_CfgPDSCH (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 CW0ModulationType, char resourceBlockAllocation[], float64 power);

Purpose

Configures the codeword0 modulation type, resource block, and relative power of a physical downlink shared channel (PDSCH) allocation. Use "PDSCH<m>" or "subframe<l>" or "carrier<k>" or "subblock<n>" or "subblock<n>/carrier<k>/subframe<l>/PDSCH<m>" as the selector string to configure or read this attribute.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, carrier number, subframe number, and PDSCH number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0/subframe0/PDSCH0"
"signal::sig1/subblock0/carrier0/subframe0/PDSCH0"
You can use the RFmxLTE_BuildPDSCHString) function to build the selector string.
CW0ModulationType int32 Specifies the modulation type of Codeword0 PDSCH allocation.
resourceBlockAllocation char[] Specifies the resource blocks of the PDSCH allocation.
The following string formats are supported fo this attribute:
1) RBStartValue1-RBStopValue1,RBStartValue2-RBStopValue2
2) RB1,RB2
3) RBStartValue1-RBStopValue1, RB1,RBStartValue2-RBStopValue2,RB2
For example: If the RB allocation is 0-5,7,8,10-15, the RB allocation string specifies contiguous resource blocks from 0 to 5, resource block 7, resource block 8, and contiguous resource blocks from 10 to 15.
power float64 Specifies the PDSCH power level (�a) relative to the power of the cell-specific reference signal. This value is expressed in dB. Measurement uses the cell specific Ratio attribute to calculate �b. Refer to section 3.3 of the 3GPP 36.521 specifications for more information about �a.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubblockString

int32 __stdcall RFmxLTE_BuildSubblockString (char selectorString[], int32 subblockNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subblock string to use as the selector string with the subblock configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
subblockNumber int32 Specifies the number of subblocks that are configured in the intra-band noncontiguous carrier aggregation. Set this parameter to 1, which is the default, for single carrier and intra-band contiguous carrier aggregation.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildCarrierString

int32 __stdcall RFmxLTE_BuildCarrierString (char selectorString[], int32 carrierNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the carrier string to use as the selector string with the SEM and ACP carrier configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
carrierNumber int32 Specifies the carrier number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubframeString

int32 __stdcall RFmxLTE_BuildSubframeString (char selectorString[], int32 subframeNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subframe string to use as the selector string with the configuration or the fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
subframeNumber int32 Specifies the subframe number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Sidelink Configuration

RFmxLTE_CfgPSSCHModulationType

int32 __stdcall RFmxLTE_CfgPSSCHModulationType (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 modulationType);

Purpose

Configures the modulation scheme used in the physical sidelink shared channel (PSSCH) channel of the signal being measured. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
modulationType int32 Specifies the modulation scheme used in the PSSCH channel of the signal being measured. The default value is RFMXLTE_VAL_PSSCH_MODULATION_TYPE_QPSK
RFMXLTE_VAL_PSSCH_MODULATION_TYPE_QPSK (0) Specifies a QPSK modulation scheme.
RFMXLTE_VAL_PSSCH_MODULATION_TYPE_QAM16 (1) Specifies a 16-QAM modulation scheme.
RFMXLTE_VAL_PSSCH_MODULATION_TYPE_QAM64 (2) Specifies a 64-QAM modulation scheme.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_CfgPSSCHResourceBlocks

int32 __stdcall RFmxLTE_CfgPSSCHResourceBlocks (niRFmxInstrHandle instrumentHandle, char selectorString[], int32 resourceBlockOffset, int32 numberOfResourceBlocks);

Purpose

Configures the start and number of resource blocks allocated for the physical sidelink shared channel (PSSCH) allocation. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to configure this function.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
resourceBlockOffset int32 Specifies the starting resource block number of the PSSCH allocation.
numberOfResourceBlocks int32 Specifies the number of consecutive resource blocks in the PSSCH allocation.

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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubblockString

int32 __stdcall RFmxLTE_BuildSubblockString (char selectorString[], int32 subblockNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subblock string to use as the selector string with the subblock configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
subblockNumber int32 Specifies the number of subblocks that are configured in the intra-band noncontiguous carrier aggregation. Set this parameter to 1, which is the default, for single carrier and intra-band contiguous carrier aggregation.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildCarrierString

int32 __stdcall RFmxLTE_BuildCarrierString (char selectorString[], int32 carrierNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the carrier string to use as the selector string with the SEM and ACP carrier configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
carrierNumber int32 Specifies the carrier number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize 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.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

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

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally