Wireless LAN Full MAC (WFM) API.

Modules
Idle state
WFM API messages applicable for an interface in idle mode.

Wi-Fi client state
WFM API messages applicable for an interface in STA mode.

Wi-Fi access point state
WFM API messages applicable for an interface in AP mode.

IBSS station state
WFM API messages applicable for an interface in IBSS mode.

API constant values
WFM API constant values.

API types
WFM API types.

API concepts
WFM API concepts.

API messages
WFM API messages.

Data Structures
union	WfmMessageIds_t
	WFM API message IDs.

Enumerations
enum	WfmRequestsIds { WFM_HI_SET_MAC_ADDRESS_REQ_ID =0x42, WFM_HI_CONNECT_REQ_ID =0x43, WFM_HI_DISCONNECT_REQ_ID =0x44, WFM_HI_START_AP_REQ_ID =0x45, WFM_HI_UPDATE_AP_REQ_ID =0x46, WFM_HI_STOP_AP_REQ_ID =0x47, WFM_HI_SEND_FRAME_REQ_ID =0x4a, WFM_HI_START_SCAN_REQ_ID =0x4b, WFM_HI_STOP_SCAN_REQ_ID =0x4c, WFM_HI_GET_SIGNAL_STRENGTH_REQ_ID =0x4e, WFM_HI_DISCONNECT_AP_CLIENT_REQ_ID =0x4f, WFM_HI_JOIN_IBSS_REQ_ID =0x50, WFM_HI_LEAVE_IBSS_REQ_ID =0x51, WFM_HI_SET_PM_MODE_REQ_ID =0x52, WFM_HI_ADD_MULTICAST_ADDR_REQ_ID =0x53, WFM_HI_REMOVE_MULTICAST_ADDR_REQ_ID =0x54, WFM_HI_SET_MAX_AP_CLIENT_COUNT_REQ_ID =0x55, WFM_HI_SET_MAX_AP_CLIENT_INACTIVITY_REQ_ID =0x56, WFM_HI_SET_ROAM_PARAMETERS_REQ_ID =0x57, WFM_HI_SET_TX_RATE_PARAMETERS_REQ_ID =0x58, WFM_HI_SET_ARP_IP_ADDRESS_REQ_ID =0x59, WFM_HI_SET_NS_IP_ADDRESS_REQ_ID =0x5A, WFM_HI_SET_BROADCAST_FILTER_REQ_ID =0x5B, WFM_HI_SET_SCAN_PARAMETERS_REQ_ID =0x5C }
	WFM API request message IDs.

enum	WfmIndicationsIds { WFM_HI_CONNECT_IND_ID =0xc3, WFM_HI_DISCONNECT_IND_ID =0xc4, WFM_HI_START_AP_IND_ID =0xc5, WFM_HI_STOP_AP_IND_ID =0xc7, WFM_HI_RECEIVED_IND_ID =0xca, WFM_HI_SCAN_RESULT_IND_ID =0xcb, WFM_HI_SCAN_COMPLETE_IND_ID =0xcc, WFM_HI_AP_CLIENT_CONNECTED_IND_ID =0xcd, WFM_HI_AP_CLIENT_REJECTED_IND_ID =0xce, WFM_HI_AP_CLIENT_DISCONNECTED_IND_ID =0xcf, WFM_HI_JOIN_IBSS_IND_ID =0xd0, WFM_HI_LEAVE_IBSS_IND_ID =0xd1 }
	WFM API confirmation message IDs.

enum	WfmConfirmationsIds { WFM_HI_SET_MAC_ADDRESS_CNF_ID =0x42, WFM_HI_CONNECT_CNF_ID =0x43, WFM_HI_DISCONNECT_CNF_ID =0x44, WFM_HI_START_AP_CNF_ID =0x45, WFM_HI_UPDATE_AP_CNF_ID =0x46, WFM_HI_STOP_AP_CNF_ID =0x47, WFM_HI_SEND_FRAME_CNF_ID =0x4a, WFM_HI_START_SCAN_CNF_ID =0x4b, WFM_HI_STOP_SCAN_CNF_ID =0x4c, WFM_HI_GET_SIGNAL_STRENGTH_CNF_ID =0x4e, WFM_HI_DISCONNECT_AP_CLIENT_CNF_ID =0x4f, WFM_HI_JOIN_IBSS_CNF_ID =0x50, WFM_HI_LEAVE_IBSS_CNF_ID =0x51, WFM_HI_SET_PM_MODE_CNF_ID =0x52, WFM_HI_ADD_MULTICAST_ADDR_CNF_ID =0x53, WFM_HI_REMOVE_MULTICAST_ADDR_CNF_ID =0x54, WFM_HI_SET_MAX_AP_CLIENT_COUNT_CNF_ID =0x55, WFM_HI_SET_MAX_AP_CLIENT_INACTIVITY_CNF_ID =0x56, WFM_HI_SET_ROAM_PARAMETERS_CNF_ID =0x57, WFM_HI_SET_TX_RATE_PARAMETERS_CNF_ID =0x58, WFM_HI_SET_ARP_IP_ADDRESS_CNF_ID =0x59, WFM_HI_SET_NS_IP_ADDRESS_CNF_ID =0x5A, WFM_HI_SET_BROADCAST_FILTER_CNF_ID =0x5B, WFM_HI_SET_SCAN_PARAMETERS_CNF_ID =0x5C }
	WFM API indication message IDs.

Detailed Description

Wireless LAN Full MAC (WFM) API.

This module describes the functionality and the API messages of the Upper MAC (UMAC) component of the device. UMAC provides the Wireless LAN Full MAC (WFM) API. WFM API is used in conjunction with the general API messages described in GENERAL_API .

The device is capable of operating in different roles such as a Wi-Fi client and as a Wi-Fi access point. In order to make it possible to use multiple roles at the same time, the device has been split into logical units called interfaces.

There are two interfaces available for WFM API. They are referenced with interface IDs 0 and 1. For general information on how to format the API messages, see MESSAGE_CONSTRUCTION .

For a list of WFM API messages, see WfmMessageIds_t for further details.

Data Structure Documentation

◆ WfmMessageIds_t

union WfmMessageIds_t

WFM API message IDs.

Definition at line 113 of file wfm_cmd_api.h .

Data Fields
WfmConfirmationsIds	Confirmations	Confirmation messages sent from the device to the host.
WfmIndicationsIds	Indications	Indication messages sent from the device to the host.
WfmRequestsIds	Requests	Request messages sent from the host to the device.

Enumeration Type Documentation

◆ WfmConfirmationsIds

enum WfmConfirmationsIds

WFM API indication message IDs.

Enumerator
WFM_HI_SET_MAC_ADDRESS_CNF_ID	SET_MAC_ADDRESS confirmation Id. Returns body ::HI_SET_MAC_ADDRESS_CNF_BODY
WFM_HI_CONNECT_CNF_ID	CONNECT confirmation Id. Returns body ::HI_CONNECT_CNF_BODY
WFM_HI_DISCONNECT_CNF_ID	DISCONNECT confirmation Id. Returns body ::HI_DISCONNECT_CNF_BODY
WFM_HI_START_AP_CNF_ID	START_AP confirmation Id. Returns body ::HI_START_AP_CNF_BODY
WFM_HI_UPDATE_AP_CNF_ID	UPDATE_AP confirmation Id. Returns body ::HI_UPDATE_AP_CNF_BODY
WFM_HI_STOP_AP_CNF_ID	STOP_AP confirmation Id. Returns body ::HI_STOP_AP_CNF_BODY
WFM_HI_SEND_FRAME_CNF_ID	SEND_FRAME confirmation Id. Returns body ::HI_SEND_FRAME_CNF_BODY
WFM_HI_START_SCAN_CNF_ID	START_SCAN confirmation Id. Returns body ::HI_START_SCAN_CNF_BODY
WFM_HI_STOP_SCAN_CNF_ID	STOP_SCAN confirmation Id. Returns body ::HI_STOP_SCAN_CNF_BODY
WFM_HI_GET_SIGNAL_STRENGTH_CNF_ID	GET_SIGNAL_STRENGTH confirmation Id. Returns body ::HI_GET_SIGNAL_STRENGTH_CNF_BODY
WFM_HI_DISCONNECT_AP_CLIENT_CNF_ID	DISCONNECT_AP_CLIENT confirmation Id. Returns body ::HI_DISCONNECT_AP_CLIENT_CNF_BODY
WFM_HI_JOIN_IBSS_CNF_ID	JOIN_IBSS confirmation Id. Returns body ::HI_JOIN_IBSS_CNF_BODY
WFM_HI_LEAVE_IBSS_CNF_ID	LEAVE_IBSS confirmation Id. Returns body ::HI_LEAVE_IBSS_CNF_BODY
WFM_HI_SET_PM_MODE_CNF_ID	SET_PM_MODE confirmation Id. Returns body ::HI_SET_PM_MODE_CNF_BODY
WFM_HI_ADD_MULTICAST_ADDR_CNF_ID	ADD_MULTICAST_ADDR confirmation Id. Returns body ::HI_ADD_MULTICAST_ADDR_CNF_BODY
WFM_HI_REMOVE_MULTICAST_ADDR_CNF_ID	REMOVE_MULTICAST_ADDR confirmation Id. Returns body ::HI_REMOVE_MULTICAST_ADDR_CNF_BODY
WFM_HI_SET_MAX_AP_CLIENT_COUNT_CNF_ID	SET_MAX_AP_CLIENT_COUNT confirmation Id. Returns body ::HI_SET_MAX_AP_CLIENT_COUNT_CNF_BODY
WFM_HI_SET_MAX_AP_CLIENT_INACTIVITY_CNF_ID	SET_MAX_AP_CLIENT_INACTIVITY confirmation Id. Returns body ::HI_SET_MAX_AP_CLIENT_INACTIVITY_CNF_BODY
WFM_HI_SET_ROAM_PARAMETERS_CNF_ID	SET_ROAM_PARAMETERS confirmation Id. Returns body ::HI_SET_ROAM_PARAMETERS_CNF_BODY
WFM_HI_SET_TX_RATE_PARAMETERS_CNF_ID	SET_TX_RATE_PARAMETERS confirmation Id. Returns body ::HI_SET_TX_RATE_PARAMETERS_CNF_BODY
WFM_HI_SET_ARP_IP_ADDRESS_CNF_ID	SET_ARP_IP_ADDRESS confirmation Id. Returns body ::HI_SET_ARP_IP_ADDRESS_CNF_BODY
WFM_HI_SET_NS_IP_ADDRESS_CNF_ID	SET_NS_IP_ADDRESS confirmation Id. Returns body ::HI_SET_NS_IP_ADDRESS_CNF_BODY
WFM_HI_SET_BROADCAST_FILTER_CNF_ID	SET_BROADCAST_FILTER confirmation Id. Returns body ::HI_SET_BROADCAST_FILTER_CNF_BODY
WFM_HI_SET_SCAN_PARAMETERS_CNF_ID	SET_SCAN_PARAMETERS confirmation Id. Returns body ::HI_SET_SCAN_PARAMETERS_CNF_BODY

Definition at line 83 of file wfm_cmd_api.h .

◆ WfmIndicationsIds

enum WfmIndicationsIds

WFM API confirmation message IDs.

Enumerator
WFM_HI_CONNECT_IND_ID	CONNECT indication id. Content is ::HI_CONNECT_IND_BODY
WFM_HI_DISCONNECT_IND_ID	DISCONNECT indication id. Content is ::HI_DISCONNECT_IND_BODY
WFM_HI_START_AP_IND_ID	START_AP indication id. Content is ::HI_START_AP_IND_BODY
WFM_HI_STOP_AP_IND_ID	STOP_AP indication id. Content is ::HI_STOP_AP_IND_BODY
WFM_HI_RECEIVED_IND_ID	RECEIVED indication id. Content is ::HI_RECEIVED_IND_BODY
WFM_HI_SCAN_RESULT_IND_ID	SCAN_RESULT indication id. Content is ::HI_SCAN_RESULT_IND_BODY
WFM_HI_SCAN_COMPLETE_IND_ID	SCAN_COMPLETE indication id. Content is ::HI_SCAN_COMPLETE_IND_BODY
WFM_HI_AP_CLIENT_CONNECTED_IND_ID	AP_CLIENT_CONNECTED indication id. Content is ::HI_AP_CLIENT_CONNECTED_IND_BODY
WFM_HI_AP_CLIENT_REJECTED_IND_ID	AP_CLIENT_REJECTED indication id. Content is ::HI_AP_CLIENT_REJECTED_IND_BODY
WFM_HI_AP_CLIENT_DISCONNECTED_IND_ID	AP_CLIENT_DISCONNECTED indication id. Content is ::HI_AP_CLIENT_DISCONNECTED_IND_BODY
WFM_HI_JOIN_IBSS_IND_ID	JOIN_IBSS indication id. Content is ::HI_JOIN_IBSS_IND_BODY
WFM_HI_LEAVE_IBSS_IND_ID	LEAVE_IBSS indication id. Content is ::HI_LEAVE_IBSS_IND_BODY

Definition at line 65 of file wfm_cmd_api.h .

◆ WfmRequestsIds

enum WfmRequestsIds

WFM API request message IDs.

Enumerator
WFM_HI_SET_MAC_ADDRESS_REQ_ID	SET_MAC_ADDRESS request ID use body ::HI_SET_MAC_ADDRESS_REQ_BODY and returns ::HI_SET_MAC_ADDRESS_CNF_BODY
WFM_HI_CONNECT_REQ_ID	CONNECT request ID use body ::HI_CONNECT_REQ_BODY and returns ::HI_CONNECT_CNF_BODY
WFM_HI_DISCONNECT_REQ_ID	DISCONNECT request ID use body ::HI_DISCONNECT_REQ_BODY and returns ::HI_DISCONNECT_CNF_BODY
WFM_HI_START_AP_REQ_ID	START_AP request ID use body ::HI_START_AP_REQ_BODY and returns ::HI_START_AP_CNF_BODY
WFM_HI_UPDATE_AP_REQ_ID	UPDATE_AP request ID use body ::HI_UPDATE_AP_REQ_BODY and returns ::HI_UPDATE_AP_CNF_BODY
WFM_HI_STOP_AP_REQ_ID	STOP_AP request ID use body ::HI_STOP_AP_REQ_BODY and returns ::HI_STOP_AP_CNF_BODY
WFM_HI_SEND_FRAME_REQ_ID	SEND_FRAME request ID use body ::HI_SEND_FRAME_REQ_BODY and returns ::HI_SEND_FRAME_CNF_BODY
WFM_HI_START_SCAN_REQ_ID	START_SCAN request ID use body ::HI_START_SCAN_REQ_BODY and returns ::HI_START_SCAN_CNF_BODY
WFM_HI_STOP_SCAN_REQ_ID	STOP_SCAN request ID use body ::HI_STOP_SCAN_REQ_BODY and returns ::HI_STOP_SCAN_CNF_BODY
WFM_HI_GET_SIGNAL_STRENGTH_REQ_ID	GET_SIGNAL_STRENGTH request ID use body ::HI_GET_SIGNAL_STRENGTH_REQ_BODY and returns ::HI_GET_SIGNAL_STRENGTH_CNF_BODY
WFM_HI_DISCONNECT_AP_CLIENT_REQ_ID	DISCONNECT_AP_CLIENT request ID use body ::HI_DISCONNECT_AP_CLIENT_REQ_BODY and returns ::HI_DISCONNECT_AP_CLIENT_CNF_BODY
WFM_HI_JOIN_IBSS_REQ_ID	JOIN_IBSS request ID use body ::HI_JOIN_IBSS_REQ_BODY and returns ::HI_JOIN_IBSS_CNF_BODY
WFM_HI_LEAVE_IBSS_REQ_ID	LEAVE_IBSS request ID use body ::HI_LEAVE_IBSS_REQ_BODY and returns ::HI_LEAVE_IBSS_CNF_BODY
WFM_HI_SET_PM_MODE_REQ_ID	SET_PM_MODE request ID use body ::HI_SET_PM_MODE_REQ_BODY and returns ::HI_SET_PM_MODE_CNF_BODY
WFM_HI_ADD_MULTICAST_ADDR_REQ_ID	ADD_MULTICAST_ADDR request ID use body ::HI_ADD_MULTICAST_ADDR_REQ_BODY and returns ::HI_ADD_MULTICAST_ADDR_CNF_BODY
WFM_HI_REMOVE_MULTICAST_ADDR_REQ_ID	REMOVE_MULTICAST_ADDR request ID use body ::HI_REMOVE_MULTICAST_ADDR_REQ_BODY and returns ::HI_REMOVE_MULTICAST_ADDR_CNF_BODY
WFM_HI_SET_MAX_AP_CLIENT_COUNT_REQ_ID	SET_MAX_AP_CLIENT_COUNT request ID use body ::HI_SET_MAX_AP_CLIENT_COUNT_REQ_BODY and returns ::HI_SET_MAX_AP_CLIENT_COUNT_CNF_BODY
WFM_HI_SET_MAX_AP_CLIENT_INACTIVITY_REQ_ID	SET_MAX_AP_CLIENT_INACTIVITY request ID use body ::HI_SET_MAX_AP_CLIENT_INACTIVITY_REQ_BODY and returns ::HI_SET_MAX_AP_CLIENT_INACTIVITY_CNF_BODY
WFM_HI_SET_ROAM_PARAMETERS_REQ_ID	SET_ROAM_PARAMETERS request ID use body ::HI_SET_ROAM_PARAMETERS_REQ_BODY and returns ::HI_SET_ROAM_PARAMETERS_CNF_BODY
WFM_HI_SET_TX_RATE_PARAMETERS_REQ_ID	SET_TX_RATE_PARAMETERS request ID use body ::HI_SET_TX_RATE_PARAMETERS_REQ_BODY and returns ::HI_SET_TX_RATE_PARAMETERS_CNF_BODY
WFM_HI_SET_ARP_IP_ADDRESS_REQ_ID	SET_ARP_IP_ADDRESS request ID use body ::HI_SET_ARP_IP_ADDRESS_REQ_BODY and returns ::HI_SET_ARP_IP_ADDRESS_CNF_BODY
WFM_HI_SET_NS_IP_ADDRESS_REQ_ID	SET_NS_IP_ADDRESS request ID use body ::HI_SET_NS_IP_ADDRESS_REQ_BODY and returns ::HI_SET_NS_IP_ADDRESS_CNF_BODY
WFM_HI_SET_BROADCAST_FILTER_REQ_ID	SET_BROADCAST_FILTER request ID use body ::HI_SET_BROADCAST_FILTER_REQ_BODY and returns ::HI_SET_BROADCAST_FILTER_CNF_BODY
WFM_HI_SET_SCAN_PARAMETERS_REQ_ID	SET_SCAN_PARAMETERS request ID use body ::HI_SET_SCAN_PARAMETERS_REQ_BODY and returns ::HI_SET_SCAN_PARAMETERS_CNF_BODY

Definition at line 35 of file wfm_cmd_api.h .

FULL_MAC_API

Modules

Data Structures