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   @param  CapsuleHeader    Point to the UEFI capsule image to be checked.
  23
  24   @retval EFI_SUCESS       Input capsule is supported by firmware.
  25   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.
  26 **/
  27 EFI_STATUS
  28 EFIAPI
  29 SupportCapsuleImage (
  30   IN EFI_CAPSULE_HEADER *CapsuleHeader
  31   )
  32 ;
  33
  34 /**
  35   The firmware implements to process the capsule image.
  36
  37   @param  CapsuleHeader    Point to the UEFI capsule image to be processed.
  38
  39   @retval EFI_SUCESS       Process Capsule Image successfully.
  40   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.
  41 **/
  42 EFI_STATUS
  43 EFIAPI
  44 ProcessCapsuleImage (
  45   IN EFI_CAPSULE_HEADER *CapsuleHeader
  46   )
  47 ;
  48
  49 #endif
  50
  51