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