]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
e0c047a0 | 2 | Include file that supports UEFI.\r |
959ccb23 | 3 | \r |
e0c047a0 | 4 | This include file must only contain things defined in the UEFI 2.1 specification.\r |
5 | If a code construct is defined in the UEFI 2.1 specification it must be included\r | |
959ccb23 | 6 | by this include file.\r |
7 | \r | |
97f8b30c | 8 | Copyright (c) 2006 - 2008, Intel Corporation<BR>\r |
9 | Portions Copyright (c) 2008-2009 Apple Inc.<BR> | |
959ccb23 | 10 | All rights reserved. This program and the accompanying materials\r |
11 | are licensed and made available under the terms and conditions of the BSD License\r | |
12 | which accompanies this distribution. The full text of the license may be found at\r | |
13 | http://opensource.org/licenses/bsd-license.php\r | |
14 | \r | |
15 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
16 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
17 | \r | |
959ccb23 | 18 | **/\r |
19 | \r | |
20 | #ifndef __UEFI_SPEC_H__\r | |
21 | #define __UEFI_SPEC_H__\r | |
22 | \r | |
23 | #include <Uefi/UefiMultiPhase.h>\r | |
24 | \r | |
25 | #include <Protocol/DevicePath.h>\r | |
26 | #include <Protocol/SimpleTextIn.h>\r | |
27 | #include <Protocol/SimpleTextOut.h>\r | |
28 | \r | |
8b13229b | 29 | ///\r |
2a3f6a21 | 30 | /// Enumeration of EFI memory allocation types.\r |
8b13229b | 31 | ///\r |
959ccb23 | 32 | typedef enum {\r |
2a3f6a21 | 33 | ///\r |
34 | /// Allocate any available range of pages that satisfies the request\r | |
35 | ///\r | |
959ccb23 | 36 | AllocateAnyPages,\r |
2a3f6a21 | 37 | ///\r |
38 | /// Allocate any available range of pages whose uppermost address is less than \r | |
39 | /// or equal to a specified maximum address\r | |
40 | ///\r | |
959ccb23 | 41 | AllocateMaxAddress,\r |
2a3f6a21 | 42 | ///\r |
43 | /// Allocate pages at a specified address\r | |
44 | ///\r | |
959ccb23 | 45 | AllocateAddress,\r |
2a3f6a21 | 46 | ///\r |
47 | /// Maximum enumeration value that may be used for bounds checking\r | |
48 | ///\r | |
959ccb23 | 49 | MaxAllocateType\r |
50 | } EFI_ALLOCATE_TYPE;\r | |
51 | \r | |
5413e8e8 | 52 | //\r |
53 | // Bit definitions for EFI_TIME.Daylight\r | |
54 | //\r | |
55 | #define EFI_TIME_ADJUST_DAYLIGHT 0x01\r | |
56 | #define EFI_TIME_IN_DAYLIGHT 0x02\r | |
57 | \r | |
8b13229b | 58 | ///\r |
59 | /// Value definition for EFI_TIME.TimeZone\r | |
60 | ///\r | |
5413e8e8 | 61 | #define EFI_UNSPECIFIED_TIMEZONE 0x07FF\r |
959ccb23 | 62 | \r |
63 | //\r | |
e0c047a0 | 64 | // Memory cacheability attributes\r |
959ccb23 | 65 | //\r |
66 | #define EFI_MEMORY_UC 0x0000000000000001ULL\r | |
67 | #define EFI_MEMORY_WC 0x0000000000000002ULL\r | |
68 | #define EFI_MEMORY_WT 0x0000000000000004ULL\r | |
69 | #define EFI_MEMORY_WB 0x0000000000000008ULL\r | |
70 | #define EFI_MEMORY_UCE 0x0000000000000010ULL\r | |
959ccb23 | 71 | //\r |
e0c047a0 | 72 | // Physical memory protection attributes\r |
959ccb23 | 73 | //\r |
00edb218 A |
74 | #define EFI_MEMORY_WP 0x0000000000001000ULL\r |
75 | #define EFI_MEMORY_RP 0x0000000000002000ULL\r | |
76 | #define EFI_MEMORY_XP 0x0000000000004000ULL\r | |
e0c047a0 | 77 | //\r |
78 | // Runtime memory attribute\r | |
79 | //\r | |
80 | #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL\r | |
959ccb23 | 81 | \r |
8b13229b | 82 | ///\r |
e0c047a0 | 83 | /// Memory descriptor version number\r |
8b13229b | 84 | ///\r |
959ccb23 | 85 | #define EFI_MEMORY_DESCRIPTOR_VERSION 1\r |
e0c047a0 | 86 | \r |
87 | ///\r | |
2a3f6a21 | 88 | /// Definition of an EFI memory descriptor\r |
e0c047a0 | 89 | ///\r |
959ccb23 | 90 | typedef struct {\r |
2a3f6a21 | 91 | ///\r |
92 | /// Type of the memory region. See EFI_MEMORY_TYPE\r | |
93 | ///\r | |
00edb218 | 94 | UINT32 Type;\r |
2a3f6a21 | 95 | ///\r |
96 | /// Physical address of the first byte of the memory region. Must aligned \r | |
97 | /// on a 4 KB boundary.\r | |
98 | ///\r | |
00edb218 | 99 | EFI_PHYSICAL_ADDRESS PhysicalStart;\r |
2a3f6a21 | 100 | ///\r |
101 | /// Virtual address of the first byte of the memory region. Must aligned \r | |
102 | /// on a 4 KB boundary.\r | |
103 | ///\r | |
00edb218 | 104 | EFI_VIRTUAL_ADDRESS VirtualStart;\r |
2a3f6a21 | 105 | ///\r |
106 | /// Number of 4KB pages in the memory region.\r | |
107 | ///\r | |
00edb218 | 108 | UINT64 NumberOfPages;\r |
2a3f6a21 | 109 | ///\r |
110 | /// Attributes of the memory region that describe the bit mask of capabilities\r | |
111 | /// for that memory region, and not necessarily the current settings for that \r | |
112 | /// memory region.\r | |
113 | ///\r | |
00edb218 | 114 | UINT64 Attribute;\r |
959ccb23 | 115 | } EFI_MEMORY_DESCRIPTOR;\r |
116 | \r | |
959ccb23 | 117 | /**\r |
118 | Allocates memory pages from the system.\r | |
119 | \r | |
120 | @param Type The type of allocation to perform.\r | |
121 | @param MemoryType The type of memory to allocate.\r | |
122 | @param Pages The number of contiguous 4 KB pages to allocate.\r | |
123 | @param Memory Pointer to a physical address. On input, the way in which the address is\r | |
124 | used depends on the value of Type.\r | |
125 | \r | |
126 | @retval EFI_SUCCESS The requested pages were allocated.\r | |
127 | @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or\r | |
128 | AllocateMaxAddress or AllocateAddress.\r | |
129 | 2) MemoryType is in the range\r | |
130 | EfiMaxMemoryType..0x7FFFFFFF.\r | |
131 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r | |
132 | @retval EFI_NOT_FOUND The requested pages could not be found.\r | |
133 | \r | |
134 | **/\r | |
135 | typedef\r | |
136 | EFI_STATUS\r | |
8b13229b | 137 | (EFIAPI *EFI_ALLOCATE_PAGES)(\r |
959ccb23 | 138 | IN EFI_ALLOCATE_TYPE Type,\r |
139 | IN EFI_MEMORY_TYPE MemoryType,\r | |
140 | IN UINTN Pages,\r | |
141 | IN OUT EFI_PHYSICAL_ADDRESS *Memory\r | |
142 | );\r | |
143 | \r | |
144 | /**\r | |
145 | Frees memory pages.\r | |
146 | \r | |
147 | @param Memory The base physical address of the pages to be freed.\r | |
148 | @param Pages The number of contiguous 4 KB pages to free.\r | |
149 | \r | |
150 | @retval EFI_SUCCESS The requested pages were freed.\r | |
151 | @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.\r | |
152 | @retval EFI_NOT_FOUND The requested memory pages were not allocated with\r | |
153 | AllocatePages().\r | |
154 | \r | |
155 | **/\r | |
156 | typedef\r | |
157 | EFI_STATUS\r | |
8b13229b | 158 | (EFIAPI *EFI_FREE_PAGES)(\r |
959ccb23 | 159 | IN EFI_PHYSICAL_ADDRESS Memory,\r |
160 | IN UINTN Pages\r | |
161 | );\r | |
162 | \r | |
163 | /**\r | |
164 | Returns the current memory map.\r | |
165 | \r | |
166 | @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.\r | |
e0c047a0 | 167 | On input, this is the size of the buffer allocated by the caller.\r |
168 | On output, it is the size of the buffer returned by the firmware if\r | |
169 | the buffer was large enough, or the size of the buffer needed to contain\r | |
170 | the map if the buffer was too small.\r | |
959ccb23 | 171 | @param MemoryMap A pointer to the buffer in which firmware places the current memory\r |
172 | map.\r | |
173 | @param MapKey A pointer to the location in which firmware returns the key for the\r | |
174 | current memory map.\r | |
175 | @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of\r | |
176 | an individual EFI_MEMORY_DESCRIPTOR.\r | |
177 | @param DescriptorVersion A pointer to the location in which firmware returns the version number\r | |
178 | associated with the EFI_MEMORY_DESCRIPTOR.\r | |
179 | \r | |
180 | @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.\r | |
181 | @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size\r | |
182 | needed to hold the memory map is returned in MemoryMapSize.\r | |
183 | @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.\r | |
184 | 2) The MemoryMap buffer is not too small and MemoryMap is\r | |
185 | NULL.\r | |
186 | \r | |
187 | **/\r | |
188 | typedef\r | |
189 | EFI_STATUS\r | |
8b13229b | 190 | (EFIAPI *EFI_GET_MEMORY_MAP)(\r |
959ccb23 | 191 | IN OUT UINTN *MemoryMapSize,\r |
192 | IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,\r | |
193 | OUT UINTN *MapKey,\r | |
194 | OUT UINTN *DescriptorSize,\r | |
195 | OUT UINT32 *DescriptorVersion\r | |
196 | );\r | |
197 | \r | |
198 | /**\r | |
199 | Allocates pool memory.\r | |
200 | \r | |
201 | @param PoolType The type of pool to allocate.\r | |
202 | @param Size The number of bytes to allocate from the pool.\r | |
203 | @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;\r | |
204 | undefined otherwise.\r | |
205 | \r | |
206 | @retval EFI_SUCCESS The requested number of bytes was allocated.\r | |
207 | @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r | |
208 | @retval EFI_INVALID_PARAMETER PoolType was invalid.\r | |
209 | \r | |
210 | **/\r | |
211 | typedef\r | |
212 | EFI_STATUS\r | |
8b13229b | 213 | (EFIAPI *EFI_ALLOCATE_POOL)(\r |
959ccb23 | 214 | IN EFI_MEMORY_TYPE PoolType,\r |
215 | IN UINTN Size,\r | |
216 | OUT VOID **Buffer\r | |
217 | );\r | |
218 | \r | |
219 | /**\r | |
220 | Returns pool memory to the system.\r | |
221 | \r | |
222 | @param Buffer Pointer to the buffer to free.\r | |
223 | \r | |
224 | @retval EFI_SUCCESS The memory was returned to the system.\r | |
225 | @retval EFI_INVALID_PARAMETER Buffer was invalid.\r | |
226 | \r | |
227 | **/\r | |
228 | typedef\r | |
229 | EFI_STATUS\r | |
8b13229b | 230 | (EFIAPI *EFI_FREE_POOL)(\r |
959ccb23 | 231 | IN VOID *Buffer\r |
232 | );\r | |
233 | \r | |
234 | /**\r | |
235 | Changes the runtime addressing mode of EFI firmware from physical to virtual.\r | |
236 | \r | |
237 | @param MemoryMapSize The size in bytes of VirtualMap.\r | |
238 | @param DescriptorSize The size in bytes of an entry in the VirtualMap.\r | |
239 | @param DescriptorVersion The version of the structure entries in VirtualMap.\r | |
240 | @param VirtualMap An array of memory descriptors which contain new virtual\r | |
241 | address mapping information for all runtime ranges.\r | |
242 | \r | |
243 | @retval EFI_SUCCESS The virtual address map has been applied.\r | |
244 | @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r | |
245 | virtual address mapped mode.\r | |
246 | @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.\r | |
247 | @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r | |
248 | map that requires a mapping.\r | |
249 | @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r | |
250 | in the memory map.\r | |
251 | \r | |
252 | **/\r | |
253 | typedef\r | |
254 | EFI_STATUS\r | |
8b13229b | 255 | (EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP)(\r |
959ccb23 | 256 | IN UINTN MemoryMapSize,\r |
257 | IN UINTN DescriptorSize,\r | |
258 | IN UINT32 DescriptorVersion,\r | |
259 | IN EFI_MEMORY_DESCRIPTOR *VirtualMap\r | |
260 | );\r | |
261 | \r | |
262 | /**\r | |
263 | Connects one or more drivers to a controller.\r | |
264 | \r | |
265 | @param ControllerHandle The handle of the controller to which driver(s) are to be connected.\r | |
266 | @param DriverImageHandle A pointer to an ordered list handles that support the\r | |
267 | EFI_DRIVER_BINDING_PROTOCOL.\r | |
268 | @param RemainingDevicePath A pointer to the device path that specifies a child of the\r | |
269 | controller specified by ControllerHandle.\r | |
270 | @param Recursive If TRUE, then ConnectController() is called recursively\r | |
271 | until the entire tree of controllers below the controller specified\r | |
272 | by ControllerHandle have been created. If FALSE, then\r | |
273 | the tree of controllers is only expanded one level.\r | |
274 | \r | |
275 | @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.\r | |
276 | 2) No drivers were connected to ControllerHandle, but\r | |
277 | RemainingDevicePath is not NULL, and it is an End Device\r | |
278 | Path Node.\r | |
279 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
280 | @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances\r | |
281 | present in the system.\r | |
282 | 2) No drivers were connected to ControllerHandle.\r | |
283 | \r | |
284 | **/\r | |
285 | typedef\r | |
286 | EFI_STATUS\r | |
8b13229b | 287 | (EFIAPI *EFI_CONNECT_CONTROLLER)(\r |
959ccb23 | 288 | IN EFI_HANDLE ControllerHandle,\r |
289 | IN EFI_HANDLE *DriverImageHandle, OPTIONAL\r | |
290 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL\r | |
291 | IN BOOLEAN Recursive\r | |
292 | );\r | |
293 | \r | |
294 | /**\r | |
295 | Disconnects one or more drivers from a controller.\r | |
296 | \r | |
297 | @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.\r | |
298 | @param DriverImageHandle The driver to disconnect from ControllerHandle.\r | |
e0c047a0 | 299 | If DriverImageHandle is NULL, then all the drivers currently managing\r |
300 | ControllerHandle are disconnected from ControllerHandle.\r | |
959ccb23 | 301 | @param ChildHandle The handle of the child to destroy.\r |
e0c047a0 | 302 | If ChildHandle is NULL, then all the children of ControllerHandle are\r |
303 | destroyed before the drivers are disconnected from ControllerHandle.\r | |
959ccb23 | 304 | \r |
305 | @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.\r | |
306 | 2) On entry, no drivers are managing ControllerHandle.\r | |
307 | 3) DriverImageHandle is not NULL, and on entry\r | |
308 | DriverImageHandle is not managing ControllerHandle.\r | |
e0c047a0 | 309 | @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.\r |
310 | 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.\r | |
311 | 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.\r | |
312 | 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.\r | |
959ccb23 | 313 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from\r |
314 | ControllerHandle.\r | |
315 | @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.\r | |
316 | \r | |
317 | **/\r | |
318 | typedef\r | |
319 | EFI_STATUS\r | |
8b13229b | 320 | (EFIAPI *EFI_DISCONNECT_CONTROLLER)(\r |
959ccb23 | 321 | IN EFI_HANDLE ControllerHandle,\r |
322 | IN EFI_HANDLE DriverImageHandle, OPTIONAL\r | |
323 | IN EFI_HANDLE ChildHandle OPTIONAL\r | |
324 | );\r | |
325 | \r | |
326 | \r | |
327 | \r | |
328 | //\r | |
329 | // ConvertPointer DebugDisposition type.\r | |
330 | //\r | |
331 | #define EFI_OPTIONAL_PTR 0x00000001\r | |
959ccb23 | 332 | \r |
333 | /**\r | |
334 | Determines the new virtual address that is to be used on subsequent memory accesses.\r | |
335 | \r | |
336 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
337 | @param Address A pointer to a pointer that is to be fixed to be the value needed\r | |
338 | for the new virtual address mappings being applied.\r | |
339 | \r | |
340 | @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r | |
341 | @retval EFI_INVALID_PARAMETER 1) Address is NULL.\r | |
342 | 2) *Address is NULL and DebugDisposition does\r | |
343 | not have the EFI_OPTIONAL_PTR bit set.\r | |
344 | @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part\r | |
345 | of the current memory map. This is normally fatal.\r | |
346 | \r | |
347 | **/\r | |
348 | typedef\r | |
349 | EFI_STATUS\r | |
8b13229b | 350 | (EFIAPI *EFI_CONVERT_POINTER)(\r |
959ccb23 | 351 | IN UINTN DebugDisposition,\r |
352 | IN OUT VOID **Address\r | |
353 | );\r | |
354 | \r | |
355 | \r | |
356 | //\r | |
ac644614 | 357 | // These types can be ORed together as needed - for example,\r |
93ce5aca | 358 | // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or\r |
959ccb23 | 359 | // EVT_NOTIFY_SIGNAL.\r |
360 | //\r | |
00edb218 A |
361 | #define EVT_TIMER 0x80000000\r |
362 | #define EVT_RUNTIME 0x40000000\r | |
00edb218 A |
363 | #define EVT_NOTIFY_WAIT 0x00000100\r |
364 | #define EVT_NOTIFY_SIGNAL 0x00000200\r | |
93ce5aca | 365 | \r |
00edb218 | 366 | #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201\r |
93ce5aca | 367 | #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202\r |
959ccb23 | 368 | \r |
369 | //\r | |
ac644614 | 370 | // The event's NotifyContext pointer points to a runtime memory\r |
d0c64728 | 371 | // address.\r |
959ccb23 | 372 | // The event is deprecated in UEFI2.0 and later specifications.\r |
d0c64728 | 373 | //\r |
959ccb23 | 374 | #define EVT_RUNTIME_CONTEXT 0x20000000\r |
375 | \r | |
376 | \r | |
377 | /**\r | |
378 | Invoke a notification event\r | |
379 | \r | |
380 | @param Event Event whose notification function is being invoked.\r | |
381 | @param Context Pointer to the notification function's context,\r | |
382 | which is implementation-dependent.\r | |
383 | \r | |
384 | **/\r | |
385 | typedef\r | |
386 | VOID\r | |
8b13229b | 387 | (EFIAPI *EFI_EVENT_NOTIFY)(\r |
959ccb23 | 388 | IN EFI_EVENT Event,\r |
389 | IN VOID *Context\r | |
390 | );\r | |
391 | \r | |
392 | /**\r | |
393 | Creates an event.\r | |
394 | \r | |
395 | @param Type The type of event to create and its mode and attributes.\r | |
e0c047a0 | 396 | @param NotifyTpl The task priority level of event notifications, if needed.\r |
959ccb23 | 397 | @param NotifyFunction Pointer to the event's notification function, if any.\r |
398 | @param NotifyContext Pointer to the notification function's context; corresponds to parameter\r | |
399 | Context in the notification function.\r | |
400 | @param Event Pointer to the newly created event if the call succeeds; undefined\r | |
401 | otherwise.\r | |
402 | \r | |
403 | @retval EFI_SUCCESS The event structure was created.\r | |
404 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
405 | @retval EFI_OUT_OF_RESOURCES The event could not be allocated.\r | |
406 | \r | |
407 | **/\r | |
408 | typedef\r | |
409 | EFI_STATUS\r | |
8b13229b | 410 | (EFIAPI *EFI_CREATE_EVENT)(\r |
959ccb23 | 411 | IN UINT32 Type,\r |
412 | IN EFI_TPL NotifyTpl,\r | |
413 | IN EFI_EVENT_NOTIFY NotifyFunction,\r | |
414 | IN VOID *NotifyContext,\r | |
415 | OUT EFI_EVENT *Event\r | |
416 | );\r | |
417 | \r | |
418 | /**\r | |
419 | Creates an event in a group.\r | |
420 | \r | |
421 | @param Type The type of event to create and its mode and attributes.\r | |
e0c047a0 | 422 | @param NotifyTpl The task priority level of event notifications,if needed.\r |
959ccb23 | 423 | @param NotifyFunction Pointer to the event's notification function, if any.\r |
424 | @param NotifyContext Pointer to the notification function's context; corresponds to parameter\r | |
425 | Context in the notification function.\r | |
426 | @param EventGroup Pointer to the unique identifier of the group to which this event belongs.\r | |
e0c047a0 | 427 | If this is NULL, then the function behaves as if the parameters were passed\r |
428 | to CreateEvent.\r | |
959ccb23 | 429 | @param Event Pointer to the newly created event if the call succeeds; undefined\r |
430 | otherwise.\r | |
431 | \r | |
432 | @retval EFI_SUCCESS The event structure was created.\r | |
433 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
434 | @retval EFI_OUT_OF_RESOURCES The event could not be allocated.\r | |
435 | \r | |
436 | **/\r | |
437 | typedef\r | |
438 | EFI_STATUS\r | |
8b13229b | 439 | (EFIAPI *EFI_CREATE_EVENT_EX)(\r |
959ccb23 | 440 | IN UINT32 Type,\r |
e0c047a0 | 441 | IN EFI_TPL NotifyTpl,\r |
959ccb23 | 442 | IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r |
443 | IN CONST VOID *NotifyContext OPTIONAL,\r | |
444 | IN CONST EFI_GUID *EventGroup OPTIONAL,\r | |
445 | OUT EFI_EVENT *Event\r | |
446 | );\r | |
447 | \r | |
e0c047a0 | 448 | ///\r |
449 | /// Timer delay types\r | |
450 | ///\r | |
959ccb23 | 451 | typedef enum {\r |
2a3f6a21 | 452 | ///\r |
453 | /// An event's timer settings is to be cancelled and not trigger time is to be set\r | |
454 | ///\r | |
959ccb23 | 455 | TimerCancel,\r |
2a3f6a21 | 456 | ///\r |
457 | /// An event is to be signalled periodically at a specified interval from the current time.\r | |
458 | ///\r | |
959ccb23 | 459 | TimerPeriodic,\r |
2a3f6a21 | 460 | ///\r |
461 | /// An event is to be signalled once at a specified interval from the current time.\r | |
462 | ///\r | |
959ccb23 | 463 | TimerRelative\r |
464 | } EFI_TIMER_DELAY;\r | |
465 | \r | |
466 | /**\r | |
467 | Sets the type of timer and the trigger time for a timer event.\r | |
468 | \r | |
469 | @param Event The timer event that is to be signaled at the specified time.\r | |
470 | @param Type The type of time that is specified in TriggerTime.\r | |
471 | @param TriggerTime The number of 100ns units until the timer expires.\r | |
e0c047a0 | 472 | A TriggerTime of 0 is legal.\r |
473 | If Type is TimerRelative and TriggerTime is 0, then the timer\r | |
474 | event will be signaled on the next timer tick.\r | |
475 | If Type is TimerPeriodic and TriggerTime is 0, then the timer\r | |
476 | event will be signaled on every timer tick.\r | |
959ccb23 | 477 | \r |
478 | @retval EFI_SUCCESS The event has been set to be signaled at the requested time.\r | |
479 | @retval EFI_INVALID_PARAMETER Event or Type is not valid.\r | |
480 | \r | |
481 | **/\r | |
482 | typedef\r | |
483 | EFI_STATUS\r | |
8b13229b | 484 | (EFIAPI *EFI_SET_TIMER)(\r |
959ccb23 | 485 | IN EFI_EVENT Event,\r |
486 | IN EFI_TIMER_DELAY Type,\r | |
487 | IN UINT64 TriggerTime\r | |
488 | );\r | |
489 | \r | |
490 | /**\r | |
491 | Signals an event.\r | |
492 | \r | |
493 | @param Event The event to signal.\r | |
494 | \r | |
495 | @retval EFI_SUCCESS The event has been signaled.\r | |
496 | \r | |
497 | **/\r | |
498 | typedef\r | |
499 | EFI_STATUS\r | |
8b13229b | 500 | (EFIAPI *EFI_SIGNAL_EVENT)(\r |
959ccb23 | 501 | IN EFI_EVENT Event\r |
502 | );\r | |
503 | \r | |
504 | /**\r | |
505 | Stops execution until an event is signaled.\r | |
506 | \r | |
507 | @param NumberOfEvents The number of events in the Event array.\r | |
508 | @param Event An array of EFI_EVENT.\r | |
509 | @param Index Pointer to the index of the event which satisfied the wait condition.\r | |
510 | \r | |
511 | @retval EFI_SUCCESS The event indicated by Index was signaled.\r | |
512 | @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.\r | |
513 | 2) The event indicated by Index is of type\r | |
514 | EVT_NOTIFY_SIGNAL.\r | |
515 | @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.\r | |
516 | \r | |
517 | **/\r | |
518 | typedef\r | |
519 | EFI_STATUS\r | |
8b13229b | 520 | (EFIAPI *EFI_WAIT_FOR_EVENT)(\r |
959ccb23 | 521 | IN UINTN NumberOfEvents,\r |
522 | IN EFI_EVENT *Event,\r | |
523 | OUT UINTN *Index\r | |
524 | );\r | |
525 | \r | |
526 | /**\r | |
527 | Closes an event.\r | |
528 | \r | |
529 | @param Event The event to close.\r | |
530 | \r | |
531 | @retval EFI_SUCCESS The event has been closed.\r | |
532 | \r | |
533 | **/\r | |
534 | typedef\r | |
535 | EFI_STATUS\r | |
8b13229b | 536 | (EFIAPI *EFI_CLOSE_EVENT)(\r |
959ccb23 | 537 | IN EFI_EVENT Event\r |
538 | );\r | |
539 | \r | |
540 | /**\r | |
541 | Checks whether an event is in the signaled state.\r | |
542 | \r | |
543 | @param Event The event to check.\r | |
544 | \r | |
545 | @retval EFI_SUCCESS The event is in the signaled state.\r | |
546 | @retval EFI_NOT_READY The event is not in the signaled state.\r | |
547 | @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.\r | |
548 | \r | |
549 | **/\r | |
550 | typedef\r | |
551 | EFI_STATUS\r | |
8b13229b | 552 | (EFIAPI *EFI_CHECK_EVENT)(\r |
959ccb23 | 553 | IN EFI_EVENT Event\r |
554 | );\r | |
555 | \r | |
556 | \r | |
557 | //\r | |
e0c047a0 | 558 | // Task priority level\r |
959ccb23 | 559 | //\r |
560 | #define TPL_APPLICATION 4\r | |
561 | #define TPL_CALLBACK 8\r | |
562 | #define TPL_NOTIFY 16\r | |
563 | #define TPL_HIGH_LEVEL 31\r | |
564 | \r | |
565 | \r | |
566 | /**\r | |
567 | Raises a task's priority level and returns its previous level.\r | |
568 | \r | |
569 | @param NewTpl The new task priority level.\r | |
570 | \r | |
e0c047a0 | 571 | @return Previous task priority level\r |
959ccb23 | 572 | \r |
573 | **/\r | |
574 | typedef\r | |
575 | EFI_TPL\r | |
8b13229b | 576 | (EFIAPI *EFI_RAISE_TPL)(\r |
959ccb23 | 577 | IN EFI_TPL NewTpl\r |
578 | );\r | |
579 | \r | |
580 | /**\r | |
581 | Restores a task's priority level to its previous value.\r | |
582 | \r | |
e0c047a0 | 583 | @param OldTpl The previous task priority level to restore.\r |
959ccb23 | 584 | \r |
585 | **/\r | |
586 | typedef\r | |
587 | VOID\r | |
8b13229b | 588 | (EFIAPI *EFI_RESTORE_TPL)(\r |
959ccb23 | 589 | IN EFI_TPL OldTpl\r |
590 | );\r | |
591 | \r | |
592 | /**\r | |
593 | Returns the value of a variable.\r | |
594 | \r | |
595 | @param VariableName A Null-terminated Unicode string that is the name of the\r | |
596 | vendor's variable.\r | |
597 | @param VendorGuid A unique identifier for the vendor.\r | |
598 | @param Attributes If not NULL, a pointer to the memory location to return the\r | |
599 | attributes bitmask for the variable.\r | |
600 | @param DataSize On input, the size in bytes of the return Data buffer.\r | |
601 | On output the size of data returned in Data.\r | |
602 | @param Data The buffer to return the contents of the variable.\r | |
603 | \r | |
e0c047a0 | 604 | @retval EFI_SUCCESS The function completed successfully.\r |
605 | @retval EFI_NOT_FOUND The variable was not found.\r | |
606 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r | |
607 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
608 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
609 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
610 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
611 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
612 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
959ccb23 | 613 | \r |
614 | **/\r | |
615 | typedef\r | |
616 | EFI_STATUS\r | |
8b13229b | 617 | (EFIAPI *EFI_GET_VARIABLE)(\r |
959ccb23 | 618 | IN CHAR16 *VariableName,\r |
619 | IN EFI_GUID *VendorGuid,\r | |
620 | OUT UINT32 *Attributes, OPTIONAL\r | |
621 | IN OUT UINTN *DataSize,\r | |
622 | OUT VOID *Data\r | |
623 | );\r | |
624 | \r | |
625 | /**\r | |
626 | Enumerates the current variable names.\r | |
627 | \r | |
628 | @param VariableNameSize The size of the VariableName buffer.\r | |
629 | @param VariableName On input, supplies the last VariableName that was returned\r | |
630 | by GetNextVariableName(). On output, returns the Nullterminated\r | |
631 | Unicode string of the current variable.\r | |
632 | @param VendorGuid On input, supplies the last VendorGuid that was returned by\r | |
633 | GetNextVariableName(). On output, returns the\r | |
634 | VendorGuid of the current variable.\r | |
635 | \r | |
636 | @retval EFI_SUCCESS The function completed successfully.\r | |
637 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
638 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
e0c047a0 | 639 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r |
640 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
641 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
959ccb23 | 642 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r |
643 | \r | |
644 | **/\r | |
645 | typedef\r | |
646 | EFI_STATUS\r | |
8b13229b | 647 | (EFIAPI *EFI_GET_NEXT_VARIABLE_NAME)(\r |
959ccb23 | 648 | IN OUT UINTN *VariableNameSize,\r |
649 | IN OUT CHAR16 *VariableName,\r | |
650 | IN OUT EFI_GUID *VendorGuid\r | |
651 | );\r | |
652 | \r | |
653 | /**\r | |
654 | Sets the value of a variable.\r | |
655 | \r | |
656 | @param VariableName A Null-terminated Unicode string that is the name of the\r | |
657 | vendor's variable.\r | |
658 | @param VendorGuid A unique identifier for the vendor.\r | |
659 | @param Attributes Attributes bitmask to set for the variable.\r | |
660 | @param DataSize The size in bytes of the Data buffer.\r | |
661 | @param Data The contents for the variable.\r | |
662 | \r | |
e0c047a0 | 663 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r |
664 | defined by the Attributes.\r | |
665 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r | |
666 | DataSize exceeds the maximum allowed.\r | |
667 | @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r | |
668 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
669 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
670 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
671 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
672 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
673 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
959ccb23 | 674 | \r |
675 | **/\r | |
676 | typedef\r | |
677 | EFI_STATUS\r | |
8b13229b | 678 | (EFIAPI *EFI_SET_VARIABLE)(\r |
959ccb23 | 679 | IN CHAR16 *VariableName,\r |
680 | IN EFI_GUID *VendorGuid,\r | |
681 | IN UINT32 Attributes,\r | |
682 | IN UINTN DataSize,\r | |
683 | IN VOID *Data\r | |
684 | );\r | |
685 | \r | |
686 | \r | |
e0c047a0 | 687 | ///\r |
688 | /// This provides the capabilities of the\r | |
689 | /// real time clock device as exposed through the EFI interfaces.\r | |
690 | ///\r | |
959ccb23 | 691 | typedef struct {\r |
1bf79370 LG |
692 | ///\r |
693 | /// Provides the reporting resolution of the real-time clock device in\r | |
694 | /// counts per second. For a normal PC-AT CMOS RTC device, this\r | |
695 | /// value would be 1 Hz, or 1, to indicate that the device only reports\r | |
696 | /// the time to the resolution of 1 second.\r | |
697 | ///\r | |
00edb218 | 698 | UINT32 Resolution;\r |
1bf79370 LG |
699 | ///\r |
700 | /// Provides the timekeeping accuracy of the real-time clock in an\r | |
701 | /// error rate of 1E-6 parts per million. For a clock with an accuracy\r | |
702 | /// of 50 parts per million, the value in this field would be\r | |
703 | /// 50,000,000.\r | |
704 | ///\r | |
00edb218 | 705 | UINT32 Accuracy;\r |
1bf79370 | 706 | ///\r |
de2314f8 | 707 | /// A TRUE indicates that a time set operation clears the device's\r |
1bf79370 LG |
708 | /// time below the Resolution reporting level. A FALSE\r |
709 | /// indicates that the state below the Resolution level of the\r | |
710 | /// device is not cleared when the time is set. Normal PC-AT CMOS\r | |
711 | /// RTC devices set this value to FALSE.\r | |
712 | ///\r | |
00edb218 | 713 | BOOLEAN SetsToZero;\r |
959ccb23 | 714 | } EFI_TIME_CAPABILITIES;\r |
715 | \r | |
716 | /**\r | |
717 | Returns the current time and date information, and the time-keeping capabilities\r | |
718 | of the hardware platform.\r | |
719 | \r | |
720 | @param Time A pointer to storage to receive a snapshot of the current time.\r | |
721 | @param Capabilities An optional pointer to a buffer to receive the real time clock\r | |
722 | device's capabilities.\r | |
723 | \r | |
724 | @retval EFI_SUCCESS The operation completed successfully.\r | |
725 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
726 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.\r | |
727 | \r | |
728 | **/\r | |
729 | typedef\r | |
730 | EFI_STATUS\r | |
8b13229b | 731 | (EFIAPI *EFI_GET_TIME)(\r |
959ccb23 | 732 | OUT EFI_TIME *Time,\r |
733 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r | |
734 | );\r | |
735 | \r | |
736 | /**\r | |
737 | Sets the current local time and date information.\r | |
738 | \r | |
739 | @param Time A pointer to the current time.\r | |
740 | \r | |
741 | @retval EFI_SUCCESS The operation completed successfully.\r | |
742 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
743 | @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.\r | |
744 | \r | |
745 | **/\r | |
746 | typedef\r | |
747 | EFI_STATUS\r | |
8b13229b | 748 | (EFIAPI *EFI_SET_TIME)(\r |
959ccb23 | 749 | IN EFI_TIME *Time\r |
750 | );\r | |
751 | \r | |
752 | /**\r | |
753 | Returns the current wakeup alarm clock setting.\r | |
754 | \r | |
755 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r | |
756 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
757 | @param Time The current alarm setting.\r | |
758 | \r | |
759 | @retval EFI_SUCCESS The alarm settings were returned.\r | |
e0c047a0 | 760 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r |
761 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
762 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
959ccb23 | 763 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r |
e0c047a0 | 764 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r |
959ccb23 | 765 | \r |
766 | **/\r | |
767 | typedef\r | |
768 | EFI_STATUS\r | |
8b13229b | 769 | (EFIAPI *EFI_GET_WAKEUP_TIME)(\r |
959ccb23 | 770 | OUT BOOLEAN *Enabled,\r |
771 | OUT BOOLEAN *Pending,\r | |
772 | OUT EFI_TIME *Time\r | |
773 | );\r | |
774 | \r | |
775 | /**\r | |
776 | Sets the system wakeup alarm clock time.\r | |
777 | \r | |
778 | @param Enabled Enable or disable the wakeup alarm.\r | |
779 | @param Time If Enable is TRUE, the time to set the wakeup alarm for.\r | |
e0c047a0 | 780 | If Enable is FALSE, then this parameter is optional, and may be NULL.\r |
959ccb23 | 781 | \r |
782 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If\r | |
783 | Enable is FALSE, then the wakeup alarm was disabled.\r | |
784 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
785 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
786 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
787 | \r | |
788 | **/\r | |
789 | typedef\r | |
790 | EFI_STATUS\r | |
8b13229b | 791 | (EFIAPI *EFI_SET_WAKEUP_TIME)(\r |
959ccb23 | 792 | IN BOOLEAN Enable,\r |
793 | IN EFI_TIME *Time OPTIONAL\r | |
794 | );\r | |
795 | \r | |
959ccb23 | 796 | /**\r |
797 | Loads an EFI image into memory.\r | |
798 | \r | |
799 | @param BootPolicy If TRUE, indicates that the request originates from the boot\r | |
800 | manager, and that the boot manager is attempting to load\r | |
801 | FilePath as a boot selection. Ignored if SourceBuffer is\r | |
802 | not NULL.\r | |
803 | @param ParentImageHandle The caller's image handle.\r | |
e0c047a0 | 804 | @param DevicePath The DeviceHandle specific file path from which the image is\r |
959ccb23 | 805 | loaded.\r |
806 | @param SourceBuffer If not NULL, a pointer to the memory location containing a copy\r | |
807 | of the image to be loaded.\r | |
e0c047a0 | 808 | @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.\r |
959ccb23 | 809 | @param ImageHandle Pointer to the returned image handle that is created when the\r |
810 | image is successfully loaded.\r | |
811 | \r | |
812 | @retval EFI_SUCCESS Image was loaded into memory correctly.\r | |
e0c047a0 | 813 | @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.\r |
959ccb23 | 814 | @retval EFI_INVALID_PARAMETER One or more parametes are invalid.\r |
815 | @retval EFI_UNSUPPORTED The image type is not supported.\r | |
816 | @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.\r | |
817 | @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not\r | |
818 | understood.\r | |
819 | @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.\r | |
820 | \r | |
821 | **/\r | |
822 | typedef\r | |
823 | EFI_STATUS\r | |
8b13229b | 824 | (EFIAPI *EFI_IMAGE_LOAD)(\r |
959ccb23 | 825 | IN BOOLEAN BootPolicy,\r |
826 | IN EFI_HANDLE ParentImageHandle,\r | |
e0c047a0 | 827 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
959ccb23 | 828 | IN VOID *SourceBuffer OPTIONAL,\r |
829 | IN UINTN SourceSize,\r | |
830 | OUT EFI_HANDLE *ImageHandle\r | |
831 | );\r | |
832 | \r | |
833 | /**\r | |
834 | Transfers control to a loaded image's entry point.\r | |
835 | \r | |
836 | @param ImageHandle Handle of image to be started.\r | |
837 | @param ExitDataSize Pointer to the size, in bytes, of ExitData.\r | |
838 | @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated\r | |
839 | Unicode string, optionally followed by additional binary data.\r | |
840 | \r | |
841 | @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r | |
842 | has already been initialized with StartImage\r | |
e0c047a0 | 843 | @return Exit code from image\r |
959ccb23 | 844 | \r |
845 | **/\r | |
846 | typedef\r | |
847 | EFI_STATUS\r | |
8b13229b | 848 | (EFIAPI *EFI_IMAGE_START)(\r |
959ccb23 | 849 | IN EFI_HANDLE ImageHandle,\r |
850 | OUT UINTN *ExitDataSize,\r | |
851 | OUT CHAR16 **ExitData OPTIONAL\r | |
852 | );\r | |
853 | \r | |
854 | /**\r | |
855 | Terminates a loaded EFI image and returns control to boot services.\r | |
856 | \r | |
857 | @param ImageHandle Handle that identifies the image.\r | |
858 | @param ExitStatus The image's exit code.\r | |
859 | @param ExitDataSize The size, in bytes, of ExitData.\r | |
860 | @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,\r | |
861 | optionally followed by additional binary data.\r | |
862 | \r | |
863 | @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.\r | |
864 | @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and\r | |
865 | started with LoadImage() and StartImage(), but the\r | |
866 | image is not the currently executing image.\r | |
867 | \r | |
868 | **/\r | |
869 | typedef\r | |
870 | EFI_STATUS\r | |
8b13229b | 871 | (EFIAPI *EFI_EXIT)(\r |
959ccb23 | 872 | IN EFI_HANDLE ImageHandle,\r |
873 | IN EFI_STATUS ExitStatus,\r | |
874 | IN UINTN ExitDataSize,\r | |
875 | IN CHAR16 *ExitData OPTIONAL\r | |
876 | );\r | |
877 | \r | |
878 | /**\r | |
879 | Unloads an image.\r | |
880 | \r | |
881 | @param ImageHandle Handle that identifies the image to be unloaded.\r | |
882 | \r | |
883 | @retval EFI_SUCCESS The image has been unloaded.\r | |
884 | @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.\r | |
959ccb23 | 885 | \r |
886 | **/\r | |
887 | typedef\r | |
888 | EFI_STATUS\r | |
8b13229b | 889 | (EFIAPI *EFI_IMAGE_UNLOAD)(\r |
959ccb23 | 890 | IN EFI_HANDLE ImageHandle\r |
891 | );\r | |
892 | \r | |
893 | /**\r | |
894 | Terminates all boot services.\r | |
895 | \r | |
896 | @param ImageHandle Handle that identifies the exiting image.\r | |
897 | @param MapKey Key to the latest memory map.\r | |
898 | \r | |
899 | @retval EFI_SUCCESS Boot services have been terminated.\r | |
900 | @retval EFI_INVALID_PARAMETER MapKey is incorrect.\r | |
901 | \r | |
902 | **/\r | |
903 | typedef\r | |
904 | EFI_STATUS\r | |
8b13229b | 905 | (EFIAPI *EFI_EXIT_BOOT_SERVICES)(\r |
959ccb23 | 906 | IN EFI_HANDLE ImageHandle,\r |
907 | IN UINTN MapKey\r | |
908 | );\r | |
909 | \r | |
910 | /**\r | |
911 | Induces a fine-grained stall.\r | |
912 | \r | |
913 | @param Microseconds The number of microseconds to stall execution.\r | |
914 | \r | |
915 | @retval EFI_SUCCESS Execution was stalled at least the requested number of\r | |
916 | Microseconds.\r | |
917 | \r | |
918 | **/\r | |
919 | typedef\r | |
920 | EFI_STATUS\r | |
8b13229b | 921 | (EFIAPI *EFI_STALL)(\r |
959ccb23 | 922 | IN UINTN Microseconds\r |
923 | );\r | |
924 | \r | |
925 | /**\r | |
926 | Sets the system's watchdog timer.\r | |
927 | \r | |
928 | @param Timeout The number of seconds to set the watchdog timer to.\r | |
929 | @param WatchdogCode The numeric code to log on a watchdog timer timeout event.\r | |
930 | @param DataSize The size, in bytes, of WatchdogData.\r | |
931 | @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally\r | |
932 | followed by additional binary data.\r | |
933 | \r | |
934 | @retval EFI_SUCCESS The timeout has been set.\r | |
935 | @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.\r | |
936 | @retval EFI_UNSUPPORTED The system does not have a watchdog timer.\r | |
937 | @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware\r | |
938 | error.\r | |
939 | \r | |
940 | **/\r | |
941 | typedef\r | |
942 | EFI_STATUS\r | |
8b13229b | 943 | (EFIAPI *EFI_SET_WATCHDOG_TIMER)(\r |
959ccb23 | 944 | IN UINTN Timeout,\r |
945 | IN UINT64 WatchdogCode,\r | |
946 | IN UINTN DataSize,\r | |
947 | IN CHAR16 *WatchdogData OPTIONAL\r | |
948 | );\r | |
949 | \r | |
e0c047a0 | 950 | ///\r |
951 | /// Enumeration of reset types.\r | |
952 | ///\r | |
959ccb23 | 953 | typedef enum {\r |
2a3f6a21 | 954 | ///\r |
955 | /// Used to induce a system-wide reset. This sets all circuitry within the \r | |
956 | /// system to its initial state. This type of reset is asynchronous to system\r | |
957 | /// operation and operates withgout regard to cycle boundaries. EfiColdReset \r | |
958 | /// is tantamount to a system power cycle.\r | |
959 | ///\r | |
959ccb23 | 960 | EfiResetCold,\r |
2a3f6a21 | 961 | ///\r |
962 | /// Used to induce a system-wide initialization. The processors are set to their\r | |
963 | /// initial state, and pending cycles are not corrupted. If the system does \r | |
964 | /// not support this reset type, then an EfiResetCold must be performed.\r | |
965 | ///\r | |
959ccb23 | 966 | EfiResetWarm,\r |
2a3f6a21 | 967 | ///\r |
f754f721 | 968 | /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3\r |
2a3f6a21 | 969 | /// state. If the system does not support this reset type, then when the system\r |
970 | /// is rebooted, it should exhibit the EfiResetCold attributes.\r | |
971 | ///\r | |
972 | EfiResetShutdown\r | |
959ccb23 | 973 | } EFI_RESET_TYPE;\r |
974 | \r | |
975 | /**\r | |
976 | Resets the entire platform.\r | |
977 | \r | |
978 | @param ResetType The type of reset to perform.\r | |
979 | @param ResetStatus The status code for the reset.\r | |
980 | @param DataSize The size, in bytes, of WatchdogData.\r | |
981 | @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or\r | |
982 | EfiResetShutdown the data buffer starts with a Null-terminated\r | |
983 | Unicode string, optionally followed by additional binary data.\r | |
984 | \r | |
985 | **/\r | |
986 | typedef\r | |
987 | VOID\r | |
8b13229b | 988 | (EFIAPI *EFI_RESET_SYSTEM)(\r |
959ccb23 | 989 | IN EFI_RESET_TYPE ResetType,\r |
990 | IN EFI_STATUS ResetStatus,\r | |
991 | IN UINTN DataSize,\r | |
b058028b | 992 | IN VOID *ResetData OPTIONAL\r |
959ccb23 | 993 | );\r |
994 | \r | |
995 | /**\r | |
996 | Returns a monotonically increasing count for the platform.\r | |
997 | \r | |
998 | @param Count Pointer to returned value.\r | |
999 | \r | |
1000 | @retval EFI_SUCCESS The next monotonic count was returned.\r | |
1001 | @retval EFI_INVALID_PARAMETER Count is NULL.\r | |
1002 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
1003 | \r | |
1004 | **/\r | |
1005 | typedef\r | |
1006 | EFI_STATUS\r | |
8b13229b | 1007 | (EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT)(\r |
959ccb23 | 1008 | OUT UINT64 *Count\r |
1009 | );\r | |
1010 | \r | |
1011 | /**\r | |
1012 | Returns the next high 32 bits of the platform's monotonic counter.\r | |
1013 | \r | |
1014 | @param HighCount Pointer to returned value.\r | |
1015 | \r | |
1016 | @retval EFI_SUCCESS The next high monotonic count was returned.\r | |
1017 | @retval EFI_INVALID_PARAMETER HighCount is NULL.\r | |
1018 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
1019 | \r | |
1020 | **/\r | |
1021 | typedef\r | |
1022 | EFI_STATUS\r | |
8b13229b | 1023 | (EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT)(\r |
959ccb23 | 1024 | OUT UINT32 *HighCount\r |
1025 | );\r | |
1026 | \r | |
1027 | /**\r | |
1028 | Computes and returns a 32-bit CRC for a data buffer.\r | |
1029 | \r | |
1030 | @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.\r | |
1031 | @param DataSize The number of bytes in the buffer Data.\r | |
1032 | @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data\r | |
1033 | and DataSize.\r | |
1034 | \r | |
1035 | @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in\r | |
1036 | Crc32.\r | |
e0c047a0 | 1037 | @retval EFI_INVALID_PARAMETER Data is NULL.\r |
1038 | @retval EFI_INVALID_PARAMETER Crc32 is NULL.\r | |
1039 | @retval EFI_INVALID_PARAMETER DataSize is 0.\r | |
959ccb23 | 1040 | \r |
1041 | **/\r | |
1042 | typedef\r | |
1043 | EFI_STATUS\r | |
8b13229b | 1044 | (EFIAPI *EFI_CALCULATE_CRC32)(\r |
959ccb23 | 1045 | IN VOID *Data,\r |
1046 | IN UINTN DataSize,\r | |
1047 | OUT UINT32 *Crc32\r | |
1048 | );\r | |
1049 | \r | |
1050 | /**\r | |
1051 | Copies the contents of one buffer to another buffer.\r | |
1052 | \r | |
1053 | @param Destination Pointer to the destination buffer of the memory copy.\r | |
1054 | @param Source Pointer to the source buffer of the memory copy.\r | |
1055 | @param Length Number of bytes to copy from Source to Destination.\r | |
1056 | \r | |
1057 | **/\r | |
1058 | typedef\r | |
1059 | VOID\r | |
8b13229b | 1060 | (EFIAPI *EFI_COPY_MEM)(\r |
959ccb23 | 1061 | IN VOID *Destination,\r |
1062 | IN VOID *Source,\r | |
1063 | IN UINTN Length\r | |
1064 | );\r | |
1065 | \r | |
1066 | /**\r | |
1067 | The SetMem() function fills a buffer with a specified value.\r | |
1068 | \r | |
1069 | @param Buffer Pointer to the buffer to fill.\r | |
1070 | @param Size Number of bytes in Buffer to fill.\r | |
1071 | @param Value Value to fill Buffer with.\r | |
1072 | \r | |
1073 | **/\r | |
1074 | typedef\r | |
1075 | VOID\r | |
8b13229b | 1076 | (EFIAPI *EFI_SET_MEM)(\r |
959ccb23 | 1077 | IN VOID *Buffer,\r |
1078 | IN UINTN Size,\r | |
1079 | IN UINT8 Value\r | |
1080 | );\r | |
1081 | \r | |
2a3f6a21 | 1082 | ///\r |
1083 | /// Enumeration of EFI Interface Types\r | |
1084 | ///\r | |
959ccb23 | 1085 | typedef enum {\r |
2a3f6a21 | 1086 | ///\r |
1087 | /// Indicates that the supplied protocol interface is supplied in native form.\r | |
1088 | ///\r | |
959ccb23 | 1089 | EFI_NATIVE_INTERFACE\r |
1090 | } EFI_INTERFACE_TYPE;\r | |
1091 | \r | |
1092 | /**\r | |
1093 | Installs a protocol interface on a device handle. If the handle does not exist, it is created and added\r | |
1094 | to the list of handles in the system. InstallMultipleProtocolInterfaces() performs\r | |
1095 | more error checking than InstallProtocolInterface(), so it is recommended that\r | |
1096 | InstallMultipleProtocolInterfaces() be used in place of\r | |
1097 | InstallProtocolInterface()\r | |
1098 | \r | |
1099 | @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.\r | |
1100 | @param Protocol The numeric ID of the protocol interface.\r | |
1101 | @param InterfaceType Indicates whether Interface is supplied in native form.\r | |
1102 | @param Interface A pointer to the protocol interface.\r | |
1103 | \r | |
1104 | @retval EFI_SUCCESS The protocol interface was installed.\r | |
1105 | @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.\r | |
e0c047a0 | 1106 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
1107 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
1108 | @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.\r | |
1109 | @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.\r | |
959ccb23 | 1110 | \r |
1111 | **/\r | |
1112 | typedef\r | |
1113 | EFI_STATUS\r | |
8b13229b | 1114 | (EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE)(\r |
959ccb23 | 1115 | IN OUT EFI_HANDLE *Handle,\r |
1116 | IN EFI_GUID *Protocol,\r | |
1117 | IN EFI_INTERFACE_TYPE InterfaceType,\r | |
1118 | IN VOID *Interface\r | |
1119 | );\r | |
1120 | \r | |
1121 | /**\r | |
1122 | Installs one or more protocol interfaces into the boot services environment.\r | |
1123 | \r | |
1124 | @param Handle The handle to install the new protocol interfaces on, or NULL if a new\r | |
1125 | handle is to be allocated.\r | |
1126 | @param ... A variable argument list containing pairs of protocol GUIDs and protocol\r | |
1127 | interfaces.\r | |
1128 | \r | |
1129 | @retval EFI_SUCCESS All the protocol interface was installed.\r | |
1130 | @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r | |
1131 | @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in\r | |
1132 | the handle database.\r | |
1133 | \r | |
1134 | **/\r | |
1135 | typedef\r | |
1136 | EFI_STATUS\r | |
8b13229b | 1137 | (EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r |
959ccb23 | 1138 | IN OUT EFI_HANDLE *Handle,\r |
1139 | ...\r | |
1140 | );\r | |
1141 | \r | |
1142 | /**\r | |
1143 | Reinstalls a protocol interface on a device handle.\r | |
1144 | \r | |
1145 | @param Handle Handle on which the interface is to be reinstalled.\r | |
1146 | @param Protocol The numeric ID of the interface.\r | |
1147 | @param OldInterface A pointer to the old interface. NULL can be used if a structure is not\r | |
1148 | associated with Protocol.\r | |
1149 | @param NewInterface A pointer to the new interface.\r | |
1150 | \r | |
1151 | @retval EFI_SUCCESS The protocol interface was reinstalled.\r | |
1152 | @retval EFI_NOT_FOUND The OldInterface on the handle was not found.\r | |
1153 | @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,\r | |
1154 | because OldInterface is still being used by a\r | |
1155 | driver that will not release it.\r | |
e0c047a0 | 1156 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r |
1157 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
959ccb23 | 1158 | \r |
1159 | **/\r | |
1160 | typedef\r | |
1161 | EFI_STATUS\r | |
8b13229b | 1162 | (EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE)(\r |
959ccb23 | 1163 | IN EFI_HANDLE Handle,\r |
1164 | IN EFI_GUID *Protocol,\r | |
1165 | IN VOID *OldInterface,\r | |
1166 | IN VOID *NewInterface\r | |
1167 | );\r | |
1168 | \r | |
1169 | /**\r | |
1170 | Removes a protocol interface from a device handle. It is recommended that\r | |
1171 | UninstallMultipleProtocolInterfaces() be used in place of\r | |
1172 | UninstallProtocolInterface().\r | |
1173 | \r | |
1174 | @param Handle The handle on which the interface was installed.\r | |
1175 | @param Protocol The numeric ID of the interface.\r | |
1176 | @param Interface A pointer to the interface.\r | |
1177 | \r | |
1178 | @retval EFI_SUCCESS The interface was removed.\r | |
1179 | @retval EFI_NOT_FOUND The interface was not found.\r | |
1180 | @retval EFI_ACCESS_DENIED The interface was not removed because the interface\r | |
1181 | is still being used by a driver.\r | |
e0c047a0 | 1182 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r |
1183 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
959ccb23 | 1184 | \r |
1185 | **/\r | |
1186 | typedef\r | |
1187 | EFI_STATUS\r | |
8b13229b | 1188 | (EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE)(\r |
959ccb23 | 1189 | IN EFI_HANDLE Handle,\r |
1190 | IN EFI_GUID *Protocol,\r | |
1191 | IN VOID *Interface\r | |
1192 | );\r | |
1193 | \r | |
1194 | /**\r | |
1195 | Removes one or more protocol interfaces into the boot services environment.\r | |
1196 | \r | |
1197 | @param Handle The handle to remove the protocol interfaces from.\r | |
1198 | @param ... A variable argument list containing pairs of protocol GUIDs and\r | |
1199 | protocol interfaces.\r | |
1200 | \r | |
1201 | @retval EFI_SUCCESS All the protocol interfaces were removed.\r | |
1202 | @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.\r | |
1203 | \r | |
1204 | **/\r | |
1205 | typedef\r | |
1206 | EFI_STATUS\r | |
8b13229b | 1207 | (EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r |
959ccb23 | 1208 | IN EFI_HANDLE Handle,\r |
1209 | ...\r | |
1210 | );\r | |
1211 | \r | |
1212 | /**\r | |
1213 | Queries a handle to determine if it supports a specified protocol.\r | |
1214 | \r | |
1215 | @param Handle The handle being queried.\r | |
1216 | @param Protocol The published unique identifier of the protocol.\r | |
1217 | @param Interface Supplies the address where a pointer to the corresponding Protocol\r | |
1218 | Interface is returned.\r | |
e0c047a0 | 1219 | \r |
959ccb23 | 1220 | @retval EFI_SUCCESS The interface information for the specified protocol was returned.\r |
1221 | @retval EFI_UNSUPPORTED The device does not support the specified protocol.\r | |
e0c047a0 | 1222 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r |
1223 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
1224 | @retval EFI_INVALID_PARAMETER Interface is NULL.\r | |
959ccb23 | 1225 | \r |
1226 | **/\r | |
1227 | typedef\r | |
1228 | EFI_STATUS\r | |
8b13229b | 1229 | (EFIAPI *EFI_HANDLE_PROTOCOL)(\r |
959ccb23 | 1230 | IN EFI_HANDLE Handle,\r |
1231 | IN EFI_GUID *Protocol,\r | |
1232 | OUT VOID **Interface\r | |
1233 | );\r | |
1234 | \r | |
1235 | #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001\r | |
1236 | #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002\r | |
1237 | #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004\r | |
1238 | #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008\r | |
1239 | #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010\r | |
1240 | #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020\r | |
1241 | \r | |
1242 | /**\r | |
1243 | Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the\r | |
1244 | handle, it opens the protocol on behalf of the calling agent.\r | |
1245 | \r | |
1246 | @param Handle The handle for the protocol interface that is being opened.\r | |
1247 | @param Protocol The published unique identifier of the protocol.\r | |
1248 | @param Interface Supplies the address where a pointer to the corresponding Protocol\r | |
1249 | Interface is returned.\r | |
1250 | @param AgentHandle The handle of the agent that is opening the protocol interface\r | |
1251 | specified by Protocol and Interface.\r | |
1252 | @param ControllerHandle If the agent that is opening a protocol is a driver that follows the\r | |
1253 | UEFI Driver Model, then this parameter is the controller handle\r | |
1254 | that requires the protocol interface. If the agent does not follow\r | |
1255 | the UEFI Driver Model, then this parameter is optional and may\r | |
1256 | be NULL.\r | |
1257 | @param Attributes The open mode of the protocol interface specified by Handle\r | |
1258 | and Protocol.\r | |
1259 | \r | |
1260 | @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the\r | |
1261 | protocol interface was returned in Interface.\r | |
1262 | @retval EFI_UNSUPPORTED Handle does not support Protocol.\r | |
1263 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
1264 | @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.\r | |
1265 | @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent\r | |
1266 | handle is the same as AgentHandle.\r | |
1267 | \r | |
1268 | **/\r | |
1269 | typedef\r | |
1270 | EFI_STATUS\r | |
8b13229b | 1271 | (EFIAPI *EFI_OPEN_PROTOCOL)(\r |
959ccb23 | 1272 | IN EFI_HANDLE Handle,\r |
1273 | IN EFI_GUID *Protocol,\r | |
e0c047a0 | 1274 | OUT VOID **Interface, OPTIONAL\r |
959ccb23 | 1275 | IN EFI_HANDLE AgentHandle,\r |
e0c047a0 | 1276 | IN EFI_HANDLE ControllerHandle,\r |
959ccb23 | 1277 | IN UINT32 Attributes\r |
1278 | );\r | |
1279 | \r | |
1280 | \r | |
1281 | /**\r | |
1282 | Closes a protocol on a handle that was opened using OpenProtocol().\r | |
1283 | \r | |
1284 | @param Handle The handle for the protocol interface that was previously opened\r | |
1285 | with OpenProtocol(), and is now being closed.\r | |
1286 | @param Protocol The published unique identifier of the protocol.\r | |
959ccb23 | 1287 | @param AgentHandle The handle of the agent that is closing the protocol interface.\r |
1288 | @param ControllerHandle If the agent that opened a protocol is a driver that follows the\r | |
1289 | UEFI Driver Model, then this parameter is the controller handle\r | |
1290 | that required the protocol interface.\r | |
1291 | \r | |
1292 | @retval EFI_SUCCESS The protocol instance was closed.\r | |
e0c047a0 | 1293 | @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.\r |
1294 | 2) AgentHandle is not a valid EFI_HANDLE.\r | |
1295 | 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.\r | |
1296 | 4) Protocol is NULL.\r | |
959ccb23 | 1297 | @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.\r |
1298 | 2) The protocol interface specified by Handle and Protocol is not\r | |
1299 | currently open by AgentHandle and ControllerHandle.\r | |
1300 | \r | |
1301 | **/\r | |
1302 | typedef\r | |
1303 | EFI_STATUS\r | |
8b13229b | 1304 | (EFIAPI *EFI_CLOSE_PROTOCOL)(\r |
959ccb23 | 1305 | IN EFI_HANDLE Handle,\r |
1306 | IN EFI_GUID *Protocol,\r | |
1307 | IN EFI_HANDLE AgentHandle,\r | |
1308 | IN EFI_HANDLE ControllerHandle\r | |
1309 | );\r | |
1310 | \r | |
2a3f6a21 | 1311 | ///\r |
1312 | /// EFI Oprn Protocol Information Entry\r | |
1313 | ///\r | |
959ccb23 | 1314 | typedef struct {\r |
1315 | EFI_HANDLE AgentHandle;\r | |
1316 | EFI_HANDLE ControllerHandle;\r | |
1317 | UINT32 Attributes;\r | |
1318 | UINT32 OpenCount;\r | |
1319 | } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;\r | |
1320 | \r | |
1321 | /**\r | |
1322 | Retrieves the list of agents that currently have a protocol interface opened.\r | |
1323 | \r | |
1324 | @param Handle The handle for the protocol interface that is being queried.\r | |
1325 | @param Protocol The published unique identifier of the protocol.\r | |
1326 | @param EntryBuffer A pointer to a buffer of open protocol information in the form of\r | |
1327 | EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r | |
1328 | @param EntryCount A pointer to the number of entries in EntryBuffer.\r | |
1329 | \r | |
1330 | @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the\r | |
1331 | number of entries was returned EntryCount.\r | |
1332 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.\r | |
1333 | @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.\r | |
1334 | \r | |
1335 | **/\r | |
1336 | typedef\r | |
1337 | EFI_STATUS\r | |
8b13229b | 1338 | (EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION)(\r |
959ccb23 | 1339 | IN EFI_HANDLE Handle,\r |
1340 | IN EFI_GUID *Protocol,\r | |
e0c047a0 | 1341 | OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,\r |
959ccb23 | 1342 | OUT UINTN *EntryCount\r |
1343 | );\r | |
1344 | \r | |
1345 | /**\r | |
1346 | Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated\r | |
1347 | from pool.\r | |
1348 | \r | |
1349 | @param Handle The handle from which to retrieve the list of protocol interface\r | |
1350 | GUIDs.\r | |
1351 | @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are\r | |
1352 | installed on Handle.\r | |
1353 | @param ProtocolBufferCount A pointer to the number of GUID pointers present in\r | |
1354 | ProtocolBuffer.\r | |
1355 | \r | |
1356 | @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in\r | |
1357 | ProtocolBuffer. The number of protocol interface GUIDs was\r | |
1358 | returned in ProtocolBufferCount.\r | |
1359 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.\r | |
e0c047a0 | 1360 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
1361 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r | |
1362 | @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.\r | |
1363 | @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.\r | |
959ccb23 | 1364 | \r |
1365 | **/\r | |
1366 | typedef\r | |
1367 | EFI_STATUS\r | |
8b13229b | 1368 | (EFIAPI *EFI_PROTOCOLS_PER_HANDLE)(\r |
959ccb23 | 1369 | IN EFI_HANDLE Handle,\r |
1370 | OUT EFI_GUID ***ProtocolBuffer,\r | |
1371 | OUT UINTN *ProtocolBufferCount\r | |
1372 | );\r | |
1373 | \r | |
1374 | /**\r | |
1375 | Creates an event that is to be signaled whenever an interface is installed for a specified protocol.\r | |
1376 | \r | |
1377 | @param Protocol The numeric ID of the protocol for which the event is to be registered.\r | |
1378 | @param Event Event that is to be signaled whenever a protocol interface is registered\r | |
1379 | for Protocol.\r | |
1380 | @param Registration A pointer to a memory location to receive the registration value.\r | |
1381 | \r | |
1382 | @retval EFI_SUCCESS The notification event has been registered.\r | |
1383 | @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.\r | |
e0c047a0 | 1384 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
1385 | @retval EFI_INVALID_PARAMETER Event is NULL.\r | |
1386 | @retval EFI_INVALID_PARAMETER Registration is NULL.\r | |
959ccb23 | 1387 | \r |
1388 | **/\r | |
1389 | typedef\r | |
1390 | EFI_STATUS\r | |
8b13229b | 1391 | (EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY)(\r |
959ccb23 | 1392 | IN EFI_GUID *Protocol,\r |
1393 | IN EFI_EVENT Event,\r | |
1394 | OUT VOID **Registration\r | |
1395 | );\r | |
1396 | \r | |
2a3f6a21 | 1397 | ///\r |
1398 | /// Enumeration of EFI Locate Search Types\r | |
1399 | ///\r | |
959ccb23 | 1400 | typedef enum {\r |
2a3f6a21 | 1401 | ///\r |
1402 | /// Retrieve all the handles in the handle database.\r | |
1403 | ///\r | |
959ccb23 | 1404 | AllHandles,\r |
2a3f6a21 | 1405 | ///\r |
1406 | /// Retrieve the next handle fron a RegisterProtocolNotify() event.\r | |
1407 | ///\r | |
959ccb23 | 1408 | ByRegisterNotify,\r |
2a3f6a21 | 1409 | ///\r |
1410 | /// Retrieve the set of handles from the handle database that support a \r | |
1411 | /// specified protocol.\r | |
1412 | ///\r | |
959ccb23 | 1413 | ByProtocol\r |
1414 | } EFI_LOCATE_SEARCH_TYPE;\r | |
1415 | \r | |
1416 | /**\r | |
1417 | Returns an array of handles that support a specified protocol.\r | |
1418 | \r | |
1419 | @param SearchType Specifies which handle(s) are to be returned.\r | |
1420 | @param Protocol Specifies the protocol to search by.\r | |
1421 | @param SearchKey Specifies the search key.\r | |
1422 | @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of\r | |
1423 | the array returned in Buffer (if the buffer was large enough) or the\r | |
1424 | size, in bytes, of the buffer needed to obtain the array (if the buffer was\r | |
1425 | not large enough).\r | |
1426 | @param Buffer The buffer in which the array is returned.\r | |
1427 | \r | |
1428 | @retval EFI_SUCCESS The array of handles was returned.\r | |
1429 | @retval EFI_NOT_FOUND No handles match the search.\r | |
1430 | @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r | |
e0c047a0 | 1431 | @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.\r |
1432 | @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.\r | |
1433 | @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.\r | |
1434 | @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.\r | |
1435 | @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.\r | |
959ccb23 | 1436 | \r |
1437 | **/\r | |
1438 | typedef\r | |
1439 | EFI_STATUS\r | |
8b13229b | 1440 | (EFIAPI *EFI_LOCATE_HANDLE)(\r |
959ccb23 | 1441 | IN EFI_LOCATE_SEARCH_TYPE SearchType,\r |
1442 | IN EFI_GUID *Protocol, OPTIONAL\r | |
1443 | IN VOID *SearchKey, OPTIONAL\r | |
1444 | IN OUT UINTN *BufferSize,\r | |
1445 | OUT EFI_HANDLE *Buffer\r | |
1446 | );\r | |
1447 | \r | |
1448 | /**\r | |
1449 | Locates the handle to a device on the device path that supports the specified protocol.\r | |
1450 | \r | |
1451 | @param Protocol Specifies the protocol to search for.\r | |
1452 | @param DevicePath On input, a pointer to a pointer to the device path. On output, the device\r | |
1453 | path pointer is modified to point to the remaining part of the device\r | |
1454 | path.\r | |
1455 | @param Device A pointer to the returned device handle.\r | |
1456 | \r | |
1457 | @retval EFI_SUCCESS The resulting handle was returned.\r | |
1458 | @retval EFI_NOT_FOUND No handles match the search.\r | |
e0c047a0 | 1459 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
1460 | @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r | |
1461 | @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.\r | |
959ccb23 | 1462 | \r |
1463 | **/\r | |
1464 | typedef\r | |
1465 | EFI_STATUS\r | |
8b13229b | 1466 | (EFIAPI *EFI_LOCATE_DEVICE_PATH)(\r |
959ccb23 | 1467 | IN EFI_GUID *Protocol,\r |
1468 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r | |
1469 | OUT EFI_HANDLE *Device\r | |
1470 | );\r | |
1471 | \r | |
1472 | /**\r | |
1473 | Adds, updates, or removes a configuration table entry from the EFI System Table.\r | |
1474 | \r | |
1475 | @param Guid A pointer to the GUID for the entry to add, update, or remove.\r | |
1476 | @param Table A pointer to the configuration table for the entry to add, update, or\r | |
1477 | remove. May be NULL.\r | |
1478 | \r | |
1479 | @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.\r | |
1480 | @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.\r | |
1481 | @retval EFI_INVALID_PARAMETER Guid is not valid.\r | |
1482 | @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.\r | |
1483 | \r | |
1484 | **/\r | |
1485 | typedef\r | |
1486 | EFI_STATUS\r | |
8b13229b | 1487 | (EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE)(\r |
959ccb23 | 1488 | IN EFI_GUID *Guid,\r |
1489 | IN VOID *Table\r | |
1490 | );\r | |
1491 | \r | |
959ccb23 | 1492 | /**\r |
1493 | Returns an array of handles that support the requested protocol in a buffer allocated from pool.\r | |
1494 | \r | |
1495 | @param SearchType Specifies which handle(s) are to be returned.\r | |
e0c047a0 | 1496 | @param Protocol Provides the protocol to search by.\r |
1497 | This parameter is only valid for a SearchType of ByProtocol.\r | |
959ccb23 | 1498 | @param SearchKey Supplies the search key depending on the SearchType.\r |
1499 | @param NoHandles The number of handles returned in Buffer.\r | |
1500 | @param Buffer A pointer to the buffer to return the requested array of handles that\r | |
1501 | support Protocol.\r | |
1502 | \r | |
1503 | @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of\r | |
1504 | handles in Buffer was returned in NoHandles.\r | |
1505 | @retval EFI_NOT_FOUND No handles match the search.\r | |
1506 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.\r | |
e0c047a0 | 1507 | @retval EFI_INVALID_PARAMETER NoHandles is NULL.\r |
1508 | @retval EFI_INVALID_PARAMETER Buffer is NULL.\r | |
959ccb23 | 1509 | \r |
1510 | **/\r | |
1511 | typedef\r | |
1512 | EFI_STATUS\r | |
8b13229b | 1513 | (EFIAPI *EFI_LOCATE_HANDLE_BUFFER)(\r |
959ccb23 | 1514 | IN EFI_LOCATE_SEARCH_TYPE SearchType,\r |
1515 | IN EFI_GUID *Protocol, OPTIONAL\r | |
1516 | IN VOID *SearchKey, OPTIONAL\r | |
1517 | IN OUT UINTN *NoHandles,\r | |
1518 | OUT EFI_HANDLE **Buffer\r | |
1519 | );\r | |
1520 | \r | |
1521 | /**\r | |
1522 | Returns the first protocol instance that matches the given protocol.\r | |
1523 | \r | |
1524 | @param Protocol Provides the protocol to search for.\r | |
1525 | @param Registration Optional registration key returned from\r | |
1526 | RegisterProtocolNotify().\r | |
1527 | @param Interface On return, a pointer to the first interface that matches Protocol and\r | |
1528 | Registration.\r | |
1529 | \r | |
1530 | @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in\r | |
1531 | Interface.\r | |
1532 | @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and\r | |
1533 | Registration.\r | |
1534 | @retval EFI_INVALID_PARAMETER Interface is NULL.\r | |
1535 | \r | |
1536 | **/\r | |
1537 | typedef\r | |
1538 | EFI_STATUS\r | |
8b13229b | 1539 | (EFIAPI *EFI_LOCATE_PROTOCOL)(\r |
959ccb23 | 1540 | IN EFI_GUID *Protocol,\r |
1541 | IN VOID *Registration, OPTIONAL\r | |
1542 | OUT VOID **Interface\r | |
1543 | );\r | |
1544 | \r | |
2a3f6a21 | 1545 | ///\r |
1546 | /// EFI Capsule Block Descriptor\r | |
1547 | ///\r | |
959ccb23 | 1548 | typedef struct {\r |
1bf79370 LG |
1549 | ///\r |
1550 | /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.\r | |
1551 | ///\r | |
2a3f6a21 | 1552 | UINT64 Length;\r |
959ccb23 | 1553 | union {\r |
1bf79370 LG |
1554 | ///\r |
1555 | /// Physical address of the data block. This member of the union is\r | |
1556 | /// used if Length is not equal to zero.\r | |
1557 | ///\r | |
959ccb23 | 1558 | EFI_PHYSICAL_ADDRESS DataBlock;\r |
1bf79370 LG |
1559 | ///\r |
1560 | /// Physical address of another block of\r | |
1561 | /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This\r | |
1562 | /// member of the union is used if Length is equal to zero. If\r | |
1563 | /// ContinuationPointer is zero this entry represents the end of the list.\r | |
1564 | ///\r | |
959ccb23 | 1565 | EFI_PHYSICAL_ADDRESS ContinuationPointer;\r |
1566 | } Union;\r | |
45ad5569 | 1567 | } EFI_CAPSULE_BLOCK_DESCRIPTOR;\r |
959ccb23 | 1568 | \r |
2a3f6a21 | 1569 | ///\r |
1570 | /// EFI Capsule Header\r | |
1571 | ///\r | |
959ccb23 | 1572 | typedef struct {\r |
1bf79370 LG |
1573 | ///\r |
1574 | /// A GUID that defines the contents of a capsule.\r | |
1575 | ///\r | |
959ccb23 | 1576 | EFI_GUID CapsuleGuid;\r |
1bf79370 LG |
1577 | ///\r |
1578 | /// The size of the capsule header. This may be larger than the size of\r | |
1579 | /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply\r | |
1580 | /// extended header entries\r | |
1581 | ///\r | |
959ccb23 | 1582 | UINT32 HeaderSize;\r |
1bf79370 LG |
1583 | ///\r |
1584 | /// Bit-mapped list describing the capsule attributes. The Flag values\r | |
f6d2bcc6 | 1585 | /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values\r |
a0d58c21 | 1586 | /// of 0x10000 - 0xFFFFFFFF are defined by this specification\r |
1bf79370 | 1587 | ///\r |
959ccb23 | 1588 | UINT32 Flags;\r |
1bf79370 LG |
1589 | ///\r |
1590 | /// Size in bytes of the capsule.\r | |
1591 | ///\r | |
959ccb23 | 1592 | UINT32 CapsuleImageSize;\r |
45ad5569 | 1593 | } EFI_CAPSULE_HEADER;\r |
959ccb23 | 1594 | \r |
1bf79370 LG |
1595 | ///\r |
1596 | /// The EFI System Table entry must point to an array of capsules\r | |
1597 | /// that contain the same CapsuleGuid value. The array must be\r | |
1598 | /// prefixed by a UINT32 that represents the size of the array of capsules.\r | |
1599 | ///\r | |
176a6bb3 | 1600 | typedef struct {\r |
1bf79370 LG |
1601 | ///\r |
1602 | /// the size of the array of capsules.\r | |
1603 | ///\r | |
176a6bb3 | 1604 | UINT32 CapsuleArrayNumber;\r |
1bf79370 LG |
1605 | ///\r |
1606 | /// Point to an array of capsules that contain the same CapsuleGuid value.\r | |
1607 | ///\r | |
176a6bb3 LG |
1608 | VOID* CapsulePtr[1];\r |
1609 | } EFI_CAPSULE_TABLE;\r | |
1610 | \r | |
959ccb23 | 1611 | #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000\r |
1612 | #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000\r | |
1613 | \r | |
1614 | /**\r | |
1615 | Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r | |
1616 | consumption, the firmware may process the capsule immediately. If the payload should persist\r | |
1617 | across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r | |
1618 | be passed into ResetSystem() and will cause the capsule to be processed by the firmware as\r | |
1619 | part of the reset process.\r | |
1620 | \r | |
1621 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
1622 | being passed into update capsule.\r | |
1623 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
1624 | CaspuleHeaderArray.\r | |
1625 | @param ScatterGatherList Physical pointer to a set of\r | |
1626 | EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r | |
1627 | location in physical memory of a set of capsules.\r | |
1628 | \r | |
1629 | @retval EFI_SUCCESS Valid capsule was passed. If\r | |
1630 | CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r | |
1631 | capsule has been successfully processed by the firmware.\r | |
a0d58c21 | 1632 | @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r |
1633 | @retval EFI_INVALID_PARAMETER CapsuleCount is 0.\r | |
959ccb23 | 1634 | @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r |
e0c047a0 | 1635 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r |
1636 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r | |
959ccb23 | 1637 | \r |
1638 | **/\r | |
1639 | typedef\r | |
1640 | EFI_STATUS\r | |
8b13229b | 1641 | (EFIAPI *EFI_UPDATE_CAPSULE)(\r |
531febc2 | 1642 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
959ccb23 | 1643 | IN UINTN CapsuleCount,\r |
1644 | IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r | |
1645 | );\r | |
1646 | \r | |
1647 | /**\r | |
1648 | Returns if the capsule can be supported via UpdateCapsule().\r | |
1649 | \r | |
1650 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
1651 | being passed into update capsule.\r | |
1652 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
1653 | CaspuleHeaderArray.\r | |
1654 | @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can\r | |
1655 | support as an argument to UpdateCapsule() via\r | |
1656 | CapsuleHeaderArray and ScatterGatherList.\r | |
1657 | @param ResetType Returns the type of reset required for the capsule update.\r | |
1658 | \r | |
1659 | @retval EFI_SUCCESS Valid answer returned.\r | |
1660 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r | |
1661 | MaximumCapsuleSize and ResetType are undefined.\r | |
1662 | @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r | |
e0c047a0 | 1663 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.\r |
959ccb23 | 1664 | \r |
1665 | **/\r | |
1666 | typedef\r | |
1667 | EFI_STATUS\r | |
8b13229b | 1668 | (EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES)(\r |
531febc2 | 1669 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
959ccb23 | 1670 | IN UINTN CapsuleCount,\r |
1671 | OUT UINT64 *MaximumCapsuleSize,\r | |
1672 | OUT EFI_RESET_TYPE *ResetType\r | |
1673 | );\r | |
1674 | \r | |
1675 | /**\r | |
1676 | Returns information about the EFI variables.\r | |
1677 | \r | |
1678 | @param Attributes Attributes bitmask to specify the type of variables on\r | |
1679 | which to return information.\r | |
1680 | @param MaximumVariableStorageSize On output the maximum size of the storage space\r | |
1681 | available for the EFI variables associated with the\r | |
1682 | attributes specified.\r | |
1683 | @param RemainingVariableStorageSize Returns the remaining size of the storage space\r | |
1684 | available for the EFI variables associated with the\r | |
1685 | attributes specified.\r | |
1686 | @param MaximumVariableSize Returns the maximum size of the individual EFI\r | |
1687 | variables associated with the attributes specified.\r | |
1688 | \r | |
1689 | @retval EFI_SUCCESS Valid answer returned.\r | |
1690 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied\r | |
1691 | @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r | |
1692 | MaximumVariableStorageSize,\r | |
1693 | RemainingVariableStorageSize, MaximumVariableSize\r | |
1694 | are undefined.\r | |
1695 | \r | |
1696 | **/\r | |
1697 | typedef\r | |
1698 | EFI_STATUS\r | |
8b13229b | 1699 | (EFIAPI *EFI_QUERY_VARIABLE_INFO)(\r |
959ccb23 | 1700 | IN UINT32 Attributes,\r |
1701 | OUT UINT64 *MaximumVariableStorageSize,\r | |
1702 | OUT UINT64 *RemainingVariableStorageSize,\r | |
1703 | OUT UINT64 *MaximumVariableSize\r | |
1704 | );\r | |
1705 | \r | |
1706 | \r | |
1707 | //\r | |
1708 | // EFI Runtime Services Table\r | |
1709 | //\r | |
07636730 | 1710 | #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')\r |
2a3f6a21 | 1711 | #define EFI_SYSTEM_TABLE_REVISION ((2 << 16) | (10))\r |
1712 | #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))\r | |
1713 | #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))\r | |
1714 | #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))\r | |
1715 | #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))\r | |
1716 | \r | |
07636730 | 1717 | #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')\r |
d1f95000 | 1718 | #define EFI_RUNTIME_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r |
959ccb23 | 1719 | \r |
e0c047a0 | 1720 | ///\r |
1721 | /// EFI Runtime Services Table\r | |
1722 | ///\r | |
959ccb23 | 1723 | typedef struct {\r |
e0c047a0 | 1724 | ///\r |
1725 | /// The table header for the EFI Runtime Services Table.\r | |
1726 | ///\r | |
c9a0a0fc | 1727 | EFI_TABLE_HEADER Hdr;\r |
00edb218 A |
1728 | \r |
1729 | //\r | |
1730 | // Time Services\r | |
1731 | //\r | |
1732 | EFI_GET_TIME GetTime;\r | |
1733 | EFI_SET_TIME SetTime;\r | |
1734 | EFI_GET_WAKEUP_TIME GetWakeupTime;\r | |
1735 | EFI_SET_WAKEUP_TIME SetWakeupTime;\r | |
1736 | \r | |
1737 | //\r | |
1738 | // Virtual Memory Services\r | |
1739 | //\r | |
1740 | EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;\r | |
1741 | EFI_CONVERT_POINTER ConvertPointer;\r | |
1742 | \r | |
1743 | //\r | |
1744 | // Variable Services\r | |
1745 | //\r | |
1746 | EFI_GET_VARIABLE GetVariable;\r | |
1747 | EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName;\r | |
1748 | EFI_SET_VARIABLE SetVariable;\r | |
1749 | \r | |
1750 | //\r | |
1751 | // Miscellaneous Services\r | |
1752 | //\r | |
1753 | EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;\r | |
1754 | EFI_RESET_SYSTEM ResetSystem;\r | |
1755 | \r | |
1756 | //\r | |
1757 | // UEFI 2.0 Capsule Services\r | |
1758 | //\r | |
1759 | EFI_UPDATE_CAPSULE UpdateCapsule;\r | |
1760 | EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;\r | |
1761 | \r | |
1762 | //\r | |
1763 | // Miscellaneous UEFI 2.0 Service\r | |
1764 | //\r | |
1765 | EFI_QUERY_VARIABLE_INFO QueryVariableInfo;\r | |
959ccb23 | 1766 | } EFI_RUNTIME_SERVICES;\r |
1767 | \r | |
1768 | \r | |
07636730 | 1769 | #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')\r |
d1f95000 | 1770 | #define EFI_BOOT_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r |
959ccb23 | 1771 | \r |
e0c047a0 | 1772 | ///\r |
1773 | /// EFI Boot Services Table\r | |
1774 | ///\r | |
959ccb23 | 1775 | typedef struct {\r |
e0c047a0 | 1776 | ///\r |
1777 | /// The table header for the EFI Boot Services Table.\r | |
1778 | ///\r | |
c9a0a0fc | 1779 | EFI_TABLE_HEADER Hdr;\r |
d0c64728 | 1780 | \r |
00edb218 A |
1781 | //\r |
1782 | // Task Priority Services\r | |
1783 | //\r | |
1784 | EFI_RAISE_TPL RaiseTPL;\r | |
1785 | EFI_RESTORE_TPL RestoreTPL;\r | |
1786 | \r | |
1787 | //\r | |
1788 | // Memory Services\r | |
1789 | //\r | |
1790 | EFI_ALLOCATE_PAGES AllocatePages;\r | |
1791 | EFI_FREE_PAGES FreePages;\r | |
1792 | EFI_GET_MEMORY_MAP GetMemoryMap;\r | |
1793 | EFI_ALLOCATE_POOL AllocatePool;\r | |
1794 | EFI_FREE_POOL FreePool;\r | |
1795 | \r | |
1796 | //\r | |
1797 | // Event & Timer Services\r | |
1798 | //\r | |
1799 | EFI_CREATE_EVENT CreateEvent;\r | |
1800 | EFI_SET_TIMER SetTimer;\r | |
1801 | EFI_WAIT_FOR_EVENT WaitForEvent;\r | |
1802 | EFI_SIGNAL_EVENT SignalEvent;\r | |
1803 | EFI_CLOSE_EVENT CloseEvent;\r | |
1804 | EFI_CHECK_EVENT CheckEvent;\r | |
1805 | \r | |
1806 | //\r | |
1807 | // Protocol Handler Services\r | |
1808 | //\r | |
1809 | EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;\r | |
1810 | EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;\r | |
1811 | EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;\r | |
1812 | EFI_HANDLE_PROTOCOL HandleProtocol;\r | |
1813 | VOID *Reserved;\r | |
1814 | EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;\r | |
1815 | EFI_LOCATE_HANDLE LocateHandle;\r | |
1816 | EFI_LOCATE_DEVICE_PATH LocateDevicePath;\r | |
1817 | EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;\r | |
1818 | \r | |
1819 | //\r | |
1820 | // Image Services\r | |
1821 | //\r | |
1822 | EFI_IMAGE_LOAD LoadImage;\r | |
1823 | EFI_IMAGE_START StartImage;\r | |
1824 | EFI_EXIT Exit;\r | |
1825 | EFI_IMAGE_UNLOAD UnloadImage;\r | |
1826 | EFI_EXIT_BOOT_SERVICES ExitBootServices;\r | |
1827 | \r | |
1828 | //\r | |
1829 | // Miscellaneous Services\r | |
1830 | //\r | |
1831 | EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;\r | |
1832 | EFI_STALL Stall;\r | |
1833 | EFI_SET_WATCHDOG_TIMER SetWatchdogTimer;\r | |
1834 | \r | |
1835 | //\r | |
1836 | // DriverSupport Services\r | |
1837 | //\r | |
1838 | EFI_CONNECT_CONTROLLER ConnectController;\r | |
1839 | EFI_DISCONNECT_CONTROLLER DisconnectController;\r | |
1840 | \r | |
1841 | //\r | |
1842 | // Open and Close Protocol Services\r | |
1843 | //\r | |
1844 | EFI_OPEN_PROTOCOL OpenProtocol;\r | |
1845 | EFI_CLOSE_PROTOCOL CloseProtocol;\r | |
1846 | EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;\r | |
1847 | \r | |
1848 | //\r | |
1849 | // Library Services\r | |
1850 | //\r | |
1851 | EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle;\r | |
1852 | EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer;\r | |
1853 | EFI_LOCATE_PROTOCOL LocateProtocol;\r | |
1854 | EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;\r | |
1855 | EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;\r | |
1856 | \r | |
1857 | //\r | |
1858 | // 32-bit CRC Services\r | |
1859 | //\r | |
1860 | EFI_CALCULATE_CRC32 CalculateCrc32;\r | |
1861 | \r | |
1862 | //\r | |
1863 | // Miscellaneous Services\r | |
1864 | //\r | |
1865 | EFI_COPY_MEM CopyMem;\r | |
1866 | EFI_SET_MEM SetMem;\r | |
00edb218 | 1867 | EFI_CREATE_EVENT_EX CreateEventEx;\r |
959ccb23 | 1868 | } EFI_BOOT_SERVICES;\r |
1869 | \r | |
e0c047a0 | 1870 | ///\r |
1871 | /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the\r | |
1872 | /// EFI System Table.\r | |
1873 | ///\r | |
2a3f6a21 | 1874 | typedef struct {\r |
e0c047a0 | 1875 | ///\r |
1876 | /// The 128-bit GUID value that uniquely identifies the system configuration table.\r | |
1877 | ///\r | |
00edb218 | 1878 | EFI_GUID VendorGuid;\r |
e0c047a0 | 1879 | ///\r |
1880 | /// A pointer to the table associated with VendorGuid.\r | |
1881 | ///\r | |
00edb218 | 1882 | VOID *VendorTable;\r |
959ccb23 | 1883 | } EFI_CONFIGURATION_TABLE;\r |
1884 | \r | |
e0c047a0 | 1885 | ///\r |
1886 | /// EFI System Table\r | |
1887 | ///\r | |
2a3f6a21 | 1888 | typedef struct {\r |
e0c047a0 | 1889 | ///\r |
1890 | /// The table header for the EFI System Table.\r | |
1891 | ///\r | |
c9a0a0fc | 1892 | EFI_TABLE_HEADER Hdr;\r |
e0c047a0 | 1893 | ///\r |
1894 | /// A pointer to a null terminated Unicode string that identifies\r | |
1895 | /// the vendor that produces the system firmware for the platform.\r | |
1896 | ///\r | |
00edb218 | 1897 | CHAR16 *FirmwareVendor;\r |
e0c047a0 | 1898 | ///\r |
1899 | /// A firmware vendor specific value that identifies the revision\r | |
1900 | /// of the system firmware for the platform.\r | |
1901 | ///\r | |
00edb218 | 1902 | UINT32 FirmwareRevision;\r |
e0c047a0 | 1903 | ///\r |
1904 | /// The handle for the active console input device.\r | |
1905 | ///\r | |
00edb218 | 1906 | EFI_HANDLE ConsoleInHandle;\r |
e0c047a0 | 1907 | ///\r |
11ca63ec | 1908 | /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is\r |
e0c047a0 | 1909 | /// associated with ConsoleInHandle.\r |
1910 | ///\r | |
00edb218 | 1911 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r |
e0c047a0 | 1912 | ///\r |
1913 | /// The handle for the active console output device.\r | |
1914 | ///\r | |
00edb218 | 1915 | EFI_HANDLE ConsoleOutHandle;\r |
e0c047a0 | 1916 | ///\r |
11ca63ec | 1917 | /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r |
e0c047a0 | 1918 | /// that is associated with ConsoleOutHandle.\r |
1919 | ///\r | |
00edb218 | 1920 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut;\r |
e0c047a0 | 1921 | ///\r |
1922 | /// The handle for the active standard error console device.\r | |
1923 | ///\r | |
00edb218 | 1924 | EFI_HANDLE StandardErrorHandle;\r |
e0c047a0 | 1925 | ///\r |
11ca63ec | 1926 | /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r |
e0c047a0 | 1927 | /// that is associated with StandardErrorHandle.\r |
1928 | ///\r | |
00edb218 | 1929 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *StdErr;\r |
e0c047a0 | 1930 | ///\r |
1931 | /// A pointer to the EFI Runtime Services Table.\r | |
1932 | ///\r | |
00edb218 | 1933 | EFI_RUNTIME_SERVICES *RuntimeServices;\r |
e0c047a0 | 1934 | ///\r |
1935 | /// A pointer to the EFI Boot Services Table.\r | |
1936 | ///\r | |
00edb218 | 1937 | EFI_BOOT_SERVICES *BootServices;\r |
e0c047a0 | 1938 | ///\r |
1939 | /// The number of system configuration tables in the buffer ConfigurationTable.\r | |
1940 | ///\r | |
00edb218 | 1941 | UINTN NumberOfTableEntries;\r |
e0c047a0 | 1942 | ///\r |
1943 | /// A pointer to the system configuration tables.\r | |
1944 | /// The number of entries in the table is NumberOfTableEntries.\r | |
1945 | ///\r | |
00edb218 | 1946 | EFI_CONFIGURATION_TABLE *ConfigurationTable;\r |
2a3f6a21 | 1947 | } EFI_SYSTEM_TABLE;\r |
1948 | \r | |
1949 | /**\r | |
1950 | This is the declaration of an EFI image entry point. This entry point is\r | |
1951 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r | |
1952 | both device drivers and bus drivers.\r | |
1953 | \r | |
1954 | @param ImageHandle The firmware allocated handle for the UEFI image.\r | |
1955 | @param SystemTable A pointer to the EFI System Table.\r | |
1956 | \r | |
1957 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1958 | @retval Others Some unexpected error happened.\r | |
1959 | **/\r | |
1960 | typedef\r | |
1961 | EFI_STATUS\r | |
1962 | (EFIAPI *EFI_IMAGE_ENTRY_POINT)(\r | |
1963 | IN EFI_HANDLE ImageHandle,\r | |
1964 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1965 | );\r | |
959ccb23 | 1966 | \r |
95cba3ee A |
1967 | //\r |
1968 | // EFI Load Options Attributes\r | |
1969 | //\r | |
1970 | #define LOAD_OPTION_ACTIVE 0x00000001\r | |
1971 | #define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r | |
95cba3ee A |
1972 | #define LOAD_OPTION_HIDDEN 0x00000008\r |
1973 | #define LOAD_OPTION_CATEGORY 0x00001F00\r | |
1974 | \r | |
1975 | #define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r | |
1976 | #define LOAD_OPTION_CATEGORY_APP 0x00000100\r | |
1977 | \r | |
1978 | #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r | |
1979 | #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r | |
1980 | #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300\r | |
1981 | \r | |
2a3f6a21 | 1982 | ///\r |
1983 | /// EFI Boot Key Data\r | |
1984 | ///\r | |
95cba3ee A |
1985 | typedef union {\r |
1986 | struct {\r | |
1bf79370 LG |
1987 | ///\r |
1988 | /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.\r | |
1989 | ///\r | |
95cba3ee | 1990 | UINT32 Revision : 8;\r |
1bf79370 LG |
1991 | ///\r |
1992 | /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).\r | |
1993 | ///\r | |
95cba3ee | 1994 | UINT32 ShiftPressed : 1;\r |
1bf79370 LG |
1995 | ///\r |
1996 | /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).\r | |
1997 | ///\r | |
95cba3ee | 1998 | UINT32 ControlPressed : 1;\r |
1bf79370 LG |
1999 | ///\r |
2000 | /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).\r | |
2001 | ///\r | |
95cba3ee | 2002 | UINT32 AltPressed : 1;\r |
1bf79370 LG |
2003 | ///\r |
2004 | /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).\r | |
2005 | ///\r | |
95cba3ee | 2006 | UINT32 LogoPressed : 1;\r |
1bf79370 LG |
2007 | ///\r |
2008 | /// The Menu key must be pressed (1) or must not be pressed (0).\r | |
2009 | ///\r | |
95cba3ee | 2010 | UINT32 MenuPressed : 1;\r |
1bf79370 LG |
2011 | ///\r |
2012 | /// The SysReq key must be pressed (1) or must not be pressed (0).\r | |
2013 | ///\r | |
298530bc | 2014 | UINT32 SysReqPressed : 1;\r |
95cba3ee | 2015 | UINT32 Reserved : 16;\r |
1bf79370 LG |
2016 | ///\r |
2017 | /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If\r | |
2018 | /// zero, then only the shift state is considered. If more than one, then the boot option will\r | |
2019 | /// only be launched if all of the specified keys are pressed with the same shift state.\r | |
2020 | ///\r | |
95cba3ee | 2021 | UINT32 InputKeyCount : 2;\r |
e0c047a0 | 2022 | } Options;\r |
95cba3ee | 2023 | UINT32 PackedValue;\r |
2a3f6a21 | 2024 | } EFI_BOOT_KEY_DATA;\r |
95cba3ee | 2025 | \r |
2a3f6a21 | 2026 | ///\r |
2027 | /// EFI Key Option\r | |
2028 | ///\r | |
95cba3ee | 2029 | typedef struct {\r |
1bf79370 LG |
2030 | ///\r |
2031 | /// Specifies options about how the key will be processed.\r | |
2032 | ///\r | |
2033 | EFI_BOOT_KEY_DATA KeyData;\r | |
2034 | ///\r | |
2035 | /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to\r | |
2036 | /// which BootOption refers. If the CRC-32s do not match this value, then this key\r | |
2037 | /// option is ignored.\r | |
2038 | ///\r | |
2a3f6a21 | 2039 | UINT32 BootOptionCrc;\r |
1bf79370 LG |
2040 | ///\r |
2041 | /// The Boot#### option which will be invoked if this key is pressed and the boot option\r | |
2042 | /// is active (LOAD_OPTION_ACTIVE is set).\r | |
2043 | ///\r | |
2a3f6a21 | 2044 | UINT16 BootOption;\r |
1bf79370 LG |
2045 | ///\r |
2046 | /// The key codes to compare against those returned by the\r | |
2047 | /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.\r | |
2048 | /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.\r | |
2049 | ///\r | |
2050 | //EFI_INPUT_KEY Keys[];\r | |
95cba3ee A |
2051 | } EFI_KEY_OPTION;\r |
2052 | \r | |
959ccb23 | 2053 | //\r |
2054 | // EFI File location to boot from on removable media devices\r | |
2055 | //\r | |
2056 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"\r | |
2057 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"\r | |
2058 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"\r | |
97f8b30c | 2059 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI" |
959ccb23 | 2060 | \r |
2061 | #if defined (MDE_CPU_IA32)\r | |
2062 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32\r | |
2063 | #elif defined (MDE_CPU_IPF)\r | |
2064 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64\r | |
2065 | #elif defined (MDE_CPU_X64)\r | |
2066 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64\r | |
2067 | #elif defined (MDE_CPU_EBC)\r | |
97f8b30c | 2068 | #elif defined (MDE_CPU_ARM) |
2069 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_ARM | |
959ccb23 | 2070 | #else\r |
2071 | #error Unknown Processor Type\r | |
2072 | #endif\r | |
2073 | \r | |
959ccb23 | 2074 | #include <Uefi/UefiPxe.h>\r |
2075 | #include <Uefi/UefiGpt.h>\r | |
2076 | #include <Uefi/UefiInternalFormRepresentation.h>\r | |
2077 | \r | |
2078 | #endif\r |