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   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <Library/DebugAgentLib.h>
  16
  17 /**
  18   Initialize debug agent.
  19
  20   This function is used to set up debug environment to support source level debugging.
  21   If certain Debug Agent Library instance has to save some private data in the stack,
  22   this function must work on the mode that doesn't return to the caller, then
  23   the caller needs to wrap up all rest of logic after InitializeDebugAgent() into one
  24   function and pass it into InitializeDebugAgent(). InitializeDebugAgent() is
  25   responsible to invoke the passing-in function at the end of InitializeDebugAgent().
  26
  27   If the parameter Function is not NULL, Debug Agent Libary instance will invoke it by
  28   passing in the Context to be its parameter.
  29
  30   If Function() is NULL, Debug Agent Library instance will return after setup debug
  31   environment.
  32
  33   @param[in] InitFlag     Init flag is used to decide the initialize process.
  34   @param[in] Context      Context needed according to InitFlag; it was optional.
  35   @param[in] Function     Continue function called by debug agent library; it was
  36                           optional.
  37
  38 **/
  39 VOID
  40 EFIAPI
  41 InitializeDebugAgent (
  42   IN UINT32                InitFlag,
  43   IN VOID                  *Context, OPTIONAL
  44   IN DEBUG_AGENT_CONTINUE  Function  OPTIONAL
  45   )
  46 {
  47   if (Function != NULL) {
  48     Function (Context);
  49   }
  50 }
  51
  52 /**
  53   Enable/Disable the interrupt of debug timer and return the interrupt state
  54   prior to the operation.
  55
  56   If EnableStatus is TRUE, enable the interrupt of debug timer.
  57   If EnableStatus is FALSE, disable the interrupt of debug timer.
  58
  59   @param[in] EnableStatus    Enable/Disable.
  60
  61   @return FALSE always.
  62
  63 **/
  64 BOOLEAN
  65 EFIAPI
  66 SaveAndSetDebugTimerInterrupt (
  67   IN BOOLEAN                EnableStatus
  68   )
  69 {
  70   return FALSE;
  71 }
  72