OvmfPkg QemuFwCfgLib: determine if S3 support is explicitly enabled

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

diff --git a/OvmfPkg/Include/Library/QemuFwCfgLib.h b/OvmfPkg/Include/Library/QemuFwCfgLib.h
index 9d023777c9d8cd8d00d38fff5dda997983b24baf..8d3b835d431c8b9e65aecd10ac609a4e26189b8c 100644 (file)
--- a/OvmfPkg/Include/Library/QemuFwCfgLib.h
+++ b/OvmfPkg/Include/Library/QemuFwCfgLib.h
@@ -2,6 +2,8 @@
   QEMU/KVM Firmware Configuration access\r
 \r
   Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (C) 2013, Red Hat, Inc.\r
+\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -56,6 +58,8 @@ typedef enum {
   Returns a boolean indicating if the firmware configuration interface\r
   is available or not.\r
 \r
+  This function may change fw_cfg state.\r
+\r
   @retval    TRUE   The interface is available\r
   @retval    FALSE  The interface is not available\r
 \r
@@ -193,5 +197,36 @@ QemuFwCfgFindFile (
   OUT  FIRMWARE_CONFIG_ITEM  *Item,\r
   OUT  UINTN                 *Size\r
   );\r
+\r
+\r
+/**\r
+  Returns a boolean indicating if the firmware configuration interface is\r
+  available for library-internal purposes.\r
+\r
+  This function never changes fw_cfg state.\r
+\r
+  @retval    TRUE   The interface is available internally.\r
+  @retval    FALSE  The interface is not available internally.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+InternalQemuFwCfgIsAvailable (\r
+  VOID\r
+  );\r
+\r
+\r
+/**\r
+  Determine if S3 support is explicitly enabled.\r
+\r
+  @retval  TRUE   if S3 support is explicitly enabled.\r
+           FALSE  otherwise. This includes unavailability of the firmware\r
+                  configuration interface.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+QemuFwCfgS3Enabled (\r
+  VOID\r
+  );\r
+\r
 #endif\r
 \r