ArmVirtPkg, OvmfPkg: retire QemuFwCfgS3Enabled() from QemuFwCfgLib

At this point we're ready to retire QemuFwCfgS3Enabled() from the
QemuFwCfgLib class, together with its implementations in:

- ArmVirtPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c
- OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c

Extend all modules that call the function with a new QemuFwCfgS3Lib class
dependency. Thanks to the previously added library class, instances, and
class resolutions, we can do this switch now as tightly as possible.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=394
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

13 files changed, 11 insertions, 42 deletions

diff --git a/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf b/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf
index bb5f14e0fc..42edc97b3d 100644
--- a/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf
+++ b/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf
@@ -52,6 +52,7 @@
   UefiDriverEntryPoint

   HobLib

   QemuFwCfgLib

+  QemuFwCfgS3Lib

   MemoryAllocationLib

   BaseLib

   DxeServicesTableLib

diff --git a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c
index 6a0ecd1ad9..76512534f5 100644
--- a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c
+++ b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c
@@ -19,6 +19,7 @@
 #include <Library/BaseMemoryLib.h>

 #include <Library/MemoryAllocationLib.h>

 #include <Library/QemuFwCfgLib.h>

+#include <Library/QemuFwCfgS3Lib.h>

 #include <Library/DxeServicesTableLib.h>

 #include <Library/PcdLib.h>

 #include <Library/OrderedCollectionLib.h>

diff --git a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf
index e550ff5a47..a935054021 100644
--- a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf
+++ b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf
@@ -44,6 +44,7 @@
   MemoryAllocationLib

   OrderedCollectionLib

   QemuFwCfgLib

+  QemuFwCfgS3Lib

   UefiBootServicesTableLib

   UefiDriverEntryPoint

 

diff --git a/OvmfPkg/Include/Library/QemuFwCfgLib.h b/OvmfPkg/Include/Library/QemuFwCfgLib.h
index 2a1261327b..596e3f25d5 100644
--- a/OvmfPkg/Include/Library/QemuFwCfgLib.h
+++ b/OvmfPkg/Include/Library/QemuFwCfgLib.h
@@ -179,19 +179,5 @@ QemuFwCfgFindFile (
   OUT  UINTN                 *Size

   );

 

-

-/**

-  Determine if S3 support is explicitly enabled.

-

-  @retval  TRUE   if S3 support is explicitly enabled.

-           FALSE  otherwise. This includes unavailability of the firmware

-                  configuration interface.

-**/

-BOOLEAN

-EFIAPI

-QemuFwCfgS3Enabled (

-  VOID

-  );

-

 #endif

 

diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c b/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c
index 818646a275..3da9cd21e5 100644
--- a/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c
@@ -19,6 +19,7 @@
 #include <Library/BaseMemoryLib.h>

 #include <Library/DebugLib.h>

 #include <Library/QemuFwCfgLib.h>

+#include <Library/QemuFwCfgS3Lib.h>

 #include <Protocol/LockBox.h>

 #include <LockBoxLib.h>

 

diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf b/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
index bedf1811e0..eb03f4f546 100644
--- a/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
@@ -40,6 +40,7 @@
   DebugLib

   UefiBootServicesTableLib

   QemuFwCfgLib

+  QemuFwCfgS3Lib

 

 [Protocols]

   gEfiLockBoxProtocolGuid    ## SOMETIMES_PRODUCES

diff --git a/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h b/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h
index ec58efa5ef..97ffbb5148 100644
--- a/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h
+++ b/OvmfPkg/Library/PlatformBootManagerLib/BdsPlatform.h
@@ -48,6 +48,7 @@ Abstract:
 #include <Library/IoLib.h>

 #include <Library/NvVarsFileLib.h>

 #include <Library/QemuFwCfgLib.h>

+#include <Library/QemuFwCfgS3Lib.h>

 #include <Library/QemuBootOrderLib.h>

 

 #include <Protocol/Decompress.h>

diff --git a/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
index f9e35c955d..27789b7377 100644
--- a/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
+++ b/OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf
@@ -52,6 +52,7 @@
   PciLib

   NvVarsFileLib

   QemuFwCfgLib

+  QemuFwCfgS3Lib

   LoadLinuxLib

   QemuBootOrderLib

   UefiLib

diff --git a/OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c b/OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c
index 3dd55ba504..1bf725d8b7 100644
--- a/OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c
+++ b/OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c
@@ -368,31 +368,3 @@ QemuFwCfgFindFile (
 

   return RETURN_NOT_FOUND;

 }

-

-

-/**

-  Determine if S3 support is explicitly enabled.

-

-  @retval  TRUE   if S3 support is explicitly enabled.

-           FALSE  otherwise. This includes unavailability of the firmware

-                  configuration interface.

-**/

-BOOLEAN

-EFIAPI

-QemuFwCfgS3Enabled (

-  VOID

-  )

-{

-  RETURN_STATUS        Status;

-  FIRMWARE_CONFIG_ITEM FwCfgItem;

-  UINTN                FwCfgSize;

-  UINT8                SystemStates[6];

-

-  Status = QemuFwCfgFindFile ("etc/system-states", &FwCfgItem, &FwCfgSize);

-  if (Status != RETURN_SUCCESS || FwCfgSize != sizeof SystemStates) {

-    return FALSE;

-  }

-  QemuFwCfgSelectItem (FwCfgItem);

-  QemuFwCfgReadBytes (sizeof SystemStates, SystemStates);

-  return (BOOLEAN) (SystemStates[3] & BIT7);

-}

diff --git a/OvmfPkg/PlatformPei/Platform.c b/OvmfPkg/PlatformPei/Platform.c
index 0be86722e5..77a8a16c15 100644
--- a/OvmfPkg/PlatformPei/Platform.c
+++ b/OvmfPkg/PlatformPei/Platform.c
@@ -32,6 +32,7 @@
 #include <Library/PeimEntryPoint.h>

 #include <Library/PeiServicesLib.h>

 #include <Library/QemuFwCfgLib.h>

+#include <Library/QemuFwCfgS3Lib.h>

 #include <Library/ResourcePublicationLib.h>

 #include <Guid/MemoryTypeInformation.h>

 #include <Ppi/MasterBootMode.h>

diff --git a/OvmfPkg/PlatformPei/PlatformPei.inf b/OvmfPkg/PlatformPei/PlatformPei.inf
index fbaed3182d..53c6dd445a 100644
--- a/OvmfPkg/PlatformPei/PlatformPei.inf
+++ b/OvmfPkg/PlatformPei/PlatformPei.inf
@@ -58,6 +58,7 @@
   PeiServicesTablePointerLib

   PeimEntryPoint

   QemuFwCfgLib

+  QemuFwCfgS3Lib

   MtrrLib

   PcdLib

 

diff --git a/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.c b/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.c
index f31646d734..bb79fce085 100644
--- a/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.c
+++ b/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.c
@@ -32,6 +32,7 @@
 #include <Library/PcdLib.h>

 #include <Library/PciLib.h>

 #include <Library/QemuFwCfgLib.h>

+#include <Library/QemuFwCfgS3Lib.h>

 #include <Library/UefiBootServicesTableLib.h>

 #include <Protocol/S3SaveState.h>

 #include <Protocol/SmmControl2.h>

diff --git a/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.inf b/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.inf
index 31c80bd444..04b1ed0e4e 100644
--- a/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.inf
+++ b/OvmfPkg/SmmControl2Dxe/SmmControl2Dxe.inf
@@ -56,6 +56,7 @@
   PcdLib

   PciLib

   QemuFwCfgLib

+  QemuFwCfgS3Lib

   UefiBootServicesTableLib

   UefiDriverEntryPoint