MdeModulePkg/Include/Library/CapsuleLib.h

   1 /** @file
   2   Capsule Library. This library class defines a set of interfaces on
   3   how to process capusle image update.
   4
   5   Copyright (c) 2007, 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   Those capsules supported by the firmwares.
  21
  22   @retval EFI_SUCESS       Input capsule is supported by firmware.
  23   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.
  24 **/
  25 EFI_STATUS
  26 EFIAPI
  27 SupportCapsuleImage (
  28   IN EFI_CAPSULE_HEADER *CapsuleHeader
  29   )
  30 ;
  31
  32 /**
  33   The firmware implements to process the capsule image.
  34
  35   @retval EFI_SUCESS       Process Capsule Image successfully.
  36   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.
  37 **/
  38 EFI_STATUS
  39 EFIAPI
  40 ProcessCapsuleImage (
  41   IN EFI_CAPSULE_HEADER *CapsuleHeader
  42   )
  43 ;
  44
  45 #endif
  46
  47