MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  This file declares Temporary RAM Done PPI.\r
  The PPI that provides a service to disable the use of Temporary RAM.\r
\r
  Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is introduced in PI Version 1.2.1.\r
\r
**/\r
\r
#ifndef __TEMPORARY_RAM_DONE_H__\r
#define __TEMPORARY_RAM_DONE_H__\r
\r
#define EFI_PEI_TEMPORARY_RAM_DONE_PPI_GUID \\r
  { 0xceab683c, 0xec56, 0x4a2d, { 0xa9, 0x6, 0x40, 0x53, 0xfa, 0x4e, 0x9c, 0x16 } }\r
\r
/**\r
  TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked\r
  by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.\r
\r
  @retval EFI_SUCCESS           Use of Temporary RAM was disabled.\r
  @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_PEI_TEMPORARY_RAM_DONE) (\r
  VOID\r
  );\r
\r
///\r
/// This is an optional PPI that may be produced by SEC or a PEIM. If present, it provide a service to\r
/// disable the use of Temporary RAM. This service may only be called by the PEI Foundation after the\r
/// transition from Temporary RAM to Permanent RAM is complete. This PPI provides an alternative\r
/// to the Temporary RAM Migration PPI for system architectures that allow Temporary RAM and\r
/// Permanent RAM to be enabled and accessed at the same time with no side effects.\r
///\r
typedef struct _EFI_PEI_TEMPORARY_RAM_DONE_PPI {\r
  EFI_PEI_TEMPORARY_RAM_DONE TemporaryRamDone;\r
} EFI_PEI_TEMPORARY_RAM_DONE_PPI;\r
\r
extern EFI_GUID gEfiTemporaryRamDonePpiGuid;\r
\r
#endif\r