OvmfPkg/QemuFwCfgS3Lib: add initial Base Null library instance

This library instance returns constant FALSE from QemuFwCfgS3Enabled(),
and all other library functions trigger assertion failures. It is suitable
for QEMU targets and machine types that never enable S3.

The QemuFwCfgS3Enabled() implementation is copied from
"ArmVirtPkg/Library/QemuFwCfgLib/QemuFwCfgLib.c". Stubs for further
QemuFwCfgS3Lib APIs (with assertion failures, see above) will be added
later.

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>
This commit is contained in:
Laszlo Ersek 2017-02-22 02:09:47 +01:00
parent f70b071e2f
commit ad223a1c54
2 changed files with 78 additions and 0 deletions

View File

@ -0,0 +1,39 @@
## @file
# Base Null library instance of the QemuFwCfgS3Lib class.
#
# This library instance returns constant FALSE from QemuFwCfgS3Enabled(), and
# all other library functions trigger assertion failures. It is suitable for
# QEMU targets and machine types that never enable S3.
#
# 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.
##
[Defines]
INF_VERSION = 1.25
BASE_NAME = BaseQemuFwCfgS3LibNull
FILE_GUID = EA7D2B69-D221-4950-9C2C-C38A65BCC96E
MODULE_TYPE = BASE
VERSION_STRING = 1.0
LIBRARY_CLASS = QemuFwCfgS3Lib
#
# The following information is for reference only and not required by the build
# tools.
#
# VALID_ARCHITECTURES = IA32 X64 ARM AARCH64 IPF EBC
#
[Sources]
QemuFwCfgS3Base.c
[Packages]
MdePkg/MdePkg.dec
OvmfPkg/OvmfPkg.dec

View File

@ -0,0 +1,39 @@
/** @file
Base Null library instance of the QemuFwCfgS3Lib class.
This library instance returns constant FALSE from QemuFwCfgS3Enabled(), and
all other library functions trigger assertion failures. It is suitable for
QEMU targets and machine types that never enable S3.
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.
**/
#include <Library/QemuFwCfgS3Lib.h>
/**
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
)
{
return FALSE;
}