wifi.h File Reference

General WiFi Definitions. More...

#include <zephyr/sys/util.h>

Go to the source code of this file.

Macros
#define	WIFI_COUNTRY_CODE_LEN   2
#define	WIFI_LISTEN_INTERVAL_MIN   0
#define	WIFI_LISTEN_INTERVAL_MAX   65535
#define	WIFI_SSID_MAX_LEN   32
#define	WIFI_PSK_MAX_LEN   64
#define	WIFI_MAC_ADDR_LEN   6
#define	WIFI_CHANNEL_MAX   233
#define	WIFI_CHANNEL_ANY   255

Enumerations
enum	wifi_security_type {   WIFI_SECURITY_TYPE_NONE = 0 , WIFI_SECURITY_TYPE_PSK , WIFI_SECURITY_TYPE_PSK_SHA256 , WIFI_SECURITY_TYPE_SAE ,   WIFI_SECURITY_TYPE_WAPI , WIFI_SECURITY_TYPE_EAP , WIFI_SECURITY_TYPE_WEP , WIFI_SECURITY_TYPE_WPA_PSK ,   __WIFI_SECURITY_TYPE_AFTER_LAST , WIFI_SECURITY_TYPE_MAX = __WIFI_SECURITY_TYPE_AFTER_LAST - 1 , WIFI_SECURITY_TYPE_UNKNOWN }
enum	wifi_mfp_options {   WIFI_MFP_DISABLE = 0 , WIFI_MFP_OPTIONAL , WIFI_MFP_REQUIRED , __WIFI_MFP_AFTER_LAST ,   WIFI_MFP_MAX = __WIFI_MFP_AFTER_LAST - 1 , WIFI_MFP_UNKNOWN }
enum	wifi_frequency_bands {   WIFI_FREQ_BAND_2_4_GHZ = 0 , WIFI_FREQ_BAND_5_GHZ , WIFI_FREQ_BAND_6_GHZ , __WIFI_FREQ_BAND_AFTER_LAST ,   WIFI_FREQ_BAND_MAX = __WIFI_FREQ_BAND_AFTER_LAST - 1 , WIFI_FREQ_BAND_UNKNOWN }
enum	wifi_iface_state {   WIFI_STATE_DISCONNECTED = 0 , WIFI_STATE_INTERFACE_DISABLED , WIFI_STATE_INACTIVE , WIFI_STATE_SCANNING ,   WIFI_STATE_AUTHENTICATING , WIFI_STATE_ASSOCIATING , WIFI_STATE_ASSOCIATED , WIFI_STATE_4WAY_HANDSHAKE ,   WIFI_STATE_GROUP_HANDSHAKE , WIFI_STATE_COMPLETED , __WIFI_STATE_AFTER_LAST , WIFI_STATE_MAX = __WIFI_STATE_AFTER_LAST - 1 ,   WIFI_STATE_UNKNOWN }
enum	wifi_iface_mode {   WIFI_MODE_INFRA = 0 , WIFI_MODE_IBSS = 1 , WIFI_MODE_AP = 2 , WIFI_MODE_P2P_GO = 3 ,   WIFI_MODE_P2P_GROUP_FORMATION = 4 , WIFI_MODE_MESH = 5 , __WIFI_MODE_AFTER_LAST , WIFI_MODE_MAX = __WIFI_MODE_AFTER_LAST - 1 ,   WIFI_MODE_UNKNOWN }
enum	wifi_link_mode {   WIFI_0 = 0 , WIFI_1 , WIFI_2 , WIFI_3 ,   WIFI_4 , WIFI_5 , WIFI_6 , WIFI_6E ,   WIFI_7 , __WIFI_LINK_MODE_AFTER_LAST , WIFI_LINK_MODE_MAX = __WIFI_LINK_MODE_AFTER_LAST - 1 , WIFI_LINK_MODE_UNKNOWN }
enum	wifi_ps { WIFI_PS_DISABLED = 0 , WIFI_PS_ENABLED }
enum	wifi_ps_mode { WIFI_PS_MODE_LEGACY = 0 , WIFI_PS_MODE_WMM }
enum	wifi_twt_operation { WIFI_TWT_SETUP = 0 , WIFI_TWT_TEARDOWN }
enum	wifi_twt_negotiation_type { WIFI_TWT_INDIVIDUAL = 0 , WIFI_TWT_BROADCAST , WIFI_TWT_WAKE_TBTT }
enum	wifi_twt_setup_cmd {   WIFI_TWT_SETUP_CMD_REQUEST = 0 , WIFI_TWT_SETUP_CMD_SUGGEST , WIFI_TWT_SETUP_CMD_DEMAND , WIFI_TWT_SETUP_CMD_GROUPING ,   WIFI_TWT_SETUP_CMD_ACCEPT , WIFI_TWT_SETUP_CMD_ALTERNATE , WIFI_TWT_SETUP_CMD_DICTATE , WIFI_TWT_SETUP_CMD_REJECT }
enum	wifi_twt_setup_resp_status { WIFI_TWT_RESP_RECEIVED = 0 , WIFI_TWT_RESP_NOT_RECEIVED }
enum	wifi_twt_fail_reason {   WIFI_TWT_FAIL_UNSPECIFIED , WIFI_TWT_FAIL_CMD_EXEC_FAIL , WIFI_TWT_FAIL_OPERATION_NOT_SUPPORTED , WIFI_TWT_FAIL_UNABLE_TO_GET_IFACE_STATUS ,   WIFI_TWT_FAIL_DEVICE_NOT_CONNECTED , WIFI_TWT_FAIL_PEER_NOT_HE_CAPAB , WIFI_TWT_FAIL_PEER_NOT_TWT_CAPAB , WIFI_TWT_FAIL_OPERATION_IN_PROGRESS ,   WIFI_TWT_FAIL_INVALID_FLOW_ID }
enum	ps_param_type {   WIFI_PS_PARAM_STATE , WIFI_PS_PARAM_LISTEN_INTERVAL , WIFI_PS_PARAM_WAKEUP_MODE , WIFI_PS_PARAM_MODE ,   WIFI_PS_PARAM_TIMEOUT }
enum	wifi_ps_wakeup_mode { WIFI_PS_WAKEUP_MODE_DTIM = 0 , WIFI_PS_WAKEUP_MODE_LISTEN_INTERVAL }
enum	wifi_config_ps_param_fail_reason {   WIFI_PS_PARAM_FAIL_UNSPECIFIED , WIFI_PS_PARAM_FAIL_CMD_EXEC_FAIL , WIFI_PS_PARAM_FAIL_OPERATION_NOT_SUPPORTED , WIFI_PS_PARAM_FAIL_UNABLE_TO_GET_IFACE_STATUS ,   WIFI_PS_PARAM_FAIL_DEVICE_NOT_CONNECTED , WIFI_PS_PARAM_FAIL_DEVICE_CONNECTED , WIFI_PS_PARAM_LISTEN_INTERVAL_RANGE_INVALID }

Functions
static const char *	wifi_security_txt (enum wifi_security_type security)
static const char *	wifi_mfp_txt (enum wifi_mfp_options mfp)
static const char *	wifi_band_txt (enum wifi_frequency_bands band)
static const char *	wifi_state_txt (enum wifi_iface_state state)
static const char *	wifi_mode_txt (enum wifi_iface_mode mode)
static const char *	wifi_link_mode_txt (enum wifi_link_mode link_mode)
static const char *	get_twt_err_code_str (int16_t err_no)
static const char *	get_ps_config_err_code_str (int16_t err_no)

Variables
static const char *const	wifi_ps2str []
static const char *const	wifi_ps_mode2str []
static const char *const	wifi_twt_operation2str []
static const char *const	wifi_twt_negotiation_type2str []
static const char *const	wifi_twt_setup_cmd2str []
static const char *const	twt_err_code_tbl []
static const char *const	wifi_ps_wakeup_mode2str []
static const char *const	ps_param_config_err_code_tbl []

Detailed Description

General WiFi Definitions.

Macro Definition Documentation

WIFI_CHANNEL_ANY

#define WIFI_CHANNEL_ANY   255

WIFI_CHANNEL_MAX

#define WIFI_CHANNEL_MAX   233

WIFI_COUNTRY_CODE_LEN

#define WIFI_COUNTRY_CODE_LEN   2

WIFI_LISTEN_INTERVAL_MAX

#define WIFI_LISTEN_INTERVAL_MAX   65535

WIFI_LISTEN_INTERVAL_MIN

#define WIFI_LISTEN_INTERVAL_MIN   0

WIFI_MAC_ADDR_LEN

#define WIFI_MAC_ADDR_LEN   6

WIFI_PSK_MAX_LEN

#define WIFI_PSK_MAX_LEN   64

WIFI_SSID_MAX_LEN

#define WIFI_SSID_MAX_LEN   32

Enumeration Type Documentation

ps_param_type

enum ps_param_type

Enumerator
WIFI_PS_PARAM_STATE
WIFI_PS_PARAM_LISTEN_INTERVAL
WIFI_PS_PARAM_WAKEUP_MODE
WIFI_PS_PARAM_MODE
WIFI_PS_PARAM_TIMEOUT

wifi_config_ps_param_fail_reason

enum wifi_config_ps_param_fail_reason

Enumerator
WIFI_PS_PARAM_FAIL_UNSPECIFIED
WIFI_PS_PARAM_FAIL_CMD_EXEC_FAIL
WIFI_PS_PARAM_FAIL_OPERATION_NOT_SUPPORTED
WIFI_PS_PARAM_FAIL_UNABLE_TO_GET_IFACE_STATUS
WIFI_PS_PARAM_FAIL_DEVICE_NOT_CONNECTED
WIFI_PS_PARAM_FAIL_DEVICE_CONNECTED
WIFI_PS_PARAM_LISTEN_INTERVAL_RANGE_INVALID

wifi_frequency_bands

enum wifi_frequency_bands

Enumerator
WIFI_FREQ_BAND_2_4_GHZ
WIFI_FREQ_BAND_5_GHZ
WIFI_FREQ_BAND_6_GHZ
WIFI_FREQ_BAND_MAX
WIFI_FREQ_BAND_UNKNOWN

wifi_iface_mode

enum wifi_iface_mode

Enumerator
WIFI_MODE_INFRA
WIFI_MODE_IBSS
WIFI_MODE_AP
WIFI_MODE_P2P_GO
WIFI_MODE_P2P_GROUP_FORMATION
WIFI_MODE_MESH
WIFI_MODE_MAX
WIFI_MODE_UNKNOWN

wifi_iface_state

enum wifi_iface_state

Enumerator
WIFI_STATE_DISCONNECTED
WIFI_STATE_INTERFACE_DISABLED
WIFI_STATE_INACTIVE
WIFI_STATE_SCANNING
WIFI_STATE_AUTHENTICATING
WIFI_STATE_ASSOCIATING
WIFI_STATE_ASSOCIATED
WIFI_STATE_4WAY_HANDSHAKE
WIFI_STATE_GROUP_HANDSHAKE
WIFI_STATE_COMPLETED
WIFI_STATE_MAX
WIFI_STATE_UNKNOWN

wifi_link_mode

enum wifi_link_mode

Enumerator
WIFI_0
WIFI_1
WIFI_2
WIFI_3
WIFI_4
WIFI_5
WIFI_6
WIFI_6E
WIFI_7
WIFI_LINK_MODE_MAX
WIFI_LINK_MODE_UNKNOWN

wifi_mfp_options

enum wifi_mfp_options

Enumerator
WIFI_MFP_DISABLE
WIFI_MFP_OPTIONAL
WIFI_MFP_REQUIRED
WIFI_MFP_MAX
WIFI_MFP_UNKNOWN

wifi_ps

enum wifi_ps

Enumerator
WIFI_PS_DISABLED
WIFI_PS_ENABLED

wifi_ps_mode

enum wifi_ps_mode

Enumerator
WIFI_PS_MODE_LEGACY
WIFI_PS_MODE_WMM

wifi_ps_wakeup_mode

enum wifi_ps_wakeup_mode

Enumerator
WIFI_PS_WAKEUP_MODE_DTIM
WIFI_PS_WAKEUP_MODE_LISTEN_INTERVAL

wifi_security_type

enum wifi_security_type

Enumerator
WIFI_SECURITY_TYPE_NONE
WIFI_SECURITY_TYPE_PSK
WIFI_SECURITY_TYPE_PSK_SHA256
WIFI_SECURITY_TYPE_SAE
WIFI_SECURITY_TYPE_WAPI
WIFI_SECURITY_TYPE_EAP
WIFI_SECURITY_TYPE_WEP
WIFI_SECURITY_TYPE_WPA_PSK
WIFI_SECURITY_TYPE_MAX
WIFI_SECURITY_TYPE_UNKNOWN

wifi_twt_fail_reason

enum wifi_twt_fail_reason

Enumerator
WIFI_TWT_FAIL_UNSPECIFIED
WIFI_TWT_FAIL_CMD_EXEC_FAIL
WIFI_TWT_FAIL_OPERATION_NOT_SUPPORTED
WIFI_TWT_FAIL_UNABLE_TO_GET_IFACE_STATUS
WIFI_TWT_FAIL_DEVICE_NOT_CONNECTED
WIFI_TWT_FAIL_PEER_NOT_HE_CAPAB
WIFI_TWT_FAIL_PEER_NOT_TWT_CAPAB
WIFI_TWT_FAIL_OPERATION_IN_PROGRESS
WIFI_TWT_FAIL_INVALID_FLOW_ID

wifi_twt_negotiation_type

enum wifi_twt_negotiation_type

Enumerator
WIFI_TWT_INDIVIDUAL
WIFI_TWT_BROADCAST
WIFI_TWT_WAKE_TBTT

wifi_twt_operation

enum wifi_twt_operation

Enumerator
WIFI_TWT_SETUP
WIFI_TWT_TEARDOWN

wifi_twt_setup_cmd

enum wifi_twt_setup_cmd

Enumerator
WIFI_TWT_SETUP_CMD_REQUEST
WIFI_TWT_SETUP_CMD_SUGGEST
WIFI_TWT_SETUP_CMD_DEMAND
WIFI_TWT_SETUP_CMD_GROUPING
WIFI_TWT_SETUP_CMD_ACCEPT
WIFI_TWT_SETUP_CMD_ALTERNATE
WIFI_TWT_SETUP_CMD_DICTATE
WIFI_TWT_SETUP_CMD_REJECT

wifi_twt_setup_resp_status

enum wifi_twt_setup_resp_status

Enumerator
WIFI_TWT_RESP_RECEIVED
WIFI_TWT_RESP_NOT_RECEIVED

Function Documentation

get_ps_config_err_code_str()

static const char * get_ps_config_err_code_str ( int16_t  err_no )

inlinestatic

get_twt_err_code_str()

static const char * get_twt_err_code_str ( int16_t  err_no )

inlinestatic

wifi_band_txt()

static const char * wifi_band_txt ( enum wifi_frequency_bands  band )

inlinestatic

wifi_mode_txt - Get the interface mode type as a text string

wifi_link_mode_txt()

static const char * wifi_link_mode_txt ( enum wifi_link_mode  link_mode )

inlinestatic

wifi_link_mode_txt - Get the link mode type as a text string

wifi_mfp_txt()

static const char * wifi_mfp_txt ( enum wifi_mfp_options  mfp )

inlinestatic

wifi_mfp_txt - Get the MFP as a text string

wifi_mode_txt()

static const char * wifi_mode_txt ( enum wifi_iface_mode  mode )

inlinestatic

wifi_mode_txt - Get the interface mode type as a text string

wifi_security_txt()

static const char * wifi_security_txt ( enum wifi_security_type  security )

inlinestatic

wifi_security_txt - Get the security type as a text string

wifi_state_txt()

static const char * wifi_state_txt ( enum wifi_iface_state  state )

inlinestatic

wifi_state_txt - Get the connection state name as a text string

Variable Documentation

ps_param_config_err_code_tbl

const char* const ps_param_config_err_code_tbl[]

static

Initial value:

= {
        [WIFI_PS_PARAM_FAIL_UNSPECIFIED] = "Unspecfied",
        [WIFI_PS_PARAM_FAIL_CMD_EXEC_FAIL] = "Command Execution failed",
        [WIFI_PS_PARAM_FAIL_OPERATION_NOT_SUPPORTED] =
                "Operation not supported",
        [WIFI_PS_PARAM_FAIL_UNABLE_TO_GET_IFACE_STATUS] =
                "Unable to get iface status",
        [WIFI_PS_PARAM_FAIL_DEVICE_NOT_CONNECTED] =
                "Can not set while device not connected",
        [WIFI_PS_PARAM_FAIL_DEVICE_CONNECTED] =
                "Can not set while device already connected",
        [WIFI_PS_PARAM_LISTEN_INTERVAL_RANGE_INVALID] =
                "Can not set due to invalid range",
}

twt_err_code_tbl

const char* const twt_err_code_tbl[]

static

Initial value:

= {
        [WIFI_TWT_FAIL_UNSPECIFIED] = "Unspecfied",
        [WIFI_TWT_FAIL_CMD_EXEC_FAIL] = "Command Execution failed",
        [WIFI_TWT_FAIL_OPERATION_NOT_SUPPORTED] =
                "Operation not supported",
        [WIFI_TWT_FAIL_UNABLE_TO_GET_IFACE_STATUS] =
                "Unable to get iface status",
        [WIFI_TWT_FAIL_DEVICE_NOT_CONNECTED] =
                "Device not connected",
        [WIFI_TWT_FAIL_PEER_NOT_HE_CAPAB] = "Peer not HE capable",
        [WIFI_TWT_FAIL_PEER_NOT_TWT_CAPAB] = "Peer not TWT capable",
        [WIFI_TWT_FAIL_OPERATION_IN_PROGRESS] =
                "Operation already in progress",
        [WIFI_TWT_FAIL_INVALID_FLOW_ID] =
                "Invalid negotiated flow id",
}

wifi_ps2str

const char* const wifi_ps2str[]

static

Initial value:

= {
        [WIFI_PS_DISABLED] = "Power save disabled",
        [WIFI_PS_ENABLED] = "Power save enabled",
}

wifi_ps_mode2str

const char* const wifi_ps_mode2str[]

static

Initial value:

= {
        [WIFI_PS_MODE_LEGACY] = "Legacy power save",
        [WIFI_PS_MODE_WMM] = "WMM power save",
}

wifi_ps_wakeup_mode2str

const char* const wifi_ps_wakeup_mode2str[]

static

Initial value:

= {
        [WIFI_PS_WAKEUP_MODE_DTIM] = "PS wakeup mode DTIM",
        [WIFI_PS_WAKEUP_MODE_LISTEN_INTERVAL] = "PS wakeup mode listen interval",
}

wifi_twt_negotiation_type2str

const char* const wifi_twt_negotiation_type2str[]

static

Initial value:

= {
        [WIFI_TWT_INDIVIDUAL] = "TWT individual negotiation",
        [WIFI_TWT_BROADCAST] = "TWT broadcast negotiation",
        [WIFI_TWT_WAKE_TBTT] = "TWT wake TBTT negotiation",
}

wifi_twt_operation2str

const char* const wifi_twt_operation2str[]

static

Initial value:

= {
        [WIFI_TWT_SETUP] = "TWT setup",
        [WIFI_TWT_TEARDOWN] = "TWT teardown",
}

wifi_twt_setup_cmd2str

const char* const wifi_twt_setup_cmd2str[]

static

Initial value:

= {
        
        [WIFI_TWT_SETUP_CMD_REQUEST] = "TWT request",
        [WIFI_TWT_SETUP_CMD_SUGGEST] = "TWT suggest",
        [WIFI_TWT_SETUP_CMD_DEMAND] = "TWT demand",
        
        [WIFI_TWT_SETUP_CMD_GROUPING] = "TWT grouping",
        [WIFI_TWT_SETUP_CMD_ACCEPT] = "TWT accept",
        [WIFI_TWT_SETUP_CMD_ALTERNATE] = "TWT alternate",
        [WIFI_TWT_SETUP_CMD_DICTATE] = "TWT dictate",
        [WIFI_TWT_SETUP_CMD_REJECT] = "TWT reject",
}