MdePkg/Include/Ppi/TemporaryRamSupport.h

   1 /** @file
   2   This file declares Temporary RAM Support PPI.
   3   This Ppi provides the service that migrates temporary RAM into permanent memory.
   4
   5   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8   @par Revision Reference:
   9   This PPI is introduced in PI Version 1.0.
  10
  11 **/
  12
  13 #ifndef __TEMPORARY_RAM_SUPPORT_H__
  14 #define __TEMPORARY_RAM_SUPPORT_H__
  15
  16 ///
  17 /// Note: The GUID name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI_GUID is different from the current
  18 ///       PI 1.2 spec.
  19 ///
  20 #define EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI_GUID  \
  21   { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }
  22
  23 /**
  24   This service of the EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into
  25   permanent memory.
  26
  27   @param PeiServices            Pointer to the PEI Services Table.
  28   @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the
  29                                 Temporary RAM contents.
  30   @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the
  31                                 Temporary RAM contents.
  32   @param CopySize               Amount of memory to migrate from temporary to permanent memory.
  33
  34   @retval EFI_SUCCESS           The data was successfully returned.
  35   @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when
  36                                 TemporaryMemoryBase > PermanentMemoryBase.
  37
  38 **/
  39 typedef
  40 EFI_STATUS
  41 (EFIAPI *TEMPORARY_RAM_MIGRATION)(
  42   IN CONST EFI_PEI_SERVICES   **PeiServices,
  43   IN EFI_PHYSICAL_ADDRESS     TemporaryMemoryBase,
  44   IN EFI_PHYSICAL_ADDRESS     PermanentMemoryBase,
  45   IN UINTN                    CopySize
  46   );
  47
  48 ///
  49 /// This service abstracts the ability to migrate contents of the platform early memory store.
  50 /// Note: The name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI is different from the current PI 1.2 spec.
  51 ///       This PPI was optional.
  52 ///
  53 typedef struct {
  54   TEMPORARY_RAM_MIGRATION    TemporaryRamMigration;
  55 } EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI;
  56
  57 extern EFI_GUID  gEfiTemporaryRamSupportPpiGuid;
  58
  59 #endif