#include <WifiConnectionManagerDxe/WifiConnectionMgrConfig.h>

Data Structures
struct	EDKII_WIFI_PROFILE_SYNC_PROTOCOL

Macros
#define	EDKII_WIFI_PROFILE_SYNC_PROTOCOL_REVISION 1

Typedefs
typedef EFI_STATUS(EFIAPI *	WIFI_PROFILE_GET) (IN OUT WIFI_MGR_NETWORK_PROFILE *Profile, IN OUT EFI_80211_MAC_ADDRESS MacAddress)

typedef VOID(EFIAPI *	WIFI_SET_CONNECT_STATE) (IN EFI_80211_CONNECT_NETWORK_RESULT_CODE ConnectionStatus)

typedef EFI_STATUS(EFIAPI *	WIFI_GET_CONNECT_STATE) (VOID)

Variables
EFI_GUID	gEdkiiWiFiProfileSyncProtocolGuid

Detailed Description

WiFi profile sync protocol. Supports One Click Recovery or KVM OS recovery boot flow over WiFi. This protocol will hold the WiFi profile provided by AMT in its original structure, then convert the profile when the WifiConnectionManager is attempting a connection during a system recovery reboot, OCR or KVM. These converstion and operations are found in the WifiProfileSync driver and in the link provided below.

This protocol facilitates the reporting and storing of the connection state incase of failure, to which a connection attempt will rety a maximum of 3 times.

Pulbic links to speficiation document for KVM and One Click Recovery feature. https://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide/default.htm?turl=WordDocuments%2Foneclickrecovery.htm

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file WiFiProfileSyncProtocol.h.

Macro Definition Documentation

◆ EDKII_WIFI_PROFILE_SYNC_PROTOCOL_REVISION

#define EDKII_WIFI_PROFILE_SYNC_PROTOCOL_REVISION 1

WiFi Profile Protocol revision number.

Revision 1: Initial version

Definition at line 91 of file WiFiProfileSyncProtocol.h.

Typedef Documentation

◆ WIFI_GET_CONNECT_STATE

typedef EFI_STATUS(EFIAPI * WIFI_GET_CONNECT_STATE) (VOID)

Retrieves the stored WiFi connection status when in either KVM OR One Click Recovery WLAN recovery flow.

Return values

EFI_SUCCESS	WiFi connection completed succesfully
Others	Connection failure occurred

Definition at line 71 of file WiFiProfileSyncProtocol.h.

◆ WIFI_PROFILE_GET

typedef EFI_STATUS(EFIAPI * WIFI_PROFILE_GET) (IN OUT WIFI_MGR_NETWORK_PROFILE *Profile, IN OUT EFI_80211_MAC_ADDRESS MacAddress)

Used by the WiFi connection manager to get the WiFi profile that AMT shared and was stored in WiFi profile protocol. Aligns the AMT WiFi profile data to the WiFi connection manager profile structure fo connection use.

Parameters

[in,out]	WcmProfile	WiFi Connection Manager profile structure
[in,out]	MacAddress	MAC address from AMT saved to NiC MAC address

Return values

EFI_SUCCESS	Stored WiFi profile converted and returned succefully
EFI_UNSUPPORTED	Profile protocol sharing not supported or enabled
EFI_NOT_FOUND	No profiles to returned
Others	Error Occurred

Definition at line 44 of file WiFiProfileSyncProtocol.h.

◆ WIFI_SET_CONNECT_STATE

typedef VOID(EFIAPI * WIFI_SET_CONNECT_STATE) (IN EFI_80211_CONNECT_NETWORK_RESULT_CODE ConnectionStatus)

Saves the WiFi connection status recieved by the WiFiConnectionManager when in a KVM OR One Click Recovery WLAN recovery flow. Input as EFI_80211_CONNECT_NETWORK_RESULT_CODE then converted and stored as EFI_STATUS type.

Parameters

[in] ConnectionStatus WiFi connection attempt results

Definition at line 58 of file WiFiProfileSyncProtocol.h.

Data Structures

Macros

Typedefs