]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Universal/Legacy8259Dxe/8259.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Update LIBRARY_CLASS declaration in the INF file so this library is type BASE and...
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / Legacy8259Dxe / 8259.h
CommitLineData
1166d068 1/**\r
2\r
3Copyright (c) 2005, 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 8259.h\r
14\r
15Abstract:\r
16\r
17 Driver implementing the Tiano Legacy 8259 Protocol\r
18\r
19**/\r
20\r
21#ifndef _8259_H__\r
22#define _8259_H__\r
23\r
24#include <FrameworkDxe.h>\r
25\r
26#include <Protocol/CpuIo.h>\r
27#include <Protocol/Legacy8259.h>\r
28\r
29#include <Library/UefiBootServicesTableLib.h>\r
30#include <Library/DebugLib.h>\r
31\r
32//\r
33// 8259 Hardware definitions\r
34//\r
35#define LEGACY_MODE_BASE_VECTOR_MASTER 0x08\r
36#define LEGACY_MODE_BASE_VECTOR_SLAVE 0x70\r
37\r
38#define PROTECTED_MODE_BASE_VECTOR_MASTER 0x68\r
39#define PROTECTED_MODE_BASE_VECTOR_SLAVE 0x70\r
40\r
41#define LEGACY_8259_CONTROL_REGISTER_MASTER 0x20\r
42#define LEGACY_8259_MASK_REGISTER_MASTER 0x21\r
43#define LEGACY_8259_CONTROL_REGISTER_SLAVE 0xA0\r
44#define LEGACY_8259_MASK_REGISTER_SLAVE 0xA1\r
45#define LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_MASTER 0x4D0\r
46#define LEGACY_8259_EDGE_LEVEL_TRIGGERED_REGISTER_SLAVE 0x4D1\r
47\r
48#define LEGACY_8259_EOI 0x20\r
49\r
50//\r
51// Protocol Function Prototypes\r
52//\r
53EFI_STATUS\r
54EFIAPI\r
55Interrupt8259SetVectorBase (\r
56 IN EFI_LEGACY_8259_PROTOCOL *This,\r
57 IN UINT8 MasterBase,\r
58 IN UINT8 SlaveBase\r
59 )\r
60/**\r
61\r
62Routine Description:\r
63\r
64 TODO: Add function description\r
65\r
66Arguments:\r
67\r
68 This - TODO: add argument description\r
69 MasterBase - TODO: add argument description\r
70 SlaveBase - TODO: add argument description\r
71\r
72Returns:\r
73\r
74 TODO: add return values\r
75\r
76**/\r
77;\r
78\r
79EFI_STATUS\r
80EFIAPI\r
81Interrupt8259GetMask (\r
82 IN EFI_LEGACY_8259_PROTOCOL * This,\r
83 OUT UINT16 *LegacyMask, OPTIONAL\r
84 OUT UINT16 *LegacyEdgeLevel, OPTIONAL\r
85 OUT UINT16 *ProtectedMask, OPTIONAL\r
86 OUT UINT16 *ProtectedEdgeLevel OPTIONAL\r
87 )\r
88/**\r
89\r
90Routine Description:\r
91\r
92 TODO: Add function description\r
93\r
94Arguments:\r
95\r
96 This - TODO: add argument description\r
97 LegacyMask - TODO: add argument description\r
98 LegacyEdgeLevel - TODO: add argument description\r
99 ProtectedMask - TODO: add argument description\r
100 ProtectedEdgeLevel - TODO: add argument description\r
101\r
102Returns:\r
103\r
104 TODO: add return values\r
105\r
106**/\r
107;\r
108\r
109EFI_STATUS\r
110EFIAPI\r
111Interrupt8259SetMask (\r
112 IN EFI_LEGACY_8259_PROTOCOL * This,\r
113 IN UINT16 *LegacyMask, OPTIONAL\r
114 IN UINT16 *LegacyEdgeLevel, OPTIONAL\r
115 IN UINT16 *ProtectedMask, OPTIONAL\r
116 IN UINT16 *ProtectedEdgeLevel OPTIONAL\r
117 )\r
118/**\r
119\r
120Routine Description:\r
121\r
122 TODO: Add function description\r
123\r
124Arguments:\r
125\r
126 This - TODO: add argument description\r
127 LegacyMask - TODO: add argument description\r
128 LegacyEdgeLevel - TODO: add argument description\r
129 ProtectedMask - TODO: add argument description\r
130 ProtectedEdgeLevel - TODO: add argument description\r
131\r
132Returns:\r
133\r
134 TODO: add return values\r
135\r
136**/\r
137;\r
138\r
139EFI_STATUS\r
140EFIAPI\r
141Interrupt8259SetMode (\r
142 IN EFI_LEGACY_8259_PROTOCOL * This,\r
143 IN EFI_8259_MODE Mode,\r
144 IN UINT16 *Mask, OPTIONAL\r
145 IN UINT16 *EdgeLevel OPTIONAL\r
146 )\r
147/**\r
148\r
149Routine Description:\r
150\r
151 TODO: Add function description\r
152\r
153Arguments:\r
154\r
155 This - TODO: add argument description\r
156 Mode - TODO: add argument description\r
157 Mask - TODO: add argument description\r
158 EdgeLevel - 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
167EFI_STATUS\r
168EFIAPI\r
169Interrupt8259GetVector (\r
170 IN EFI_LEGACY_8259_PROTOCOL *This,\r
171 IN EFI_8259_IRQ Irq,\r
172 OUT UINT8 *Vector\r
173 )\r
174/**\r
175\r
176Routine Description:\r
177\r
178 TODO: Add function description\r
179\r
180Arguments:\r
181\r
182 This - TODO: add argument description\r
183 Irq - TODO: add argument description\r
184 Vector - TODO: add argument description\r
185\r
186Returns:\r
187\r
188 TODO: add return values\r
189\r
190**/\r
191;\r
192\r
193EFI_STATUS\r
194EFIAPI\r
195Interrupt8259EnableIrq (\r
196 IN EFI_LEGACY_8259_PROTOCOL *This,\r
197 IN EFI_8259_IRQ Irq,\r
198 IN BOOLEAN LevelTriggered\r
199 )\r
200/**\r
201\r
202Routine Description:\r
203\r
204 TODO: Add function description\r
205\r
206Arguments:\r
207\r
208 This - TODO: add argument description\r
209 Irq - TODO: add argument description\r
210 LevelTriggered - TODO: add argument description\r
211\r
212Returns:\r
213\r
214 TODO: add return values\r
215\r
216**/\r
217;\r
218\r
219EFI_STATUS\r
220EFIAPI\r
221Interrupt8259DisableIrq (\r
222 IN EFI_LEGACY_8259_PROTOCOL *This,\r
223 IN EFI_8259_IRQ Irq\r
224 )\r
225/**\r
226\r
227Routine Description:\r
228\r
229 TODO: Add function description\r
230\r
231Arguments:\r
232\r
233 This - TODO: add argument description\r
234 Irq - TODO: add argument description\r
235\r
236Returns:\r
237\r
238 TODO: add return values\r
239\r
240**/\r
241;\r
242\r
243EFI_STATUS\r
244EFIAPI\r
245Interrupt8259GetInterruptLine (\r
246 IN EFI_LEGACY_8259_PROTOCOL *This,\r
247 IN EFI_HANDLE PciHandle,\r
248 OUT UINT8 *Vector\r
249 )\r
250/**\r
251\r
252Routine Description:\r
253\r
254 TODO: Add function description\r
255\r
256Arguments:\r
257\r
258 This - TODO: add argument description\r
259 PciHandle - TODO: add argument description\r
260 Vector - TODO: add argument description\r
261\r
262Returns:\r
263\r
264 TODO: add return values\r
265\r
266**/\r
267;\r
268\r
269EFI_STATUS\r
270EFIAPI\r
271Interrupt8259EndOfInterrupt (\r
272 IN EFI_LEGACY_8259_PROTOCOL *This,\r
273 IN EFI_8259_IRQ Irq\r
274 )\r
275/**\r
276\r
277Routine Description:\r
278\r
279 TODO: Add function description\r
280\r
281Arguments:\r
282\r
283 This - TODO: add argument description\r
284 Irq - TODO: add argument description\r
285\r
286Returns:\r
287\r
288 TODO: add return values\r
289\r
290**/\r
291;\r
292\r
293#endif\r
EFI Development Kit II mirror for PVE