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