1. remove FirmwareVolumeBlock.h for IntelFrameworkPkg
[mirror_edk2.git] / Nt32Pkg / TimerDxe / Timer.h
1 /*++
2
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13
14 Timer.h
15
16 Abstract:
17
18 NT Emulation Architectural Protocol Driver as defined in Tiano.
19 This Timer module uses an NT Thread to simulate the timer-tick driven
20 timer service.
21
22 --*/
23
24 #ifndef _TIMER_H_
25 #define _TIMER_H_
26
27
28
29
30 //
31 // Include common header file for this module.
32 //
33 #include "CommonHeader.h"
34
35 //
36 // Legal timer value range in 100 ns units
37 //
38 #define TIMER_MINIMUM_VALUE 0
39 #define TIMER_MAXIMUM_VALUE (0x100000000 - 1)
40
41 //
42 // Default timer value in 100 ns units (10 ms)
43 //
44 #define DEFAULT_TIMER_TICK_DURATION 100000
45
46 //
47 // Function Prototypes
48 //
49 EFI_STATUS
50 EFIAPI
51 WinNtTimerDriverInitialize (
52 IN EFI_HANDLE ImageHandle,
53 IN EFI_SYSTEM_TABLE *SystemTable
54 )
55 /*++
56
57 Routine Description:
58
59 TODO: Add function description
60
61 Arguments:
62
63 ImageHandle - TODO: add argument description
64 SystemTable - TODO: add argument description
65
66 Returns:
67
68 TODO: add return values
69
70 --*/
71 ;
72
73 EFI_STATUS
74 EFIAPI
75 WinNtTimerDriverRegisterHandler (
76 IN EFI_TIMER_ARCH_PROTOCOL *This,
77 IN EFI_TIMER_NOTIFY NotifyFunction
78 )
79 /*++
80
81 Routine Description:
82
83 TODO: Add function description
84
85 Arguments:
86
87 This - TODO: add argument description
88 NotifyFunction - TODO: add argument description
89
90 Returns:
91
92 TODO: add return values
93
94 --*/
95 ;
96
97 EFI_STATUS
98 EFIAPI
99 WinNtTimerDriverSetTimerPeriod (
100 IN EFI_TIMER_ARCH_PROTOCOL *This,
101 IN UINT64 TimerPeriod
102 )
103 /*++
104
105 Routine Description:
106
107 TODO: Add function description
108
109 Arguments:
110
111 This - TODO: add argument description
112 TimerPeriod - TODO: add argument description
113
114 Returns:
115
116 TODO: add return values
117
118 --*/
119 ;
120
121 EFI_STATUS
122 EFIAPI
123 WinNtTimerDriverGetTimerPeriod (
124 IN EFI_TIMER_ARCH_PROTOCOL *This,
125 OUT UINT64 *TimerPeriod
126 )
127 /*++
128
129 Routine Description:
130
131 TODO: Add function description
132
133 Arguments:
134
135 This - TODO: add argument description
136 TimerPeriod - TODO: add argument description
137
138 Returns:
139
140 TODO: add return values
141
142 --*/
143 ;
144
145 EFI_STATUS
146 EFIAPI
147 WinNtTimerDriverGenerateSoftInterrupt (
148 IN EFI_TIMER_ARCH_PROTOCOL *This
149 )
150 /*++
151
152 Routine Description:
153
154 TODO: Add function description
155
156 Arguments:
157
158 This - TODO: add argument description
159
160 Returns:
161
162 TODO: add return values
163
164 --*/
165 ;
166
167 #endif