![]() |
Morse Micro IoT SDK
2.11.2
|
Arguments data structure for mmwlan_sta_enable().
This structure should be initialized using MMWLAN_STA_ARGS_INIT for sensible default values, particularly for forward compatibility with new releases that may add new fields to the struct. For example:
#include <mmwlan.h>
Data Fields | |
| uint8_t | ssid [MMWLAN_SSID_MAXLEN] |
| SSID of the AP to connect to. More... | |
| uint16_t | ssid_len |
| Length of the SSID. More... | |
| uint8_t | bssid [MMWLAN_MAC_ADDR_LEN] |
| BSSID of the AP to connect to. More... | |
| enum mmwlan_security_type | security_type |
| Type of security to use. More... | |
| char | passphrase [MMWLAN_PASSPHRASE_MAXLEN+1] |
Passphrase (only used if security_type is MMWLAN_SAE, otherwise ignored. More... | |
| uint16_t | passphrase_len |
Length of passphrase. More... | |
| enum mmwlan_pmf_mode | pmf_mode |
| Protected Management Frame mode to use (802.11w) More... | |
| int16_t | raw_sta_priority |
| Priority used by the AP to assign a STA to a Restricted Access Window (RAW) group. More... | |
| enum mmwlan_station_type | sta_type |
| S1G non-AP STA type. More... | |
| int | sae_owe_ec_groups [MMWLAN_MAX_EC_GROUPS] |
| Preference list of enabled elliptic curve groups for SAE and OWE. More... | |
| enum mmwlan_cac_mode | cac_mode |
| Whether Centralized Authentication Controlled is enabled on the STA. More... | |
| uint16_t | bgscan_short_interval_s |
| Background scan short interval, measured in seconds. More... | |
| int | bgscan_signal_threshold_dbm |
| Background scan signal strength threshold that switches between short and long intervals. More... | |
| uint16_t | bgscan_long_interval_s |
| Background scan long interval, measured in seconds. More... | |
| mmwlan_scan_rx_cb_t | scan_rx_cb |
| Optional callback for scan results which are received during the connection process. More... | |
| void * | scan_rx_cb_arg |
| Opaque argument to be passed to scan_rx_cb. More... | |
| uint16_t | scan_interval_base_s |
| The base scan interval (in seconds) to use when (re)connecting. More... | |
| uint16_t | scan_interval_limit_s |
| The maximum interval between scan attempts when (re)connecting. More... | |
| uint8_t * | extra_assoc_ies |
| Extra Information Elements to include in association request frames. More... | |
| size_t | extra_assoc_ies_len |
Length of extra_assoc_ies. More... | |
| mmwlan_sta_event_cb_t | sta_evt_cb |
| STA event callback with a user-defined opaque parameter. More... | |
| void * | sta_evt_cb_arg |
STA event callback argument to be passed to sta_evt_cb. More... | |
| enum mmwlan_4addr_mode | use_4addr |
| Whether the station should use Linux 4-address mode. More... | |
| uint16_t mmwlan_sta_args::bgscan_long_interval_s |
Background scan long interval, measured in seconds.
When the signal strength is above bgscan_signal_threshold_dbm, this interval will be used between iterations of background scan. If the signal threshold falls below bgscan_signal_threshold_dbm, background scan will use the short interval.
| uint16_t mmwlan_sta_args::bgscan_short_interval_s |
Background scan short interval, measured in seconds.
When the signal strength falls below bgscan_signal_threshold_dbm, this interval will be used between iterations of background scan. After several iterations, or if the signal threshold increases above bgscan_signal_threshold_dbm background scan will return to using the long interval.
| int mmwlan_sta_args::bgscan_signal_threshold_dbm |
Background scan signal strength threshold that switches between short and long intervals.
| uint8_t mmwlan_sta_args::bssid[MMWLAN_MAC_ADDR_LEN] |
| enum mmwlan_cac_mode mmwlan_sta_args::cac_mode |
| uint8_t* mmwlan_sta_args::extra_assoc_ies |
Extra Information Elements to include in association request frames.
Should be NULL if extra_assoc_ies_len is zero. It is the caller's responsibility to handle potentially duplicate IEs. It is the caller's responsibility to free this buffer after calling mmwlan_sta_enable().
| size_t mmwlan_sta_args::extra_assoc_ies_len |
| char mmwlan_sta_args::passphrase[MMWLAN_PASSPHRASE_MAXLEN+1] |
| uint16_t mmwlan_sta_args::passphrase_len |
| enum mmwlan_pmf_mode mmwlan_sta_args::pmf_mode |
| int16_t mmwlan_sta_args::raw_sta_priority |
Priority used by the AP to assign a STA to a Restricted Access Window (RAW) group.
Valid range is 0 - MMWLAN_RAW_MAX_PRIORITY, or -1 to disable RAW.
| int mmwlan_sta_args::sae_owe_ec_groups[MMWLAN_MAX_EC_GROUPS] |
| uint16_t mmwlan_sta_args::scan_interval_base_s |
The base scan interval (in seconds) to use when (re)connecting.
An exponential back off is applied such that if the AP is not found during the first scan, we will wait for scan_interval_base_s seconds before attempting the second scan, then scan_interval_base_s squared seconds before attempting for the next scan, and so on until scan_interval_limit_s is reached.
If this is 0 then the MMWLAN_DEFAULT_SCAN_INTERVAL_BASE_S will be used.
| uint16_t mmwlan_sta_args::scan_interval_limit_s |
The maximum interval between scan attempts when (re)connecting.
The scan algorithm will begin with an interval of scan_interval_base_s between scans and increase the interval exponentially until this limit is reached.
If this is 0 then the MMWLAN_DEFAULT_SCAN_INTERVAL_LIMIT_S will be used.
| mmwlan_scan_rx_cb_t mmwlan_sta_args::scan_rx_cb |
| void* mmwlan_sta_args::scan_rx_cb_arg |
Opaque argument to be passed to scan_rx_cb.
| enum mmwlan_security_type mmwlan_sta_args::security_type |
| uint8_t mmwlan_sta_args::ssid[MMWLAN_SSID_MAXLEN] |
| mmwlan_sta_event_cb_t mmwlan_sta_args::sta_evt_cb |
| void* mmwlan_sta_args::sta_evt_cb_arg |
STA event callback argument to be passed to sta_evt_cb.
May optionally be NULL. The value of this parameter must remain valid during the lifetime of the connection.
| enum mmwlan_station_type mmwlan_sta_args::sta_type |
S1G non-AP STA type.
For valid STA types, mmwlan_station_type
| enum mmwlan_4addr_mode mmwlan_sta_args::use_4addr |