OvmfPkg/Library/QemuFwCfgS3Lib/QemuFwCfgS3Base.c

   1 /** @file
   2   Base Null library instance of the QemuFwCfgS3Lib class.
   3
   4   This library instance returns constant FALSE from QemuFwCfgS3Enabled(), and
   5   all other library functions trigger assertion failures. It is suitable for
   6   QEMU targets and machine types that never enable S3.
   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 #include <Library/QemuFwCfgS3Lib.h>
  20
  21 /**
  22   Determine if S3 support is explicitly enabled.
  23
  24   @retval  TRUE   If S3 support is explicitly enabled. Other functions in this
  25                   library may be called (subject to their individual
  26                   restrictions).
  27
  28            FALSE  Otherwise. This includes unavailability of the firmware
  29                   configuration interface. No other function in this library
  30                   must be called.
  31 **/
  32 BOOLEAN
  33 EFIAPI
  34 QemuFwCfgS3Enabled (
  35   VOID
  36   )
  37 {
  38   return FALSE;
  39 }