Code Scrub for header files in MdePkg/Include/Ppi and Uefi directory.

[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 - 2008, Intel Corporation                                                         \r
  All rights reserved. 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 defined in PI.\r
  Version 1.00.\r
\r
**/\r
\r
#ifndef __TEMPORARY_RAM_SUPPORT_H__\r
#define __TEMPORARY_RAM_SUPPORT_H__\r
\r
#define 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 TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into\r
  permanent memory.\r
\r
  @param PeiServices            Pointer to the PEI Services Table.\r
\r
  @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the\r
                                Temporary RAM contents.\r
\r
  @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the\r
                                Temporary RAM contents.\r
\r
  @param CopySize               Amount of memory to migrate from temporary to permanent memory.\r
\r
\r
\r
  @retval EFI_SUCCESS           The data was successfully returned.\r
\r
  @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize >\r
                                TemporaryMemoryBase when TemporaryMemoryBase >\r
                                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
\r
  @param ResetSystem\r
  Perform the migration of contents of Temporary RAM to Permanent RAM.\r
  Terminate the Temporary RAM if it cannot coexist with the Permanent RAM.\r
\r
**/\r
typedef struct {\r
  TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
} TEMPORARY_RAM_SUPPORT_PPI;\r
\r
extern EFI_GUID gEfiTemporaryRamSupportPpiGuid;\r
\r
#endif\r