Add comments and DoxyGen format for these files.

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

/** @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
**/\r
\r
#ifndef __CAPSULE_LIB_H__\r
#define __CAPSULE_LIB_H__\r
\r
/**\r
  Those capsules supported by the firmwares.\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
/**\r
  The firmware implements to process the capsule image.\r
  \r
  @param  CapsuleHeader    Point to the UEFI capsule image to be processed. \r
   \r
  @retval EFI_SUCESS       Process Capsule Image 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
#endif\r
\r
\r