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