Update the copyright notice format
[mirror_edk2.git] / EmbeddedPkg / Include / Library / DebugAgentTimerLib.h
CommitLineData
969eba7b 1/** @file\r
2 Platform specific Debug Agent abstraction for timer used by the agent. \r
3\r
4 The timer is used by the debugger to break into a running program.\r
5\r
6 Copyright (c) 2008-2010, Apple Inc. All rights reserved.\r
7 \r
8 All rights reserved. This program and the accompanying materials\r
9 are licensed and made available under the terms and conditions of the BSD License\r
10 which accompanies this distribution. The full text of the license may be found at\r
11 http://opensource.org/licenses/bsd-license.php\r
12\r
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15\r
16**/\r
17\r
18#ifndef __GDB_TIMER_LIB__\r
19#define __GDB_TIMER_LIB__\r
20\r
21\r
22\r
23/**\r
24 Setup all the hardware needed for the debug agents timer.\r
25\r
26 This function is used to set up debug enviroment. It may enable interrupts.\r
27\r
28**/\r
29VOID\r
30EFIAPI\r
31DebugAgentTimerIntialize (\r
32 VOID\r
33 );\r
34 \r
35\r
36/**\r
37 Set the period for the debug agent timer. Zero means disable the timer.\r
38\r
39 @param[in] TimerPeriodMilliseconds Frequency of the debug agent timer.\r
40\r
41**/ \r
42VOID\r
43EFIAPI\r
44DebugAgentTimerSetPeriod (\r
45 IN UINT32 TimerPeriodMilliseconds\r
46 );\r
47 \r
48\r
49/**\r
50 Perform End Of Interrupt for the debug agent timer. This is called in the \r
51 interrupt handler after the interrupt has been processed. \r
52\r
53**/ \r
54VOID\r
55EFIAPI\r
56DebugAgentTimerEndOfInterrupt (\r
57 VOID\r
58 );\r
59 \r
60#endif\r
61 \r
62