wifi_mgmt.h File Reference

WiFi L2 stack public header. More...

#include <zephyr/net/net_mgmt.h>
#include <zephyr/net/wifi.h>
#include <zephyr/net/ethernet.h>
#include <zephyr/net/net_if.h>

Go to the source code of this file.

Data Structures
struct	wifi_scan_result
struct	wifi_connect_req_params
struct	wifi_status
struct	wifi_iface_status
struct	wifi_ps_params
struct	wifi_ps_mode_params
struct	wifi_ps_timeout_params
struct	wifi_twt_params
struct	wifi_twt_flow_info
struct	wifi_ps_config
struct	wifi_reg_domain
struct	net_wifi_mgmt_offload

Macros
#define	NET_REQUEST_WIFI_SCAN    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_SCAN)
#define	NET_REQUEST_WIFI_CONNECT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_CONNECT)
#define	NET_REQUEST_WIFI_DISCONNECT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_DISCONNECT)
#define	NET_REQUEST_WIFI_AP_ENABLE    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_AP_ENABLE)
#define	NET_REQUEST_WIFI_AP_DISABLE    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_AP_DISABLE)
#define	NET_REQUEST_WIFI_IFACE_STATUS    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_IFACE_STATUS)
#define	NET_REQUEST_WIFI_PS    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS)
#define	NET_REQUEST_WIFI_PS_MODE    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS_MODE)
#define	NET_REQUEST_WIFI_TWT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_TWT)
#define	NET_REQUEST_WIFI_PS_CONFIG    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS_CONFIG)
#define	NET_REQUEST_WIFI_REG_DOMAIN    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_REG_DOMAIN)
#define	NET_REQUEST_WIFI_PS_TIMEOUT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS_TIMEOUT)
#define	NET_EVENT_WIFI_SCAN_RESULT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_SCAN_RESULT)
#define	NET_EVENT_WIFI_SCAN_DONE    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_SCAN_DONE)
#define	NET_EVENT_WIFI_CONNECT_RESULT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_CONNECT_RESULT)
#define	NET_EVENT_WIFI_DISCONNECT_RESULT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_DISCONNECT_RESULT)
#define	NET_EVENT_WIFI_IFACE_STATUS    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_IFACE_STATUS)
#define	NET_EVENT_WIFI_TWT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_TWT)
#define	WIFI_MAX_TWT_FLOWS   8
#define	WIFI_MAX_TWT_INTERVAL_MS   0x7FFFFFFF

Typedefs
typedef void(*	scan_result_cb_t) (struct net_if *iface, int status, struct wifi_scan_result *entry)

Enumerations
enum	net_request_wifi_cmd {   NET_REQUEST_WIFI_CMD_SCAN = 1 , NET_REQUEST_WIFI_CMD_CONNECT , NET_REQUEST_WIFI_CMD_DISCONNECT , NET_REQUEST_WIFI_CMD_AP_ENABLE ,   NET_REQUEST_WIFI_CMD_AP_DISABLE , NET_REQUEST_WIFI_CMD_IFACE_STATUS , NET_REQUEST_WIFI_CMD_PS , NET_REQUEST_WIFI_CMD_PS_MODE ,   NET_REQUEST_WIFI_CMD_TWT , NET_REQUEST_WIFI_CMD_PS_CONFIG , NET_REQUEST_WIFI_CMD_REG_DOMAIN , NET_REQUEST_WIFI_CMD_PS_TIMEOUT }
enum	net_event_wifi_cmd {   NET_EVENT_WIFI_CMD_SCAN_RESULT = 1 , NET_EVENT_WIFI_CMD_SCAN_DONE , NET_EVENT_WIFI_CMD_CONNECT_RESULT , NET_EVENT_WIFI_CMD_DISCONNECT_RESULT ,   NET_EVENT_WIFI_CMD_IFACE_STATUS , NET_EVENT_WIFI_CMD_TWT }
enum	wifi_mgmt_op { WIFI_MGMT_GET = 0 , WIFI_MGMT_SET = 1 }

Functions
void	wifi_mgmt_raise_connect_result_event (struct net_if *iface, int status)
void	wifi_mgmt_raise_disconnect_result_event (struct net_if *iface, int status)
void	wifi_mgmt_raise_iface_status_event (struct net_if *iface, struct wifi_iface_status *iface_status)
void	wifi_mgmt_raise_twt_event (struct net_if *iface, struct wifi_twt_params *twt_params)

Detailed Description

WiFi L2 stack public header.

Macro Definition Documentation

NET_EVENT_WIFI_CONNECT_RESULT

#define NET_EVENT_WIFI_CONNECT_RESULT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_CONNECT_RESULT)

NET_EVENT_WIFI_DISCONNECT_RESULT

#define NET_EVENT_WIFI_DISCONNECT_RESULT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_DISCONNECT_RESULT)

NET_EVENT_WIFI_IFACE_STATUS

#define NET_EVENT_WIFI_IFACE_STATUS    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_IFACE_STATUS)

NET_EVENT_WIFI_SCAN_DONE

#define NET_EVENT_WIFI_SCAN_DONE    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_SCAN_DONE)

NET_EVENT_WIFI_SCAN_RESULT

#define NET_EVENT_WIFI_SCAN_RESULT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_SCAN_RESULT)

NET_EVENT_WIFI_TWT

#define NET_EVENT_WIFI_TWT    (_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_TWT)

NET_REQUEST_WIFI_AP_DISABLE

#define NET_REQUEST_WIFI_AP_DISABLE    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_AP_DISABLE)

NET_REQUEST_WIFI_AP_ENABLE

#define NET_REQUEST_WIFI_AP_ENABLE    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_AP_ENABLE)

NET_REQUEST_WIFI_CONNECT

#define NET_REQUEST_WIFI_CONNECT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_CONNECT)

NET_REQUEST_WIFI_DISCONNECT

#define NET_REQUEST_WIFI_DISCONNECT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_DISCONNECT)

NET_REQUEST_WIFI_IFACE_STATUS

#define NET_REQUEST_WIFI_IFACE_STATUS    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_IFACE_STATUS)

NET_REQUEST_WIFI_PS

#define NET_REQUEST_WIFI_PS    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS)

NET_REQUEST_WIFI_PS_CONFIG

#define NET_REQUEST_WIFI_PS_CONFIG    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS_CONFIG)

NET_REQUEST_WIFI_PS_MODE

#define NET_REQUEST_WIFI_PS_MODE    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS_MODE)

NET_REQUEST_WIFI_PS_TIMEOUT

#define NET_REQUEST_WIFI_PS_TIMEOUT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_PS_TIMEOUT)

NET_REQUEST_WIFI_REG_DOMAIN

#define NET_REQUEST_WIFI_REG_DOMAIN    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_REG_DOMAIN)

NET_REQUEST_WIFI_SCAN

#define NET_REQUEST_WIFI_SCAN    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_SCAN)

NET_REQUEST_WIFI_TWT

#define NET_REQUEST_WIFI_TWT    (_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_TWT)

WIFI_MAX_TWT_FLOWS

#define WIFI_MAX_TWT_FLOWS   8

WIFI_MAX_TWT_INTERVAL_MS

#define WIFI_MAX_TWT_INTERVAL_MS   0x7FFFFFFF

Typedef Documentation

scan_result_cb_t

typedef void(* scan_result_cb_t) (struct net_if *iface, int status, struct wifi_scan_result *entry)

Enumeration Type Documentation

net_event_wifi_cmd

enum net_event_wifi_cmd

Enumerator
NET_EVENT_WIFI_CMD_SCAN_RESULT
NET_EVENT_WIFI_CMD_SCAN_DONE
NET_EVENT_WIFI_CMD_CONNECT_RESULT
NET_EVENT_WIFI_CMD_DISCONNECT_RESULT
NET_EVENT_WIFI_CMD_IFACE_STATUS
NET_EVENT_WIFI_CMD_TWT

net_request_wifi_cmd

enum net_request_wifi_cmd

Enumerator
NET_REQUEST_WIFI_CMD_SCAN
NET_REQUEST_WIFI_CMD_CONNECT
NET_REQUEST_WIFI_CMD_DISCONNECT
NET_REQUEST_WIFI_CMD_AP_ENABLE
NET_REQUEST_WIFI_CMD_AP_DISABLE
NET_REQUEST_WIFI_CMD_IFACE_STATUS
NET_REQUEST_WIFI_CMD_PS
NET_REQUEST_WIFI_CMD_PS_MODE
NET_REQUEST_WIFI_CMD_TWT
NET_REQUEST_WIFI_CMD_PS_CONFIG
NET_REQUEST_WIFI_CMD_REG_DOMAIN
NET_REQUEST_WIFI_CMD_PS_TIMEOUT

wifi_mgmt_op

enum wifi_mgmt_op

Enumerator
WIFI_MGMT_GET
WIFI_MGMT_SET

Function Documentation

wifi_mgmt_raise_connect_result_event()

void wifi_mgmt_raise_connect_result_event	(	struct net_if *	iface,
		int	status
	)

wifi_mgmt_raise_disconnect_result_event()

void wifi_mgmt_raise_disconnect_result_event	(	struct net_if *	iface,
		int	status
	)

wifi_mgmt_raise_iface_status_event()

void wifi_mgmt_raise_iface_status_event	(	struct net_if *	iface,
		struct wifi_iface_status *	iface_status
	)

wifi_mgmt_raise_twt_event()

void wifi_mgmt_raise_twt_event	(	struct net_if *	iface,
		struct wifi_twt_params *	twt_params
	)