Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Wi-Fi Network Manager API

Wi-Fi Network manager API. More...

Data Structures

struct  wifi_nm_instance
 WiFi Network manager instance. More...
 

Macros

#define WIFI_NM_NAME(name)   wifi_nm_##name
 
#define DEFINE_WIFI_NM_INSTANCE(_name, _ops)
 

Functions

struct wifi_nm_instancewifi_nm_get_instance (const char *name)
 Get a Network manager instance for a given name.
 
struct wifi_nm_instancewifi_nm_get_instance_iface (struct net_if *iface)
 Get a Network manager instance for a given interface.
 
int wifi_nm_register_mgd_iface (struct wifi_nm_instance *nm, struct net_if *iface)
 Register a managed interface.
 
int wifi_nm_unregister_mgd_iface (struct wifi_nm_instance *nm, struct net_if *iface)
 Unregister managed interface.
 

Detailed Description

Wi-Fi Network manager API.

Macro Definition Documentation

◆ DEFINE_WIFI_NM_INSTANCE

#define DEFINE_WIFI_NM_INSTANCE (   _name,
  _ops 
)

#include <zephyr/net/wifi_nm.h>

Value:
.name = STRINGIFY(_name), \
.ops = _ops, \
.mgd_ifaces = { NULL }, \
}
#define STRINGIFY(s)
Definition: common.h:134
#define STRUCT_SECTION_ITERABLE(struct_type, varname)
Defines a new element for an iterable section.
Definition: iterable_sections.h:216
#define WIFI_NM_NAME(name)
Definition: wifi_nm.h:45
WiFi Network manager instance.
Definition: wifi_nm.h:36

◆ WIFI_NM_NAME

#define WIFI_NM_NAME (   name)    wifi_nm_##name

Function Documentation

◆ wifi_nm_get_instance()

struct wifi_nm_instance * wifi_nm_get_instance ( const char *  name)

#include <zephyr/net/wifi_nm.h>

Get a Network manager instance for a given name.

Parameters
nameName of the Network manager instance

◆ wifi_nm_get_instance_iface()

struct wifi_nm_instance * wifi_nm_get_instance_iface ( struct net_if iface)

#include <zephyr/net/wifi_nm.h>

Get a Network manager instance for a given interface.

Parameters
ifaceInterface

◆ wifi_nm_register_mgd_iface()

int wifi_nm_register_mgd_iface ( struct wifi_nm_instance nm,
struct net_if iface 
)

#include <zephyr/net/wifi_nm.h>

Register a managed interface.

Parameters
nmPointer to Network manager instance
ifaceManaged interface
Return values
0If successful.
-EINVALIf invalid parameters were passed.
-ENOTSUPIf the interface is not a Wi-Fi interface.
-ENOMEMIf the maximum number of managed interfaces has been reached.

◆ wifi_nm_unregister_mgd_iface()

int wifi_nm_unregister_mgd_iface ( struct wifi_nm_instance nm,
struct net_if iface 
)

#include <zephyr/net/wifi_nm.h>

Unregister managed interface.

Parameters
nmPointer to Network manager instance
ifaceInterface
Returns
int 0 for OK; -EINVAL for invalid parameters; -ENOENT if interface is not registered with the Network manager.