WiFi2.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	EFI_80211_MAC_ADDRESS
struct	EFI_80211_SSID
struct	EFI_80211_GET_NETWORKS_DATA
struct	EFI_80211_SUITE_SELECTOR
struct	EFI_80211_AKM_SUITE_SELECTOR
struct	EFI_80211_CIPHER_SUITE_SELECTOR
struct	EFI_80211_NETWORK
struct	EFI_80211_NETWORK_DESCRIPTION
struct	EFI_80211_GET_NETWORKS_RESULT
struct	EFI_80211_GET_NETWORKS_TOKEN
struct	EFI_80211_CONNECT_NETWORK_DATA
struct	EFI_80211_CONNECT_NETWORK_TOKEN
struct	EFI_80211_DISCONNECT_NETWORK_TOKEN
struct	_EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL

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)
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)
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)

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

Variables
EFI_GUID	gEfiWiFi2ProtocolGuid

Detailed Description

This file defines the EFI Wireless MAC Connection II Protocol.

Copyright (c) 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:

This Protocol is introduced in UEFI Specification 2.6

Macro Definition Documentation

EFI_MAX_SSID_LEN

#define EFI_MAX_SSID_LEN   32

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 } \
  }

Typedef Documentation

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.

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.

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.

EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL

typedef struct _EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL EFI_WIRELESS_MAC_CONNECTION_II_PROTOCOL

Enumeration Type Documentation

EFI_80211_BSS_TYPE

enum EFI_80211_BSS_TYPE

EFI_80211_BSS_TYPE

Enumerator
IeeeInfrastructureBSS
IeeeIndependentBSS
IeeeMeshBSS
IeeeAnyBss

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

Variable Documentation

gEfiWiFi2ProtocolGuid

EFI_GUID gEfiWiFi2ProtocolGuid

extern