]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/AuthenticationInfo.h
Code Scrub for Protocol and Ppi Definition
[mirror_edk2.git] / MdePkg / Include / Protocol / AuthenticationInfo.h
index e3849663b4621522e788766388919c681be2eaab..df2a2195169a3603ecf76dce5d3deecd8541f67b 100644 (file)
@@ -3,7 +3,7 @@
   This protocol is used on any device handle to obtain authentication information \r
   associated with the physical or logical device.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -68,9 +68,9 @@ typedef struct {
 /**\r
   Retrieves the Authentication information associated with a particular controller handle.\r
 \r
-  @param  This                   Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
-  @param  ControllerHandle       Handle to the Controller\r
-  @param  Buffer                 Pointer to the authentication information.\r
+  @param  This                  Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
+  @param  ControllerHandle      Handle to the Controller\r
+  @param  Buffer                Pointer to the authentication information.\r
 \r
   @retval EFI_SUCCESS           Successfully retrieved Authentication information for the given ControllerHandle\r
   @retval EFI_INVALID_PARAMETER No matching Authentication information found for the given ControllerHandle\r
@@ -90,9 +90,9 @@ EFI_STATUS
 /**\r
   Set the Authentication information for a given controller handle.\r
 \r
-  @param  This                  Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
-  @param  ControllerHandle      Handle to the Controller\r
-  @param  Buffer                Pointer to the authentication information.\r
+  @param  This                 Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
+  @param  ControllerHandle     Handle to the Controller\r
+  @param  Buffer               Pointer to the authentication information.\r
                                 \r
   @retval EFI_SUCCESS          Successfully set Authentication information for the given ControllerHandle\r
   @retval EFI_UNSUPPORTED      If the platform policies do not allow setting of the Authentication\r
@@ -111,6 +111,18 @@ EFI_STATUS
   )\r
 ;  \r
 \r
+/**\r
+  @par Protocol Description:\r
+  This protocol is used on any device handle to obtain authentication \r
+  information associated with the physical or logical device.\r
+\r
+  @param Get\r
+  Used to retrieve the Authentication Information associated with the controller handle\r
+  \r
+  @param Set\r
+  Used to set the Authentication information associated with the controller handle\r
+  \r
+**/  \r
 struct _EFI_AUTHENTICATION_INFO_PROTOCOL {\r
   EFI_AUTHENTICATION_PROTOCOL_INFO_GET Get;\r
   EFI_AUTHENTICATION_PROTOCOL_INFO_SET Set;\r