Zephyr Project API  3.2.0
A Scalable Open Source RTOS
wifi.h File Reference

General WiFi Definitions. More...

Go to the source code of this file.

Macros

#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_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
}
 

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)
 

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_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

◆ 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

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

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

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

Enumerator
WIFI_MFP_DISABLE 
WIFI_MFP_OPTIONAL 
WIFI_MFP_REQUIRED 
WIFI_MFP_MAX 
WIFI_MFP_UNKNOWN 

◆ wifi_security_type

Enumerator
WIFI_SECURITY_TYPE_NONE 
WIFI_SECURITY_TYPE_PSK 
WIFI_SECURITY_TYPE_PSK_SHA256 
WIFI_SECURITY_TYPE_SAE 
WIFI_SECURITY_TYPE_MAX 
WIFI_SECURITY_TYPE_UNKNOWN 

Function Documentation

◆ 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