c:/temp/src/cu_cmd.h File Reference

This file contains all WLAN API functions exposed to the user. More...

Go to the source code of this file.

Data Structures

struct  named_value_t

Functions

THandle CuCmd_Create (const PS8 device_name, THandle hConsole, S32 BypassSupplicant, PS8 pSupplIfFile)
 Creates the command module.
VOID CuCmd_Destroy (THandle hCuCmd)
 Destroys the command module.
VOID CuCmd_StartDriver (THandle hCuCmd)
 Starts the driver.
VOID CuCmd_StopDriver (THandle hCuCmd)
 Stops the driver.
S32 CuCmd_GetDeviceStatus (THandle hCuCmd)
 Gets the driver status.
THandle CuCmd_GetCuCommonHandle (THandle hCuCmd)
 Gets the CU Common module pointer.
THandle CuCmd_GetCuWpaHandle (THandle hCuCmd)
 Gets the supplicant pointer.
VOID CuCmd_Show_Status (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the station status information.
VOID CuCmd_BssidList (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSSID list.
VOID CuCmd_FullBssidList (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSSID list with complete information.
VOID CuCmd_StartEnrolleePIN (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts the enrollee PIN method.
VOID CuCmd_StartEnrolleePBC (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts the enrollee PBC method.
VOID CuCmd_StopEnrollee (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Stops the WSC process.
VOID CuCmd_SetPin (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the PIN.
VOID CuCmd_Connect (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Connects to a BSSID.
VOID CuCmd_Disassociate (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Disconnects from the BSSID.
VOID CuCmd_ModifyChannel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the applicable channel.
VOID CuCmd_ModifyConnectMode (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the applicable connection mode.
VOID CuCmd_GetTxRate (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the Tx rate.
VOID CuCmd_ModifyBssType (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the BSS type.
VOID CuCmd_ModifyFragTh (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the fragmentation threshold.
VOID CuCmd_ModifyRtsTh (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the RTS threshold.
VOID CuCmd_ModifyPreamble (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the preamble mode.
VOID CuCmd_ModifyShortSlot (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the slot time.
VOID CuCmd_RadioOnOff (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the radio activation mode.
VOID CuCmd_GetSelectedBssidInfo (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the selected BSSID information.
VOID CuCmd_GetRsiiLevel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the RSSI level.
VOID CuCmd_GetSnrRatio (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the SNR ratio.
VOID CuCmd_TxPowerDbm (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the transmission power.
VOID CuCmd_ModifyState_802_11d (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures regulatory domain support.
VOID CuCmd_ModifyState_802_11h (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures spectrum management support.
VOID CuCmd_D_Country_2_4Ie (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the country IE for the 2.4GHz band.
VOID CuCmd_D_Country_5Ie (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the country IE for the 5.0GHz band.
VOID CuCmd_ModifyDfsRange (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the DFS range.
VOID CuCmd_SetBeaconFilterDesiredState (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the beacon filter state.
VOID CuCmd_GetBeaconFilterDesiredState (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the beacon filter state.
VOID CuCmd_ModifySupportedRates (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the supported rates.
VOID CuCmd_SendHealthCheck (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Performs a health check.
VOID CuCmd_EnableRxDataFilters (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Enables Rx data filtering.
VOID CuCmd_DisableRxDataFilters (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Disables Rx data filtering.
VOID CuCmd_AddRxDataFilter (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds an Rx data filter.
VOID CuCmd_RemoveRxDataFilter (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Removes an Rx data filter.
VOID CuCmd_GetRxDataFiltersStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows Rx data filter statistics.
VOID CuCmd_ShowStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the driver basic statistics.
VOID CuCmd_ShowTxStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the Tx statistics.
VOID CuCmd_ShowAdvancedParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows driver advanced statistics.
VOID CuCmd_ScanAppGlobalConfig (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures application scan parameters.
VOID CuCmd_ScanAppChannelConfig (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures channel scan parameters.
VOID CuCmd_ScanAppClear (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Clears the application scan.
VOID CuCmd_ScanAppDisplay (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the application scan.
VOID CuCmd_StartScan (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts the application scan.
VOID CuCmd_StopScan (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Stops the application scan.
VOID CuCmd_WextStartScan (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts a default scan.
VOID CuCmd_ConfigPeriodicScanGlobal (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures periodic scan parameters.
VOID CuCmd_ConfigPeriodicScanInterval (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the periodic scan interval.
VOID CuCmd_ConfigurePeriodicScanSsid (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the periodic scan SSID list.
VOID CuCmd_ConfigurePeriodicScanChannel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures a periodic scan’s channel parameters.
VOID CuCmd_ClearPeriodicScanConfiguration (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Clears a periodic scan.
VOID CuCmd_DisplayPeriodicScanConfiguration (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the periodic scan.
VOID CuCmd_StartPeriodicScan (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts a periodic scan.
VOID CuCmd_StopPeriodicScan (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Stops a periodic scan.
VOID CuCmd_ConfigScanPolicy (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures continuous scan parameters.
VOID CuCmd_ConfigScanBand (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the continuous scan band parameters.
VOID CuCmd_ConfigScanBandChannel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the channels list for each band defined for the continuous scan.
VOID CuCmd_ConfigScanBandTrack (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the policy for the tracking scan method.
VOID CuCmd_ConfigScanBandDiscover (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the policy for the discover scan method.
VOID CuCmd_ConfigScanBandImmed (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the policy for the immediate scan method.
VOID CuCmd_DisplayScanPolicy (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows continuous scan parameters.
VOID CuCmd_ClearScanPolicy (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Clears a continuous scan.
VOID CuCmd_SetScanPolicy (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the continuous scan policy.
VOID CuCmd_GetScanBssList (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSS list.
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.
VOID CuCmd_CurrBssUserDefinedTrigger (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures a user-defined trigger.
VOID CuCmd_AddTspec (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a TSPEC.
VOID CuCmd_GetTspec (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Gets a TSPEC.
VOID CuCmd_DeleteTspec (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Deletes a TSPEC.
VOID CuCmd_GetApQosParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSSID QoS per AC configuration.
VOID CuCmd_GetPsRxStreamingParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows Rx streaming parameters.
VOID CuCmd_GetApQosCapabilities (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSSID global QoS configuration.
VOID CuCmd_GetAcStatus (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the access category status.
VOID CuCmd_ModifyMediumUsageTh (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the medium usage threshold.
VOID CuCmd_GetDesiredPsMode (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the power-save mode.
VOID CuCmd_InsertClsfrEntry (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a classifier.
VOID CuCmd_RemoveClsfrEntry (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Removes a classifier.
VOID CuCmd_SetPsRxDelivery (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures power-save Rx delivery.
VOID CuCmd_SetQosParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the QoS parameters.
VOID CuCmd_SetRxTimeOut (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the Rx timeout.
VOID CuCmd_RegisterEvents (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Registers for events.
VOID CuCmd_UnregisterEvents (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Unregisters reception of events.
VOID CuCmd_EnableBtCoe (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets BlueTooth Coexistence mode.
VOID CuCmd_ConfigBtCoe (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures BlueTooth Coexistence parameters.
VOID CuCmd_GetBtCoeStatus (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BlueTooth Coexistence configuration and status.
VOID CuCmd_SetPowerMode (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the default power mode profile.
VOID CuCmd_SetPowerSavePowerLevel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the power-save power level.
VOID CuCmd_SetDefaultPowerLevel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the default power level.
VOID CuCmd_SetDozeModeInAutoPowerLevel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the doze mode.
VOID CuCmd_SetTrafficIntensityTh (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the traffic intensity.
VOID CuCmd_EnableTrafficEvents (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Enables traffic events.
VOID CuCmd_DisableTrafficEvents (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Disables traffic events.
VOID CuCmd_AddReport (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a report module.
VOID CuCmd_ClearReport (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Clears a report module.
VOID CuCmd_ReportSeverityLevel (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a report severity.
VOID CuCmd_PrintDriverDebug (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Calls a debug function.
VOID CuCmd_SetRateMngDebug (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the rate management.
VOID CuCmd_GetRateMngDebug (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows rate management parameters.
VOID CuCmd_ShowAbout (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the driver and firmware versions.
VOID CuCmd_Quit (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Quits the CLI.
VOID CuCmd_RadioDebug_ChannelTune (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Tunes the radio.
VOID CuCmd_RadioDebug_StartTxCw (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts the carrier wave test.
VOID CuCmd_RadioDebug_StartContinuousTx (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 FCC test.
VOID CuCmd_RadioDebug_StopTx (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Stops Tx transmission.
VOID CuCmd_RadioDebug_StartRxStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts Rx statistics.
VOID CuCmd_RadioDebug_StopRxStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Stops Rx statistics.
VOID CuCmd_RadioDebug_ResetRxStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Resets Rx statistics.
VOID CuCmd_RadioDebug_GetRxStatistics (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Gets Rx statistics.
VOID CuCmd_RadioDebug_GetHDKVersion (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Gets the HDK version.
VOID CuCmd_BIP_StartBIP (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts calibration.
VOID CuCmd_BIP_EnterRxBIP (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Enters the Rx calibration state.
VOID CuCmd_BIP_StartRxBIP (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Starts Rx calibration.
VOID CuCmd_BIP_ExitRxBIP (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Exits Rx calibration.
VOID CuCmd_BIP_BufferCalReferencePoint (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Sets the buffer calibration reference point.
VOID CuCmd_SetPrivacyAuth (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the authentication type.
VOID CuCmd_SetPrivacyEap (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the EAP protocol.
VOID CuCmd_SetPrivacyEncryption (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the encryption type.
VOID CuCmd_SetPrivacyKeyType (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the key type.
VOID CuCmd_SetPrivacyMixedMode (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the mixed mode.
VOID CuCmd_SetPrivacyAnyWpaMode (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the Any WPA mode.
VOID CuCmd_SetPrivacyCredentials (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the privacy credentials.
VOID CuCmd_SetPrivacyPskPassPhrase (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the private shared key (PSK).
VOID CuCmd_SetPrivacyCertificate (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the certificate path.
VOID CuCmd_StopSuppl (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Stops the supplicant.
VOID CuCmd_ChangeSupplDebugLevels (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the supplicant debug levels.
VOID CuCmd_AddPrivacyKey (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the WEP key.
VOID CuCmd_RemovePrivacyKey (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Removes the WEP key.
VOID CuCmd_GetPrivacyDefaultKey (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the WEP default key ID.
VOID CuCmd_EnableKeepAlive (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Enables the keep-alive mechanism.
VOID CuCmd_DisableKeepAlive (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Disables the keep-alive mechanism.
VOID CuCmd_AddKeepAliveMessage (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a keep-alive message.
VOID CuCmd_RemoveKeepAliveMessage (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Removes a keep-alive message.
VOID CuCmd_ShowKeepAlive (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the keep-alive configuration.
VOID Cucmd_ShowPowerConsumptionStats (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the power consumption statistics.


Detailed Description

This file contains all WLAN API functions exposed to the user.

Definition in file cu_cmd.h.


Function Documentation

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

Adds a report module.

This function enables the report mechanism for a specific module.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The report module to be enabled (0 - 137, each number corresponds to a specific module, 138 - enables all modules, by default, all modules are enabled).
[in] nParms The number of parameters, which can be one of the following:
0 - No module is given. The function prints the current report modules table.
Each enabled module is printed with a preceding plus sign.
1 - A module is given. The report mechanism is enabled for the module.
Returns:
None
See also:
CuCmd_ClearReport()
Note:
When a report module is enabled, a report message for this module is printed according to the message severity. A message is printed only if both its report module and severity are enabled. For a list of all modules, use this command with no parameters.
Warning:

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

Adds an Rx data filter.

This function adds an Rx data filter to the firmware. Rx frames matching this filter are forwarded to the driver.
The decision about whether or not a frame matches the filter is made by the firmware.
The firmware compares selected bytes inside the frame to a given pattern.
The location and number of those selected bytes are given by the offset and mask parameters.
If the compared bytes match the pattern, the frame is forwarded to the driver.

Parameters:
[in] hCuCmd Handle for the command module.
[in] parm parm[0] The offset inside the frame from which to start the comparison.
parm[1] A mask compound consisting of an eight digit number that represents the bytes to compare. Each digit represents a byte (0 - do not compare, 1 - compare).
parm[2] A string of bytes that represents the pattern value that the compared bytes should match.
[in] nParms Always 3.
Returns:
None
See also:
CuCmd_RemoveRxDataFilter(), CuCmd_EnableRxDataFilters()
Note:
A maximum of four Rx filters can be defined.
Warning:

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

Clears a report module.

This function disables the report mechanism for a specific module.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The report module to be disabled (0 - 137, each number corresponds to a specific module, 138 - disables all modules).
[in] nParms The number of parameters, which can be one of the following:
0 - No module is given. The function prints the current report modules table.
Each enabled module is printed with a preceding plus sign.
1 - A module is given. The report mechanism is disabled for the module.
Returns:
None
See also:
CuCmd_AddReport()
Note:
When a report module is disabled, the report messages of this module are not printed, regardless of the message severity. For a list of all modules, use this command with no parameters.
Warning:

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

Configures a user-defined trigger.

This function configures a user defined trigger on the driver.
The station monitors the traffic according to the user configuration and generates the matching trigger accordingly.
The user can use these triggers as inputs to his or her own roaming mechanism.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] Trigger index (0 - 1)
parm[1] RSSI or SNR Threshold, in dBm / dB ([-100] - 100)
parm[2] Minimum delay, in msecs, between consecutive triggers of the same event (0 – 60,000)
parm[3] The type of traffic to monitor, which can be one of the followings:
0 - Beacon RSSI
1 - Data RSSI
2 - Beacon SNR
3 - Data SNR
parm[4] An indication of when to issue the trigger, which can be one of the following:
0 - Level triggers are continuously raised (at a configurable period) when the RSSI/SNR level is below or above the threshold.
1 - Edge triggers are raised once when the RSSI/SNR level crosses the threshold value in the configured direction.
parm[5] The trigger direction, which can be one of the following:
0 – Down: The trigger is issued when crossing the threshold in the down direction.
1 – Up: The trigger is issued when crossing the threshold in the up direction.
2 – Both: The trigger is issued when crossing the threshold in both directions. This is used only for Edge triggers.
parm[6] The hysteresis range around the threshold value.
This determines the range in which changes to the compared metric do not cause a retriggering of the event.
It is used only for Edge triggers.
parm[7] Enables / disables the trigger (0 - disable, 1 - enable),
[in] nParms Always 8
Returns:
None
See also:
Note:
Warning:

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

Configures the country IE for the 2.4GHz band.

This function configures the country IE for the 2.4GHz band. This IE is part of the regulatory domain standard. It defines which channels can be used.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms The number of parameters, which can be one of the following:
0 - No country IE is given. The function prints the current country IE.
1 - The following default regulatory domain parameters are configured on the driver:
  • Country string - GB
  • First channel number - 1
  • Max. Tx power level - 23
  • Number of channels - 11
Returns:
None
See also:
Note:
The driver sets the supported channels according to this IE.
Warning:

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

Configures the country IE for the 5.0GHz band.

This function configures the country IE for the 5.0GHz band. This IE is part of the regulatory domain standard. It defines which channels can be used.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms The number of parameters, which can be one of the following:
0 - No country IE is given. The function prints the current country IE.
1 - The following default regulatory domain parameters are configured on the driver:
  • Country string - US
  • First channel number - 36
  • Max. Tx power level - 13
  • Number of channels - 8
Returns:
None
See also:
Note:
The driver sets the supported channels according to this IE.
Warning:

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

Disables Rx data filtering.

This function disables the Rx data filter.

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_EnableRxDataFilters()
Note:
By default, Rx filtering is disabled.
Warning:

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

Disables traffic events.

This function disables traffic event notifications.

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_EnableTrafficEvents(), CuCmd_SetTrafficIntensityTh()
Note:
Warning:

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

Enables Rx data filtering.

This function enables the Rx data filter.

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_DisableRxDataFilters(), CuCmd_AddRxDataFilter()
Note:
When Rx filtering is enabled, the firmware forwards to the driver, Rx data frames that match one of the configured filters.
If an Rx frame does not match any filter or no filter is configured, the firmware handles the frame according to the default action configured in the registry.
This default action can be one of the following:
0 - Frame is dropped.
1 - Frame is delivered to the driver (this is also the default value for the default action).
2 - The firmware handles the frame and does not forward it to the driver.
By default, Rx filtering is disabled.
Warning:

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

Enables traffic events.

This function enables traffic event notifications.

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_DisableTrafficEvents(), CuCmd_SetTrafficIntensityTh()
Note:
When traffic event notifications are enabled, the station monitors the traffic amount over a specified time and sends notifications to the CLI.
By default, this feature is disabled.
Two thresholds are defined: Low and High. The station tracks the traffic over a given time interval.
When this interval ends, the station checks whether the traffic crossed the given thresholds.
If yes, it calls a callback function that sends a corresponding IPC event to the CLI.

In order to get this event notification, three conditions must be fulfilled:
  • The traffic event notification feature should be enabled (using this function).
  • The user should register for the IPC event IPC_EVENT_TRAFFIC_INTENSITY_THRESHOLD_CROSSED (using the function CuCmd_RegisterEvents()).
    When this event is received at the CLI, it is printed to the screen.
  • The user should configure the thresholds and time interval (using the function CuCmd_SetTrafficIntensityTh()).

There is only one traffic threshold IPC event, but it used to report four different events:

  • The high threshold crossed in the up direction
  • The high threshold crossed in the down direction
  • The low threshold crossed in the up direction
  • The low threshold crossed in the down direction
    Warning:

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

Shows the beacon filter state.

This function gets the beacon filter state 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:
CuCmd_SetBeaconFilterDesiredState()
Note:
Please refer to the function CuCmd_SetBeaconFilterDesiredState() for a description of the states.
Warning:

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

Shows rate management parameters.

This function gets the rate management parameters used by the firmware from the driver and prints them.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] If nParam does not equal 0, it represents the parameter to be printed (0 - 15, 14 - print the rate retry policy for each rate, 15 - print all parameters).
[in] nParms The number of parameters, which can be one of the following:
0 - The current values of all the rate management parameters used by the firmware are printed.
1 - The current value of the rate management parameter defined in parm[0] is printed.
Returns:
None
See also:
CuCmd_SetRateMngDebug()
Note:
Warning:

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

Shows the RSSI level.

This function gets from the driver, the average RSSI level of the network to which it is associated 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:
Two values are printed: the beacons average RSSI level and the data average RSSI level.
The values are in dBm units.
Warning:

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

Shows Rx data filter statistics.

This function gets the Rx data filter statistics from the driver and prints them.
The following statistics are printed:

  • The number of frames that did not match any of the filters (while Rx data filtering was enabled)
  • For each filter, the number of frames that matched the filter

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_AddRxDataFilter(), CuCmd_EnableRxDataFilters()
Note:
Warning:

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

Shows the selected BSSID information.

This function gets from the driver, the SSID and BSSID of the network to which it is associated and prints them.

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:
If the station is not associated, the SSID and BSSID are empty.
Warning:

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

Shows the SNR ratio.

This function gets from the driver, the average SNR ratio of the network to which it is associated 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:
Two values are printed: the beacons average SNR ratio and the data average SNR ratio.
Warning:

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

Shows the Tx rate.

This function gets the transmission rate, in Mbps, 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:
Warning:

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

Configures the DFS range.

It defines the minimum and maximum channel numbers when working in Dynamic Frequency Selection (DFS). This is part of the 802.11h standard.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] Defines the minimum DFS channel number
parm[1] Defines the maximum DFS channel number
[in] nParms The number of parameters, which can be one of the following:
0 - No DFS range is given. The function prints the DFS range (minimum and maximum DFS channel numbers).
2 - The minimum DFS channel number and maximum DFS channel number are configured on the driver.
Returns:
None
See also:
Note:
Warning:

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

Configures regulatory domain support.

This function configures regulatory domain support, as defined in the 802.11d standard.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The regulatory domain support(0 - disabled, 1 – enabled; default = 0)
[in] nParms The number of parameters, which can be one of the following:
0 - No support mode is given. The function prints the current regulatory domain support mode.
1 - The support mode is configured on the driver.
Returns:
None
See also:
CuCmd_ModifyState_802_11h()
Note:
The regulatory domain support cannot be disabled when spectrum management support is enabled.
Warning:

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

Configures spectrum management support.

This function configures spectrum management support, as defined in the 802.11h standard.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The spectrum management support(0 - disabled, 1 – enabled; default = 0)
[in] nParms The number of parameters, which can be one of the following:
0 - No support mode is given. The function prints the current spectrum management support mode.
1 - The support mode is configured on the driver.
Returns:
None
See also:
CuCmd_ModifyState_802_11d()
Note:
When enabling spectrum management support, regulatory domain support is enabled automatically.
Warning:

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

Modifies the supported rates.

This function configures the supported rates on the driver.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] A list defining the desired supported rates
  • B mode rates: 1 2 5.5 11
  • G mode rates: 1 2 5.5 6 9 11 12 18 24 36 48 54.
  • A mode rates: 6 9 12 18 24 36 48 54
  • N mode rates: 6.5 13 19.5 26 39 52 58.5 65
[in] nParms Can be one of the following:
0 - No rates are given. The supported rates are printed. If a rate is also a basic one, it is so indicated.
1 - The supported rates are configured on the driver.
Returns:
None
See also:
Note:
Warning:

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

Calls a debug function.

This function calls a specific driver debug function, based on the ID.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The ID of the debug function to be called (a three- or four-digit number). There are 23 debug modules. The function IDs of each module start with a specific digit(s).
Use this function with a 0 value to see a list of all debug modules.
Use this function with a specific module value and two zeros to see a list of all debug function IDs for this module (for example, 500).
parm[1] If nParms equals 2 and the function type is not READ REGISTER, the function is called with this parameter as an input.
If nParms equals 2 and the function type is READ REGISTER, this is the register address from which to read. The function reads this register and prints its value.
If nParms equals 3, the function type must be WRITE REGISTER. This is the address of the register to which to write. The function writes parm[2] in this address.
parm[2] Used only when the debug function is WRITE REGISTER. The function writes this parameter into the register address given in parm[1].
[in] nParms The number of parameters, which can be one of the following:
1 - For a standard debug function with no input parameters
2 - For a standard debug function with an input or a READ REGISTER function.
3 - For a WRITE REGISTER function.
Returns:
None
See also:
Note:
Warning:

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

Quits the CLI.

This function quits the WLAN CLI.
In order to return to the WLAN CLI, you should reactivate the WLAN utility by calling './wlan_cu' from the WLAN directory.

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:
Warning:

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

Modifies the radio activation mode.

This function configures the radio activation on the driver.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The radio activation mode value (0 - off, 1 – on; default = 1)
[in] nParms The number of parameters, which can be one of the following:
0 - No radio activation is given. The function prints the current radio activation mode and the available values.
1 - The activation mode is configured on the driver.
Returns:
None
See also:
Note:
The radio activation defines whether the radio is on or off.
Warning:

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

Registers for events.

This function enables reception of an IPC event.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The event value
[in] nParms The number of parameters, which can be one of the following:
0 - No event is given. The function prints the events list.
1 - The event is enabled.
Returns:
None
See also:
CuCmd_UnregisterEvents()
Note:
Events are sent from the driver to the application layer using an IPC socket.
They are always received by the application. This function enables their printing by the application.
By default, all events are disabled.
Warning:

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

Removes an Rx data filter.

This function removes a previously configured Rx data filter.

Parameters:
[in] hCuCmd Handle for the command module.
[in] parm parm[0] The offset inside the frame from which to start the comparison.
parm[1] A mask compound consisting of an eight digit number that represents the bytes to compare. Each digit represents a byte (0 - do not compare, 1 - compare).
parm[2] A string of bytes that represents the pattern value that the compared bytes should match.
[in] nParms Always 3.
Returns:
None
See also:
CuCmd_AddRxDataFilter()
Note:
Warning:

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

Adds a report severity.

This function enables the report messages for a specific severity.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The severity number to be enabled (1 - 7, each number corresponds to a specific severity, 8 - enables all severities, 0 - disables all severities, by default, severities ERROR + FATAL_ERROR + CLI are enabled).
[in] nParms The number of parameters, which can be one of the following:
0 - No severity is given. The function prints the current severities table.
Each enabled severity is printed with a preceding plus sign.
1 - A severity is given. The report mechanism is enabled for the severity.
Returns:
None
See also:
Note:
When a report severity is enabled, the messages of this severity are printed only for the report modules that are enabled. For a list of all severities, use this command with no parameters.
Warning:

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

Performs a health check.

This function performs a health check for the firmware. It sends a command to the firmware in order to check that the firmware is alive.

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:
Warning:

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

Modifies the beacon filter state.

This function configures the beacon filter state on the driver.
Beacon filtering should be activated only when the station is in power save mode.
This feature defines whether and when to forward beacons from the firmware to the driver while in power save mode.
It operates only on beacons where the TIM bit is not set for the station.
If the TIM bit is set for the station, the beacon is always forwarded to the driver upon arrival.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The filter state value (0 - disabled, 1 – enabled; default = 1)
If the filter is disabled, all the beacons are forwarded from the firmware to the driver upon arrival.
If the filter is enabled, the beacons are buffered in the firmware until reaching the maximum number of beacons stored, and only then, are they forwarded to the driver.
The maximum number of beacons stored can be configured from the registry only (0 – 8; default = 1).
If configured to 0, the beacons are dropped.
[in] nParms The number of parameters, which can be one of the following:
0 - No filter state is given. The function prints the available filter states.
1 - The filter state is configured on the driver.
Returns:
None
See also:
CuCmd_GetBeaconFilterDesiredState()
Note:
Warning:

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

Modifies the rate management.

This function modifies the rate management parameters used by the firmware. The rate management parameters in the firmware are a compound of the following:

  • Some general parameters that serve all rates, such as Rate check up (indicates when to upgrade the rate) and so on
  • Rate retry policy for each rate

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] If nParam equals 2, it represents the parameter to be modified.
If nParam equals 14, it represents the retry policy parameter.
parm[1] If nParms equals 2, the parameter defined in parm[0] are set to this value.
If nParms equals 14, the rate retry policy of the first rate is set to this value.
parm[x] If nParms equals 14, the rate retry policy of the X rate is set to this value.
[in] nParms The number of parameters, which can be one of the following:
0 - The list of rate management parameters used by the firmware is printed.
2 - A specific parameter is modified.
14 - The rate retry policy for each rate is modified.
Returns:
None
See also:
CuCmd_GetRateMngDebug()
Note:
Warning:

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

Shows the driver and firmware versions.

This function gets driver and firmware versions and prints them.

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:
Warning:

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

Shows driver advanced statistics.

This function gets advanced statistics from the driver and prints them.

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:
  • Additional WLAN configuration parameters, such as encryption suites
Warning:

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

Shows the driver basic statistics.

This function gets the driver basic statistics from the driver and print them.

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:
  • Basic WLAN configuration parameters, such as channel, MAC address and rates and so on
  • General Rx counters, such as FCS error counter, successful frame receive counter and so on
Warning:

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

Shows the Tx statistics.

This function gets the Tx statistics from the driver and prints them.

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:
For each Tx queue (out of the 4), the following are printed:
  • General counters, such as total successful frame transmission counter, total broadcast frames sent and so on
  • Retry counters, such as the number of packets transmitted successfully in the N retry only
  • Delay counters, such as the amount of time consumed by the firmware and driver for packet transmission and so on
Warning:

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

Modifies the transmission power.

This function configures the transmission power level, in dBm * 10, on the driver.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The transmission power level value (0 – 250; default = 205)
[in] nParms The number of parameters, which can be one of the following:
0 - No transmission power is given. The function prints the current transmission power.
1 - The transmission power is configured on the driver.
Returns:
None
See also:
Note:
The actual transmission power is fixed based on several parameters, such as transmission power, regulatory domain restriction and 11h power constraints.
Warning:

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

Unregisters reception of events.

This function disables the reception of an IPC event.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The event value
[in] nParms The number of parameters, which can be one of the following:
0 - No event is given. The function prints the events list.
1 - The event is disabled.
Returns:
None
See also:
CuCmd_RegisterEvents()
Note:
Events are sent from the driver to the application layer using an IPC socket.
They are always received by the application. This functions disables their printing by the application.
By default, all events are disabled.
Warning:


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