EapManagement.h

Go to the documentation of this file.

 
#ifndef __EFI_EAP_MANAGEMENT_PROTOCOL_H__
#define __EFI_EAP_MANAGEMENT_PROTOCOL_H__
 
#include <Protocol/Eap.h>
 
#define EFI_EAP_MANAGEMENT_PROTOCOL_GUID \
  { \
    0xbb62e663, 0x625d, 0x40b2, {0xa0, 0x88, 0xbb, 0xe8, 0x36, 0x23, 0xa2, 0x45 } \
  }
 
typedef struct _EFI_EAP_MANAGEMENT_PROTOCOL EFI_EAP_MANAGEMENT_PROTOCOL;
 
#define PAE_SUPPORT_AUTHENTICATOR  0x01
#define PAE_SUPPORT_SUPPLICANT     0x02
 
typedef struct _EFI_EAPOL_PORT_INFO {
  EFI_PORT_HANDLE    PortNumber;
  UINT8              ProtocolVersion;
  UINT8              PaeCapabilities;
} EFI_EAPOL_PORT_INFO;
 
typedef enum _EFI_EAPOL_SUPPLICANT_PAE_STATE {
  Logoff,
  Disconnected,
  Connecting,
  Acquired,
  Authenticating,
  Held,
  Authenticated,
  MaxSupplicantPaeState
} EFI_EAPOL_SUPPLICANT_PAE_STATE;
 
#define AUTH_PERIOD_FIELD_VALID   0x01
#define HELD_PERIOD_FIELD_VALID   0x02
#define START_PERIOD_FIELD_VALID  0x04
#define MAX_START_FIELD_VALID     0x08
 
typedef struct _EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION {
  UINT8    ValidFieldMask;
  UINTN    AuthPeriod;
  UINTN    HeldPeriod;
  UINTN    StartPeriod;
  UINTN    MaxStart;
} EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION;
 
typedef struct _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS {
  UINTN    EapolFramesReceived;
  UINTN    EapolFramesTransmitted;
  UINTN    EapolStartFramesTransmitted;
  UINTN    EapolLogoffFramesTransmitted;
  UINTN    EapRespIdFramesTransmitted;
  UINTN    EapResponseFramesTransmitted;
  UINTN    EapReqIdFramesReceived;
  UINTN    EapRequestFramesReceived;
  UINTN    InvalidEapolFramesReceived;
  UINTN    EapLengthErrorFramesReceived;
  UINTN    LastEapolFrameVersion;
  UINTN    LastEapolFrameSource;
} EFI_EAPOL_SUPPLICANT_PAE_STATISTICS;
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_GET_SYSTEM_CONFIGURATION)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL          *This,
  OUT BOOLEAN                             *SystemAuthControl,
  OUT EFI_EAPOL_PORT_INFO                 *PortInfo OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_SET_SYSTEM_CONFIGURATION)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL          *This,
  IN BOOLEAN                              SystemAuthControl
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_INITIALIZE_PORT)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL            *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_USER_LOGON)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL          *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_USER_LOGOFF)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL          *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_GET_SUPPLICANT_STATUS)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL                  *This,
  OUT EFI_EAPOL_SUPPLICANT_PAE_STATE              *CurrentState,
  IN OUT EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION   *Configuration  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_SET_SUPPLICANT_CONFIGURATION)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL              *This,
  IN EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION   *Configuration
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_EAP_GET_SUPPLICANT_STATISTICS)(
  IN EFI_EAP_MANAGEMENT_PROTOCOL              *This,
  OUT EFI_EAPOL_SUPPLICANT_PAE_STATISTICS     *Statistics
  );
 
struct _EFI_EAP_MANAGEMENT_PROTOCOL {
  EFI_EAP_GET_SYSTEM_CONFIGURATION        GetSystemConfiguration;
  EFI_EAP_SET_SYSTEM_CONFIGURATION        SetSystemConfiguration;
  EFI_EAP_INITIALIZE_PORT                 InitializePort;
  EFI_EAP_USER_LOGON                      UserLogon;
  EFI_EAP_USER_LOGOFF                     UserLogoff;
  EFI_EAP_GET_SUPPLICANT_STATUS           GetSupplicantStatus;
  EFI_EAP_SET_SUPPLICANT_CONFIGURATION    SetSupplicantConfiguration;
  EFI_EAP_GET_SUPPLICANT_STATISTICS       GetSupplicantStatistics;
};
 
extern EFI_GUID  gEfiEapManagementProtocolGuid;
 
#endif