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