projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 13d4af68 | 1 | /** @file\r |
| 0a6f4824 | 2 | This is an implementation of the ACPI S3 Save protocol. This is defined in\r |
| 13d4af68 | 3 | S3 boot path specification 0.9.\r |
| 4 | \r | |
| 0a6f4824 | 5 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 13d4af68 | 6 | \r |
| 7 | This program and the accompanying materials\r | |
| 8 | are licensed and made available under the terms and conditions\r | |
| 9 | of the BSD License which accompanies this distribution. The\r | |
| 10 | full text of the license may be found at\r | |
| 11 | http://opensource.org/licenses/bsd-license.php\r | |
| 12 | \r | |
| 13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 15 | \r | |
| 16 | **/\r | |
| 17 | \r | |
| 18 | #ifndef _ACPI_S3_SAVE_H_\r | |
| 19 | #define _ACPI_S3_SAVE_H_\r | |
| 20 | \r | |
| 13d4af68 | 21 | /**\r |
| 0a6f4824 | 22 | Gets the buffer of legacy memory below 1 MB\r |
| 13d4af68 | 23 | This function is to get the buffer in legacy memory below 1MB that is required during S3 resume.\r |
| 24 | \r | |
| 25 | @param This A pointer to the EFI_ACPI_S3_SAVE_PROTOCOL instance.\r | |
| 26 | @param Size The returned size of legacy memory below 1 MB.\r | |
| 27 | \r | |
| 28 | @retval EFI_SUCCESS Size is successfully returned.\r | |
| 29 | @retval EFI_INVALID_PARAMETER The pointer Size is NULL.\r | |
| 30 | \r | |
| 31 | **/\r | |
| 32 | EFI_STATUS\r | |
| 33 | EFIAPI\r | |
| 34 | LegacyGetS3MemorySize (\r | |
| 35 | IN EFI_ACPI_S3_SAVE_PROTOCOL * This,\r | |
| 36 | OUT UINTN * Size\r | |
| 37 | );\r | |
| 38 | \r | |
| 39 | /**\r | |
| 40 | Prepares all information that is needed in the S3 resume boot path.\r | |
| 0a6f4824 LG |
41 | \r |
| 42 | Allocate the resources or prepare informations and save in ACPI variable set for S3 resume boot path\r | |
| 43 | \r | |
| 13d4af68 | 44 | @param This A pointer to the EFI_ACPI_S3_SAVE_PROTOCOL instance.\r |
| 45 | @param LegacyMemoryAddress The base address of legacy memory.\r | |
| 46 | \r | |
| 47 | @retval EFI_NOT_FOUND Some necessary information cannot be found.\r | |
| 48 | @retval EFI_SUCCESS All information was saved successfully.\r | |
| 49 | @retval EFI_OUT_OF_RESOURCES Resources were insufficient to save all the information.\r | |
| 50 | @retval EFI_INVALID_PARAMETER The memory range is not located below 1 MB.\r | |
| 51 | \r | |
| 52 | **/\r | |
| 53 | EFI_STATUS\r | |
| 54 | EFIAPI\r | |
| 55 | S3Ready (\r | |
| 56 | IN EFI_ACPI_S3_SAVE_PROTOCOL *This,\r | |
| 0a6f4824 | 57 | IN VOID *LegacyMemoryAddress\r |
| 13d4af68 | 58 | );\r |
| 59 | #endif\r |