MdeModulePkg/Include/Library/CapsuleLib.h

   1 /** @file
   2
   3   This library class defines a set of interfaces on how to process capusle image update.
   4
   5   Copyright (c) 2007 - 2008, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __CAPSULE_LIB_H__
  17 #define __CAPSULE_LIB_H__
  18
  19 /**
  20   The firmware checks whether the capsule image is supported
  21   by the CapsuleGuid in CapsuleHeader or other specific information in capsule image.
  22
  23   @param  CapsuleHeader    Point to the UEFI capsule image to be checked.
  24
  25   @retval EFI_SUCESS       Input capsule is supported by firmware.
  26   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.
  27 **/
  28 EFI_STATUS
  29 EFIAPI
  30 SupportCapsuleImage (
  31   IN EFI_CAPSULE_HEADER *CapsuleHeader
  32   );
  33
  34 /**
  35   The firmware specific implementation processes the capsule image
  36   if it recognized the format of this capsule image.
  37
  38   @param  CapsuleHeader    Point to the UEFI capsule image to be processed.
  39
  40   @retval EFI_SUCESS       Process Capsule Image successfully.
  41   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.
  42 **/
  43 EFI_STATUS
  44 EFIAPI
  45 ProcessCapsuleImage (
  46   IN EFI_CAPSULE_HEADER *CapsuleHeader
  47   );
  48
  49 #endif