ArmVirtPkg, OvmfPkg: retire QemuFwCfgS3Enabled() from QemuFwCfgLib

[mirror_edk2.git] / OvmfPkg / Include / Library / QemuFwCfgS3Lib.h

/** @file\r
  S3 support for QEMU fw_cfg\r
\r
  This library class enables driver modules (a) to query whether S3 support was\r
  enabled on the QEMU command line, (b) to produce fw_cfg DMA operations that\r
  are to be replayed at S3 resume time.\r
\r
  Copyright (C) 2017, Red Hat, Inc.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
#ifndef __FW_CFG_S3_LIB__\r
#define __FW_CFG_S3_LIB__\r
\r
/**\r
  Determine if S3 support is explicitly enabled.\r
\r
  @retval  TRUE   If S3 support is explicitly enabled. Other functions in this\r
                  library may be called (subject to their individual\r
                  restrictions).\r
\r
           FALSE  Otherwise. This includes unavailability of the firmware\r
                  configuration interface. No other function in this library\r
                  must be called.\r
**/\r
BOOLEAN\r
EFIAPI\r
QemuFwCfgS3Enabled (\r
  VOID\r
  );\r
\r
#endif\r