WLAN Control API for Device Provisioning Protocol (DPP)

Detailed Description

API for executing Device Provisioning Protocol (DPP), also known as Wi-Fi Easy Connect.

Data Structures
struct	mmwlan_dpp_cb_args
	Structure passed back when a DPP event occurs. More...
struct	mmwlan_dpp_args
	Structure to hold the arguments used for the DPP process. More...

Enumerations
enum	mmwlan_dpp_event { MMWLAN_DPP_EVT_PB_RESULT }
	Enumeration of DPP events. More...
enum	mmwlan_dpp_pb_result { MMWLAN_DPP_PB_RESULT_SUCCESS , MMWLAN_DPP_PB_RESULT_ERROR , MMWLAN_DPP_PB_RESULT_SESSION_OVERLAP }
	Enumeration of results for MMWLAN_DPP_EVT_PB_RESULT. More...

Functions
enum mmwlan_status	mmwlan_dpp_start (const struct mmwlan_dpp_args *args)
	Function to start the Device Provisioning Protocol (DPP) process. More...
enum mmwlan_status	mmwlan_dpp_stop (void)
	Function to stop the DPP process. More...

Enumeration Type Documentation

mmwlan_dpp_event

enum mmwlan_dpp_event

Enumeration of DPP events.

Enumerator
MMWLAN_DPP_EVT_PB_RESULT	DPP push button result.

Definition at line 2133 of file mmwlan.h.

mmwlan_dpp_pb_result

enum mmwlan_dpp_pb_result

Enumeration of results for MMWLAN_DPP_EVT_PB_RESULT.

Enumerator
MMWLAN_DPP_PB_RESULT_SUCCESS	DPP push button process was successful.
MMWLAN_DPP_PB_RESULT_ERROR	An error occurred during the DPP push button process.
MMWLAN_DPP_PB_RESULT_SESSION_OVERLAP	A session overlap occurred during the DPP push button process.

Definition at line 2140 of file mmwlan.h.

Function Documentation

mmwlan_dpp_start()

enum mmwlan_status mmwlan_dpp_start

(

const struct mmwlan_dpp_args *

args

)

Function to start the Device Provisioning Protocol (DPP) process.

This will return once DPP has successfully started. Feedback will be provided via the dpp_event_cb.

Warning

If this has been called mmwlan_dpp_stop() MUST be called before mmwlan_shutdown() is called.

Parameters

args	Reference to the dpp arguments to use.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.

Warning

BETA NOTICE: This is beta API that is under development; breaking changes may be introduced in future releases.

mmwlan_dpp_stop()

enum mmwlan_status mmwlan_dpp_stop

(

void

)

Function to stop the DPP process.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.

Warning

BETA NOTICE: This is beta API that is under development; breaking changes may be introduced in future releases.