MdeModulePkg/Library/DebugAgentLibNull/DebugAgentLibNull.c

   1 /** @file
   2   Debug Agent library implementition with empty functions.
   3
   4   Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include <Library/DebugAgentLib.h>
  10
  11 /**
  12   Initialize debug agent.
  13
  14   This function is used to set up debug environment to support source level debugging.
  15   If certain Debug Agent Library instance has to save some private data in the stack,
  16   this function must work on the mode that doesn't return to the caller, then
  17   the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one
  18   function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is
  19   responsible to invoke the passing-in function at the end of InitializeDebugAgent().
  20
  21   If the parameter Function is not NULL, Debug Agent Library instance will invoke it by
  22   passing in the Context to be its parameter.
  23
  24   If Function() is NULL, Debug Agent Library instance will return after setup debug
  25   environment.
  26
  27   @param[in] InitFlag     Init flag is used to decide the initialize process.
  28   @param[in] Context      Context needed according to InitFlag; it was optional.
  29   @param[in] Function     Continue function called by debug agent library; it was
  30                           optional.
  31
  32 **/
  33 VOID
  34 EFIAPI
  35 InitializeDebugAgent (
  36   IN UINT32                InitFlag,
  37   IN VOID                  *Context, OPTIONAL
  38   IN DEBUG_AGENT_CONTINUE  Function  OPTIONAL
  39   )
  40 {
  41   if (Function != NULL) {
  42     Function (Context);
  43   }
  44 }
  45
  46 /**
  47   Enable/Disable the interrupt of debug timer and return the interrupt state
  48   prior to the operation.
  49
  50   If EnableStatus is TRUE, enable the interrupt of debug timer.
  51   If EnableStatus is FALSE, disable the interrupt of debug timer.
  52
  53   @param[in] EnableStatus    Enable/Disable.
  54
  55   @return FALSE always.
  56
  57 **/
  58 BOOLEAN
  59 EFIAPI
  60 SaveAndSetDebugTimerInterrupt (
  61   IN BOOLEAN                EnableStatus
  62   )
  63 {
  64   return FALSE;
  65 }
  66