Detailed Description

Arguments data structure for mmwlan_ap_enable().

Warning: ALPHA NOTICE: This is an alpha API that is under development; breaking changes may be introduced in future releases.

This structure should be initialized using MMWLAN_AP_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_ap_args ap_args = MMWLAN_AP_ARGS_INIT;
// HERE: initialize arguments
status = mmwlan_ap_enable(&ap_args);

Definition at line 1781 of file mmwlan.h.

#include <mmwlan.h>

Data Fields
uint8_t	ssid [MMWLAN_SSID_MAXLEN]
	SSID of the AP. More...

uint16_t	ssid_len
	Length of the SSID. More...

uint8_t	bssid [MMWLAN_MAC_ADDR_LEN]
	Optional BSSID of the AP. 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...

int	sae_owe_ec_groups [MMWLAN_MAX_EC_GROUPS]
	Preference list of enabled elliptic curve groups for SAE and OWE. More...

uint16_t	op_class
	Operating Class to use (S1G or Global). More...

uint16_t	s1g_chan_num
	S1G channel number of the channel to use. More...

uint16_t	beacon_interval_tus
	The Beacon period in units of TUs. More...

uint16_t	dtim_period
	The Delivery Traffic Indication Map (DTIM) interval in beacons. More...

uint8_t	pri_bw_mhz
	Bandwidth to use for the primary channel. More...

uint8_t	pri_1mhz_chan_idx
	Index of the primary 1 Mhz channel within the operating channel. More...

mmwlan_ap_sta_status_cb_t	sta_status_cb
	Optional callback to be invoked when the status of a connected STA changes. More...

void *	sta_status_cb_arg
	Optional opaque argument to be passed to `sta_status_cb`. More...

uint8_t	max_stas
	Maximum number of stations that can connect to the AP simultaneously. More...

bool	async_start
	Whether the function should return immediately instead of waiting for the AP interface to be fully started before returning. More...

Field Documentation

◆ async_start

bool mmwlan_ap_args::async_start

Whether the function should return immediately instead of waiting for the AP interface to be fully started before returning.

When returning immediately, the AP interface will not be immediately active and functions such as mmwlan_ap_get_bssid will return MMWLAN_UNAVAILABLE until active.

Definition at line 1870 of file mmwlan.h.

◆ beacon_interval_tus

uint16_t mmwlan_ap_args::beacon_interval_tus

The Beacon period in units of TUs.

A TU is equal to 1.024 ms.

If zero then the default value, MMWLAN_DEFAULT_AP_BEACON_INTERVAL_TUS, will be used.

Definition at line 1827 of file mmwlan.h.

◆ bssid

uint8_t mmwlan_ap_args::bssid[MMWLAN_MAC_ADDR_LEN]

Optional BSSID of the AP.

If zero then the devices MAC address will be used.

Warning: The MAC address selection behavior may change in future.

Definition at line 1792 of file mmwlan.h.

◆ dtim_period

uint16_t mmwlan_ap_args::dtim_period

The Delivery Traffic Indication Map (DTIM) interval in beacons.

If zero then the default value, MMWLAN_DEFAULT_AP_DTIM_PERIOD, will be used.

Definition at line 1833 of file mmwlan.h.

◆ max_stas

uint8_t mmwlan_ap_args::max_stas

Maximum number of stations that can connect to the AP simultaneously.

The maximum value limit is MMWLAN_AP_MAX_STAS_LIMIT.

If zero, the default value of MMWLAN_DEFAULT_AP_MAX_STAS will be used.

Definition at line 1863 of file mmwlan.h.

◆ op_class

uint16_t mmwlan_ap_args::op_class

Operating Class to use (S1G or Global).

The combination of this field and s1g_chan_num will be used to look up the appropriate entry in the channel list, which must have been previously provided using mmwlan_set_channel_list().

Definition at line 1813 of file mmwlan.h.

◆ passphrase

char mmwlan_ap_args::passphrase[MMWLAN_PASSPHRASE_MAXLEN+1]

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

Definition at line 1796 of file mmwlan.h.

◆ passphrase_len

uint16_t mmwlan_ap_args::passphrase_len

Length of passphrase.

May be zero if passphrase is null-terminated.

Definition at line 1798 of file mmwlan.h.

◆ pmf_mode

enum mmwlan_pmf_mode mmwlan_ap_args::pmf_mode

Protected Management Frame mode to use (802.11w)

Definition at line 1800 of file mmwlan.h.

◆ pri_1mhz_chan_idx

uint8_t mmwlan_ap_args::pri_1mhz_chan_idx

Index of the primary 1 Mhz channel within the operating channel.

This must be less than the bandwidth of the operating channel.

Definition at line 1846 of file mmwlan.h.

◆ pri_bw_mhz

uint8_t mmwlan_ap_args::pri_bw_mhz

Bandwidth to use for the primary channel.

This may be set to 0 to automatically select the highest primary bandwidth supported by the operating channel.

Note: This must not be greater than the bandwidth of the operating channel or 2 MHz, whichever is lower.

Definition at line 1841 of file mmwlan.h.

◆ s1g_chan_num

uint16_t mmwlan_ap_args::s1g_chan_num

S1G channel number of the channel to use.

The combination of this field and op_class will be used to look up the appropriate entry in the channel list, which must have been previously provided using mmwlan_set_channel_list().

Definition at line 1821 of file mmwlan.h.

◆ sae_owe_ec_groups

int mmwlan_ap_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 1805 of file mmwlan.h.

◆ security_type

enum mmwlan_security_type mmwlan_ap_args::security_type

Type of security to use.

If MMWLAN_SAE then a passphrase must be specified.

Definition at line 1794 of file mmwlan.h.

◆ ssid

uint8_t mmwlan_ap_args::ssid[MMWLAN_SSID_MAXLEN]

SSID of the AP.

Definition at line 1784 of file mmwlan.h.

◆ ssid_len

uint16_t mmwlan_ap_args::ssid_len

Length of the SSID.

Definition at line 1786 of file mmwlan.h.

◆ sta_status_cb

mmwlan_ap_sta_status_cb_t mmwlan_ap_args::sta_status_cb

Optional callback to be invoked when the status of a connected STA changes.

May be set to NULL.

Definition at line 1851 of file mmwlan.h.

◆ sta_status_cb_arg

void* mmwlan_ap_args::sta_status_cb_arg

Optional opaque argument to be passed to sta_status_cb.

May optionally be NULL. The value of this parameter must remain valid during the lifetime of the AP.

Definition at line 1856 of file mmwlan.h.

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

mmwlan.h