Fix the comments in the core interface to follow the UEFI Spec regarding how to check...

[mirror_edk2.git] / MdePkg / Include / Ppi / TemporaryRamSupport.h

/** @file\r
  This file declares Temporary RAM Support PPI.\r
  This Ppi provides the service that migrates temporary RAM into permanent memory.\r
\r
  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  @par Revision Reference:\r
  This PPI is introduced in PI Version 1.0.\r
\r
**/\r
\r
#ifndef __TEMPORARY_RAM_SUPPORT_H__\r
#define __TEMPORARY_RAM_SUPPORT_H__\r
\r
///\r
/// Note: The GUID name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI_GUID is different from the current\r
///       PI 1.2 spec.\r
///\r
#define EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI_GUID  \\r
  { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }\r
\r
\r
/**\r
  This service of the EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into\r
  permanent memory.\r
\r
  @param PeiServices            Pointer to the PEI Services Table.\r
  @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the\r
                                Temporary RAM contents.\r
  @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the\r
                                Temporary RAM contents.\r
  @param CopySize               Amount of memory to migrate from temporary to permanent memory.\r
\r
  @retval EFI_SUCCESS           The data was successfully returned.\r
  @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when\r
                                TemporaryMemoryBase > PermanentMemoryBase.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * TEMPORARY_RAM_MIGRATION)(\r
  IN CONST EFI_PEI_SERVICES   **PeiServices,\r
  IN EFI_PHYSICAL_ADDRESS     TemporaryMemoryBase,\r
  IN EFI_PHYSICAL_ADDRESS     PermanentMemoryBase,\r
  IN UINTN                    CopySize\r
);\r
\r
///\r
/// This service abstracts the ability to migrate contents of the platform early memory store.\r
/// Note: The name EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI is different from the current PI 1.2 spec.\r
///       This PPI was optional.\r
///\r
typedef struct {\r
  TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
} EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI;\r
\r
extern EFI_GUID gEfiTemporaryRamSupportPpiGuid;\r
\r
#endif\r