WTM Functions

This topic describes the following functions:

• SetCIDValue

• GetSSRNGINFO

• GetSSPRDRNGINFO

• GetSSPRDInitRNGINFO

• ClearRNGINFO

• Get/Set RefRPValue

• Get/Set RNGRSPTimingMode

• Get/Set BSRNGRSPOffset

• Get/Set BSRNGRSP_PowerOffset

• Get/Set BSRNGRSP_FreqOffset

• Get/Set BSRNGRSP_TimeOffset

• Get/Set BSRNGRSP_Status

• Get/Set RNGRSPPowerMode

• GetTimingOffsetRTD

• GetTimingErrorValue

• StartMeasureMode

• StopMeasureMode

• GetULTTG

• GetULRTG

• GetULSymbol

E6651_SetCIDValue

Declaration

int E6651_SetCIDValue(BYTE MID, int Idx, WORD Value);

Parameter

MID [in]: User defined E6651A Machine ID

Idx [in]: The CID to be allocated the value specified by this command.

Value [in]: E6651’s Connection ID (CID) to be set.

Idx:
0 - Basic CID
1 - Primary CID
2 - UL burst CID
3 - DL burst CID

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Configure a connection ID value for a specified connection - Basic, Primary, UL burst and DL burst.

E6651_GetSSRNGINFO

Declaration

int E6651_GetSSRNGINFO(BYTE MID, double* dPW1, int* nPLW, int* nDPW, int* nFOW, int* nSuccess);

Parameter

MID [in]: User defined E6651A Machine ID

dPW1 [out] : Calculated Ranging Power from Ranging Message.

nPLW [out] : Detect Power from DSP.

nDPW [out] : Detect Position.

nFOW [out] : Frequency Offset.

Return Value

nSuccess:

Status
1 - Continue
2 - Abort
3 - Success

Failure: STATE_ERROR(-1)

Description

Retrieve Ranging Information.

E6651_GetSSPRDRNGINFO

Declaration

int E6651_GetSSPRDRNGINFO(BYTE MID, double* dPW1, int* nPLW, int* nDPW, int* nFOW, int* nSuccess);

Parameter

MID [in]: User defined E6651A Machine ID

dPW1 [out] : Calculated Ranging Power from Periodic Ranging Message.

nPLW [out] : Detect Power from DSP.

nDPW [out] : Detect Position.

nFOW [out] : Frequency Offset.

Return Value

nSuccess:

Status
1 - Continue
2 - Abort
3 - Success

Failure: STATE_ERROR(-1)

Description

Retrieve Periodic Ranging Information.

E6651_GetSSPRDInitRNGINFO

Declaration

int E6651_GetSSPRDInitRNGINFO(BYTE MID, double* dPW1, int* nPLW, int* nDPW, int* nFOW, int* nSuccess);

Parameter

MID [in]: User defined E6651A Machine ID

dPW1 [out] : Calculated Ranging Power from PRD(INI) Ranging Message.

nPLW [out] : Detect Power from DSP.

nDPW [out] : Detect Position.

nFOW [out] : Frequency Offset.

Return Value

nSuccess:

Status
1 - Continue
2 - Abort
3 - Success

Failure: STATE_ERROR(-1)

Description

Retrieve PRD(INI) Ranging Information.

E6651_ClearRNGINFO

Declaration

int E6651_ClearRNGINFO(BYTE MID);

Parameter

MID [in]: User defined E6651A Machine ID

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Reset the parameters' values of various Ranging messages, dPW1, nPLW, nDPW, and nFOW to 0 (zero).

E6651_Get/Set RefRPValue

Declaration

int E6651_GetRefRPValue(BYTE MID, double* Value);  

int E6651_SetRefRPValue(BYTE MID, double Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current reference ranging power value.

Value [in]: Set the power threshold, in dBm, to declare initial ranging success.

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieves or sets power threshold to determine the success of initial ranging. If measured power of initial ranging exceeds the threshold, E6651A declares initial ranging success.

E6651_Get/Set RNGRSPTimingMode

Declaration

int E6651_GetRNGRSPTimingMode(BYTE MID, int* Value);

int E6651_SetRNGRSPTimingMode(BYTE MID, int Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current timing offset determination mode.

Value [in]: Set the method used to determine the timing offset.

0 - default
1 - DPW method.

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieves or sets the timing offset determination mode. Timing offset can be set as either the default value (calculated from DL start position and RTD value) or DPW value from the initial ranging message from the DUT. The timing offset is used for timing reference when E6651A demodulates UL signal.

E6651_Get/Set BSRNGRSPOffset

Declaration

int E6651_GetBSRNGRSPOffset(BYTE MID, int* Value);

int E6651_SetBSRNGRSPOffset(BYTE MID, int Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current power offset value for Initial Ranging or Periodic Ranging in dB.

Value [in]: Set the power offset value for Initial Ranging or Periodic Ranging in dB.

Default

0 dB

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the power offset value for Initial Ranging or Periodic Ranging.

E6651_Get/Set BSRNGRSP_PowerOffset

Declaration

int E6651_GetBSRNGRSP_PowerOffset(BYTE MID, int * Value);

int E6651_SetBSRNGRSP_PowerOffset(BYTE MID, int Value);

Parameter

MID [in]: User defined E6651A Machine ID.

Value [out]: Current Power Offset of E6651(MID) in dB.

Value [in]: Set the Power Offset value in dB.

Default

0 dB

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the overall power offset value in dB.

E6651_Get/Set BSRNGRSP_FreqOffset

Declaration

int E6651_GetBSRNGRSP_FreqOffset(BYTE MID, int * Value);

int E6651_SetBSRNGRSP_FreqOffset(BYTE MID, int Value);

Parameter

MID [in]: User defined E6651A Machine ID.

Value [out]: Current Frequency Offset value of E6651(MID)

Value [in]: Frequency Offset value to be set in Hz.

Default

0 Hz

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the Frequency Offset value of E6651(MID).

E6651_Get/Set BSRNGRSP_TimeOffset

Declaration

int E6651_GetBSRNGRSP_TimeOffset(BYTE MID, double* Value);

int E6651_SetBSRNGRSP_TimeOffset(BYTE MID, double Value);

Parameter

MID [in]: User defined E6651A Machine ID.

Value [out]: Current Time Offset of E6651(MID).

Value [in]: Time Offset of E6651(MID) to be set.

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the Time Offset of the E6651A during Initial Ranging. Units of set value: 0.25 * n ps.

E6651_Get/Set BSRNGRSP_Status

Declaration

int E6651_GetBSRNGRSP_Status(BYTE MID, int* Value);

int E6651_SetBSRNGRSP_Status(BYTE MID, int Value);

Parameter

MID [in]: User defined E6651A Machine ID.

Value [out]: Current State value of RNG-RSP msg. Transmission Mode.

Value [in]: State value of RNG-RSP msg. Transmission Mode to be set.

• 0 - Auto

• 1 if Transmission mode is always ‘Continue’ when a mobile phone is trying Initial Ranging.

• 2 if Transmission mode is always ‘Abort’ when a mobile phone is trying Initial Ranging.

• 3 if Transmission mode is always ‘Success’ when a mobile phone is trying Initial Ranging.

• 4 - Block

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve  and set the Status value of Initial Ranging’ Result Transmission Mode.

E6651_Get/Set RNGRSPPowerMode

Declaration

int E6651_GetRNGRSPPowerMode(BYTE MID, int* Value);

int E6651_SetRNGRSPPowerMode(BYTE MID, int Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current power mode value.

Value [in]: E6651’s setting to be set.

0 - Auto
1 - dBm

Default

0, Auto

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the power mode value. When retrieving E6651A's receiver power value from ranging response message or setting E6651A's receiver power value to determine successful ranging, the parameter determines the power value to be retrieved or set.

E6651_GetTimingOffsetRTD

Declaration

int E6651_GetTimingOffsetRTD(BYTE MID, int* Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Timing offset value calculated from RTD information when timing mode is "1".

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Returns timing offset value calculated from DPW in initial ranging message and RTD information.

E6651_GetTimingErrorValue

Declaration

int E6651_GetTimingErrorValue(BYTE MID, double* Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: The current timing error value in SA. It's the deviation error from DP value of 200 when in BSE mode. The error can be varied according to UL timing offset variation.

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve the current timing error value in SA.

E6651_StartMeasureMode

Declaration

int E6651_StartMeasureMode(BYTE MID);

Parameter

MID [in]: User defined E6651A Machine ID

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Set "Measure Mode Start Flag" as "1". Start measurement mode.

E6651_StopMeasureMode

Declaration

int E6651_StopMeasureMode(BYTE MID, double* MAXValue, double* MINValue);

Parameter

MID [in]: User defined E6651A Machine ID

MAXValue [out] : The maximum measured power value.

MINValue[out] : The minimum measured power value.

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Returns the maximum and the minimum power information from the start of measurement mode (Measurement mode start) to the end of measurement mode (Measurement mode stop).

E6651_GetULTTG

Declaration

int E6651_GetULTTG(BYTE MID, double* Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: The current TTG (Transmit Time Gab) value

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve the TTG value when E6651A(MID) is operating.

E6651_GetULRTG

Declaration

int E6651_GetULRTG(BYTE MID, double* Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: The current RTG (Receive Time Gab) value.

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve the RTG value when E6651A(MID) is operating.

E6651_GetULSymbol

Declaration

int E6651_GetULSymbol(BYTE MID, int* Value);

MID [in]: User defined E6651A Machine ID

Value [out]: UL symbol number of E6651 (dBm).

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve the UL symbol number of E6651A(MID).