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