MdeModulePkg/Include/Library/CapsuleLib.h

   1 /** @file
   2
   3   Capsule Library. This library class defines a set of interfaces on
   4   how to process capusle image update.
   5
   6   Copyright (c) 2007, Intel Corporation
   7   All rights reserved. This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __CAPSULE_LIB_H__
  18 #define __CAPSULE_LIB_H__
  19
  20 /**
  21   Those capsules supported by the firmwares.
  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 /**
  36   The firmware implements to process the 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
  50 #endif
  51
  52