Roaming functions


Functions

VOID CuCmd_RoamingEnable (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Enables roaming.
VOID CuCmd_RoamingDisable (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Disables roaming.
VOID CuCmd_RoamingLowPassFilter (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the low-pass filter parameter.
VOID CuCmd_RoamingQualityIndicator (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the quality indicator.
VOID CuCmd_RoamingDataRetryThreshold (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingNumExpectedTbttForBSSLoss (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingTxRateThreshold (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingLowRssiThreshold (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingLowSnrThreshold (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingLowQualityForBackgroungScanCondition (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingNormalQualityForBackgroungScanCondition (THandle hCuCmd, ConParm_t parm[], U16 nParms)
VOID CuCmd_RoamingGetConfParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the roaming configuration.

Detailed Description


Function Documentation

VOID CuCmd_RoamingDataRetryThreshold ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the data retry threshold

This function configures the data retry threshold used for roaming.
When the data retry number exceeds this threshold, a roaming event of type ROAMING_TRIGGER_MAX_TX_RETRIES is triggered.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The data retry threshold (0 – 255; default = 20).
[in] nParms The number of parameters, which can be one of the following:
0 - No retry threshold is given. The function prints the current retry threshold.
1 - The retry threshold is configured on the driver.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_RoamingDisable ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Disables roaming.

This function disables the roaming feature.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
CuCmd_RoamingEnable()
Note:
When a roaming trigger is received while roaming is disabled, the station does not roam to a better AP.
By default, roaming is disabled.
Warning:

VOID CuCmd_RoamingEnable ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Enables roaming.

This function enables the roaming feature.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
CuCmd_RoamingDisable()
Note:
When the roaming trigger is received while roaming is enabled, the station attempts to roam to a better AP, if one is found.
A roaming trigger is an indication received from the driver or from the firmware that the current WLAN connection is terminated, is suspicious, is not good enough and so on.
For example: Low-quality trigger, security-attack trigger or AP-disconnect trigger.
By default, roaming is disabled.
Warning:

VOID CuCmd_RoamingGetConfParams ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the roaming configuration.

This function gets the roaming configuration from the driver and prints it.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
Note:
The following are printed:
Some general roaming parameters, such as whether roaming is disabled or enabled and so on
Roaming trigger thresholds, such as the low RSSI threshold, data retry threshold and so on
Warning:

VOID CuCmd_RoamingLowPassFilter ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Configures the low-pass filter parameter.

This function configures the low-pass filter roaming attempt parameter used in the roaming process.
The low-pass filter parameter specifies the time to wait, in seconds, before roaming is triggered due to a low-quality connection.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The low-pass filter roaming attempt parameters, in seconds (0 – 255; default = 30).
[in] nParms The number of parameters, which can be one of the following:
0 - No low-pass filter is given. The function prints the current low-pass filter.
1 - The given low-pass filter is configured on the driver.
Returns:
None
See also:
CuCmd_RoamingQualityIndicator()
Note:
Warning:

VOID CuCmd_RoamingLowQualityForBackgroungScanCondition ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the low quality condition

This function configures the low-quality background scan condition.
If the quality of the BSSID drops below this threshold, a roaming event of type ROAMING_TRIGGER_LOW_QUALITY_FOR_BG_SCAN is triggered and the background scan is activated more frequently.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The low-quality condition ([-150] – [-40]; default = -80 dBm).
[in] nParms the number of parameters, which can be one of the following:
0 - No low-quality condition is given. The function prints the current low-quality condition.
1 - The low-quality condition is configured on the driver.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_RoamingLowRssiThreshold ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the low RSSI threshold

This function configures the low RSSI threshold, in dBm, used for roaming. When the RSSI value drops below this threshold, a roaming event of type ROAMING_TRIGGER_LOW_QUALITY is triggered.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The low RSSI threshold ([-150] – 0; default = -70 dBm).
[in] nParms The number of parameters, which can be one of the following:
0 - No RSSI threshold is given. The function prints the current low RSSI threshold.
1 - The RSSI threshold is configured on the driver.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_RoamingLowSnrThreshold ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the low SNR threshold

This function configures the low SNR threshold used for roaming.
When the signal-to-noise ratio drops below this threshold, a roaming event of type ROAMING_TRIGGER_LOW_SNR is triggered.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The low SNR threshold (0 – 255; default = 0).
[in] nParms The number of parameters, which can be one of the following:
0 - No SNR threshold is given. The function prints the current low SNR threshold.
1 - The SNR threshold is configured on the driver.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_RoamingNormalQualityForBackgroungScanCondition ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the normal-quality condition

This function configures the normal-quality background scan condition.
If the quality of the BSSID exceeds this threshold, a roaming event of type ROAMING_TRIGGER_NORMAL_QUALITY_FOR_BG_SCAN is triggered and the background scan is activated less frequently.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The normal-quality condition ([-150] – [-40]; default = -70 dBm).
[in] nParms The number of parameters, which can be one of the following:
0 - No normal-quality threshold is given. The function prints the current normal-quality threshold.
1 - The normal-quality threshold is be configured on the driver.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_RoamingNumExpectedTbttForBSSLoss ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the TBTT threshold

This function configures the TBTT threshold used for roaming.
When the number of missing beacons exceeds this threshold, a roaming event of type ROAMING_TRIGGER_BSS_LOSS is triggered.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The beacon loss threshold (1 – 255; default = 10).
[in] nParms The number of parameters, which can be one of the following:
0 - No beacon loss threshold is given. The function prints the current beacon loss threshold.
1 - The beacon loss threshold is configured on the driver.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_RoamingQualityIndicator ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Configures the quality indicator.

This function configures the quality indicator parameter used in the roaming process.
The quality indicator is an RSSI level, in dBm.
During roaming, APs with an RSSI level lower than this value are not considered as candidates.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The quality indicator, in dBm ([-150] – 0; default = [-70]).
[in] nParms The number of parameters, which can be one of the following:
0 - No quality indicator is given. The function prints the current quality indicator.
1 - The quality indicator is configured on the driver.
Returns:
None
See also:
CuCmd_RoamingLowPassFilter()
Note:
Warning:

VOID CuCmd_RoamingTxRateThreshold ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the Tx rate threshold

This function configures the Tx rate threshold used for roaming.
When the Tx rate drops below this threshold, a roaming event of type ROAMING_TRIGGER_LOW_TX_RATE is triggered.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The Tx rate threshold (0 – 54; default = 2).
[in] nParms The number of parameters, which can be one of the following:
0 - No Tx rate threshold is given. The function prints the current Tx rate threshold.
1 - The Tx rate threshold is configured on the driver.
Returns:
None
See also:
Note:
Warning:


Generated on Sun Dec 6 12:34:03 2009 for WLAN DRIVER API REFERENCE MANUAL by  doxygen 1.5.9