1 /** @file
2   This file declares Temporary RAM Done PPI.
3   The PPI that provides a service to disable the use of Temporary RAM.
4 
5   Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
6   SPDX-License-Identifier: BSD-2-Clause-Patent
7 
8   @par Revision Reference:
9   This PPI is introduced in PI Version 1.2.1.
10 
11 **/
12 
13 #ifndef __TEMPORARY_RAM_DONE_H__
14 #define __TEMPORARY_RAM_DONE_H__
15 
16 #define EFI_PEI_TEMPORARY_RAM_DONE_PPI_GUID \
17   { 0xceab683c, 0xec56, 0x4a2d, { 0xa9, 0x6, 0x40, 0x53, 0xfa, 0x4e, 0x9c, 0x16 } }
18 
19 /**
20   TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked
21   by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.
22 
23   @retval EFI_SUCCESS           Use of Temporary RAM was disabled.
24   @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.
25 
26 **/
27 typedef
28 EFI_STATUS
29 (EFIAPI * EFI_PEI_TEMPORARY_RAM_DONE) (
30   VOID
31   );
32 
33 ///
34 /// This is an optional PPI that may be produced by SEC or a PEIM. If present, it provide a service to
35 /// disable the use of Temporary RAM. This service may only be called by the PEI Foundation after the
36 /// transition from Temporary RAM to Permanent RAM is complete. This PPI provides an alternative
37 /// to the Temporary RAM Migration PPI for system architectures that allow Temporary RAM and
38 /// Permanent RAM to be enabled and accessed at the same time with no side effects.
39 ///
40 typedef struct _EFI_PEI_TEMPORARY_RAM_DONE_PPI {
41   EFI_PEI_TEMPORARY_RAM_DONE TemporaryRamDone;
42 } EFI_PEI_TEMPORARY_RAM_DONE_PPI;
43 
44 extern EFI_GUID gEfiTemporaryRamDonePpiGuid;
45 
46 #endif
47