Update function description per UEFI2.3d. The main changes include:

[mirror_edk2.git] / MdePkg / Include / Protocol / Eap.h

diff --git a/MdePkg/Include/Protocol/Eap.h b/MdePkg/Include/Protocol/Eap.h
index 99c2b865ecd1a8ac5d8099c7c8e5bfaaf15473cc..f1c45d495c29c3b2215c86dc76d284af33ff9c74 100644 (file)
--- a/MdePkg/Include/Protocol/Eap.h
+++ b/MdePkg/Include/Protocol/Eap.h
@@ -5,8 +5,8 @@
   The definitions in this file are defined in UEFI Specification 2.3, which have\r
   not been verified by one implementation yet.\r
 \r
-  Copyright (c) 2009, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2009 - 2011, 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
   http://opensource.org/licenses/bsd-license.php\r
@@ -14,6 +14,9 @@
   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
+  This Protocol is introduced in UEFI Specification 2.2\r
+\r
 **/\r
 \r
 #ifndef __EFI_EAP_PROTOCOL_H__\r
@@ -80,8 +83,8 @@ EFI_STATUS
   \r
   If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is \r
   returned.\r
-  If the EAP authentication method of EapAuthType is unsupported by the Ports, then this\r
-  function will return EFI_UNSUPPORTED.\r
+  If the EAP authentication method of EapAuthType is unsupported by the Ports, then it will\r
+  return EFI_UNSUPPORTED.\r
 \r
   @param[in] This                A pointer to the EFI_EAP_PROTOCOL instance that indicates \r
                                  the calling context.\r
@@ -92,13 +95,14 @@ EFI_STATUS
   @retval EFI_SUCCESS            The EAP authentication method of EapAuthType is \r
                                  registered successfully.\r
   @retval EFI_INVALID_PARAMETER  EapAuthType is an invalid EAP authentication type.\r
-  @retval EFI_OUT_OF_RESOURCES   There is not enough system memory to perform the registration.\r
+  @retval EFI_UNSUPPORTED        The EAP authentication method of EapAuthType is\r
+                                 unsupported by the Port.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_EAP_SET_DESIRED_AUTHENTICATION_METHOD)(\r
-  IN struct _EFI_EAP_PROTOCOL    *This, \r
+  IN EFI_EAP_PROTOCOL            *This, \r
   IN UINT8                       EapAuthType\r
   );\r
 \r
@@ -128,7 +132,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_EAP_REGISTER_AUTHENTICATION_METHOD)(\r
-  IN struct _EFI_EAP_PROTOCOL             *This, \r
+  IN EFI_EAP_PROTOCOL                     *This, \r
   IN UINT8                                EapAuthType, \r
   IN EFI_EAP_BUILD_RESPONSE_PACKET        Handler\r
   );\r