Idle state

WFM API messages applicable for an interface in idle mode.

Data Structures

struct  WfmHiSetMacAddressReq_t
 Request message to set MAC address of the interface.
 
struct  WfmHiSetMacAddressCnf_t
 Confirmation message for WfmHiSetMacAddressReq_t.
 
struct  WfmHiConnectReq_t
 Request message for connecting to a Wi-Fi network.
 
struct  WfmHiConnectCnf_t
 Confirmation message for WfmHiConnectReq_t.
 
struct  WfmHiConnectInd_t
 Indication message used to signal the completion of a connection operation.
 
struct  WfmHiStartApReq_t
 Request message for starting a Wi-Fi network.
 
struct  WfmHiStartApCnf_t
 Confirmation message for WfmHiStartApReq_t.
 
struct  WfmHiStartApInd_t
 Indication message used to signal the completion of a start request.
 
struct  WfmHiStartScanReq_t
 Request message for starting a scan to detect near-by access points.
 
struct  WfmHiStartScanCnf_t
 Confirmation message for WfmHiStartScanReq_t.
 
struct  WfmHiStopScanCnf_t
 Confirmation message for WfmHiStopScanReq_t.
 
struct  WfmHiScanResultInd_t
 Indication message used to signal an access point has been detected.
 
struct  WfmHiScanCompleteInd_t
 Indication message used to signal a scan was completed.
 
struct  WfmHiJoinIbssReq_t
 Request message for connecting to or starting an IBSS network.
 
struct  WfmHiJoinIbssCnf_t
 Confirmation message for WfmHiJoinIbssReq_t.
 
struct  WfmHiJoinIbssInd_t
 Indication message used to signal the completion of a join request.
 
struct  WfmHiSetRoamParametersReq_t
 Request message for setting the roaming parameters.
 
struct  WfmHiSetRoamParametersCnf_t
 Confirmation message for WfmHiSetRoamParametersReq_t.
 
struct  WfmHiSetTxRateParametersReq_t
 Request message for setting the TX rate set parameters.
 
struct  WfmHiSetTxRateParametersCnf_t
 Confirmation message for WfmHiSetTxRateParametersReq_t.
 
struct  WfmHiStopScanReq_t
 Request message for stopping an ongoing scan.

Detailed Description

WFM API messages applicable for an interface in idle mode.


Data Structure Documentation

◆ WfmHiSetMacAddressReq_t

struct WfmHiSetMacAddressReq_t

Request message to set MAC address of the interface.

The host can use this request to set the MAC address an interface. If not set, the device will use a built-in MAC address. Note that if multiple interfaces are used, the MAC address MUST be different on each interface.

Definition at line 651 of file wfm_cmd_api.h.

Data Fields
WfmHiSetMacAddressReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiSetMacAddressCnf_t

struct WfmHiSetMacAddressCnf_t

Confirmation message for WfmHiSetMacAddressReq_t.

Definition at line 675 of file wfm_cmd_api.h.

Data Fields
WfmHiSetMacAddressCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiConnectReq_t

struct WfmHiConnectReq_t

Request message for connecting to a Wi-Fi network.

The host can use this request to iniate a connection to a Wi-Fi network.

Successful connection request moves the interface to Wi-Fi client state.

Definition at line 760 of file wfm_cmd_api.h.

Data Fields
WfmHiConnectReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiConnectCnf_t

struct WfmHiConnectCnf_t

Confirmation message for WfmHiConnectReq_t.

Definition at line 784 of file wfm_cmd_api.h.

Data Fields
WfmHiConnectCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiConnectInd_t

struct WfmHiConnectInd_t

Indication message used to signal the completion of a connection operation.

The device will send this indication to signal the connection request initiated with WfmHiConnectReq_t has been completed. The indication is also sent when the device autonomously roams to another access point.

Definition at line 834 of file wfm_cmd_api.h.

Data Fields
WfmHiConnectIndBody_t Body Indication message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStartApReq_t

struct WfmHiStartApReq_t

Request message for starting a Wi-Fi network.

The host can use this request to iniate a Wi-Fi network.

Successful start request moves the interface to Wi-Fi access point state.

Definition at line 1090 of file wfm_cmd_api.h.

Data Fields
WfmHiStartApReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStartApCnf_t

struct WfmHiStartApCnf_t

Confirmation message for WfmHiStartApReq_t.

Definition at line 1114 of file wfm_cmd_api.h.

Data Fields
WfmHiStartApCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStartApInd_t

struct WfmHiStartApInd_t

Indication message used to signal the completion of a start request.

The device will send this indication to signal the start request initiated with WfmHiStartApReq_t has been completed.

Definition at line 1140 of file wfm_cmd_api.h.

Data Fields
WfmHiStartApIndBody_t Body Indication message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStartScanReq_t

struct WfmHiStartScanReq_t

Request message for starting a scan to detect near-by access points.

The host can use this request to start a scan operation to detect near-by access points.

Definition at line 1567 of file wfm_cmd_api.h.

Data Fields
WfmHiStartScanReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStartScanCnf_t

struct WfmHiStartScanCnf_t

Confirmation message for WfmHiStartScanReq_t.

Definition at line 1592 of file wfm_cmd_api.h.

Data Fields
WfmHiStartScanCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStopScanCnf_t

struct WfmHiStopScanCnf_t

Confirmation message for WfmHiStopScanReq_t.

Definition at line 1626 of file wfm_cmd_api.h.

Data Fields
WfmHiStopScanCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiScanResultInd_t

struct WfmHiScanResultInd_t

Indication message used to signal an access point has been detected.

The device will send this indication to signal an access point has has been detected during the scan operation.

Definition at line 1676 of file wfm_cmd_api.h.

Data Fields
WfmHiScanResultIndBody_t Body Indication message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiScanCompleteInd_t

struct WfmHiScanCompleteInd_t

Indication message used to signal a scan was completed.

The device will send this indication to signal a scan operation has been completed.

Definition at line 1703 of file wfm_cmd_api.h.

Data Fields
WfmHiScanCompleteIndBody_t Body Indication message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiJoinIbssReq_t

struct WfmHiJoinIbssReq_t

Request message for connecting to or starting an IBSS network.

The host can use this request to connect to an IBSS network. If no existing network is found, the device will start a new network.

Successful join request moves the interface to IBSS station state.

Definition at line 1752 of file wfm_cmd_api.h.

Data Fields
WfmHiJoinIbssReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiJoinIbssCnf_t

struct WfmHiJoinIbssCnf_t

Confirmation message for WfmHiJoinIbssReq_t.

Definition at line 1776 of file wfm_cmd_api.h.

Data Fields
WfmHiJoinIbssCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiJoinIbssInd_t

struct WfmHiJoinIbssInd_t

Indication message used to signal the completion of a join request.

The device will send this indication to signal the join request initiated with WfmHiJoinIbssReq_t has been completed.

Definition at line 1811 of file wfm_cmd_api.h.

Data Fields
WfmHiJoinIbssIndBody_t Body Indication message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiSetRoamParametersReq_t

struct WfmHiSetRoamParametersReq_t

Request message for setting the roaming parameters.

The host can use this request to configure the roaming parameters of the device.
See Roaming for further details.

Definition at line 2116 of file wfm_cmd_api.h.

Data Fields
WfmHiSetRoamParametersReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiSetRoamParametersCnf_t

struct WfmHiSetRoamParametersCnf_t

Confirmation message for WfmHiSetRoamParametersReq_t.

Definition at line 2141 of file wfm_cmd_api.h.

Data Fields
WfmHiSetRoamParametersCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiSetTxRateParametersReq_t

struct WfmHiSetTxRateParametersReq_t

Request message for setting the TX rate set parameters.

The host can use this request to configure the TX rate set parameters of the device. The rate set determines what data rates will be used by the device to transmit data frames.

Definition at line 2171 of file wfm_cmd_api.h.

Data Fields
WfmHiSetTxRateParametersReqBody_t Body Request message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiSetTxRateParametersCnf_t

struct WfmHiSetTxRateParametersCnf_t

Confirmation message for WfmHiSetTxRateParametersReq_t.

Definition at line 2196 of file wfm_cmd_api.h.

Data Fields
WfmHiSetTxRateParametersCnfBody_t Body Confirmation message body.
HiMsgHdr_t Header Common message header.

◆ WfmHiStopScanReq_t

struct WfmHiStopScanReq_t

Request message for stopping an ongoing scan.

The host can use this request to stop an ongoing scan operation.