/** @file\r
EFI EAP Management Protocol Definition\r
The EFI EAP Management Protocol is designed to provide ease of management and\r
- ease of test for EAPOL state machine. It is intended for the supplicant side. \r
- It conforms to IEEE 802.1x specification. \r
+ ease of test for EAPOL state machine. It is intended for the supplicant side.\r
+ It conforms to IEEE 802.1x specification.\r
The definitions in this file are defined in UEFI Specification 2.2, which have\r
not been verified by one implementation yet.\r
\r
- Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- @par Revision Reference: \r
+ @par Revision Reference:\r
This Protocol is introduced in UEFI Specification 2.2\r
\r
**/\r
///\r
/// EFI_EAPOL_PORT_INFO\r
///\r
-typedef struct _EFI_EAPOL_PORT_INFO { \r
- /// \r
- /// The identification number assigned to the Port by the System in \r
+typedef struct _EFI_EAPOL_PORT_INFO {\r
+ ///\r
+ /// The identification number assigned to the Port by the System in\r
/// which the Port resides.\r
- /// \r
+ ///\r
EFI_PORT_HANDLE PortNumber;\r
- /// \r
- /// The protocol version number of the EAPOL implementation \r
- /// supported by the Port. \r
- /// \r
+ ///\r
+ /// The protocol version number of the EAPOL implementation\r
+ /// supported by the Port.\r
+ ///\r
UINT8 ProtocolVersion;\r
- /// \r
- /// The capabilities of the PAE associated with the Port. This field \r
- /// indicates whether Authenticator functionality, Supplicant \r
+ ///\r
+ /// The capabilities of the PAE associated with the Port. This field\r
+ /// indicates whether Authenticator functionality, Supplicant\r
/// functionality, both, or neither, is supported by the Port's PAE.\r
- /// \r
+ ///\r
UINT8 PaeCapabilities;\r
} EFI_EAPOL_PORT_INFO;\r
\r
} EFI_EAPOL_SUPPLICANT_PAE_STATE;\r
\r
///\r
-/// Definitions for ValidFieldMask \r
+/// Definitions for ValidFieldMask\r
///\r
///@{\r
#define AUTH_PERIOD_FIELD_VALID 0x01\r
/// EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION\r
///\r
typedef struct _EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION {\r
- /// \r
+ ///\r
/// Indicates which of the following fields are valid.\r
- /// \r
- UINT8 ValidFieldMask; \r
+ ///\r
+ UINT8 ValidFieldMask;\r
///\r
/// The initial value for the authWhile timer. Its default value is 30s.\r
///\r
- UINTN AuthPeriod; \r
+ UINTN AuthPeriod;\r
+ ///\r
+ /// The initial value for the heldWhile timer. Its default value is 60s.\r
///\r
- /// The initial value for the heldWhile timer. Its default value is 60s. \r
+ UINTN HeldPeriod;\r
///\r
- UINTN HeldPeriod; \r
+ /// The initial value for the startWhen timer. Its default value is 30s.\r
///\r
- /// The initial value for the startWhen timer. Its default value is 30s. \r
+ UINTN StartPeriod;\r
///\r
- UINTN StartPeriod; \r
- /// \r
- /// The maximum number of successive EAPOL-Start messages will \r
- /// be sent before the Supplicant assumes that there is no \r
+ /// The maximum number of successive EAPOL-Start messages will\r
+ /// be sent before the Supplicant assumes that there is no\r
/// Authenticator present. Its default value is 3.\r
- /// \r
+ ///\r
UINTN MaxStart;\r
} EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION;\r
\r
typedef struct _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS {\r
///\r
/// The number of EAPOL frames of any type that have been received by this Supplican.\r
- /// \r
+ ///\r
UINTN EapolFramesReceived;\r
///\r
- /// The number of EAPOL frames of any type that have been transmitted by this Supplicant. \r
+ /// The number of EAPOL frames of any type that have been transmitted by this Supplicant.\r
///\r
UINTN EapolFramesTransmitted;\r
- /// \r
- /// The number of EAPOL Start frames that have been transmitted by this Supplicant. \r
- /// \r
+ ///\r
+ /// The number of EAPOL Start frames that have been transmitted by this Supplicant.\r
+ ///\r
UINTN EapolStartFramesTransmitted;\r
- /// \r
+ ///\r
/// The number of EAPOL Logoff frames that have been transmitted by this Supplicant.\r
///\r
UINTN EapolLogoffFramesTransmitted;\r
/// The number of EAP Resp/Id frames that have been transmitted by this Supplicant.\r
///\r
UINTN EapRespIdFramesTransmitted;\r
- /// \r
- /// The number of valid EAP Response frames (other than Resp/Id frames) that have been \r
+ ///\r
+ /// The number of valid EAP Response frames (other than Resp/Id frames) that have been\r
/// transmitted by this Supplicant.\r
///\r
UINTN EapResponseFramesTransmitted;\r
- /// \r
+ ///\r
/// The number of EAP Req/Id frames that have been received by this Supplicant.\r
- /// \r
+ ///\r
UINTN EapReqIdFramesReceived;\r
///\r
- /// The number of EAP Request frames (other than Rq/Id frames) that have been received \r
+ /// The number of EAP Request frames (other than Rq/Id frames) that have been received\r
/// by this Supplicant.\r
///\r
UINTN EapRequestFramesReceived;\r
///\r
- /// The number of EAPOL frames that have been received by this Supplicant in which the \r
+ /// The number of EAPOL frames that have been received by this Supplicant in which the\r
/// frame type is not recognized.\r
///\r
UINTN InvalidEapolFramesReceived;\r
- /// \r
- /// The number of EAPOL frames that have been received by this Supplicant in which the \r
+ ///\r
+ /// The number of EAPOL frames that have been received by this Supplicant in which the\r
/// Packet Body Length field (7.5.5) is invalid.\r
- /// \r
+ ///\r
UINTN EapLengthErrorFramesReceived;\r
- /// \r
+ ///\r
/// The protocol version number carried in the most recently received EAPOL frame.\r
- /// \r
+ ///\r
UINTN LastEapolFrameVersion;\r
- /// \r
+ ///\r
/// The source MAC address carried in the most recently received EAPOL frame.\r
- /// \r
+ ///\r
UINTN LastEapolFrameSource;\r
} EFI_EAPOL_SUPPLICANT_PAE_STATISTICS;\r
\r
/**\r
- Read the system configuration information associated with the Port. \r
+ Read the system configuration information associated with the Port.\r
\r
The GetSystemConfiguration() function reads the system configuration\r
- information associated with the Port, including the value of the \r
+ information associated with the Port, including the value of the\r
SystemAuthControl parameter of the System is returned in SystemAuthControl\r
and the Port's information is returned in the buffer pointed to by PortInfo.\r
- The Port's information is optional. \r
+ The Port's information is optional.\r
If PortInfo is NULL, then reading the Port's information is ignored.\r
\r
If SystemAuthControl is NULL, then EFI_INVALID_PARAMETER is returned.\r
@param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL\r
instance that indicates the calling context.\r
@param[out] SystemAuthControl Returns the value of the SystemAuthControl\r
- parameter of the System. \r
+ parameter of the System.\r
TRUE means Enabled. FALSE means Disabled.\r
@param[out] PortInfo Returns EFI_EAPOL_PORT_INFO structure to describe\r
the Port's information. This parameter can be NULL\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EAP_GET_SYSTEM_CONFIGURATION)(\r
- IN EFI_EAP_MANAGEMENT_PROTOCOL *This, \r
- OUT BOOLEAN *SystemAuthControl, \r
+ IN EFI_EAP_MANAGEMENT_PROTOCOL *This,\r
+ OUT BOOLEAN *SystemAuthControl,\r
OUT EFI_EAPOL_PORT_INFO *PortInfo OPTIONAL\r
);\r
\r
/**\r
- Set the system configuration information associated with the Port. \r
+ Set the system configuration information associated with the Port.\r
\r
- The SetSystemConfiguration() function sets the value of the SystemAuthControl \r
+ The SetSystemConfiguration() function sets the value of the SystemAuthControl\r
parameter of the System to SystemAuthControl.\r
\r
@param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL\r
instance that indicates the calling context.\r
- @param[in] SystemAuthControl The desired value of the SystemAuthControl \r
- parameter of the System. \r
+ @param[in] SystemAuthControl The desired value of the SystemAuthControl\r
+ parameter of the System.\r
TRUE means Enabled. FALSE means Disabled.\r
\r
@retval EFI_SUCCESS The system configuration information of the\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EAP_SET_SYSTEM_CONFIGURATION)(\r
- IN EFI_EAP_MANAGEMENT_PROTOCOL *This, \r
+ IN EFI_EAP_MANAGEMENT_PROTOCOL *This,\r
IN BOOLEAN SystemAuthControl\r
);\r
\r
);\r
\r
/**\r
- Notify the EAPOL state machines for the Port that the user of the System has \r
+ Notify the EAPOL state machines for the Port that the user of the System has\r
logged off.\r
\r
The UserLogoff() function notifies the EAPOL state machines for the Port.\r
The GetSupplicantStatus() function reads the status of the Supplicant PAE state\r
machine for the Port, including the current state CurrentState and the configuration\r
of the operational parameters Configuration. The configuration of the operational\r
- parameters is optional. If Configuration is NULL, then reading the configuration \r
- is ignored. The operational parameters in Configuration to be read can also be \r
+ parameters is optional. If Configuration is NULL, then reading the configuration\r
+ is ignored. The operational parameters in Configuration to be read can also be\r
specified by Configuration.ValidFieldMask.\r
\r
If CurrentState is NULL, then EFI_INVALID_PARAMETER is returned.\r
@param[in, out] Configuration Returns the configuration of the operational\r
parameters of the Supplicant PAE state machine\r
for the Port as required. This parameter can be\r
- NULL to ignore reading the configuration. \r
- On input, Configuration.ValidFieldMask specifies the \r
+ NULL to ignore reading the configuration.\r
+ On input, Configuration.ValidFieldMask specifies the\r
operational parameters to be read.\r
On output, Configuration returns the configuration\r
- of the required operational parameters. \r
+ of the required operational parameters.\r
\r
@retval EFI_SUCCESS The configuration of the operational parameter\r
of the Supplicant PAE state machine for the Port\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EAP_GET_SUPPLICANT_STATUS)(\r
- IN EFI_EAP_MANAGEMENT_PROTOCOL *This, \r
- OUT EFI_EAPOL_SUPPLICANT_PAE_STATE *CurrentState, \r
+ IN EFI_EAP_MANAGEMENT_PROTOCOL *This,\r
+ OUT EFI_EAPOL_SUPPLICANT_PAE_STATE *CurrentState,\r
IN OUT EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION *Configuration OPTIONAL\r
);\r
\r
/**\r
- Set the configuration of the operational parameter of the Supplicant PAE \r
+ Set the configuration of the operational parameter of the Supplicant PAE\r
state machine for the Port.\r
\r
- The SetSupplicantConfiguration() function sets the configuration of the \r
+ The SetSupplicantConfiguration() function sets the configuration of the\r
operational Parameter of the Supplicant PAE state machine for the Port to\r
Configuration. The operational parameters in Configuration to be set can be\r
specified by Configuration.ValidFieldMask.\r
\r
@param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL\r
instance that indicates the calling context.\r
- @param[in] Configuration The desired configuration of the operational \r
+ @param[in] Configuration The desired configuration of the operational\r
parameters of the Supplicant PAE state machine\r
for the Port as required.\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EAP_SET_SUPPLICANT_CONFIGURATION)(\r
- IN EFI_EAP_MANAGEMENT_PROTOCOL *This, \r
+ IN EFI_EAP_MANAGEMENT_PROTOCOL *This,\r
IN EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION *Configuration\r
);\r
\r
/**\r
Read the statistical information regarding the operation of the Supplicant\r
- associated with the Port. \r
+ associated with the Port.\r
\r
- The GetSupplicantStatistics() function reads the statistical information \r
+ The GetSupplicantStatistics() function reads the statistical information\r
Statistics regarding the operation of the Supplicant associated with the Port.\r
- \r
+\r
If Statistics is NULL, then EFI_INVALID_PARAMETER is returned.\r
\r
@param[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL\r
instance that indicates the calling context.\r
- @param[out] Statistics Returns the statistical information regarding the \r
- operation of the Supplicant for the Port. \r
+ @param[out] Statistics Returns the statistical information regarding the\r
+ operation of the Supplicant for the Port.\r
\r
@retval EFI_SUCCESS The statistical information regarding the operation\r
of the Supplicant for the Port is read successfully.\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_EAP_GET_SUPPLICANT_STATISTICS)(\r
- IN EFI_EAP_MANAGEMENT_PROTOCOL *This, \r
+ IN EFI_EAP_MANAGEMENT_PROTOCOL *This,\r
OUT EFI_EAPOL_SUPPLICANT_PAE_STATISTICS *Statistics\r
);\r
\r
///\r
-/// EFI_EAP_MANAGEMENT_PROTOCOL \r
+/// EFI_EAP_MANAGEMENT_PROTOCOL\r
/// is used to control, configure and monitor EAPOL state machine on\r
/// a Port. EAPOL state machine is built on a per-Port basis. Herein,\r
-/// a Port means a NIC. For the details of EAPOL, please refer to \r
+/// a Port means a NIC. For the details of EAPOL, please refer to\r
/// IEEE 802.1x specification.\r
///\r
struct _EFI_EAP_MANAGEMENT_PROTOCOL {\r
projects / mirror_edk2.git / blobdiff