Zephyr API Documentation  3.7.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
wifi_mgmt_ops Struct Reference

Wi-Fi management API. More...

#include <wifi_mgmt.h>

Data Fields

int(* scan )(const struct device *dev, struct wifi_scan_params *params, scan_result_cb_t cb)
 Scan for Wi-Fi networks.
 
int(* connect )(const struct device *dev, struct wifi_connect_req_params *params)
 Connect to a Wi-Fi network.
 
int(* disconnect )(const struct device *dev)
 Disconnect from a Wi-Fi network.
 
int(* ap_enable )(const struct device *dev, struct wifi_connect_req_params *params)
 Enable AP mode.
 
int(* ap_disable )(const struct device *dev)
 Disable AP mode.
 
int(* ap_sta_disconnect )(const struct device *dev, const uint8_t *mac)
 Disconnect a STA from AP.
 
int(* iface_status )(const struct device *dev, struct wifi_iface_status *status)
 Get interface status.
 
int(* get_stats )(const struct device *dev, struct net_stats_wifi *stats)
 Get Wi-Fi statistics.
 
int(* set_power_save )(const struct device *dev, struct wifi_ps_params *params)
 Set power save status.
 
int(* set_twt )(const struct device *dev, struct wifi_twt_params *params)
 Setup or teardown TWT flow.
 
int(* get_power_save_config )(const struct device *dev, struct wifi_ps_config *config)
 Get power save config.
 
int(* reg_domain )(const struct device *dev, struct wifi_reg_domain *reg_domain)
 Set or get regulatory domain.
 
int(* filter )(const struct device *dev, struct wifi_filter_info *filter)
 Set or get packet filter settings for monitor and promiscuous modes.
 
int(* mode )(const struct device *dev, struct wifi_mode_info *mode)
 Set or get mode of operation.
 
int(* channel )(const struct device *dev, struct wifi_channel_info *channel)
 Set or get current channel of operation.
 
int(* get_version )(const struct device *dev, struct wifi_version *params)
 Get Version of WiFi driver and Firmware.
 
int(* set_rts_threshold )(const struct device *dev, unsigned int rts_threshold)
 Set RTS threshold value.
 
int(* ap_config_params )(const struct device *dev, struct wifi_ap_config_params *params)
 Configure AP parameter.
 

Detailed Description

Wi-Fi management API.

Field Documentation

◆ ap_config_params

int(* wifi_mgmt_ops::ap_config_params) (const struct device *dev, struct wifi_ap_config_params *params)

Configure AP parameter.

Parameters
devPointer to the device structure for the driver instance.
paramsAP mode parameter configuration parameter info
Returns
0 if ok, < 0 if error

◆ ap_disable

int(* wifi_mgmt_ops::ap_disable) (const struct device *dev)

Disable AP mode.

Parameters
devPointer to the device structure for the driver instance.
Returns
0 if ok, < 0 if error

◆ ap_enable

int(* wifi_mgmt_ops::ap_enable) (const struct device *dev, struct wifi_connect_req_params *params)

Enable AP mode.

Parameters
devPointer to the device structure for the driver instance.
paramsAP mode parameters
Returns
0 if ok, < 0 if error

◆ ap_sta_disconnect

int(* wifi_mgmt_ops::ap_sta_disconnect) (const struct device *dev, const uint8_t *mac)

Disconnect a STA from AP.

Parameters
devPointer to the device structure for the driver instance.
macMAC address of the STA to disconnect
Returns
0 if ok, < 0 if error

◆ channel

int(* wifi_mgmt_ops::channel) (const struct device *dev, struct wifi_channel_info *channel)

Set or get current channel of operation.

Parameters
devPointer to the device structure for the driver instance.
channelsettings
Returns
0 if ok, < 0 if error

◆ connect

int(* wifi_mgmt_ops::connect) (const struct device *dev, struct wifi_connect_req_params *params)

Connect to a Wi-Fi network.

Parameters
devPointer to the device structure for the driver instance.
paramsConnect parameters
Returns
0 if ok, < 0 if error

◆ disconnect

int(* wifi_mgmt_ops::disconnect) (const struct device *dev)

Disconnect from a Wi-Fi network.

Parameters
devPointer to the device structure for the driver instance.
Returns
0 if ok, < 0 if error

◆ filter

int(* wifi_mgmt_ops::filter) (const struct device *dev, struct wifi_filter_info *filter)

Set or get packet filter settings for monitor and promiscuous modes.

Parameters
devPointer to the device structure for the driver instance.
packetfilter settings
Returns
0 if ok, < 0 if error

◆ get_power_save_config

int(* wifi_mgmt_ops::get_power_save_config) (const struct device *dev, struct wifi_ps_config *config)

Get power save config.

Parameters
devPointer to the device structure for the driver instance.
configPower save config
Returns
0 if ok, < 0 if error

◆ get_stats

int(* wifi_mgmt_ops::get_stats) (const struct device *dev, struct net_stats_wifi *stats)

Get Wi-Fi statistics.

Parameters
devPointer to the device structure for the driver instance.
statsWi-Fi statistics
Returns
0 if ok, < 0 if error

◆ get_version

int(* wifi_mgmt_ops::get_version) (const struct device *dev, struct wifi_version *params)

Get Version of WiFi driver and Firmware.

The driver that implements the get_version function must not use stack to allocate the version information pointers that are returned as params struct members. The version pointer parameters should point to a static memory either in ROM (preferred) or in RAM.

Parameters
devPointer to the device structure for the driver instance
paramsVersion parameters
Returns
0 if ok, < 0 if error

◆ iface_status

int(* wifi_mgmt_ops::iface_status) (const struct device *dev, struct wifi_iface_status *status)

Get interface status.

Parameters
devPointer to the device structure for the driver instance.
statusInterface status
Returns
0 if ok, < 0 if error

◆ mode

int(* wifi_mgmt_ops::mode) (const struct device *dev, struct wifi_mode_info *mode)

Set or get mode of operation.

Parameters
devPointer to the device structure for the driver instance.
modesettings
Returns
0 if ok, < 0 if error

◆ reg_domain

int(* wifi_mgmt_ops::reg_domain) (const struct device *dev, struct wifi_reg_domain *reg_domain)

Set or get regulatory domain.

Parameters
devPointer to the device structure for the driver instance.
reg_domainRegulatory domain
Returns
0 if ok, < 0 if error

◆ scan

int(* wifi_mgmt_ops::scan) (const struct device *dev, struct wifi_scan_params *params, scan_result_cb_t cb)

Scan for Wi-Fi networks.

Parameters
devPointer to the device structure for the driver instance.
paramsScan parameters
cbCallback to be called for each result cb parameter is the cb that should be called for each result by the driver. The wifi mgmt part will take care of raising the necessary event etc.
Returns
0 if ok, < 0 if error

◆ set_power_save

int(* wifi_mgmt_ops::set_power_save) (const struct device *dev, struct wifi_ps_params *params)

Set power save status.

Parameters
devPointer to the device structure for the driver instance.
paramsPower save parameters
Returns
0 if ok, < 0 if error

◆ set_rts_threshold

int(* wifi_mgmt_ops::set_rts_threshold) (const struct device *dev, unsigned int rts_threshold)

Set RTS threshold value.

Parameters
devPointer to the device structure for the driver instance.
RTSthreshold value
Returns
0 if ok, < 0 if error

◆ set_twt

int(* wifi_mgmt_ops::set_twt) (const struct device *dev, struct wifi_twt_params *params)

Setup or teardown TWT flow.

Parameters
devPointer to the device structure for the driver instance.
paramsTWT parameters
Returns
0 if ok, < 0 if error

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