This file defines the EFI Wireless MAC Connection II Protocol. More...

Go to the source code of this file.

Data Structures
struct	EFI_80211_MAC_ADDRESS
	EFI_80211_MAC_ADDRESS. More...
struct	EFI_80211_SSID
	EFI_80211_SSID. More...
struct	EFI_80211_GET_NETWORKS_DATA
	EFI_80211_GET_NETWORKS_DATA. More...
struct	EFI_80211_SUITE_SELECTOR
	EFI_80211_SUITE_SELECTOR. More...
struct	EFI_80211_AKM_SUITE_SELECTOR
	EFI_80211_AKM_SUITE_SELECTOR. More...
struct	EFI_80211_CIPHER_SUITE_SELECTOR
	EFI_80211_CIPHER_SUITE_SELECTOR. More...
struct	EFI_80211_NETWORK
	EFI_80211_NETWORK. More...
struct	EFI_80211_NETWORK_DESCRIPTION
	EFI_80211_NETWORK_DESCRIPTION. More...
struct	EFI_80211_GET_NETWORKS_RESULT
	EFI_80211_GET_NETWORKS_RESULT. More...
struct	EFI_80211_GET_NETWORKS_TOKEN
	EFI_80211_GET_NETWORKS_TOKEN. More...
struct	EFI_80211_CONNECT_NETWORK_DATA
	EFI_80211_CONNECT_NETWORK_DATA. More...
struct	EFI_80211_CONNECT_NETWORK_TOKEN
	EFI_80211_CONNECT_NETWORK_TOKEN. More...
struct	EFI_80211_DISCONNECT_NETWORK_TOKEN
	EFI_80211_DISCONNECT_NETWORK_TOKEN. More...
struct	_EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL
	The EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL provides network management service interfaces for 802.11 network stack. More...

Macros
#define	EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL_GUID
#define	EFI_MAX_SSID_LEN 32

Typedefs
typedef struct _EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL	EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_WIRELESS_MAC_CONNECTION_II_GET_NETWORKS) (IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL This, IN EFI_80211_GET_NETWORKS_TOKEN Token)
	Request a survey of potential wireless networks that administrator can later elect to try to join.
typedef EFI_STATUS(EFIAPI *	EFI_WIRELESS_MAC_CONNECTION_II_CONNECT_NETWORK) (IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL This, IN EFI_80211_CONNECT_NETWORK_TOKEN Token)
	Connect a wireless network specified by a particular SSID, BSS type and Security type.
typedef EFI_STATUS(EFIAPI *	EFI_WIRELESS_MAC_CONNECTION_II_DISCONNECT_NETWORK) (IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL This, IN EFI_80211_DISCONNECT_NETWORK_TOKEN Token)
	Request a disconnection with current connected wireless network.

Enumerations
enum	EFI_80211_BSS_TYPE { IeeeInfrastructureBSS , IeeeIndependentBSS , IeeeMeshBSS , IeeeAnyBss }
	EFI_80211_BSS_TYPE. More...
enum	EFI_80211_CONNECT_NETWORK_RESULT_CODE { ConnectSuccess , ConnectRefused , ConnectFailed , ConnectFailureTimeout , ConnectFailedReasonUnspecified }
	EFI_80211_CONNECT_NETWORK_RESULT_CODE. More...

Functions
	FILE_LICENCE (BSD2_PATENT)
	FILE_SECBOOT (PERMITTED)

Variables
EFI_GUID	gEfiWiFi2ProtocolGuid

Detailed Description

This file defines the EFI Wireless MAC Connection II Protocol.

Copyright (c) 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:: This Protocol is introduced in UEFI Specification 2.6

Definition in file WiFi2.h.

Macro Definition Documentation

◆ EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL_GUID

#define EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL_GUID

Value:

  { \
    0x1b0fb9bf, 0x699d, 0x4fdd, { 0xa7, 0xc3, 0x25, 0x46, 0x68, 0x1b, 0xf6, 0x3b } \
  }

Definition at line 18 of file WiFi2.h.

#define EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL_GUID \
  { \
    0x1b0fb9bf, 0x699d, 0x4fdd, { 0xa7, 0xc3, 0x25, 0x46, 0x68, 0x1b, 0xf6, 0x3b } \
  }

◆ EFI_MAX_SSID_LEN

#define EFI_MAX_SSID_LEN 32

Definition at line 69 of file WiFi2.h.

Typedef Documentation

◆ EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL

typedef struct _EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL

Definition at line 23 of file WiFi2.h.

◆ EFI_WIRELESS_MAC_CONNECTION_II_GET_NETWORKS

typedef EFI_STATUS(EFIAPI * EFI_WIRELESS_MAC_CONNECTION_II_GET_NETWORKS) (IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL *This, IN EFI_80211_GET_NETWORKS_TOKEN *Token)

Request a survey of potential wireless networks that administrator can later elect to try to join.

Parameters

[in]	This	Pointer to the EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL instance.
[in]	Token	Pointer to the token for getting wireless network.

Return values

EFI_SUCCESS	The operation started, and an event will eventually be raised for the caller.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. Token is NULL.
EFI_UNSUPPORTED	One or more of the input parameters is not supported by this implementation.
EFI_ALREADY_STARTED	The operation of getting wireless network is already started.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 330 of file WiFi2.h.

◆ EFI_WIRELESS_MAC_CONNECTION_II_CONNECT_NETWORK

typedef EFI_STATUS(EFIAPI * EFI_WIRELESS_MAC_CONNECTION_II_CONNECT_NETWORK) (IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL *This, IN EFI_80211_CONNECT_NETWORK_TOKEN *Token)

Connect a wireless network specified by a particular SSID, BSS type and Security type.

Parameters

[in]	This	Pointer to the EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL instance.
[in]	Token	Pointer to the token for connecting wireless network.

Return values

EFI_SUCCESS	The operation started successfully. Results will be notified eventually.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. Token is NULL.
EFI_UNSUPPORTED	One or more of the input parameters are not supported by this implementation.
EFI_ALREADY_STARTED	The connection process is already started.
EFI_NOT_FOUND	The specified wireless network is not found.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 361 of file WiFi2.h.

◆ EFI_WIRELESS_MAC_CONNECTION_II_DISCONNECT_NETWORK

typedef EFI_STATUS(EFIAPI * EFI_WIRELESS_MAC_CONNECTION_II_DISCONNECT_NETWORK) (IN EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL *This, IN EFI_80211_DISCONNECT_NETWORK_TOKEN *Token)

Request a disconnection with current connected wireless network.

Parameters

[in]	This	Pointer to the EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL instance.
[in]	Token	Pointer to the token for disconnecting wireless network.

Return values

EFI_SUCCESS	The operation started successfully. Results will be notified eventually.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. Token is NULL.
EFI_UNSUPPORTED	One or more of the input parameters are not supported by this implementation.
EFI_NOT_FOUND	Not connected to a wireless network.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 390 of file WiFi2.h.

Enumeration Type Documentation

◆ EFI_80211_BSS_TYPE

enum EFI_80211_BSS_TYPE

EFI_80211_BSS_TYPE.

Enumerator
IeeeInfrastructureBSS
IeeeIndependentBSS
IeeeMeshBSS
IeeeAnyBss

Definition at line 28 of file WiFi2.h.

             {
  IeeeInfrastructureBSS,
  IeeeIndependentBSS,
  IeeeMeshBSS,
  IeeeAnyBss
} EFI_80211_BSS_TYPE;

◆ EFI_80211_CONNECT_NETWORK_RESULT_CODE

enum EFI_80211_CONNECT_NETWORK_RESULT_CODE

EFI_80211_CONNECT_NETWORK_RESULT_CODE.

Enumerator
ConnectSuccess
ConnectRefused
ConnectFailed
ConnectFailureTimeout
ConnectFailedReasonUnspecified

Definition at line 38 of file WiFi2.h.

             {
  //
  // The connection establishment operation finished successfully.
  //
  ConnectSuccess,
  //
  // The connection was refused by the Network.
  //
  ConnectRefused,
  //
  // The connection establishment operation failed (i.e, Network is not
  // detected).
  //
  ConnectFailed,
  //
  // The connection establishment operation was terminated on timeout.
  //
  ConnectFailureTimeout,
  //
  // The connection establishment operation failed on other reason.
  //
  ConnectFailedReasonUnspecified
} EFI_80211_CONNECT_NETWORK_RESULT_CODE;

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

Variable Documentation

◆ gEfiWiFi2ProtocolGuid

EFI_GUID gEfiWiFi2ProtocolGuid

extern

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL_GUID

◆ EFI_MAX_SSID_LEN

Typedef Documentation

◆ EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL

◆ EFI_WIRELESS_MAC_CONNECTION_II_GET_NETWORKS

◆ EFI_WIRELESS_MAC_CONNECTION_II_CONNECT_NETWORK

◆ EFI_WIRELESS_MAC_CONNECTION_II_DISCONNECT_NETWORK

Enumeration Type Documentation

◆ EFI_80211_BSS_TYPE

◆ EFI_80211_CONNECT_NETWORK_RESULT_CODE

Function Documentation

◆ FILE_LICENCE()

◆ FILE_SECBOOT()

Variable Documentation

◆ gEfiWiFi2ProtocolGuid