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