projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| fcfd5fb0 LG |
1 | /** @file\r |
| 2 | This file declares Temporary RAM Done PPI.\r | |
| 3 | The PPI that provides a service to disable the use of Temporary RAM.\r | |
| 4 | \r | |
| 5 | Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r | |
| 6 | This program and the accompanying materials \r | |
| 7 | are licensed and made available under the terms and conditions of the BSD License \r | |
| 8 | which accompanies this distribution. The full text of the license may be found at \r | |
| 9 | http://opensource.org/licenses/bsd-license.php \r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
| 13 | \r | |
| 14 | @par Revision Reference:\r | |
| d18b71c1 | 15 | This PPI is introduced in PI Version 1.2.1.\r |
| fcfd5fb0 LG |
16 | \r |
| 17 | **/\r | |
| 18 | \r | |
| 19 | #ifndef __TEMPORARY_RAM_DONE_H__\r | |
| 20 | #define __TEMPORARY_RAM_DONE_H__\r | |
| 21 | \r | |
| 22 | #define EFI_PEI_TEMPORARY_RAM_DONE_PPI_GUID \\r | |
| 23 | { 0xceab683c, 0xec56, 0x4a2d, { 0xa9, 0x6, 0x40, 0x53, 0xfa, 0x4e, 0x9c, 0x16 } }\r | |
| 24 | \r | |
| 25 | /**\r | |
| 26 | TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked\r | |
| 27 | by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.\r | |
| 28 | \r | |
| 29 | @retval EFI_SUCCESS Use of Temporary RAM was disabled.\r | |
| 30 | @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.\r | |
| 31 | \r | |
| 32 | **/\r | |
| 33 | typedef\r | |
| 34 | EFI_STATUS\r | |
| 35 | (EFIAPI * EFI_PEI_TEMPORARY_RAM_DONE) (\r | |
| 36 | VOID\r | |
| 37 | );\r | |
| 38 | \r | |
| 39 | ///\r | |
| 40 | /// This is an optional PPI that may be produced by SEC or a PEIM. If present, it provide a service to\r | |
| 41 | /// disable the use of Temporary RAM. This service may only be called by the PEI Foundation after the\r | |
| 42 | /// transition from Temporary RAM to Permanent RAM is complete. This PPI provides an alternative\r | |
| 43 | /// to the Temporary RAM Migration PPI for system architectures that allow Temporary RAM and\r | |
| 44 | /// Permanent RAM to be enabled and accessed at the same time with no side effects.\r | |
| 45 | ///\r | |
| 46 | typedef struct _EFI_PEI_TEMPORARY_RAM_DONE_PPI {\r | |
| 47 | EFI_PEI_TEMPORARY_RAM_DONE TemporaryRamDone;\r | |
| 48 | } EFI_PEI_TEMPORARY_RAM_DONE_PPI;\r | |
| 49 | \r | |
| 50 | extern EFI_GUID gEfiTemporaryRamDonePpiGuid;\r | |
| 51 | \r | |
| 52 | #endif\r |