MdePkg/Include/Ppi/TemporaryRamSupport.h

   1 /* @file
   2   This file declares Temporary RAM Support PPI.
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   @par Revision Reference:
  14   This PPI is defined in PI.
  15   Version 1.00.
  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
  32   @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the
  33                                 Temporary RAM contents.
  34
  35   @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the
  36                                 Temporary RAM contents.
  37
  38   @param CopySize               Amount of memory to migrate from temporary to permanent memory.
  39
  40
  41
  42   @retval EFI_SUCCESS           The data was successfully returned.
  43
  44   @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize >
  45                                 TemporaryMemoryBase when TemporaryMemoryBase >
  46                                 PermanentMemoryBase.
  47
  48 **/
  49 typedef
  50 EFI_STATUS
  51 (EFIAPI * TEMPORARY_RAM_MIGRATION) (
  52   IN CONST EFI_PEI_SERVICES   **PeiServices,
  53   IN EFI_PHYSICAL_ADDRESS     TemporaryMemoryBase,
  54   IN EFI_PHYSICAL_ADDRESS     PermanentMemoryBase,
  55   IN UINTN                    CopySize
  56 );
  57
  58
  59 typedef struct {
  60   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;
  61 } TEMPORARY_RAM_SUPPORT_PPI;
  62
  63 extern EFI_GUID gEfiTemporaryRamSupportPpiGuid;
  64
  65 #endif