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