]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Include/Library/CapsuleLib.h
Clean up DEC files:
[mirror_edk2.git] / MdeModulePkg / Include / Library / CapsuleLib.h
index b8691bc4aba98a56d94f30289a343749cd2505c7..487cb0f3112a9a4cad3e71445eb7738364c08f1e 100644 (file)
@@ -1,15 +1,15 @@
 /** @file\r
-  Capsule Library. This library class defines a set of interfaces on \r
-  how to process capusle image update.\r
-\r
-  Copyright (c) 2007, 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
-  http://opensource.org/licenses/bsd-license.php\r
-  \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
+  This library class defines a set of interfaces for how to process capsule image updates.\r
+\r
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                            \r
+\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
 **/\r
 \r
 #define __CAPSULE_LIB_H__\r
 \r
 /**\r
-  Those capsules supported by the firmwares.\r
+  The firmware checks whether the capsule image is supported \r
+  by the CapsuleGuid in CapsuleHeader or if there is other specific information in \r
+  the capsule image.\r
+  \r
+  @param  CapsuleHeader    Pointer to the UEFI capsule image to be checked.\r
   \r
   @retval EFI_SUCESS       Input capsule is supported by firmware.\r
   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.\r
@@ -26,22 +30,21 @@ EFI_STATUS
 EFIAPI\r
 SupportCapsuleImage (\r
   IN EFI_CAPSULE_HEADER *CapsuleHeader\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-  The firmware implements to process the capsule image.\r
+  The firmware-specific implementation processes the capsule image\r
+  if it recognized the format of this capsule image.\r
   \r
-  @retval EFI_SUCESS       Process Capsule Image successfully. \r
+  @param  CapsuleHeader    Pointer to the UEFI capsule image to be processed. \r
+   \r
+  @retval EFI_SUCESS       Capsule Image processed successfully. \r
   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 ProcessCapsuleImage (\r
   IN EFI_CAPSULE_HEADER *CapsuleHeader\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
-\r
-\r