IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / Acpi / AcpiS3SaveDxe / AcpiS3Save.h

/** @file\r
  This is an implementation of the ACPI S3 Save protocol.  This is defined in\r
  S3 boot path specification 0.9.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ACPI_S3_SAVE_H_\r
#define _ACPI_S3_SAVE_H_\r
\r
/**\r
  Gets the buffer of legacy memory below 1 MB\r
  This function is to get the buffer in legacy memory below 1MB that is required during S3 resume.\r
\r
  @param This           A pointer to the EFI_ACPI_S3_SAVE_PROTOCOL instance.\r
  @param Size           The returned size of legacy memory below 1 MB.\r
\r
  @retval EFI_SUCCESS           Size is successfully returned.\r
  @retval EFI_INVALID_PARAMETER The pointer Size is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LegacyGetS3MemorySize (\r
  IN  EFI_ACPI_S3_SAVE_PROTOCOL    * This,\r
  OUT UINTN                        * Size\r
  );\r
\r
/**\r
  Prepares all information that is needed in the S3 resume boot path.\r
\r
  Allocate the resources or prepare informations and save in ACPI variable set for S3 resume boot path\r
\r
  @param This                 A pointer to the EFI_ACPI_S3_SAVE_PROTOCOL instance.\r
  @param LegacyMemoryAddress  The base address of legacy memory.\r
\r
  @retval EFI_NOT_FOUND         Some necessary information cannot be found.\r
  @retval EFI_SUCCESS           All information was saved successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Resources were insufficient to save all the information.\r
  @retval EFI_INVALID_PARAMETER The memory range is not located below 1 MB.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
S3Ready (\r
  IN EFI_ACPI_S3_SAVE_PROTOCOL     *This,\r
  IN VOID                          *LegacyMemoryAddress\r
  );\r
#endif\r