SourceLevelDebugPkg/DebugTimer: Dump Debug Timer parameter

[mirror_edk2.git] / SourceLevelDebugPkg / Library / DebugAgent / DebugAgentCommon / DebugTimer.h

/** @file\r
  Header file for debug timer to support debug agent library implementation.\r
\r
  Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _DEBUG_TIMER_H_\r
#define _DEBUG_TIMER_H_\r
\r
/**\r
  Initialize CPU local APIC timer.\r
\r
  @param[out] TimerFrequency  Local APIC timer frequency returned.\r
  @param[in]  DumpFlag        If TRUE, dump Local APIC timer's parameter.\r
 \r
  @return   32-bit Local APIC timer init count.\r
**/\r
UINT32\r
InitializeDebugTimer (\r
  OUT UINT32     *TimerFrequency,\r
  IN  BOOLEAN    DumpFlag\r
  );\r
\r
/**\r
  Check if the timer is time out.\r
  \r
  @param[in] TimerCycle             Timer total count.\r
  @param[in] Timer                  The start timer from the begin.\r
  @param[in] TimeoutTicker          Ticker number need time out.\r
\r
  @return TRUE  Timer time out occurs.\r
  @retval FALSE Timer does not time out.\r
\r
**/\r
BOOLEAN\r
IsDebugTimerTimeout (\r
  IN UINT32                     TimerCycle,\r
  IN UINT32                     Timer,\r
  IN UINT32                     TimeoutTicker\r
  );\r
\r
#endif\r
\r