Detailed Description

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:

enum mmwlan_status status;
struct mmwlan_sta_args sta_args = MMWLAN_STA_ARGS_INIT;
// HERE: initialize arguments
status = mmwlan_sta_enable(&sta_args);

Definition at line 700 of file mmwlan.h.

#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...

Field Documentation

◆ bgscan_long_interval_s

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.

Note: Setting this to zero will disable background scanning.

Definition at line 758 of file mmwlan.h.

◆ bgscan_short_interval_s

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.

Note: Setting this to zero will disable background scanning.

Definition at line 743 of file mmwlan.h.

◆ bgscan_signal_threshold_dbm

int mmwlan_sta_args::bgscan_signal_threshold_dbm

Background scan signal strength threshold that switches between short and long intervals.

Definition at line 747 of file mmwlan.h.

◆ bssid

uint8_t mmwlan_sta_args::bssid[MMWLAN_MAC_ADDR_LEN]

BSSID of the AP to connect to.

If non-zero, the STA will only connect to an AP that matches this value.

Definition at line 710 of file mmwlan.h.

◆ cac_mode

enum mmwlan_cac_mode mmwlan_sta_args::cac_mode

Whether Centralized Authentication Controlled is enabled on the STA.

Definition at line 732 of file mmwlan.h.

◆ passphrase

char mmwlan_sta_args::passphrase[MMWLAN_PASSPHRASE_MAXLEN+1]

Passphrase (only used if security_type is MMWLAN_SAE, otherwise ignored.

Definition at line 714 of file mmwlan.h.

◆ passphrase_len

uint16_t mmwlan_sta_args::passphrase_len

Length of passphrase.

May be zero if passphrase is null-terminated.

Definition at line 716 of file mmwlan.h.

◆ pmf_mode

enum mmwlan_pmf_mode mmwlan_sta_args::pmf_mode

Protected Management Frame mode to use (802.11w)

Definition at line 718 of file mmwlan.h.

◆ raw_sta_priority

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.

Definition at line 723 of file mmwlan.h.

◆ sae_owe_ec_groups

int mmwlan_sta_args::sae_owe_ec_groups[MMWLAN_MAX_EC_GROUPS]

Preference list of enabled elliptic curve groups for SAE and OWE.

By default (if this parameter is not set), the mandatory group 19 is preferred.

Definition at line 730 of file mmwlan.h.

◆ scan_rx_cb

mmwlan_scan_rx_cb_t mmwlan_sta_args::scan_rx_cb

Optional callback for scan results which are received during the connection process.

Definition at line 760 of file mmwlan.h.

◆ scan_rx_cb_arg

void* mmwlan_sta_args::scan_rx_cb_arg

Opaque argument to be passed to scan_rx_cb.

Definition at line 762 of file mmwlan.h.

◆ security_type

enum mmwlan_security_type mmwlan_sta_args::security_type

Type of security to use.

If MMWLAN_SAE then a passphrase must be specified.

Definition at line 712 of file mmwlan.h.

◆ ssid

uint8_t mmwlan_sta_args::ssid[MMWLAN_SSID_MAXLEN]

SSID of the AP to connect to.

Definition at line 703 of file mmwlan.h.

◆ ssid_len

uint16_t mmwlan_sta_args::ssid_len

Length of the SSID.

Definition at line 705 of file mmwlan.h.

◆ sta_type

enum mmwlan_station_type mmwlan_sta_args::sta_type

S1G non-AP STA type.

For valid STA types, mmwlan_station_type

Definition at line 725 of file mmwlan.h.

The documentation for this struct was generated from the following file:

mmwlan.h