EmbeddedPkg/Include/Library/DebugAgentTimerLib.h

   1 /** @file
   2   Platform specific Debug Agent abstraction for timer used by the agent.
   3
   4   The timer is used by the debugger to break into a running program.
   5
   6   Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
   7
   8   SPDX-License-Identifier: BSD-2-Clause-Patent
   9
  10 **/
  11
  12 #ifndef __GDB_TIMER_LIB__
  13 #define __GDB_TIMER_LIB__
  14
  15 /**
  16   Setup all the hardware needed for the debug agents timer.
  17
  18   This function is used to set up debug environment. It may enable interrupts.
  19
  20 **/
  21 VOID
  22 EFIAPI
  23 DebugAgentTimerIntialize (
  24   VOID
  25   );
  26
  27 /**
  28   Set the period for the debug agent timer. Zero means disable the timer.
  29
  30   @param[in] TimerPeriodMilliseconds    Frequency of the debug agent timer.
  31
  32 **/
  33 VOID
  34 EFIAPI
  35 DebugAgentTimerSetPeriod (
  36   IN  UINT32  TimerPeriodMilliseconds
  37   );
  38
  39 /**
  40   Perform End Of Interrupt for the debug agent timer. This is called in the
  41   interrupt handler after the interrupt has been processed.
  42
  43 **/
  44 VOID
  45 EFIAPI
  46 DebugAgentTimerEndOfInterrupt (
  47   VOID
  48   );
  49
  50 #endif