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 - 2008, Intel Corporation. All rights reserved.<BR>
   6   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   @par Revision Reference:
  15   This PPI is introduced in PI Version 1.0.
  16
  17 **/
  18
  19 #ifndef __TEMPORARY_RAM_SUPPORT_H__
  20 #define __TEMPORARY_RAM_SUPPORT_H__
  21
  22 #define TEMPORARY_RAM_SUPPORT_PPI_GUID \
  23   { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }
  24
  25
  26 /**
  27   This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into
  28   permanent memory.
  29
  30   @param PeiServices            Pointer to the PEI Services Table.
  31   @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the
  32                                 Temporary RAM contents.
  33   @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the
  34                                 Temporary RAM contents.
  35   @param CopySize               Amount of memory to migrate from temporary to permanent memory.
  36
  37   @retval EFI_SUCCESS           The data was successfully returned.
  38   @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when
  39                                 TemporaryMemoryBase > PermanentMemoryBase.
  40
  41 **/
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI * TEMPORARY_RAM_MIGRATION)(
  45   IN CONST EFI_PEI_SERVICES   **PeiServices,
  46   IN EFI_PHYSICAL_ADDRESS     TemporaryMemoryBase,
  47   IN EFI_PHYSICAL_ADDRESS     PermanentMemoryBase,
  48   IN UINTN                    CopySize
  49 );
  50
  51 ///
  52 /// This service abstracts the ability to migrate contents of the platform early memory store.
  53 ///
  54 typedef struct {
  55   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;
  56 } TEMPORARY_RAM_SUPPORT_PPI;
  57
  58 extern EFI_GUID gEfiTemporaryRamSupportPpiGuid;
  59
  60 #endif