OvmfPkg/Library/PlatformDebugLibIoPort/DebugLibDetect.h

   1 /** @file
   2   Base Debug library instance for hypervisor debug port.
   3   It uses PrintLib to send debug messages to a fixed I/O port.
   4
   5   Copyright (c) 2017, Red Hat, Inc.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __DEBUG_IO_PORT_DETECT_H__
  11 #define __DEBUG_IO_PORT_DETECT_H__
  12
  13 #include <Base.h>
  14
  15 /**
  16   Helper function to return whether the virtual machine has a debug I/O port.
  17   PlatformDebugLibIoPortFound can call this function directly or cache the
  18   result.
  19
  20   @retval TRUE   if the debug I/O port device was detected.
  21   @retval FALSE  otherwise
  22
  23 **/
  24 BOOLEAN
  25 EFIAPI
  26 PlatformDebugLibIoPortDetect (
  27   VOID
  28   );
  29
  30 /**
  31   Return whether the virtual machine has a debug I/O port.  DebugLib.c
  32   calls this function instead of PlatformDebugLibIoPortDetect, to allow
  33   caching if possible.
  34
  35   @retval TRUE   if the debug I/O port device was detected.
  36   @retval FALSE  otherwise
  37
  38 **/
  39 BOOLEAN
  40 EFIAPI
  41 PlatformDebugLibIoPortFound (
  42   VOID
  43   );
  44
  45 #endif