8c5b22e2acb6954213c5fde6ecde8b6666aa2598
[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, 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 Module Name: UefiSpec.h
18
19 **/
20
21 #ifndef __UEFI_SPEC_H__
22 #define __UEFI_SPEC_H__
23
24 #include <Common/MultiPhase.h>
25
26 //
27 // EFI Data Types derived from other EFI data types.
28 //
29 #define NULL_HANDLE ((VOID *) 0)
30
31 typedef VOID *EFI_EVENT;
32 typedef UINTN EFI_TPL;
33
34 //
35 // Networking
36 //
37 typedef struct {
38 UINT8 Addr[4];
39 } EFI_IPv4_ADDRESS;
40
41 typedef struct {
42 UINT8 Addr[16];
43 } EFI_IPv6_ADDRESS;
44
45 typedef struct {
46 UINT8 Addr[32];
47 } EFI_MAC_ADDRESS;
48
49 typedef union {
50 UINT32 Addr[4];
51 EFI_IPv4_ADDRESS v4;
52 EFI_IPv6_ADDRESS v6;
53 } EFI_IP_ADDRESS;
54
55
56 typedef enum {
57 AllocateAnyPages,
58 AllocateMaxAddress,
59 AllocateAddress,
60 MaxAllocateType
61 } EFI_ALLOCATE_TYPE;
62
63
64 //
65 // possible caching types for the memory range
66 //
67 #define EFI_MEMORY_UC 0x0000000000000001ULL
68 #define EFI_MEMORY_WC 0x0000000000000002ULL
69 #define EFI_MEMORY_WT 0x0000000000000004ULL
70 #define EFI_MEMORY_WB 0x0000000000000008ULL
71 #define EFI_MEMORY_UCE 0x0000000000000010ULL
72
73 //
74 // physical memory protection on range
75 //
76 #define EFI_MEMORY_WP 0x0000000000001000ULL
77 #define EFI_MEMORY_RP 0x0000000000002000ULL
78 #define EFI_MEMORY_XP 0x0000000000004000ULL
79
80 //
81 // range requires a runtime mapping
82 //
83 #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
84
85 typedef UINT64 EFI_VIRTUAL_ADDRESS;
86
87 #define EFI_MEMORY_DESCRIPTOR_VERSION 1
88 typedef struct {
89 UINT32 Type;
90 UINT32 Pad;
91 EFI_PHYSICAL_ADDRESS PhysicalStart;
92 EFI_VIRTUAL_ADDRESS VirtualStart;
93 UINT64 NumberOfPages;
94 UINT64 Attribute;
95 } EFI_MEMORY_DESCRIPTOR;
96
97 //
98 // EFI_FIELD_OFFSET - returns the byte offset to a field within a structure
99 //
100 #define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
101
102 #include <Protocol/DevicePath.h>
103 #include <Protocol/SimpleTextIn.h>
104 #include <Protocol/SimpleTextOut.h>
105
106 //
107 // Declare forward referenced data structures
108 //
109 typedef struct _EFI_SYSTEM_TABLE EFI_SYSTEM_TABLE;
110
111 /**
112 Allocates memory pages from the system.
113
114 @param Type The type of allocation to perform.
115 @param MemoryType The type of memory to allocate.
116 @param Pages The number of contiguous 4 KB pages to allocate.
117 @param Memory Pointer to a physical address. On input, the way in which the address is
118 used depends on the value of Type.
119
120 @retval EFI_SUCCESS The requested pages were allocated.
121 @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
122 AllocateMaxAddress or AllocateAddress.
123 2) MemoryType is in the range
124 EfiMaxMemoryType..0x7FFFFFFF.
125 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
126 @retval EFI_NOT_FOUND The requested pages could not be found.
127
128 **/
129 typedef
130 EFI_STATUS
131 (EFIAPI *EFI_ALLOCATE_PAGES) (
132 IN EFI_ALLOCATE_TYPE Type,
133 IN EFI_MEMORY_TYPE MemoryType,
134 IN UINTN Pages,
135 IN OUT EFI_PHYSICAL_ADDRESS *Memory
136 );
137
138 /**
139 Frees memory pages.
140
141 @param Memory The base physical address of the pages to be freed.
142 @param Pages The number of contiguous 4 KB pages to free.
143
144 @retval EFI_SUCCESS The requested pages were freed.
145 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
146 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
147 AllocatePages().
148
149 **/
150 typedef
151 EFI_STATUS
152 (EFIAPI *EFI_FREE_PAGES) (
153 IN EFI_PHYSICAL_ADDRESS Memory,
154 IN UINTN Pages
155 );
156
157 /**
158 Returns the current memory map.
159
160 @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
161 @param MemoryMap A pointer to the buffer in which firmware places the current memory
162 map.
163 @param MapKey A pointer to the location in which firmware returns the key for the
164 current memory map.
165 @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
166 an individual EFI_MEMORY_DESCRIPTOR.
167 @param DescriptorVersion A pointer to the location in which firmware returns the version number
168 associated with the EFI_MEMORY_DESCRIPTOR.
169
170 @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
171 @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
172 needed to hold the memory map is returned in MemoryMapSize.
173 @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
174 2) The MemoryMap buffer is not too small and MemoryMap is
175 NULL.
176
177 **/
178 typedef
179 EFI_STATUS
180 (EFIAPI *EFI_GET_MEMORY_MAP) (
181 IN OUT UINTN *MemoryMapSize,
182 IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,
183 OUT UINTN *MapKey,
184 OUT UINTN *DescriptorSize,
185 OUT UINT32 *DescriptorVersion
186 );
187
188 #define NextMemoryDescriptor(_Ptr, _Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) (_Ptr)) + (_Size)))
189 #define NEXT_MEMORY_DESCRIPTOR(_Ptr, _Size) NextMemoryDescriptor (_Ptr, _Size)
190
191 /**
192 Allocates pool memory.
193
194 @param PoolType The type of pool to allocate.
195 @param Size The number of bytes to allocate from the pool.
196 @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
197 undefined otherwise.
198
199 @retval EFI_SUCCESS The requested number of bytes was allocated.
200 @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
201 @retval EFI_INVALID_PARAMETER PoolType was invalid.
202
203 **/
204 typedef
205 EFI_STATUS
206 (EFIAPI *EFI_ALLOCATE_POOL) (
207 IN EFI_MEMORY_TYPE PoolType,
208 IN UINTN Size,
209 OUT VOID **Buffer
210 );
211
212 /**
213 Returns pool memory to the system.
214
215 @param Buffer Pointer to the buffer to free.
216
217 @retval EFI_SUCCESS The memory was returned to the system.
218 @retval EFI_INVALID_PARAMETER Buffer was invalid.
219
220 **/
221 typedef
222 EFI_STATUS
223 (EFIAPI *EFI_FREE_POOL) (
224 IN VOID *Buffer
225 );
226
227 /**
228 Changes the runtime addressing mode of EFI firmware from physical to virtual.
229
230 @param MemoryMapSize The size in bytes of VirtualMap.
231 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
232 @param DescriptorVersion The version of the structure entries in VirtualMap.
233 @param VirtualMap An array of memory descriptors which contain new virtual
234 address mapping information for all runtime ranges.
235
236 @retval EFI_SUCCESS The virtual address map has been applied.
237 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
238 virtual address mapped mode.
239 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
240 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
241 map that requires a mapping.
242 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
243 in the memory map.
244
245 **/
246 typedef
247 EFI_STATUS
248 (EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP) (
249 IN UINTN MemoryMapSize,
250 IN UINTN DescriptorSize,
251 IN UINT32 DescriptorVersion,
252 IN EFI_MEMORY_DESCRIPTOR *VirtualMap
253 );
254
255 /**
256 Connects one or more drivers to a controller.
257
258 @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
259 @param DriverImageHandle A pointer to an ordered list handles that support the
260 EFI_DRIVER_BINDING_PROTOCOL.
261 @param RemainingDevicePath A pointer to the device path that specifies a child of the
262 controller specified by ControllerHandle.
263 @param Recursive If TRUE, then ConnectController() is called recursively
264 until the entire tree of controllers below the controller specified
265 by ControllerHandle have been created. If FALSE, then
266 the tree of controllers is only expanded one level.
267
268 @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
269 2) No drivers were connected to ControllerHandle, but
270 RemainingDevicePath is not NULL, and it is an End Device
271 Path Node.
272 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
273 @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
274 present in the system.
275 2) No drivers were connected to ControllerHandle.
276
277 **/
278 typedef
279 EFI_STATUS
280 (EFIAPI *EFI_CONNECT_CONTROLLER) (
281 IN EFI_HANDLE ControllerHandle,
282 IN EFI_HANDLE *DriverImageHandle, OPTIONAL
283 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL
284 IN BOOLEAN Recursive
285 );
286
287 /**
288 Disconnects one or more drivers from a controller.
289
290 @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
291 @param DriverImageHandle The driver to disconnect from ControllerHandle.
292 @param ChildHandle The handle of the child to destroy.
293
294 @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
295 2) On entry, no drivers are managing ControllerHandle.
296 3) DriverImageHandle is not NULL, and on entry
297 DriverImageHandle is not managing ControllerHandle.
298
299 @retval EFI_INVALID_PARAMETER One ore more parameters are invalid.
300 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
301 ControllerHandle.
302 @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
303
304 **/
305 typedef
306 EFI_STATUS
307 (EFIAPI *EFI_DISCONNECT_CONTROLLER) (
308 IN EFI_HANDLE ControllerHandle,
309 IN EFI_HANDLE DriverImageHandle, OPTIONAL
310 IN EFI_HANDLE ChildHandle OPTIONAL
311 );
312
313 //
314 // ConvertPointer DebugDisposition type.
315 //
316 #define EFI_OPTIONAL_PTR 0x00000001
317 #define EFI_OPTIONAL_POINTER EFI_OPTIONAL_PTR
318
319 /**
320 Determines the new virtual address that is to be used on subsequent memory accesses.
321
322 @param DebugDisposition Supplies type information for the pointer being converted.
323 @param Address A pointer to a pointer that is to be fixed to be the value needed
324 for the new virtual address mappings being applied.
325
326 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
327 @retval EFI_INVALID_PARAMETER 1) Address is NULL.
328 2) *Address is NULL and DebugDisposition does
329 not have the EFI_OPTIONAL_PTR bit set.
330 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
331 of the current memory map. This is normally fatal.
332
333 **/
334 typedef
335 EFI_STATUS
336 (EFIAPI *EFI_CONVERT_POINTER) (
337 IN UINTN DebugDisposition,
338 IN OUT VOID **Address
339 );
340
341 //
342 // EFI Event Types (name defined in spec)
343 //
344 #define EVENT_TIMER 0x80000000
345 #define EVENT_RUNTIME 0x40000000
346 #define EVENT_RUNTIME_CONTEXT 0x20000000
347
348 #define EVENT_NOTIFY_WAIT 0x00000100
349 #define EVENT_NOTIFY_SIGNAL 0x00000200
350
351 #define EVENT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
352 #define EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
353
354 #if ((EDK_RELEASE_VERSION != 0) && (EFI_SPECIFICATION_VERSION < 0x00020000))
355 //
356 // Prior to UEFI 2.0 Tiano extended these enums. This was replaced by
357 // CreateEventEx() Event Groups in UEFI 2.0
358 //
359 #define EFI_EVENT_NOTIFY_SIGNAL_ALL 0x00000400
360
361 #define EFI_EVENT_SIGNAL_READY_TO_BOOT 0x00000203
362 #define EFI_EVENT_SIGNAL_LEGACY_BOOT 0x00000204
363
364 #endif
365
366 //
367 // EFI Event Types (name following coding style)
368 //
369 #define EFI_EVENT_TIMER EVENT_TIMER
370 #define EFI_EVENT_RUNTIME EVENT_RUNTIME
371 #define EFI_EVENT_RUNTIME_CONTEXT EVENT_RUNTIME_CONTEXT
372
373 #define EFI_EVENT_NOTIFY_WAIT EVENT_NOTIFY_WAIT
374 #define EFI_EVENT_NOTIFY_SIGNAL EVENT_NOTIFY_SIGNAL
375
376 #define EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES EVENT_SIGNAL_EXIT_BOOT_SERVICES
377 #define EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
378
379
380 /**
381 Invoke a notification event
382
383 @param Event Event whose notification function is being invoked.
384 @param Context Pointer to the notification function's context,
385 which is implementation-dependent.
386
387 **/
388 typedef
389 VOID
390 (EFIAPI *EFI_EVENT_NOTIFY) (
391 IN EFI_EVENT Event,
392 IN VOID *Context
393 );
394
395 /**
396 Creates an event.
397
398 @param Type The type of event to create and its mode and attributes.
399 @param NotifyTpl Pointer to the notification function's context.
400 @param NotifyFunction Pointer to the event's notification function, if any.
401 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
402 Context in the notification function.
403 @param Event Pointer to the newly created event if the call succeeds; undefined
404 otherwise.
405
406 @retval EFI_SUCCESS The event structure was created.
407 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
408 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
409
410 **/
411 typedef
412 EFI_STATUS
413 (EFIAPI *EFI_CREATE_EVENT) (
414 IN UINT32 Type,
415 IN EFI_TPL NotifyTpl,
416 IN EFI_EVENT_NOTIFY NotifyFunction,
417 IN VOID *NotifyContext,
418 OUT EFI_EVENT *Event
419 );
420
421 /**
422 Creates an event in a group.
423
424 @param Type The type of event to create and its mode and attributes.
425 @param NotifyTpl Pointer to the notification function's context.
426 @param NotifyFunction Pointer to the event's notification function, if any.
427 @param NotifyContext Pointer to the notification function's context; corresponds to parameter
428 Context in the notification function.
429 @param EventGroup Pointer to the unique identifier of the group to which this event belongs.
430 @param Event Pointer to the newly created event if the call succeeds; undefined
431 otherwise.
432
433 @retval EFI_SUCCESS The event structure was created.
434 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
435 @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
436
437 **/
438 typedef
439 EFI_STATUS
440 (EFIAPI *EFI_CREATE_EVENT_EX) (
441 IN UINT32 Type,
442 IN EFI_TPL NotifyTpl OPTIONAL,
443 IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,
444 IN CONST VOID *NotifyContext OPTIONAL,
445 IN CONST EFI_GUID *EventGroup OPTIONAL,
446 OUT EFI_EVENT *Event
447 );
448
449 typedef enum {
450 TimerCancel,
451 TimerPeriodic,
452 TimerRelative
453 } EFI_TIMER_DELAY;
454
455 /**
456 Sets the type of timer and the trigger time for a timer event.
457
458 @param Event The timer event that is to be signaled at the specified time.
459 @param Type The type of time that is specified in TriggerTime.
460 @param TriggerTime The number of 100ns units until the timer expires.
461
462 @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
463 @retval EFI_INVALID_PARAMETER Event or Type is not valid.
464
465 **/
466 typedef
467 EFI_STATUS
468 (EFIAPI *EFI_SET_TIMER) (
469 IN EFI_EVENT Event,
470 IN EFI_TIMER_DELAY Type,
471 IN UINT64 TriggerTime
472 );
473
474 /**
475 Signals an event.
476
477 @param Event The event to signal.
478
479 @retval EFI_SUCCESS The event has been signaled.
480
481 **/
482 typedef
483 EFI_STATUS
484 (EFIAPI *EFI_SIGNAL_EVENT) (
485 IN EFI_EVENT Event
486 );
487
488 /**
489 Stops execution until an event is signaled.
490
491 @param NumberOfEvents The number of events in the Event array.
492 @param Event An array of EFI_EVENT.
493 @param Index Pointer to the index of the event which satisfied the wait condition.
494
495 @retval EFI_SUCCESS The event indicated by Index was signaled.
496 @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
497 2) The event indicated by Index is of type
498 EVT_NOTIFY_SIGNAL.
499 @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
500
501 **/
502 typedef
503 EFI_STATUS
504 (EFIAPI *EFI_WAIT_FOR_EVENT) (
505 IN UINTN NumberOfEvents,
506 IN EFI_EVENT *Event,
507 OUT UINTN *Index
508 );
509
510 /**
511 Closes an event.
512
513 @param Event The event to close.
514
515 @retval EFI_SUCCESS The event has been closed.
516
517 **/
518 typedef
519 EFI_STATUS
520 (EFIAPI *EFI_CLOSE_EVENT) (
521 IN EFI_EVENT Event
522 );
523
524 /**
525 Checks whether an event is in the signaled state.
526
527 @param Event The event to check.
528
529 @retval EFI_SUCCESS The event is in the signaled state.
530 @retval EFI_NOT_READY The event is not in the signaled state.
531 @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
532
533 **/
534 typedef
535 EFI_STATUS
536 (EFIAPI *EFI_CHECK_EVENT) (
537 IN EFI_EVENT Event
538 );
539
540 //
541 // Task priority level (name defined in spec).
542 //
543 #define TPL_APPLICATION 4
544 #define TPL_CALLBACK 8
545 #define TPL_NOTIFY 16
546 #define TPL_HIGH_LEVEL 31
547
548 //
549 // Task priority level (name following coding style).
550 //
551 #define EFI_TPL_APPLICATION TPL_APPLICATION
552 #define EFI_TPL_CALLBACK TPL_CALLBACK
553 #define EFI_TPL_NOTIFY TPL_NOTIFY
554 #define EFI_TPL_HIGH_LEVEL TPL_HIGH_LEVEL
555
556 /**
557 Raises a task's priority level and returns its previous level.
558
559 @param NewTpl The new task priority level.
560
561 @retval Previous task priority level
562
563 **/
564 typedef
565 EFI_TPL
566 (EFIAPI *EFI_RAISE_TPL) (
567 IN EFI_TPL NewTpl
568 );
569
570 /**
571 Restores a task's priority level to its previous value.
572
573 @param OldTpl The previous task priority level to restore
574
575 **/
576 typedef
577 VOID
578 (EFIAPI *EFI_RESTORE_TPL) (
579 IN EFI_TPL OldTpl
580 );
581
582 //
583 // Variable attributes
584 //
585 #define EFI_VARIABLE_NON_VOLATILE 0x00000001
586 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
587 #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
588
589 /**
590 Returns the value of a variable.
591
592 @param VariableName A Null-terminated Unicode string that is the name of the
593 vendor's variable.
594 @param VendorGuid A unique identifier for the vendor.
595 @param Attributes If not NULL, a pointer to the memory location to return the
596 attributes bitmask for the variable.
597 @param DataSize On input, the size in bytes of the return Data buffer.
598 On output the size of data returned in Data.
599 @param Data The buffer to return the contents of the variable.
600
601 @retval EFI_SUCCESS The function completed successfully.
602 @retval EFI_NOT_FOUND The variable was not found.
603 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
604 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
605 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
606
607 **/
608 typedef
609 EFI_STATUS
610 (EFIAPI *EFI_GET_VARIABLE) (
611 IN CHAR16 *VariableName,
612 IN EFI_GUID *VendorGuid,
613 OUT UINT32 *Attributes, OPTIONAL
614 IN OUT UINTN *DataSize,
615 OUT VOID *Data
616 );
617
618 /**
619 Enumerates the current variable names.
620
621 @param VariableNameSize The size of the VariableName buffer.
622 @param VariableName On input, supplies the last VariableName that was returned
623 by GetNextVariableName(). On output, returns the Nullterminated
624 Unicode string of the current variable.
625 @param VendorGuid On input, supplies the last VendorGuid that was returned by
626 GetNextVariableName(). On output, returns the
627 VendorGuid of the current variable.
628
629 @retval EFI_SUCCESS The function completed successfully.
630 @retval EFI_NOT_FOUND The next variable was not found.
631 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
632 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
633 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
634
635 **/
636 typedef
637 EFI_STATUS
638 (EFIAPI *EFI_GET_NEXT_VARIABLE_NAME) (
639 IN OUT UINTN *VariableNameSize,
640 IN OUT CHAR16 *VariableName,
641 IN OUT EFI_GUID *VendorGuid
642 );
643
644 /**
645 Sets the value of a variable.
646
647 @param VariableName A Null-terminated Unicode string that is the name of the
648 vendor's variable.
649 @param VendorGuid A unique identifier for the vendor.
650 @param Attributes Attributes bitmask to set for the variable.
651 @param DataSize The size in bytes of the Data buffer.
652 @param Data The contents for the variable.
653
654 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
655 defined by the Attributes.
656 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
657 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
658 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
659 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
660
661 **/
662 typedef
663 EFI_STATUS
664 (EFIAPI *EFI_SET_VARIABLE) (
665 IN CHAR16 *VariableName,
666 IN EFI_GUID *VendorGuid,
667 IN UINT32 Attributes,
668 IN UINTN DataSize,
669 IN VOID *Data
670 );
671
672 //
673 // EFI Time
674 //
675 typedef struct {
676 UINT32 Resolution;
677 UINT32 Accuracy;
678 BOOLEAN SetsToZero;
679 } EFI_TIME_CAPABILITIES;
680
681 /**
682 Returns the current time and date information, and the time-keeping capabilities
683 of the hardware platform.
684
685 @param Time A pointer to storage to receive a snapshot of the current time.
686 @param Capabilities An optional pointer to a buffer to receive the real time clock
687 device's capabilities.
688
689 @retval EFI_SUCCESS The operation completed successfully.
690 @retval EFI_INVALID_PARAMETER Time is NULL.
691 @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
692
693 **/
694 typedef
695 EFI_STATUS
696 (EFIAPI *EFI_GET_TIME) (
697 OUT EFI_TIME *Time,
698 OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL
699 );
700
701 /**
702 Sets the current local time and date information.
703
704 @param Time A pointer to the current time.
705
706 @retval EFI_SUCCESS The operation completed successfully.
707 @retval EFI_INVALID_PARAMETER A time field is out of range.
708 @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
709
710 **/
711 typedef
712 EFI_STATUS
713 (EFIAPI *EFI_SET_TIME) (
714 IN EFI_TIME *Time
715 );
716
717 /**
718 Returns the current wakeup alarm clock setting.
719
720 @param Enabled Indicates if the alarm is currently enabled or disabled.
721 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
722 @param Time The current alarm setting.
723
724 @retval EFI_SUCCESS The alarm settings were returned.
725 @retval EFI_INVALID_PARAMETER Any parameter is NULL.
726 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
727
728 **/
729 typedef
730 EFI_STATUS
731 (EFIAPI *EFI_GET_WAKEUP_TIME) (
732 OUT BOOLEAN *Enabled,
733 OUT BOOLEAN *Pending,
734 OUT EFI_TIME *Time
735 );
736
737 /**
738 Sets the system wakeup alarm clock time.
739
740 @param Enabled Enable or disable the wakeup alarm.
741 @param Time If Enable is TRUE, the time to set the wakeup alarm for.
742
743 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
744 Enable is FALSE, then the wakeup alarm was disabled.
745 @retval EFI_INVALID_PARAMETER A time field is out of range.
746 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
747 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
748
749 **/
750 typedef
751 EFI_STATUS
752 (EFIAPI *EFI_SET_WAKEUP_TIME) (
753 IN BOOLEAN Enable,
754 IN EFI_TIME *Time OPTIONAL
755 );
756
757 /**
758 This is the declaration of an EFI image entry point. This can be the entry point to an application
759 written to this specification, an EFI boot service driver, or an EFI runtime driver.
760
761 @param ImageHandle Handle that identifies the loaded image.
762 @param SystemTable System Table for this image.
763
764 @retval EFI_SUCCESS The operation completed successfully.
765
766 **/
767 typedef
768 EFI_STATUS
769 (EFIAPI *EFI_IMAGE_ENTRY_POINT) (
770 IN EFI_HANDLE ImageHandle,
771 IN EFI_SYSTEM_TABLE *SystemTable
772 );
773
774 /**
775 Loads an EFI image into memory.
776
777 @param BootPolicy If TRUE, indicates that the request originates from the boot
778 manager, and that the boot manager is attempting to load
779 FilePath as a boot selection. Ignored if SourceBuffer is
780 not NULL.
781 @param ParentImageHandle The caller's image handle.
782 @param FilePath The DeviceHandle specific file path from which the image is
783 loaded.
784 @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
785 of the image to be loaded.
786 @param SourceSize The size in bytes of SourceBuffer.
787 @param ImageHandle Pointer to the returned image handle that is created when the
788 image is successfully loaded.
789
790 @retval EFI_SUCCESS Image was loaded into memory correctly.
791 @retval EFI_NOT_FOUND Both SourceBuffer and FilePath are NULL.
792 @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
793 @retval EFI_UNSUPPORTED The image type is not supported.
794 @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
795 @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
796 understood.
797 @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
798
799 **/
800 typedef
801 EFI_STATUS
802 (EFIAPI *EFI_IMAGE_LOAD) (
803 IN BOOLEAN BootPolicy,
804 IN EFI_HANDLE ParentImageHandle,
805 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
806 IN VOID *SourceBuffer OPTIONAL,
807 IN UINTN SourceSize,
808 OUT EFI_HANDLE *ImageHandle
809 );
810
811 /**
812 Transfers control to a loaded image's entry point.
813
814 @param ImageHandle Handle of image to be started.
815 @param ExitDataSize Pointer to the size, in bytes, of ExitData.
816 @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
817 Unicode string, optionally followed by additional binary data.
818
819 @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
820 has already been initialized with StartImage
821 @retval Exit code from image Exit code from image
822
823 **/
824 typedef
825 EFI_STATUS
826 (EFIAPI *EFI_IMAGE_START) (
827 IN EFI_HANDLE ImageHandle,
828 OUT UINTN *ExitDataSize,
829 OUT CHAR16 **ExitData OPTIONAL
830 );
831
832 /**
833 Terminates a loaded EFI image and returns control to boot services.
834
835 @param ImageHandle Handle that identifies the image.
836 @param ExitStatus The image's exit code.
837 @param ExitDataSize The size, in bytes, of ExitData.
838 @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,
839 optionally followed by additional binary data.
840
841 @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
842 @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
843 started with LoadImage() and StartImage(), but the
844 image is not the currently executing image.
845
846 **/
847 typedef
848 EFI_STATUS
849 (EFIAPI *EFI_EXIT) (
850 IN EFI_HANDLE ImageHandle,
851 IN EFI_STATUS ExitStatus,
852 IN UINTN ExitDataSize,
853 IN CHAR16 *ExitData OPTIONAL
854 );
855
856 /**
857 Unloads an image.
858
859 @param ImageHandle Handle that identifies the image to be unloaded.
860
861 @retval EFI_SUCCESS The image has been unloaded.
862 @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
863 @retval EFI_UNSUPPORTED The image has been started, and does not support unload.
864 @retval Exit code from the image's unload handler
865
866 **/
867 typedef
868 EFI_STATUS
869 (EFIAPI *EFI_IMAGE_UNLOAD) (
870 IN EFI_HANDLE ImageHandle
871 );
872
873 /**
874 Terminates all boot services.
875
876 @param ImageHandle Handle that identifies the exiting image.
877 @param MapKey Key to the latest memory map.
878
879 @retval EFI_SUCCESS Boot services have been terminated.
880 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
881
882 **/
883 typedef
884 EFI_STATUS
885 (EFIAPI *EFI_EXIT_BOOT_SERVICES) (
886 IN EFI_HANDLE ImageHandle,
887 IN UINTN MapKey
888 );
889
890 /**
891 Induces a fine-grained stall.
892
893 @param Microseconds The number of microseconds to stall execution.
894
895 @retval EFI_SUCCESS Execution was stalled at least the requested number of
896 Microseconds.
897
898 **/
899 typedef
900 EFI_STATUS
901 (EFIAPI *EFI_STALL) (
902 IN UINTN Microseconds
903 );
904
905 /**
906 Sets the system's watchdog timer.
907
908 @param Timeout The number of seconds to set the watchdog timer to.
909 @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
910 @param DataSize The size, in bytes, of WatchdogData.
911 @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally
912 followed by additional binary data.
913
914 @retval EFI_SUCCESS The timeout has been set.
915 @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
916 @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
917 @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware
918 error.
919
920 **/
921 typedef
922 EFI_STATUS
923 (EFIAPI *EFI_SET_WATCHDOG_TIMER) (
924 IN UINTN Timeout,
925 IN UINT64 WatchdogCode,
926 IN UINTN DataSize,
927 IN CHAR16 *WatchdogData OPTIONAL
928 );
929
930 typedef enum {
931 EfiResetCold,
932 EfiResetWarm,
933 EfiResetShutdown,
934 #if ((EDK_RELEASE_VERSION != 0) && (EFI_SPECIFICATION_VERSION < 0x00020000))
935 //
936 // Tiano extension for capsules that was removed after UEFI 2.0 came out
937 //
938 EfiResetUpdate
939 #endif
940 } EFI_RESET_TYPE;
941
942 /**
943 Resets the entire platform.
944
945 @param ResetType The type of reset to perform.
946 @param ResetStatus The status code for the reset.
947 @param DataSize The size, in bytes, of WatchdogData.
948 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
949 EfiResetShutdown the data buffer starts with a Null-terminated
950 Unicode string, optionally followed by additional binary data.
951
952 **/
953 typedef
954 VOID
955 (EFIAPI *EFI_RESET_SYSTEM) (
956 IN EFI_RESET_TYPE ResetType,
957 IN EFI_STATUS ResetStatus,
958 IN UINTN DataSize,
959 IN CHAR16 *ResetData OPTIONAL
960 );
961
962 /**
963 Returns a monotonically increasing count for the platform.
964
965 @param Count Pointer to returned value.
966
967 @retval EFI_SUCCESS The next monotonic count was returned.
968 @retval EFI_INVALID_PARAMETER Count is NULL.
969 @retval EFI_DEVICE_ERROR The device is not functioning properly.
970
971 **/
972 typedef
973 EFI_STATUS
974 (EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT) (
975 OUT UINT64 *Count
976 );
977
978 /**
979 Returns the next high 32 bits of the platform's monotonic counter.
980
981 @param HighCount Pointer to returned value.
982
983 @retval EFI_SUCCESS The next high monotonic count was returned.
984 @retval EFI_INVALID_PARAMETER HighCount is NULL.
985 @retval EFI_DEVICE_ERROR The device is not functioning properly.
986
987 **/
988 typedef
989 EFI_STATUS
990 (EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT) (
991 OUT UINT32 *HighCount
992 );
993
994 /**
995 Computes and returns a 32-bit CRC for a data buffer.
996
997 @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
998 @param DataSize The number of bytes in the buffer Data.
999 @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
1000 and DataSize.
1001
1002 @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
1003 Crc32.
1004 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1005
1006 **/
1007 typedef
1008 EFI_STATUS
1009 (EFIAPI *EFI_CALCULATE_CRC32) (
1010 IN VOID *Data,
1011 IN UINTN DataSize,
1012 OUT UINT32 *Crc32
1013 );
1014
1015 /**
1016 Copies the contents of one buffer to another buffer.
1017
1018 @param Destination Pointer to the destination buffer of the memory copy.
1019 @param Source Pointer to the source buffer of the memory copy.
1020 @param Length Number of bytes to copy from Source to Destination.
1021
1022 **/
1023 typedef
1024 VOID
1025 (EFIAPI *EFI_COPY_MEM) (
1026 IN VOID *Destination,
1027 IN VOID *Source,
1028 IN UINTN Length
1029 );
1030
1031 /**
1032 The SetMem() function fills a buffer with a specified value.
1033
1034 @param Buffer Pointer to the buffer to fill.
1035 @param Size Number of bytes in Buffer to fill.
1036 @param Value Value to fill Buffer with.
1037
1038 **/
1039 typedef
1040 VOID
1041 (EFIAPI *EFI_SET_MEM) (
1042 IN VOID *Buffer,
1043 IN UINTN Size,
1044 IN UINT8 Value
1045 );
1046
1047 //
1048 // Protocol handler functions
1049 //
1050 typedef enum {
1051 EFI_NATIVE_INTERFACE
1052 } EFI_INTERFACE_TYPE;
1053
1054 /**
1055 Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
1056 to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
1057 more error checking than InstallProtocolInterface(), so it is recommended that
1058 InstallMultipleProtocolInterfaces() be used in place of
1059 InstallProtocolInterface()
1060
1061 @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
1062 @param Protocol The numeric ID of the protocol interface.
1063 @param InterfaceType Indicates whether Interface is supplied in native form.
1064 @param Interface A pointer to the protocol interface.
1065
1066 @retval EFI_SUCCESS The protocol interface was installed.
1067 @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
1068 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1069
1070 **/
1071 typedef
1072 EFI_STATUS
1073 (EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE) (
1074 IN OUT EFI_HANDLE *Handle,
1075 IN EFI_GUID *Protocol,
1076 IN EFI_INTERFACE_TYPE InterfaceType,
1077 IN VOID *Interface
1078 );
1079
1080 /**
1081 Installs one or more protocol interfaces into the boot services environment.
1082
1083 @param Handle The handle to install the new protocol interfaces on, or NULL if a new
1084 handle is to be allocated.
1085 @param ... A variable argument list containing pairs of protocol GUIDs and protocol
1086 interfaces.
1087
1088 @retval EFI_SUCCESS All the protocol interface was installed.
1089 @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
1090 @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
1091 the handle database.
1092
1093 **/
1094 typedef
1095 EFI_STATUS
1096 (EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) (
1097 IN OUT EFI_HANDLE *Handle,
1098 ...
1099 );
1100
1101 /**
1102 Reinstalls a protocol interface on a device handle.
1103
1104 @param Handle Handle on which the interface is to be reinstalled.
1105 @param Protocol The numeric ID of the interface.
1106 @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
1107 associated with Protocol.
1108 @param NewInterface A pointer to the new interface.
1109
1110 @retval EFI_SUCCESS The protocol interface was reinstalled.
1111 @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
1112 @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
1113 because OldInterface is still being used by a
1114 driver that will not release it.
1115 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1116
1117 **/
1118 typedef
1119 EFI_STATUS
1120 (EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE) (
1121 IN EFI_HANDLE Handle,
1122 IN EFI_GUID *Protocol,
1123 IN VOID *OldInterface,
1124 IN VOID *NewInterface
1125 );
1126
1127 /**
1128 Removes a protocol interface from a device handle. It is recommended that
1129 UninstallMultipleProtocolInterfaces() be used in place of
1130 UninstallProtocolInterface().
1131
1132 @param Handle The handle on which the interface was installed.
1133 @param Protocol The numeric ID of the interface.
1134 @param Interface A pointer to the interface.
1135
1136 @retval EFI_SUCCESS The interface was removed.
1137 @retval EFI_NOT_FOUND The interface was not found.
1138 @retval EFI_ACCESS_DENIED The interface was not removed because the interface
1139 is still being used by a driver.
1140 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1141
1142 **/
1143 typedef
1144 EFI_STATUS
1145 (EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE) (
1146 IN EFI_HANDLE Handle,
1147 IN EFI_GUID *Protocol,
1148 IN VOID *Interface
1149 );
1150
1151 /**
1152 Removes one or more protocol interfaces into the boot services environment.
1153
1154 @param Handle The handle to remove the protocol interfaces from.
1155 @param ... A variable argument list containing pairs of protocol GUIDs and
1156 protocol interfaces.
1157
1158 @retval EFI_SUCCESS All the protocol interfaces were removed.
1159 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1160
1161 **/
1162 typedef
1163 EFI_STATUS
1164 (EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) (
1165 IN EFI_HANDLE Handle,
1166 ...
1167 );
1168
1169 /**
1170 Queries a handle to determine if it supports a specified protocol.
1171
1172 @param Handle The handle being queried.
1173 @param Protocol The published unique identifier of the protocol.
1174 @param Interface Supplies the address where a pointer to the corresponding Protocol
1175 Interface is returned.
1176 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
1177 @retval EFI_UNSUPPORTED The device does not support the specified protocol.
1178 @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
1179
1180 **/
1181 typedef
1182 EFI_STATUS
1183 (EFIAPI *EFI_HANDLE_PROTOCOL) (
1184 IN EFI_HANDLE Handle,
1185 IN EFI_GUID *Protocol,
1186 OUT VOID **Interface
1187 );
1188
1189 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
1190 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
1191 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
1192 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
1193 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
1194 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
1195
1196 /**
1197 Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
1198 handle, it opens the protocol on behalf of the calling agent.
1199
1200 @param Handle The handle for the protocol interface that is being opened.
1201 @param Protocol The published unique identifier of the protocol.
1202 @param Interface Supplies the address where a pointer to the corresponding Protocol
1203 Interface is returned.
1204 @param AgentHandle The handle of the agent that is opening the protocol interface
1205 specified by Protocol and Interface.
1206 @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
1207 UEFI Driver Model, then this parameter is the controller handle
1208 that requires the protocol interface. If the agent does not follow
1209 the UEFI Driver Model, then this parameter is optional and may
1210 be NULL.
1211 @param Attributes The open mode of the protocol interface specified by Handle
1212 and Protocol.
1213
1214 @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
1215 protocol interface was returned in Interface.
1216 @retval EFI_UNSUPPORTED Handle does not support Protocol.
1217 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1218 @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
1219 @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
1220 handle is the same as AgentHandle.
1221
1222 **/
1223 typedef
1224 EFI_STATUS
1225 (EFIAPI *EFI_OPEN_PROTOCOL) (
1226 IN EFI_HANDLE Handle,
1227 IN EFI_GUID *Protocol,
1228 OUT VOID **Interface,
1229 IN EFI_HANDLE AgentHandle,
1230 IN EFI_HANDLE ControllerHandle, OPTIONAL
1231 IN UINT32 Attributes
1232 );
1233
1234
1235 /**
1236 Closes a protocol on a handle that was opened using OpenProtocol().
1237
1238 @param Handle The handle for the protocol interface that was previously opened
1239 with OpenProtocol(), and is now being closed.
1240 @param Protocol The published unique identifier of the protocol.
1241 @param Interface Supplies the address where a pointer to the corresponding Protocol
1242 Interface is returned.
1243 @param AgentHandle The handle of the agent that is closing the protocol interface.
1244 @param ControllerHandle If the agent that opened a protocol is a driver that follows the
1245 UEFI Driver Model, then this parameter is the controller handle
1246 that required the protocol interface.
1247
1248 @retval EFI_SUCCESS The protocol instance was closed.
1249 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1250 @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
1251 2) The protocol interface specified by Handle and Protocol is not
1252 currently open by AgentHandle and ControllerHandle.
1253
1254 **/
1255 typedef
1256 EFI_STATUS
1257 (EFIAPI *EFI_CLOSE_PROTOCOL) (
1258 IN EFI_HANDLE Handle,
1259 IN EFI_GUID *Protocol,
1260 IN EFI_HANDLE AgentHandle,
1261 IN EFI_HANDLE ControllerHandle
1262 );
1263
1264 typedef struct {
1265 EFI_HANDLE AgentHandle;
1266 EFI_HANDLE ControllerHandle;
1267 UINT32 Attributes;
1268 UINT32 OpenCount;
1269 } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;
1270
1271 /**
1272 Retrieves the list of agents that currently have a protocol interface opened.
1273
1274 @param Handle The handle for the protocol interface that is being queried.
1275 @param Protocol The published unique identifier of the protocol.
1276 @param EntryBuffer A pointer to a buffer of open protocol information in the form of
1277 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
1278 @param EntryCount A pointer to the number of entries in EntryBuffer.
1279
1280 @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
1281 number of entries was returned EntryCount.
1282 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
1283 @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
1284
1285 **/
1286 typedef
1287 EFI_STATUS
1288 (EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION) (
1289 IN EFI_HANDLE Handle,
1290 IN EFI_GUID *Protocol,
1291 IN EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,
1292 OUT UINTN *EntryCount
1293 );
1294
1295 /**
1296 Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
1297 from pool.
1298
1299 @param Handle The handle from which to retrieve the list of protocol interface
1300 GUIDs.
1301 @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
1302 installed on Handle.
1303 @param ProtocolBufferCount A pointer to the number of GUID pointers present in
1304 ProtocolBuffer.
1305
1306 @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
1307 ProtocolBuffer. The number of protocol interface GUIDs was
1308 returned in ProtocolBufferCount.
1309 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
1310 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1311
1312 **/
1313 typedef
1314 EFI_STATUS
1315 (EFIAPI *EFI_PROTOCOLS_PER_HANDLE) (
1316 IN EFI_HANDLE Handle,
1317 OUT EFI_GUID ***ProtocolBuffer,
1318 OUT UINTN *ProtocolBufferCount
1319 );
1320
1321 /**
1322 Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
1323
1324 @param Protocol The numeric ID of the protocol for which the event is to be registered.
1325 @param Event Event that is to be signaled whenever a protocol interface is registered
1326 for Protocol.
1327 @param Registration A pointer to a memory location to receive the registration value.
1328
1329 @retval EFI_SUCCESS The notification event has been registered.
1330 @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
1331 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1332
1333 **/
1334 typedef
1335 EFI_STATUS
1336 (EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY) (
1337 IN EFI_GUID *Protocol,
1338 IN EFI_EVENT Event,
1339 OUT VOID **Registration
1340 );
1341
1342 typedef enum {
1343 AllHandles,
1344 ByRegisterNotify,
1345 ByProtocol
1346 } EFI_LOCATE_SEARCH_TYPE;
1347
1348 /**
1349 Returns an array of handles that support a specified protocol.
1350
1351 @param SearchType Specifies which handle(s) are to be returned.
1352 @param Protocol Specifies the protocol to search by.
1353 @param SearchKey Specifies the search key.
1354 @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
1355 the array returned in Buffer (if the buffer was large enough) or the
1356 size, in bytes, of the buffer needed to obtain the array (if the buffer was
1357 not large enough).
1358 @param Buffer The buffer in which the array is returned.
1359
1360 @retval EFI_SUCCESS The array of handles was returned.
1361 @retval EFI_NOT_FOUND No handles match the search.
1362 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
1363 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1364
1365 **/
1366 typedef
1367 EFI_STATUS
1368 (EFIAPI *EFI_LOCATE_HANDLE) (
1369 IN EFI_LOCATE_SEARCH_TYPE SearchType,
1370 IN EFI_GUID *Protocol, OPTIONAL
1371 IN VOID *SearchKey, OPTIONAL
1372 IN OUT UINTN *BufferSize,
1373 OUT EFI_HANDLE *Buffer
1374 );
1375
1376 /**
1377 Locates the handle to a device on the device path that supports the specified protocol.
1378
1379 @param Protocol Specifies the protocol to search for.
1380 @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
1381 path pointer is modified to point to the remaining part of the device
1382 path.
1383 @param Device A pointer to the returned device handle.
1384
1385 @retval EFI_SUCCESS The resulting handle was returned.
1386 @retval EFI_NOT_FOUND No handles match the search.
1387 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1388
1389 **/
1390 typedef
1391 EFI_STATUS
1392 (EFIAPI *EFI_LOCATE_DEVICE_PATH) (
1393 IN EFI_GUID *Protocol,
1394 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,
1395 OUT EFI_HANDLE *Device
1396 );
1397
1398 /**
1399 Adds, updates, or removes a configuration table entry from the EFI System Table.
1400
1401 @param Guid A pointer to the GUID for the entry to add, update, or remove.
1402 @param Table A pointer to the configuration table for the entry to add, update, or
1403 remove. May be NULL.
1404
1405 @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
1406 @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
1407 @retval EFI_INVALID_PARAMETER Guid is not valid.
1408 @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
1409
1410 **/
1411 typedef
1412 EFI_STATUS
1413 (EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE) (
1414 IN EFI_GUID *Guid,
1415 IN VOID *Table
1416 );
1417
1418 /**
1419 Reserved service.
1420
1421 @retval EFI_SUCCESS The operation has been completed successfully.
1422
1423 **/
1424 typedef
1425 EFI_STATUS
1426 (EFIAPI *EFI_RESERVED_SERVICE) (
1427 VOID
1428 );
1429
1430 /**
1431 Returns an array of handles that support the requested protocol in a buffer allocated from pool.
1432
1433 @param SearchType Specifies which handle(s) are to be returned.
1434 @param Protocol Specifies the protocol to search by.
1435 @param SearchKey Supplies the search key depending on the SearchType.
1436 @param NoHandles The number of handles returned in Buffer.
1437 @param Buffer A pointer to the buffer to return the requested array of handles that
1438 support Protocol.
1439
1440 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
1441 handles in Buffer was returned in NoHandles.
1442 @retval EFI_NOT_FOUND No handles match the search.
1443 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
1444 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1445
1446 **/
1447 typedef
1448 EFI_STATUS
1449 (EFIAPI *EFI_LOCATE_HANDLE_BUFFER) (
1450 IN EFI_LOCATE_SEARCH_TYPE SearchType,
1451 IN EFI_GUID *Protocol, OPTIONAL
1452 IN VOID *SearchKey, OPTIONAL
1453 IN OUT UINTN *NoHandles,
1454 OUT EFI_HANDLE **Buffer
1455 );
1456
1457 /**
1458 Returns the first protocol instance that matches the given protocol.
1459
1460 @param Protocol Provides the protocol to search for.
1461 @param Registration Optional registration key returned from
1462 RegisterProtocolNotify().
1463 @param Interface On return, a pointer to the first interface that matches Protocol and
1464 Registration.
1465
1466 @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
1467 Interface.
1468 @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
1469 Registration.
1470 @retval EFI_INVALID_PARAMETER Interface is NULL.
1471
1472 **/
1473 typedef
1474 EFI_STATUS
1475 (EFIAPI *EFI_LOCATE_PROTOCOL) (
1476 IN EFI_GUID *Protocol,
1477 IN VOID *Registration, OPTIONAL
1478 OUT VOID **Interface
1479 );
1480
1481 typedef struct {
1482 UINT64 Length;
1483 union {
1484 EFI_PHYSICAL_ADDRESS DataBlock;
1485 EFI_PHYSICAL_ADDRESS ContinuationPointer;
1486 } Union;
1487 } UEFI_CAPSULE_BLOCK_DESCRIPTOR;
1488
1489 typedef struct {
1490 EFI_GUID CapsuleGuid;
1491 UINT32 HeaderSize;
1492 UINT32 Flags;
1493 UINT32 CapsuleImageSize;
1494 } UEFI_CAPSULE_HEADER;
1495
1496 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
1497 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
1498
1499 /**
1500 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
1501 consumption, the firmware may process the capsule immediately. If the payload should persist
1502 across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
1503 be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
1504 part of the reset process.
1505
1506 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1507 being passed into update capsule.
1508 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1509 CaspuleHeaderArray.
1510 @param ScatterGatherList Physical pointer to a set of
1511 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
1512 location in physical memory of a set of capsules.
1513
1514 @retval EFI_SUCCESS Valid capsule was passed. If
1515 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
1516 capsule has been successfully processed by the firmware.
1517 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
1518 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL.
1519
1520 **/
1521 typedef
1522 EFI_STATUS
1523 (EFIAPI *EFI_UPDATE_CAPSULE) (
1524 IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,
1525 IN UINTN CapsuleCount,
1526 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
1527 );
1528
1529 /**
1530 Returns if the capsule can be supported via UpdateCapsule().
1531
1532 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
1533 being passed into update capsule.
1534 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
1535 CaspuleHeaderArray.
1536 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
1537 support as an argument to UpdateCapsule() via
1538 CapsuleHeaderArray and ScatterGatherList.
1539 @param ResetType Returns the type of reset required for the capsule update.
1540
1541 @retval EFI_SUCCESS Valid answer returned.
1542 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
1543 MaximumCapsuleSize and ResetType are undefined.
1544 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
1545
1546 **/
1547 typedef
1548 EFI_STATUS
1549 (EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES) (
1550 IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,
1551 IN UINTN CapsuleCount,
1552 OUT UINT64 *MaximumCapsuleSize,
1553 OUT EFI_RESET_TYPE *ResetType
1554 );
1555
1556 /**
1557 Returns information about the EFI variables.
1558
1559 @param Attributes Attributes bitmask to specify the type of variables on
1560 which to return information.
1561 @param MaximumVariableStorageSize On output the maximum size of the storage space
1562 available for the EFI variables associated with the
1563 attributes specified.
1564 @param RemainingVariableStorageSize Returns the remaining size of the storage space
1565 available for the EFI variables associated with the
1566 attributes specified.
1567 @param MaximumVariableSize Returns the maximum size of the individual EFI
1568 variables associated with the attributes specified.
1569
1570 @retval EFI_SUCCESS Valid answer returned.
1571 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
1572 @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
1573 MaximumVariableStorageSize,
1574 RemainingVariableStorageSize, MaximumVariableSize
1575 are undefined.
1576
1577 **/
1578 typedef
1579 EFI_STATUS
1580 (EFIAPI *EFI_QUERY_VARIABLE_INFO) (
1581 IN UINT32 Attributes,
1582 OUT UINT64 *MaximumVariableStorageSize,
1583 OUT UINT64 *RemainingVariableStorageSize,
1584 OUT UINT64 *MaximumVariableSize
1585 );
1586
1587
1588 //
1589 // EFI Runtime Services Table
1590 //
1591 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | 02)
1592 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | 10)
1593 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | 0)
1594
1595 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
1596 #define EFI_RUNTIME_SERVICES_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
1597
1598 #if (EDK_RELEASE_VERSION != 0) && (EFI_SPECIFICATION_VERSION < 0x00020000)
1599 //
1600 // Include the definition for TIANO_REPORT_STATUS_CODE if this is the version
1601 // of Tiano that extended the EFI specification. If Tiano mode is diabled
1602 // don't include it.
1603 //
1604 #include <Dxe/ArchProtocol/StatusCode.h>
1605 #endif
1606
1607
1608 typedef struct {
1609 EFI_TABLE_HEADER Hdr;
1610
1611 //
1612 // Time services
1613 //
1614 EFI_GET_TIME GetTime;
1615 EFI_SET_TIME SetTime;
1616 EFI_GET_WAKEUP_TIME GetWakeupTime;
1617 EFI_SET_WAKEUP_TIME SetWakeupTime;
1618
1619 //
1620 // Virtual memory services
1621 //
1622 EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;
1623 EFI_CONVERT_POINTER ConvertPointer;
1624
1625 //
1626 // Variable services
1627 //
1628 EFI_GET_VARIABLE GetVariable;
1629 EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName;
1630 EFI_SET_VARIABLE SetVariable;
1631
1632 //
1633 // Misc
1634 //
1635 EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;
1636 EFI_RESET_SYSTEM ResetSystem;
1637
1638 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1639 //
1640 // New Boot Services added by UEFI 2.0
1641 //
1642 EFI_UPDATE_CAPSULE UpdateCapsule;
1643 EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;
1644 EFI_QUERY_VARIABLE_INFO QueryVariableInfo;
1645 #elif (EDK_RELEASE_VERSION != 0)
1646 //
1647 // Tiano extension to EFI 1.10 runtime table
1648 // It was moved to a protocol to not conflict with UEFI 2.0
1649 // If Tiano is disabled this item is not enabled for EFI 1.10
1650 //
1651 EFI_REPORT_STATUS_CODE ReportStatusCode;
1652 #endif
1653 } EFI_RUNTIME_SERVICES;
1654
1655 //
1656 // EFI Boot Services Table
1657 //
1658 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42ULL
1659 #define EFI_BOOT_SERVICES_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
1660
1661 typedef struct {
1662 EFI_TABLE_HEADER Hdr;
1663
1664 //
1665 // Task priority functions
1666 //
1667 EFI_RAISE_TPL RaiseTPL;
1668 EFI_RESTORE_TPL RestoreTPL;
1669
1670 //
1671 // Memory functions
1672 //
1673 EFI_ALLOCATE_PAGES AllocatePages;
1674 EFI_FREE_PAGES FreePages;
1675 EFI_GET_MEMORY_MAP GetMemoryMap;
1676 EFI_ALLOCATE_POOL AllocatePool;
1677 EFI_FREE_POOL FreePool;
1678
1679 //
1680 // Event & timer functions
1681 //
1682 EFI_CREATE_EVENT CreateEvent;
1683 EFI_SET_TIMER SetTimer;
1684 EFI_WAIT_FOR_EVENT WaitForEvent;
1685 EFI_SIGNAL_EVENT SignalEvent;
1686 EFI_CLOSE_EVENT CloseEvent;
1687 EFI_CHECK_EVENT CheckEvent;
1688
1689 //
1690 // Protocol handler functions
1691 //
1692 EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;
1693 EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;
1694 EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;
1695 EFI_HANDLE_PROTOCOL HandleProtocol;
1696 VOID *Reserved;
1697 EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;
1698 EFI_LOCATE_HANDLE LocateHandle;
1699 EFI_LOCATE_DEVICE_PATH LocateDevicePath;
1700 EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;
1701
1702 //
1703 // Image functions
1704 //
1705 EFI_IMAGE_LOAD LoadImage;
1706 EFI_IMAGE_START StartImage;
1707 EFI_EXIT Exit;
1708 EFI_IMAGE_UNLOAD UnloadImage;
1709 EFI_EXIT_BOOT_SERVICES ExitBootServices;
1710
1711 //
1712 // Misc functions
1713 //
1714 EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;
1715 EFI_STALL Stall;
1716 EFI_SET_WATCHDOG_TIMER SetWatchdogTimer;
1717
1718 //
1719 // ////////////////////////////////////////////////////
1720 // EFI 1.1 Services
1721 //////////////////////////////////////////////////////
1722 //
1723 // DriverSupport Services
1724 //
1725 EFI_CONNECT_CONTROLLER ConnectController;
1726 EFI_DISCONNECT_CONTROLLER DisconnectController;
1727
1728 //
1729 // Added Open and Close protocol for the new driver model
1730 //
1731 EFI_OPEN_PROTOCOL OpenProtocol;
1732 EFI_CLOSE_PROTOCOL CloseProtocol;
1733 EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;
1734
1735 //
1736 // Added new services to EFI 1.1 as Lib to reduce code size.
1737 //
1738 EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle;
1739 EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer;
1740 EFI_LOCATE_PROTOCOL LocateProtocol;
1741
1742 EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;
1743 EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;
1744
1745 //
1746 // CRC32 services
1747 //
1748 EFI_CALCULATE_CRC32 CalculateCrc32;
1749
1750 //
1751 // Memory Utility Services
1752 //
1753 EFI_COPY_MEM CopyMem;
1754 EFI_SET_MEM SetMem;
1755
1756 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1757 //
1758 // UEFI 2.0 Extension to the table
1759 //
1760 EFI_CREATE_EVENT_EX CreateEventEx;
1761 #endif
1762 } EFI_BOOT_SERVICES;
1763
1764 //
1765 // EFI Configuration Table
1766 //
1767 typedef struct {
1768 EFI_GUID VendorGuid;
1769 VOID *VendorTable;
1770 } EFI_CONFIGURATION_TABLE;
1771
1772 //
1773 // EFI System Table
1774 //
1775 #define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249ULL
1776 #define EFI_SYSTEM_TABLE_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
1777
1778 struct _EFI_SYSTEM_TABLE {
1779 EFI_TABLE_HEADER Hdr;
1780
1781 CHAR16 *FirmwareVendor;
1782 UINT32 FirmwareRevision;
1783
1784 EFI_HANDLE ConsoleInHandle;
1785 EFI_SIMPLE_TEXT_IN_PROTOCOL *ConIn;
1786
1787 EFI_HANDLE ConsoleOutHandle;
1788 EFI_SIMPLE_TEXT_OUT_PROTOCOL *ConOut;
1789
1790 EFI_HANDLE StandardErrorHandle;
1791 EFI_SIMPLE_TEXT_OUT_PROTOCOL *StdErr;
1792
1793 EFI_RUNTIME_SERVICES *RuntimeServices;
1794 EFI_BOOT_SERVICES *BootServices;
1795
1796 UINTN NumberOfTableEntries;
1797 EFI_CONFIGURATION_TABLE *ConfigurationTable;
1798
1799 };
1800
1801 //
1802 // Device Path information
1803 //
1804
1805 #pragma pack(1)
1806
1807 //
1808 // Hardware Device Paths
1809 //
1810 #define HARDWARE_DEVICE_PATH 0x01
1811
1812 #define HW_PCI_DP 0x01
1813 typedef struct {
1814 EFI_DEVICE_PATH_PROTOCOL Header;
1815 UINT8 Function;
1816 UINT8 Device;
1817 } PCI_DEVICE_PATH;
1818
1819 #define HW_PCCARD_DP 0x02
1820 typedef struct {
1821 EFI_DEVICE_PATH_PROTOCOL Header;
1822 UINT8 FunctionNumber;
1823 } PCCARD_DEVICE_PATH;
1824
1825 #define HW_MEMMAP_DP 0x03
1826 typedef struct {
1827 EFI_DEVICE_PATH_PROTOCOL Header;
1828 UINT32 MemoryType;
1829 EFI_PHYSICAL_ADDRESS StartingAddress;
1830 EFI_PHYSICAL_ADDRESS EndingAddress;
1831 } MEMMAP_DEVICE_PATH;
1832
1833 #define HW_VENDOR_DP 0x04
1834 typedef struct {
1835 EFI_DEVICE_PATH_PROTOCOL Header;
1836 EFI_GUID Guid;
1837 } VENDOR_DEVICE_PATH;
1838
1839 #define HW_CONTROLLER_DP 0x05
1840 typedef struct {
1841 EFI_DEVICE_PATH_PROTOCOL Header;
1842 UINT32 ControllerNumber;
1843 } CONTROLLER_DEVICE_PATH;
1844
1845 //
1846 // ACPI Device Paths
1847 //
1848 #define ACPI_DEVICE_PATH 0x02
1849
1850 #define ACPI_DP 0x01
1851 typedef struct {
1852 EFI_DEVICE_PATH_PROTOCOL Header;
1853 UINT32 HID;
1854 UINT32 UID;
1855 } ACPI_HID_DEVICE_PATH;
1856
1857 #define ACPI_EXTENDED_DP 0x02
1858 typedef struct {
1859 EFI_DEVICE_PATH_PROTOCOL Header;
1860 UINT32 HID;
1861 UINT32 UID;
1862 UINT32 CID;
1863 //
1864 // Optional variable length _HIDSTR
1865 // Optional variable length _UIDSTR
1866 //
1867 } ACPI_EXTENDED_HID_DEVICE_PATH;
1868
1869 //
1870 // EISA ID Macro
1871 // EISA ID Definition 32-bits
1872 // bits[15:0] - three character compressed ASCII EISA ID.
1873 // bits[31:16] - binary number
1874 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
1875 //
1876 #define PNP_EISA_ID_CONST 0x41d0
1877 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
1878 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
1879 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
1880
1881 #define PNP_EISA_ID_MASK 0xffff
1882 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
1883
1884
1885 #define ACPI_ADR_DP 0x03
1886 typedef struct {
1887 EFI_DEVICE_PATH_PROTOCOL Header;
1888 UINT32 ADR;
1889 } ACPI_ADR_DEVICE_PATH;
1890
1891
1892 //
1893 // Messaging Device Paths
1894 //
1895 #define MESSAGING_DEVICE_PATH 0x03
1896
1897 #define MSG_ATAPI_DP 0x01
1898 typedef struct {
1899 EFI_DEVICE_PATH_PROTOCOL Header;
1900 UINT8 PrimarySecondary;
1901 UINT8 SlaveMaster;
1902 UINT16 Lun;
1903 } ATAPI_DEVICE_PATH;
1904
1905 #define MSG_SCSI_DP 0x02
1906 typedef struct {
1907 EFI_DEVICE_PATH_PROTOCOL Header;
1908 UINT16 Pun;
1909 UINT16 Lun;
1910 } SCSI_DEVICE_PATH;
1911
1912 #define MSG_FIBRECHANNEL_DP 0x03
1913 typedef struct {
1914 EFI_DEVICE_PATH_PROTOCOL Header;
1915 UINT32 Reserved;
1916 UINT64 WWN;
1917 UINT64 Lun;
1918 } FIBRECHANNEL_DEVICE_PATH;
1919
1920 #define MSG_1394_DP 0x04
1921 typedef struct {
1922 EFI_DEVICE_PATH_PROTOCOL Header;
1923 UINT32 Reserved;
1924 UINT64 Guid;
1925 } F1394_DEVICE_PATH;
1926
1927 #define MSG_USB_DP 0x05
1928 typedef struct {
1929 EFI_DEVICE_PATH_PROTOCOL Header;
1930 UINT8 ParentPortNumber;
1931 UINT8 InterfaceNumber;
1932 } USB_DEVICE_PATH;
1933
1934 #define MSG_USB_CLASS_DP 0x0f
1935 typedef struct {
1936 EFI_DEVICE_PATH_PROTOCOL Header;
1937 UINT16 VendorId;
1938 UINT16 ProductId;
1939 UINT8 DeviceClass;
1940 UINT8 DeviceSubClass;
1941 UINT8 DeviceProtocol;
1942 } USB_CLASS_DEVICE_PATH;
1943
1944 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
1945 #define MSG_USB_WWID_DP 0x10
1946 typedef struct {
1947 EFI_DEVICE_PATH_PROTOCOL Header;
1948 UINT16 InterfaceNumber;
1949 UINT16 VendorId;
1950 UINT16 ProductId;
1951 // CHAR16 SerialNumber[];
1952 } USB_WWID_DEVICE_PATH;
1953
1954 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
1955 typedef struct {
1956 EFI_DEVICE_PATH_PROTOCOL Header;
1957 UINT8 Lun;
1958 } DEVICE_LOGICAL_UNIT_DEVICE_PATH;
1959 #endif
1960
1961 #define MSG_I2O_DP 0x06
1962 typedef struct {
1963 EFI_DEVICE_PATH_PROTOCOL Header;
1964 UINT32 Tid;
1965 } I2O_DEVICE_PATH;
1966
1967 #define MSG_MAC_ADDR_DP 0x0b
1968 typedef struct {
1969 EFI_DEVICE_PATH_PROTOCOL Header;
1970 EFI_MAC_ADDRESS MacAddress;
1971 UINT8 IfType;
1972 } MAC_ADDR_DEVICE_PATH;
1973
1974 #define MSG_IPv4_DP 0x0c
1975 typedef struct {
1976 EFI_DEVICE_PATH_PROTOCOL Header;
1977 EFI_IPv4_ADDRESS LocalIpAddress;
1978 EFI_IPv4_ADDRESS RemoteIpAddress;
1979 UINT16 LocalPort;
1980 UINT16 RemotePort;
1981 UINT16 Protocol;
1982 BOOLEAN StaticIpAddress;
1983 } IPv4_DEVICE_PATH;
1984
1985 #define MSG_IPv6_DP 0x0d
1986 typedef struct {
1987 EFI_DEVICE_PATH_PROTOCOL Header;
1988 EFI_IPv6_ADDRESS LocalIpAddress;
1989 EFI_IPv6_ADDRESS RemoteIpAddress;
1990 UINT16 LocalPort;
1991 UINT16 RemotePort;
1992 UINT16 Protocol;
1993 BOOLEAN StaticIpAddress;
1994 } IPv6_DEVICE_PATH;
1995
1996 #define MSG_INFINIBAND_DP 0x09
1997 typedef struct {
1998 EFI_DEVICE_PATH_PROTOCOL Header;
1999 UINT32 ResourceFlags;
2000 UINT8 PortGid[16];
2001 UINT64 ServiceId;
2002 UINT64 TargetPortId;
2003 UINT64 DeviceId;
2004 } INFINIBAND_DEVICE_PATH;
2005
2006 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
2007 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
2008 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
2009 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
2010 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
2011
2012 #define MSG_UART_DP 0x0e
2013 typedef struct {
2014 EFI_DEVICE_PATH_PROTOCOL Header;
2015 UINT32 Reserved;
2016 UINT64 BaudRate;
2017 UINT8 DataBits;
2018 UINT8 Parity;
2019 UINT8 StopBits;
2020 } UART_DEVICE_PATH;
2021
2022 //
2023 // Use VENDOR_DEVICE_PATH struct
2024 //
2025 #define MSG_VENDOR_DP 0x0a
2026
2027 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
2028 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
2029 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
2030 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
2031
2032 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
2033
2034 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
2035 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
2036
2037 typedef struct {
2038 EFI_DEVICE_PATH_PROTOCOL Header;
2039 EFI_GUID Guid;
2040 UINT32 FlowControlMap;
2041 } UART_FLOW_CONTROL_DEVICE_PATH;
2042
2043 typedef struct {
2044 EFI_DEVICE_PATH_PROTOCOL Header;
2045 EFI_GUID Guid;
2046 UINT32 Reserved;
2047 UINT64 SasAddress;
2048 UINT64 Lun;
2049 UINT16 DeviceTopology;
2050 UINT16 RelativeTargetPort;
2051 } SAS_DEVICE_PATH;
2052
2053 #define MSG_ISCSI_DP 0x13
2054 typedef struct {
2055 EFI_DEVICE_PATH_PROTOCOL Header;
2056 UINT16 NetworkProtocol;
2057 UINT16 LoginOption;
2058 UINT16 Reserved;
2059 UINT16 TargetPortalGroupTag;
2060 UINT64 LUN;
2061 // CHAR8 iSCSI Target Name
2062 } ISCSI_DEVICE_PATH;
2063
2064 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
2065 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
2066 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
2067 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
2068 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
2069 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
2070 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
2071 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
2072
2073 #endif
2074
2075 //
2076 // Media Device Path
2077 //
2078 #define MEDIA_DEVICE_PATH 0x04
2079
2080 #define MEDIA_HARDDRIVE_DP 0x01
2081 typedef struct {
2082 EFI_DEVICE_PATH_PROTOCOL Header;
2083 UINT32 PartitionNumber;
2084 UINT64 PartitionStart;
2085 UINT64 PartitionSize;
2086 UINT8 Signature[16];
2087 UINT8 MBRType;
2088 UINT8 SignatureType;
2089 } HARDDRIVE_DEVICE_PATH;
2090
2091 #define MBR_TYPE_PCAT 0x01
2092 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
2093
2094 #define SIGNATURE_TYPE_MBR 0x01
2095 #define SIGNATURE_TYPE_GUID 0x02
2096
2097 #define MEDIA_CDROM_DP 0x02
2098 typedef struct {
2099 EFI_DEVICE_PATH_PROTOCOL Header;
2100 UINT32 BootEntry;
2101 UINT64 PartitionStart;
2102 UINT64 PartitionSize;
2103 } CDROM_DEVICE_PATH;
2104
2105 //
2106 // Use VENDOR_DEVICE_PATH struct
2107 //
2108 #define MEDIA_VENDOR_DP 0x03
2109
2110 #define MEDIA_FILEPATH_DP 0x04
2111 typedef struct {
2112 EFI_DEVICE_PATH_PROTOCOL Header;
2113 CHAR16 PathName[1];
2114 } FILEPATH_DEVICE_PATH;
2115
2116 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
2117
2118 #define MEDIA_PROTOCOL_DP 0x05
2119 typedef struct {
2120 EFI_DEVICE_PATH_PROTOCOL Header;
2121 EFI_GUID Protocol;
2122 } MEDIA_PROTOCOL_DEVICE_PATH;
2123
2124 #if ((EDK_RELEASE_VERSION != 0) && (EFI_SPECIFICATION_VERSION < 0x00020000))
2125 //
2126 // Prior to UEFI 2.0 Tiano extended this enum. UEFI owns device path values
2127 // and we moved to a new GUID'ed device path for Tiano
2128 //
2129
2130 #define MEDIA_FV_FILEPATH_DP 0x06
2131 typedef struct {
2132 EFI_DEVICE_PATH_PROTOCOL Header;
2133 EFI_GUID NameGuid;
2134 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
2135
2136 #else
2137
2138 typedef struct {
2139 EFI_DEVICE_PATH_PROTOCOL Header;
2140 EFI_GUID TianoSpecificDevicePath;
2141 UINT32 Type;
2142 } TIANO_DEVICE_PATH;
2143
2144 #define TIANO_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE 0x01
2145 typedef struct {
2146 TIANO_DEVICE_PATH Tiano;
2147 EFI_GUID NameGuid;
2148 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
2149
2150 //
2151 // Place holder for a future extension
2152 //
2153 #define TIANO_MEDIAFW_VOL_DEVICE_PATH_TYPE 0x02
2154 typedef struct {
2155 TIANO_DEVICE_PATH Tiano;
2156 EFI_GUID VolumeGuid;
2157 } MEDIA_FW_VOL_DEVICE_PATH;
2158
2159 #endif
2160
2161
2162 //
2163 // BBS Device Path
2164 //
2165 #define BBS_DEVICE_PATH 0x05
2166 #define BBS_BBS_DP 0x01
2167 typedef struct {
2168 EFI_DEVICE_PATH_PROTOCOL Header;
2169 UINT16 DeviceType;
2170 UINT16 StatusFlag;
2171 CHAR8 String[1];
2172 } BBS_BBS_DEVICE_PATH;
2173
2174 //
2175 // DeviceType definitions - from BBS specification
2176 //
2177 #define BBS_TYPE_FLOPPY 0x01
2178 #define BBS_TYPE_HARDDRIVE 0x02
2179 #define BBS_TYPE_CDROM 0x03
2180 #define BBS_TYPE_PCMCIA 0x04
2181 #define BBS_TYPE_USB 0x05
2182 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
2183 #define BBS_TYPE_BEV 0x80
2184 #define BBS_TYPE_UNKNOWN 0xFF
2185
2186
2187 //
2188 // Union of all possible Device Paths and pointers to Device Paths
2189 //
2190
2191 typedef union {
2192 EFI_DEVICE_PATH_PROTOCOL DevPath;
2193 PCI_DEVICE_PATH Pci;
2194 PCCARD_DEVICE_PATH PcCard;
2195 MEMMAP_DEVICE_PATH MemMap;
2196 VENDOR_DEVICE_PATH Vendor;
2197
2198 CONTROLLER_DEVICE_PATH Controller;
2199 ACPI_HID_DEVICE_PATH Acpi;
2200
2201 ATAPI_DEVICE_PATH Atapi;
2202 SCSI_DEVICE_PATH Scsi;
2203 FIBRECHANNEL_DEVICE_PATH FibreChannel;
2204
2205 F1394_DEVICE_PATH F1394;
2206 USB_DEVICE_PATH Usb;
2207 USB_CLASS_DEVICE_PATH UsbClass;
2208 I2O_DEVICE_PATH I2O;
2209 MAC_ADDR_DEVICE_PATH MacAddr;
2210 IPv4_DEVICE_PATH Ipv4;
2211 IPv6_DEVICE_PATH Ipv6;
2212 INFINIBAND_DEVICE_PATH InfiniBand;
2213 UART_DEVICE_PATH Uart;
2214
2215 HARDDRIVE_DEVICE_PATH HardDrive;
2216 CDROM_DEVICE_PATH CD;
2217
2218 FILEPATH_DEVICE_PATH FilePath;
2219 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol;
2220
2221 BBS_BBS_DEVICE_PATH Bbs;
2222 } EFI_DEV_PATH;
2223
2224
2225
2226 typedef union {
2227 EFI_DEVICE_PATH_PROTOCOL *DevPath;
2228 PCI_DEVICE_PATH *Pci;
2229 PCCARD_DEVICE_PATH *PcCard;
2230 MEMMAP_DEVICE_PATH *MemMap;
2231 VENDOR_DEVICE_PATH *Vendor;
2232
2233 CONTROLLER_DEVICE_PATH *Controller;
2234 ACPI_HID_DEVICE_PATH *Acpi;
2235 ACPI_EXTENDED_HID_DEVICE_PATH *ExtendedAcpi;
2236
2237 ATAPI_DEVICE_PATH *Atapi;
2238 SCSI_DEVICE_PATH *Scsi;
2239 FIBRECHANNEL_DEVICE_PATH *FibreChannel;
2240
2241 F1394_DEVICE_PATH *F1394;
2242 USB_DEVICE_PATH *Usb;
2243 USB_CLASS_DEVICE_PATH *UsbClass;
2244 I2O_DEVICE_PATH *I2O;
2245 MAC_ADDR_DEVICE_PATH *MacAddr;
2246 IPv4_DEVICE_PATH *Ipv4;
2247 IPv6_DEVICE_PATH *Ipv6;
2248 INFINIBAND_DEVICE_PATH *InfiniBand;
2249 UART_DEVICE_PATH *Uart;
2250
2251 HARDDRIVE_DEVICE_PATH *HardDrive;
2252 CDROM_DEVICE_PATH *CD;
2253
2254 FILEPATH_DEVICE_PATH *FilePath;
2255 MEDIA_PROTOCOL_DEVICE_PATH *MediaProtocol;
2256
2257 BBS_BBS_DEVICE_PATH *Bbs;
2258 UINT8 *Raw;
2259 } EFI_DEV_PATH_PTR;
2260
2261 #pragma pack()
2262
2263
2264 //
2265 // PXE Informations
2266 //
2267
2268 //
2269 // Packet definitions
2270 //
2271 typedef struct {
2272 UINT8 BootpOpcode;
2273 UINT8 BootpHwType;
2274 UINT8 BootpHwAddrLen;
2275 UINT8 BootpGateHops;
2276 UINT32 BootpIdent;
2277 UINT16 BootpSeconds;
2278 UINT16 BootpFlags;
2279 UINT8 BootpCiAddr[4];
2280 UINT8 BootpYiAddr[4];
2281 UINT8 BootpSiAddr[4];
2282 UINT8 BootpGiAddr[4];
2283 UINT8 BootpHwAddr[16];
2284 UINT8 BootpSrvName[64];
2285 UINT8 BootpBootFile[128];
2286 UINT32 DhcpMagik;
2287 UINT8 DhcpOptions[56];
2288 } EFI_PXE_BASE_CODE_DHCPV4_PACKET;
2289
2290 typedef union {
2291 UINT8 Raw[1472];
2292 EFI_PXE_BASE_CODE_DHCPV4_PACKET Dhcpv4;
2293
2294 //
2295 // EFI_PXE_BASE_CODE_DHCPV6_PACKET Dhcpv6;
2296 //
2297 } EFI_PXE_BASE_CODE_PACKET;
2298
2299 #include <Uefi/EfiPxe.h>
2300
2301 //
2302 // EFI Revision information
2303 //
2304 #define EFI_FIRMWARE_REVISION (EFI_2_00_SYSTEM_TABLE_REVISION)
2305
2306 #include <Common/EfiImage.h>
2307 #include <IndustryStandard/Usb.h>
2308
2309
2310 #define EFI_USB_HC_RESET_GLOBAL 0x0001
2311 #define EFI_USB_HC_RESET_HOST_CONTROLLER 0x0002
2312 #define EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG 0x0004
2313 #define EFI_USB_HC_RESET_HOST_WITH_DEBUG 0x0008
2314
2315 //
2316 // USB Host Controller state
2317 //
2318 typedef enum {
2319 EfiUsbHcStateHalt,
2320 EfiUsbHcStateOperational,
2321 EfiUsbHcStateSuspend,
2322 EfiUsbHcStateMaximum
2323 } EFI_USB_HC_STATE;
2324
2325
2326 //
2327 // EFI File location to boot from on removable media devices
2328 //
2329 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
2330 #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
2331 #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
2332 #define EFI_REMOVABLE_MEDIA_FILE_NAME_EBC L"\\EFI\\BOOT\\BOOTEBC.EFI"
2333
2334 #if defined (MDE_CPU_IA32)
2335 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
2336 #elif defined (MDE_CPU_IPF)
2337 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
2338 #elif defined (MDE_CPU_X64)
2339 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64
2340 #elif defined (MDE_CPU_EBC)
2341 #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_EBC
2342 #else
2343 #error Unknown Processor Type
2344 #endif
2345
2346
2347 //
2348 // Protocols from EFI 1.10 that got thier names fixed in UEFI 2.0
2349 //
2350 #include <Protocol/LoadedImage.h>
2351 #include <Protocol/SimpleTextIn.h>
2352 #include <Protocol/SimpleTextOut.h>
2353 #include <Protocol/SerialIo.h>
2354 #include <Protocol/LoadFile.h>
2355 #include <Protocol/SimpleFileSystem.h>
2356 #include <Protocol/DiskIo.h>
2357 #include <Protocol/BlockIo.h>
2358 #include <Protocol/UnicodeCollation.h>
2359 #include <Protocol/SimpleNetwork.h>
2360 #include <Protocol/EfiNetworkInterfaceIdentifier.h>
2361 #include <Protocol/PxeBaseCode.h>
2362 #include <Protocol/PxeBaseCodeCallBack.h>
2363
2364 //
2365 // EFI 1.10 Protocols
2366 //
2367 #include <Protocol/Bis.h>
2368 #include <Protocol/BusSpecificDriverOverride.h>
2369 #include <Protocol/ComponentName.h>
2370 #include <Protocol/DebugPort.h>
2371 #include <Protocol/DebugSupport.h>
2372 #include <Protocol/Decompress.h>
2373 #include <Protocol/DriverBinding.h>
2374 #include <Protocol/DriverConfiguration.h>
2375 #include <Protocol/DriverDiagnostics.h>
2376 #include <Protocol/Ebc.h>
2377 #include <Protocol/EfiNetworkInterfaceIdentifier.h>
2378 #include <Protocol/PciIo.h>
2379 #include <Protocol/PciRootBridgeIo.h>
2380 #include <Protocol/PlatformDriverOverride.h>
2381 #include <Protocol/SimplePointer.h>
2382 #include <Protocol/ScsiPassThru.h>
2383 #include <Protocol/UsbIo.h>
2384 #include <Protocol/UsbHostController.h>
2385 #include <Protocol/UgaDraw.h>
2386
2387 //
2388 // EFI 1.10 GUIDs
2389 //
2390 #include <Guid/Acpi.h>
2391 #include <Guid/DebugImageInfoTable.h>
2392 #include <Guid/GlobalVariable.h>
2393 #include <Guid/Gpt.h>
2394 #include <Guid/PcAnsi.h>
2395 #include <Guid/SmBios.h>
2396 #include <Guid/SalSystemTable.h>
2397 #include <Guid/FileInfo.h>
2398 #include <Guid/FileSystemInfo.h>
2399 #include <Guid/FileSystemVolumeLabelInfo.h>
2400
2401 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
2402 //
2403 // Turn on UEFI 2.0 Protocols and GUIDs
2404 //
2405 #include <Protocol/AuthenticationInfo.h>
2406 #include <Protocol/DevicePathUtilities.h>
2407 #include <Protocol/DevicePathToText.h>
2408 #include <Protocol/DevicePathFromText.h>
2409 #include <Protocol/GraphicsOutput.h>
2410 #include <Protocol/EdidDiscovered.h>
2411 #include <Protocol/EdidActive.h>
2412 #include <Protocol/EdidOverride.h>
2413 #include <Protocol/ScsiIoExt.h>
2414 #include <Protocol/ScsiPassThruExt.h>
2415 #include <Protocol/IScsiInitatorName.h>
2416 #include <Protocol/Usb2HostController.h>
2417 #include <Protocol/TapeIo.h>
2418 #include <Protocol/ManagedNetwork.h>
2419 #include <Protocol/Arp.h>
2420 #include <Protocol/Dhcp4.h>
2421 #include <Protocol/IP4.h>
2422 #include <Protocol/IP4Config.h>
2423 #include <Protocol/Tcp4.h>
2424 #include <Protocol/Udp4.h>
2425 #include <Protocol/Mtftp4.h>
2426 #include <Protocol/ServiceBinding.h>
2427 #include <Protocol/Hash.h>
2428
2429 #include <Guid/EventGroup.h>
2430 #endif
2431
2432
2433 #endif