OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLibInternal.h

   1 /** @file
   2   Internal interfaces specific to the QemuFwCfgLib instances in OvmfPkg.
   3
   4   Copyright (C) 2016, Red Hat, Inc.
   5
   6   This program and the accompanying materials are licensed and made available
   7   under the terms and conditions of the BSD License which accompanies this
   8   distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
  12   WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __QEMU_FW_CFG_LIB_INTERNAL_H__
  17 #define __QEMU_FW_CFG_LIB_INTERNAL_H__
  18
  19 /**
  20   Returns a boolean indicating if the firmware configuration interface is
  21   available for library-internal purposes.
  22
  23   This function never changes fw_cfg state.
  24
  25   @retval    TRUE   The interface is available internally.
  26   @retval    FALSE  The interface is not available internally.
  27 **/
  28 BOOLEAN
  29 InternalQemuFwCfgIsAvailable (
  30   VOID
  31   );
  32
  33
  34 /**
  35   Returns a boolean indicating whether QEMU provides the DMA-like access method
  36   for fw_cfg.
  37
  38   @retval    TRUE   The DMA-like access method is available.
  39   @retval    FALSE  The DMA-like access method is unavailable.
  40 **/
  41 BOOLEAN
  42 InternalQemuFwCfgDmaIsAvailable (
  43   VOID
  44   );
  45
  46 #endif