Morse Micro IoT SDK  2.11.2
WLAN Control API for S1G Relay functionality

Detailed Description

API for configuration and control of S1G Relay.

Warning
ALPHA NOTICE: This is an alpha API that is under development. It is not intended for production use. It may be removed in a future release and/or breaking changes may be introduced.

Data Structures

struct  mmwlan_relay_args
 Arguments data structure for mmwlan_relay_enable(). More...
 

Macros

#define MMWLAN_RELAY_DEFAULT_FORWARDING_TABLE_SIZE   (64)
 Default value for the forwarding_table_size member of mmwlan_relay_args. More...
 
#define MMWLAN_RELAY_ARGS_INIT
 Initializer for mmwlan_relay_args. More...
 

Functions

enum mmwlan_status mmwlan_relay_enable (const struct mmwlan_relay_args *args)
 Enable S1G Relay mode. More...
 
enum mmwlan_status mmwlan_relay_disable (void)
 Disable S1G Relay mode. More...
 

Macro Definition Documentation

◆ MMWLAN_RELAY_ARGS_INIT

#define MMWLAN_RELAY_ARGS_INIT
Value:
{ \
.forwarding_table_size = 0, \
.is_root_node = false, \
}

Initializer for mmwlan_relay_args.

See also
mmwlan_relay_args

Definition at line 2001 of file mmwlan.h.

◆ MMWLAN_RELAY_DEFAULT_FORWARDING_TABLE_SIZE

#define MMWLAN_RELAY_DEFAULT_FORWARDING_TABLE_SIZE   (64)

Default value for the forwarding_table_size member of mmwlan_relay_args.

Definition at line 1964 of file mmwlan.h.

Function Documentation

◆ mmwlan_relay_disable()

enum mmwlan_status mmwlan_relay_disable ( void  )

Disable S1G Relay mode.

Warning
ALPHA NOTICE: This is an alpha API that is under development; breaking changes may be introduced in future releases.
Returns
MMWLAN_SUCCESS on success, MMWLAN_NOT_SUPPORTED if S1G Relay support was not enabled at build time, or another appropriate error code.

◆ mmwlan_relay_enable()

enum mmwlan_status mmwlan_relay_enable ( const struct mmwlan_relay_args args)

Enable S1G Relay mode.

Warning
ALPHA NOTICE: This is an alpha API that is under development; breaking changes may be introduced in future releases.
Parameters
argsArguments from application.
Returns
MMWLAN_SUCCESS on success, MMWLAN_NOT_SUPPORTED if S1G Relay support was not enabled at build time, MMWLAN_INVALID_ARGUMENT if arguments are invalid, or another appropriate error code.