SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugTimer.h

   1 /** @file
   2   Header file for debug timer to support debug agent library implementation.
   3
   4   Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _DEBUG_TIMER_H_
  10 #define _DEBUG_TIMER_H_
  11
  12 /**
  13   Initialize CPU local APIC timer.
  14
  15   @param[out] TimerFrequency  Local APIC timer frequency returned.
  16   @param[in]  DumpFlag        If TRUE, dump Local APIC timer's parameter.
  17
  18   @return   32-bit Local APIC timer init count.
  19 **/
  20 UINT32
  21 InitializeDebugTimer (
  22   OUT UINT32   *TimerFrequency,
  23   IN  BOOLEAN  DumpFlag
  24   );
  25
  26 /**
  27   Check if the timer is time out.
  28
  29   @param[in] TimerCycle             Timer initial count.
  30   @param[in] Timer                  The start timer from the begin.
  31   @param[in] TimeoutTicker          Ticker number need time out.
  32
  33   @return TRUE  Timer time out occurs.
  34   @retval FALSE Timer does not time out.
  35
  36 **/
  37 BOOLEAN
  38 IsDebugTimerTimeout (
  39   IN UINT32  TimerCycle,
  40   IN UINT32  Timer,
  41   IN UINT32  TimeoutTicker
  42   );
  43
  44 #endif