MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLibNull.c

   1 /** @file
   2   DXE capsule process.
   3   Dummy function for runtime module, because CapsuleDxeRuntime
   4   does not need call ProcessCapsules().
   5
   6   Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
   7   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 #include <PiDxe.h>
  18 #include <Library/CapsuleLib.h>
  19
  20 /**
  21
  22   This routine is called to process capsules.
  23
  24   Caution: This function may receive untrusted input.
  25
  26   The capsules reported in EFI_HOB_UEFI_CAPSULE are processed.
  27   If there is no EFI_HOB_UEFI_CAPSULE, this routine does nothing.
  28
  29   This routine should be called twice in BDS.
  30   1) The first call must be before EndOfDxe. The system capsules is processed.
  31      If device capsule FMP protocols are exposted at this time and device FMP
  32      capsule has zero EmbeddedDriverCount, the device capsules are processed.
  33      Each individual capsule result is recorded in capsule record variable.
  34      System may reset in this function, if reset is required by capsule and
  35      all capsules are processed.
  36      If not all capsules are processed, reset will be defered to second call.
  37
  38   2) The second call must be after EndOfDxe and after ConnectAll, so that all
  39      device capsule FMP protocols are exposed.
  40      The system capsules are skipped. If the device capsules are NOT processed
  41      in first call, they are processed here.
  42      Each individual capsule result is recorded in capsule record variable.
  43      System may reset in this function, if reset is required by capsule
  44      processed in first call and second call.
  45
  46   @retval EFI_SUCCESS             There is no error when processing capsules.
  47   @retval EFI_OUT_OF_RESOURCES    No enough resource to process capsules.
  48
  49 **/
  50 EFI_STATUS
  51 EFIAPI
  52 ProcessCapsules (
  53   VOID
  54   )
  55 {
  56   return EFI_UNSUPPORTED;
  57 }