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