Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Library / CapsuleLib.h

/** @file\r
\r
  This library class defines a set of interfaces for how to process capsule image updates.\r
\r
  Copyright (c) 2007 - 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
  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
#ifndef __CAPSULE_LIB_H__\r
#define __CAPSULE_LIB_H__\r
\r
/**\r
  The firmware checks whether the capsule image is supported \r
  by the CapsuleGuid in CapsuleHeader or other specific information in capsule image.\r
  \r
  @param  CapsuleHeader    Point 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
**/\r
EFI_STATUS\r
EFIAPI\r
SupportCapsuleImage (\r
  IN EFI_CAPSULE_HEADER *CapsuleHeader\r
  );\r
\r
/**\r
  The firmware-specific implementation processes the capsule image\r
  if it recognized the format of this capsule image.\r
  \r
  @param  CapsuleHeader    Point to the UEFI capsule image to be processed. \r
   \r
  @retval EFI_SUCESS       Capsule Image was 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
#endif\r