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 - 2018, 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   Function indicate the current completion progress of the firmware
  22   update. Platform may override with own specific progress function.
  23
  24   @param[in]  Completion  A value between 1 and 100 indicating the current
  25                           completion progress of the firmware update
  26
  27   @retval EFI_SUCESS             The capsule update progress was updated.
  28   @retval EFI_INVALID_PARAMETER  Completion is greater than 100%.
  29 **/
  30 EFI_STATUS
  31 EFIAPI
  32 UpdateImageProgress (
  33   IN UINTN  Completion
  34   )
  35 {
  36   return EFI_SUCCESS;
  37 }
  38
  39 /**
  40
  41   This routine is called to process capsules.
  42
  43   Caution: This function may receive untrusted input.
  44
  45   The capsules reported in EFI_HOB_UEFI_CAPSULE are processed.
  46   If there is no EFI_HOB_UEFI_CAPSULE, this routine does nothing.
  47
  48   This routine should be called twice in BDS.
  49   1) The first call must be before EndOfDxe. The system capsules is processed.
  50      If device capsule FMP protocols are exposted at this time and device FMP
  51      capsule has zero EmbeddedDriverCount, the device capsules are processed.
  52      Each individual capsule result is recorded in capsule record variable.
  53      System may reset in this function, if reset is required by capsule and
  54      all capsules are processed.
  55      If not all capsules are processed, reset will be defered to second call.
  56
  57   2) The second call must be after EndOfDxe and after ConnectAll, so that all
  58      device capsule FMP protocols are exposed.
  59      The system capsules are skipped. If the device capsules are NOT processed
  60      in first call, they are processed here.
  61      Each individual capsule result is recorded in capsule record variable.
  62      System may reset in this function, if reset is required by capsule
  63      processed in first call and second call.
  64
  65   @retval EFI_SUCCESS             There is no error when processing capsules.
  66   @retval EFI_OUT_OF_RESOURCES    No enough resource to process capsules.
  67
  68 **/
  69 EFI_STATUS
  70 EFIAPI
  71 ProcessCapsules (
  72   VOID
  73   )
  74 {
  75   return EFI_UNSUPPORTED;
  76 }