Functions | |
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_ClearPeriodicScanConfiguration | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Clears a periodic scan.
This function clears the periodic scan parameters (global, channel, SSID and interval parameters).
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_ClearScanPolicy | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Clears a continuous scan.
This function clears the continuous scan parameters.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_ConfigPeriodicScanGlobal | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures periodic scan parameters.
This function configures the general parameters to be used in a periodic scan.
The periodic scan should be activated by the application only when the connection mode is manual.
The purpose of this scan is to retrieve a list of BSSIDs from which the application can select a proper candidate to which to connect.
A periodic scan has more facilities than an application scan and can have a longer duration.
A periodic scan lasts until one of the following occurs:
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] An RSSI threshold. APs with an RSSI lower than this value are not added to the BSSID list ([-100] – 0; default = [-97]). parm[1] An SNR threshold. APs with a signal-to-noise ratio lower than this value are not added to the BSSID list ([-5] – 20; default = 0). parm[2] Defines the number of results that should be received at the firmware before reporting to the application (1 – 8; default = 1). parm[3] Must be set to 1; otherwise, a conflict with the station functionality may occur. parm[4] The BSS type to scan for (0 - independent, 1 - infrastructure, 2- any; default = 2). parm[5] The number of probe requests to transmit per SSID on each channel (1 – 10; default = 3). parm[6] The number of scan cycles to perform (0 – 100; default = 50; 0 means no cycle limit). parm[7] The number of SSIDs to scan for (1 - 8). The SSIDs are configured using the function CuCmd_ConfigurePeriodicScanSsid(). parm[8] Indicates whether or not to filter the scan results according to the configured SSIDs (0 - do not filter, 1 – filter; default = 1). parm[9] The number of channels to scan (1- 37; default = 14). |
[in] | nParms | Always 10. |
VOID CuCmd_ConfigPeriodicScanInterval | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the periodic scan interval.
This function configures the time interval between two sequential scan cycles.
The number of cycles can be greater than the number of intervals. In this case, the interval values repeat.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The scan interval index (0 - 15). parm[1] The interval value, in msecs (0 – 512,000. By default, the first interval is 0, the second is 1,000, and it is multiplied by 2 for each index that follows). |
[in] | nParms | Always 2. |
VOID CuCmd_ConfigScanBand | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the continuous scan band parameters.
This function configures the band parameters used in the continuous scan.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The band index (0 - 1). Up to two bands can be configured. parm[1] The radio band to scan (0 - 2.4GHz band, 1 - 5.0GHz band). parm[2] The quality threshold for received frames, in dBm ([-100] – 0; default = [-80]). parm[3] The number of channels to scan at each discovery attempt (1 - 30). parm[4] The number of channels to use on this band (1 - 30). |
[in] | nParms | Always 5. |
VOID CuCmd_ConfigScanBandChannel | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the channels list for each band defined for the continuous scan.
This function configures the list of channels to be used on each band in the continuous scan.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The band index (0 - 2.4GHz band, 1 - 5.0GHz band). parm[1] The channel index (0 - 29). parm[2] The channel to be scanned (1 - 160). |
[in] | nParms | Always 3. |
VOID CuCmd_ConfigScanBandDiscover | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the policy for the discover scan method.
This function configures the policy for the scan method used to discover new BSSs.
[in] | hCuCmd | Please refer to the function CuCmd_ConfigScanBandTrack(). |
[in] | parm | parm[0] Please refer to the function CuCmd_ConfigScanBandTrack(). |
[in] | nParms | Please refer to the function CuCmd_ConfigScanBandTrack(). |
VOID CuCmd_ConfigScanBandImmed | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the policy for the immediate scan method.
This function configures the policy for the method used for an immediate scan.
[in] | hCuCmd | Please refer to the function CuCmd_ConfigScanBandTrack(). |
[in] | parm | parm[0] Please refer to the function CuCmd_ConfigScanBandTrack(). |
[in] | nParms | Please refer to the function CuCmd_ConfigScanBandTrack(). |
VOID CuCmd_ConfigScanBandTrack | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the policy for the tracking scan method.
This function configures the policy for the scan method used to track previously discovered APs.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The band index (0 - 2.4GHz band, 1 - 5.0GHz band). parm[1] The scan type, which can be one of the following: 3 - Passive scan: The scan is performed only by listening on the channel, without transmitting any probe request. 4 - Active scan: The station listens on the channel, and also transmits probe requests in order to retrieve probe responses from the APs. 6 - Passive before active scan: The station first perform a passive scan on the channel. The station then decides whether or not to perform an active scan based on the passive scan results, in accordance with the 802.1h standard. parm[2] Early termination condition, which can be one of the following: 0 - No early termination 1 - Early termination scan on beacon reception 2 - Early termination scan on probe response reception 3 - Early termination scan on beacon or probe response reception Upon reception of the frames defined in the early termination condition, the station moves to the next channel. Default = 0. parm[3] The number of frames from the early termination frame types (based on the early termination condition), after which the scan is stopped on this channel (0 – 255; default = 0). parm[4] The time at which to trigger the scan. It must be set to 255; otherwise, a conflict with the station functionality may occur. parm[5] The time, in microseconds, to spend on each channel. parm[6] The maximum time, in microseconds, to stay on the channel if frames were received, but the early termination condition has not yet been reached (5,000 – 500,000; default = 30,000). parm[7] The minimum time, in microseconds, to stay on the channel if no frames were received (5,000 – 500,000; default = 15,000). parm[8] The number of probe requests to send on each channel during an active scan (1 – 10; default 3). parm[9] The rate for probe request transmission (0 - the rate is fixed by the firmware, 1 - 1 Mbit, 2 - 2Mbits; default = 0). Other rates are also available, but they are not recommended. parm[10] The power level, in 10dBm units, used to transmit the probe requests during an active scan (0 – 250; default = 205). |
[in] | nParms | Always 11 |
VOID CuCmd_ConfigScanPolicy | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures continuous scan parameters.
This function configures the general parameters used in a continuous scan.
The driver performs continuous scanning automatically, as long as the driver is connected and roaming is enabled, regardless of the connection mode (manual or auto).
The purpose of this scan is to create and maintain (and sometimes to immediately find) a list of candidate APs that may be used if the station needs to roam.n\ This scan is activated periodically, as long as the station is connected and roaming is enabled.
The interval between two sequential scans is determined by the BSSID quality.
A continuous scan has three different modes:
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] Time interval, in msecs, at which to perform a continuous scan, when the current BSS quality is considered "normal" (0 – 3,600,000; default = 10,000). parm[1] Time interval, in msecs, at which to perform a continuous scan, when the current BSS quality is considered "deteriorating" (0 – 3,600,000; default = 5,000). parm[2] The maximum number of track failures. If the station fails to track a candidate AP this number of times, the AP is removed from the BSS list (0 – 20; default = 3). parm[3] The BSS list size (1 - 16). parm[4] The number of APs in the BSS list, which specifies when the discovery process is initiated (1 - 16). parm[5] The number of bands to scan (1 - 2). |
[in] | nParms | Always 6. |
VOID CuCmd_ConfigurePeriodicScanChannel | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures a periodic scan’s channel parameters.
This function configures the parameters to be used when scanning a specific channel during a periodic scan.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The channel index parm[1] The radio band to scan (0 - 2.4GHz band, 1 - 5.0GHz band) parm[2] Channel to scan parm[3] The scan type, which can be one of the following: 3 - Passive scan: The scan is performed only by listening on the channel, without transmitting any probe request. 4 - Active scan: The station listens on the channel, and also transmits probe requests in order to retrieve probe responses from the APs. 6 - Passive before active scan: The station first performs a passive scan on the channel. The station then decides whether or not to perform an active scan based on the passive scan results, in accordance with the 802.1h standard. parm[4] Minimum time, in microseconds, to stay on the channel if no frames were received (5,000 – 500,000; default = 30,000). parm[5] Maximum time, in microseconds, to stay on the channel if frames were received (5,000 – 500,000; default = 60,000). parm[6] Power level, in 10dBm units, used to transmit the probe requests during an active scan (0 – 250; default = 205). |
[in] | nParms | Always 7. |
VOID CuCmd_ConfigurePeriodicScanSsid | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures the periodic scan SSID list.
This function configures the list of SSIDs to scan in the periodic scan.
For each SSID, it defines whether or not the SSID is hidden.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The SSID index (0 - 7) parm[1] Defines whether or not the SSID is hidden (0 - public, 1 – hidden; default = 0). parm[2] The SSID to scan for (0 - 32 bytes; string). |
[in] | nParms | Always 3. |
VOID CuCmd_DisplayPeriodicScanConfiguration | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Shows the periodic scan.
This function gets the periodic scan parameters from the driver and prints them.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_DisplayScanPolicy | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Shows continuous scan parameters.
This function gets the continuous scan parameters from the driver and prints them.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_GetScanBssList | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Shows the BSS list.
This function gets the list of BSSIDs found during the scan from the driver and prints it.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_ScanAppChannelConfig | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures channel scan parameters.
This function configures the parameters to be used when scanning a specific channel during an application scan.
Please refer to the function CuCmd_ScanAppGlobalConfig().
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The channel index. parm[1] A MAC address defines the BSSID to filter. It must be set to broadcast MAC; otherwise, a conflict with the station functionality may occur. parm[2] The maximum time, in microseconds, to stay on the channel if frames were received, but the early termination condition has not yet been reached (5,000 – 500,000; default = 60,000). parm[3] The minimum time, in microseconds, to stay on the channel if no frames were received (5,000 – 500,000; default = 30,000). parm[4] Defines the early termination condition, which can be one of the following: 0 - No early termination 1 - Early termination scan on beacon reception 2 - Early termination scan on probe response reception 3 - Early termination scan on beacon or probe response reception Upon reception of the frames defined in the early termination condition, the station moves to the next channel. Default = 0. parm[5] The number of frames from the early termination frame types (based on the early termination condition), after which the scan is stopped on this channel (0 – 255; default = 0). parm[6] The power level, in 10dBm units, used to transmit the probe requests during an active scan. (0 – 250; default = 205). parm[7] Channel to scan |
[in] | nParms | Always 8. |
VOID CuCmd_ScanAppClear | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Clears the application scan.
This function clears the application scan parameters (both global parameters and per-channel parameters).
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_ScanAppDisplay | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Shows the application scan.
This function gets the application scan parameters from the driver and prints them.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_ScanAppGlobalConfig | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Configures application scan parameters.
This function configures the general parameters to be used in the application scan.
The purpose of this scan is to retrieve a list of BSSIDs from which the application can select a proper candidate to which to connect.
There is only one scan cycle, where each channel is scanned once. After that, the scan stops, regardless of whether or not it found the applicable SSID.
In order to activate the application scan, the following operations should be performed:
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The SSID to scan for (0 - 32 characters; string; default = empty). parm[1] The scan type, which can be one of the following: 3 - Passive scan: The scan is performed only by listening on the channel, without transmitting any probe request. 4 - Active scan: The station listens on the channel, and also transmits probe requests in order to retrieve probe responses from the APs. 6 - Passive before active scan: The station first performs a passive scan on the channel. The station then decides whether or not to perform an active scan based on the passive scan results, in accordance with the 802.1h standard. parm[2] The radio band to scan, which can be on of the following: 0 - 2.4GHz band 1 - 5.0GHz band parm[3] The number of probe requests to send on each channel, when performing an active scan (1 – 10; default = 3). parm[4] The rate for probe request transmission (0 - the rate is fixed by the firmware, 1 - 1 Mbit, 2 - 2Mbit; default = 0). Other rates are also available, but they are not recommended. parm[5] The time at which to trigger the scan. It must be set to 255; otherwise, a conflict with the station functionality may occur. parm[6] The number of channels to scan (1 -16). |
[in] | nParms | Always 7. |
VOID CuCmd_SetScanPolicy | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Sets the continuous scan policy.
This function sets the continuous scan policy on the driver.
If the driver is connected and roaming is enabled, the driver starts a continuous scan according to defined policy.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_StartPeriodicScan | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Starts a periodic scan.
This function starts the periodic scan. The scan is performed using the parameters defined using the CuCmd_ConfigPeriodicScanGlobal(), CuCmd_ConfigPeriodicScanInterval(), CuCmd_ConfigurePeriodicScanSsid() and CuCmd_ConfigurePeriodicScanChannel()functions.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_StartScan | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Starts the application scan.
This function starts the application scan. The scan is performed using the parameters defined in the CuCmd_ScanAppChannelConfig() and CuCmd_ScanAppGlobalConfig()functions.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_StopPeriodicScan | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Stops a periodic scan.
This function stops the periodic scan.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_StopScan | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Stops the application scan.
This function stops the application scan.
[in] | hCuCmd | Handle for the command module |
[in] | parm | Not used; should be 0 |
[in] | nParms | Not used; should be 0 |
VOID CuCmd_WextStartScan | ( | THandle | hCuCmd, | |
ConParm_t | parm[], | |||
U16 | nParms | |||
) |
Starts a default scan.
This function starts a default scan.
In this scan mode, only the SSID and the scan type are given by the user.
The value of the other scan parameters (such as channels, number of probe requests and so on) are fixed by the firmware.
[in] | hCuCmd | Handle for the command module |
[in] | parm | parm[0] The scan type (0 - active, 1 – passive; default = 0) parm[1] The SSID to scan for (0 - 32 chars string; default = empty). |
[in] | nParms | Can be one of the following: 0 - No parameters are given. The scan type is configured to active and the station scans for any SSID 1 - Only a scan type is given. The station scans for any SSID in this scan mode. 2 - Both scan type and SSID are given. The station scans for the given SSID in this scan mode. |