OvmfPkg/Include/Library/QemuFwCfgS3Lib.h

   1 /** @file
   2   S3 support for QEMU fw_cfg
   3
   4   This library class enables driver modules (a) to query whether S3 support was
   5   enabled on the QEMU command line, (b) to produce fw_cfg DMA operations that
   6   are to be replayed at S3 resume time.
   7
   8   Copyright (C) 2017, Red Hat, Inc.
   9
  10   This program and the accompanying materials are licensed and made available
  11   under the terms and conditions of the BSD License which accompanies this
  12   distribution.  The full text of the license may be found at
  13   http://opensource.org/licenses/bsd-license.php
  14
  15   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
  16   WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  17 **/
  18
  19 #ifndef __FW_CFG_S3_LIB__
  20 #define __FW_CFG_S3_LIB__
  21
  22 /**
  23   Determine if S3 support is explicitly enabled.
  24
  25   @retval  TRUE   If S3 support is explicitly enabled. Other functions in this
  26                   library may be called (subject to their individual
  27                   restrictions).
  28
  29            FALSE  Otherwise. This includes unavailability of the firmware
  30                   configuration interface. No other function in this library
  31                   must be called.
  32 **/
  33 BOOLEAN
  34 EFIAPI
  35 QemuFwCfgS3Enabled (
  36   VOID
  37   );
  38
  39 #endif