audk/OvmfPkg/Include/Library/QemuFwCfgS3Lib.h

40 lines
1.2 KiB
C
Raw Normal View History

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