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
  17 /**
  18   Setup all the hardware needed for the debug agents timer.
  19
  20   This function is used to set up debug environment. It may enable interrupts.
  21
  22 **/
  23 VOID
  24 EFIAPI
  25 DebugAgentTimerIntialize (
  26   VOID
  27   );
  28
  29
  30 /**
  31   Set the period for the debug agent timer. Zero means disable the timer.
  32
  33   @param[in] TimerPeriodMilliseconds    Frequency of the debug agent timer.
  34
  35 **/
  36 VOID
  37 EFIAPI
  38 DebugAgentTimerSetPeriod (
  39   IN  UINT32  TimerPeriodMilliseconds
  40   );
  41
  42
  43 /**
  44   Perform End Of Interrupt for the debug agent timer. This is called in the
  45   interrupt handler after the interrupt has been processed.
  46
  47 **/
  48 VOID
  49 EFIAPI
  50 DebugAgentTimerEndOfInterrupt (
  51   VOID
  52   );
  53
  54 #endif
  55
  56