iPXE
PiDxeCis.h
Go to the documentation of this file.
1 /** @file
2  Include file matches things in PI.
3 
4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
6 
7  @par Revision Reference:
8  PI Version 1.7
9 
10 **/
11 
12 #ifndef __PI_DXECIS_H__
13 #define __PI_DXECIS_H__
14 
15 FILE_LICENCE ( BSD2_PATENT );
16 
19 
20 ///
21 /// Global Coherencey Domain types - Memory type.
22 ///
23 typedef enum {
24  ///
25  /// A memory region that is visible to the boot processor. However, there are no system
26  /// components that are currently decoding this memory region.
27  ///
29  ///
30  /// A memory region that is visible to the boot processor. This memory region is being
31  /// decoded by a system component, but the memory region is not considered to be either
32  /// system memory or memory-mapped I/O.
33  ///
35  ///
36  /// A memory region that is visible to the boot processor. A memory controller is
37  /// currently decoding this memory region and the memory controller is producing a
38  /// tested system memory region that is available to the memory services.
39  ///
41  ///
42  /// A memory region that is visible to the boot processor. This memory region is
43  /// currently being decoded by a component as memory-mapped I/O that can be used to
44  /// access I/O devices in the platform.
45  ///
47  ///
48  /// A memory region that is visible to the boot processor.
49  /// This memory supports byte-addressable non-volatility.
50  ///
52  //
53  // Keep original one for the compatibility.
54  //
56  ///
57  /// A memory region that provides higher reliability relative to other memory in the
58  /// system. If all memory has the same reliability, then this bit is not used.
59  ///
61  // ///
62  // /// A memory region that describes system memory that has not been accepted
63  // /// by a corresponding call to the underlying isolation architecture.
64  // ///
65  // /// Please be noted:
66  // /// EfiGcdMemoryTypeUnaccepted is defined in PrePiDxeCis.h because it has not been
67  // /// defined in PI spec.
68  // EfiGcdMemoryTypeUnaccepted,
71 
72 ///
73 /// Global Coherencey Domain types - IO type.
74 ///
75 typedef enum {
76  ///
77  /// An I/O region that is visible to the boot processor. However, there are no system
78  /// components that are currently decoding this I/O region.
79  ///
81  ///
82  /// An I/O region that is visible to the boot processor. This I/O region is currently being
83  /// decoded by a system component, but the I/O region cannot be used to access I/O devices.
84  ///
86  ///
87  /// An I/O region that is visible to the boot processor. This I/O region is currently being
88  /// decoded by a system component that is producing I/O ports that can be used to access I/O devices.
89  ///
93 
94 ///
95 /// The type of allocation to perform.
96 ///
97 typedef enum {
98  ///
99  /// The GCD memory space map is searched from the lowest address up to the highest address
100  /// looking for unallocated memory ranges.
101  ///
103  ///
104  /// The GCD memory space map is searched from the lowest address up
105  /// to the specified MaxAddress looking for unallocated memory ranges.
106  ///
108  ///
109  /// The GCD memory space map is checked to see if the memory range starting
110  /// at the specified Address is available.
111  ///
113  ///
114  /// The GCD memory space map is searched from the highest address down to the lowest address
115  /// looking for unallocated memory ranges.
116  ///
118  ///
119  /// The GCD memory space map is searched from the specified MaxAddress
120  /// down to the lowest address looking for unallocated memory ranges.
121  ///
125 
126 ///
127 /// EFI_GCD_MEMORY_SPACE_DESCRIPTOR.
128 ///
129 typedef struct {
130  ///
131  /// The physical address of the first byte in the memory region. Type
132  /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function
133  /// description in the UEFI 2.0 specification.
134  ///
136 
137  ///
138  /// The number of bytes in the memory region.
139  ///
141 
142  ///
143  /// The bit mask of attributes that the memory region is capable of supporting. The bit
144  /// mask of available attributes is defined in the GetMemoryMap() function description
145  /// in the UEFI 2.0 specification.
146  ///
148  ///
149  /// The bit mask of attributes that the memory region is currently using. The bit mask of
150  /// available attributes is defined in GetMemoryMap().
151  ///
153  ///
154  /// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the
155  /// AddMemorySpace() function description.
156  ///
158 
159  ///
160  /// The image handle of the agent that allocated the memory resource described by
161  /// PhysicalStart and NumberOfBytes. If this field is NULL, then the memory
162  /// resource is not currently allocated. Type EFI_HANDLE is defined in
163  /// InstallProtocolInterface() in the UEFI 2.0 specification.
164  ///
166 
167  ///
168  /// The device handle for which the memory resource has been allocated. If
169  /// ImageHandle is NULL, then the memory resource is not currently allocated. If this
170  /// field is NULL, then the memory resource is not associated with a device that is
171  /// described by a device handle. Type EFI_HANDLE is defined in
172  /// InstallProtocolInterface() in the UEFI 2.0 specification.
173  ///
176 
177 ///
178 /// EFI_GCD_IO_SPACE_DESCRIPTOR.
179 ///
180 typedef struct {
181  ///
182  /// Physical address of the first byte in the I/O region. Type
183  /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function
184  /// description in the UEFI 2.0 specification.
185  ///
187 
188  ///
189  /// Number of bytes in the I/O region.
190  ///
192 
193  ///
194  /// Type of the I/O region. Type EFI_GCD_IO_TYPE is defined in the
195  /// AddIoSpace() function description.
196  ///
198 
199  ///
200  /// The image handle of the agent that allocated the I/O resource described by
201  /// PhysicalStart and NumberOfBytes. If this field is NULL, then the I/O
202  /// resource is not currently allocated. Type EFI_HANDLE is defined in
203  /// InstallProtocolInterface() in the UEFI 2.0 specification.
204  ///
206 
207  ///
208  /// The device handle for which the I/O resource has been allocated. If ImageHandle
209  /// is NULL, then the I/O resource is not currently allocated. If this field is NULL, then
210  /// the I/O resource is not associated with a device that is described by a device handle.
211  /// Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI
212  /// 2.0 specification.
213  ///
216 
217 /**
218  Adds reserved memory, system memory, or memory-mapped I/O resources to the
219  global coherency domain of the processor.
220 
221  @param GcdMemoryType The type of memory resource being added.
222  @param BaseAddress The physical address that is the start address
223  of the memory resource being added.
224  @param Length The size, in bytes, of the memory resource that
225  is being added.
226  @param Capabilities The bit mask of attributes that the memory
227  resource region supports.
228 
229  @retval EFI_SUCCESS The memory resource was added to the global
230  coherency domain of the processor.
231  @retval EFI_INVALID_PARAMETER GcdMemoryType is invalid.
232  @retval EFI_INVALID_PARAMETER Length is zero.
233  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to add
234  the memory resource to the global coherency
235  domain of the processor.
236  @retval EFI_UNSUPPORTED The processor does not support one or more bytes
237  of the memory resource range specified by
238  BaseAddress and Length.
239  @retval EFI_ACCESS_DENIED One or more bytes of the memory resource range
240  specified by BaseAddress and Length conflicts
241  with a memory resource range that was previously
242  added to the global coherency domain of the processor.
243  @retval EFI_ACCESS_DENIED One or more bytes of the memory resource range
244  specified by BaseAddress and Length was allocated
245  in a prior call to AllocateMemorySpace().
246 
247 **/
248 typedef
251  IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
253  IN UINT64 Length,
254  IN UINT64 Capabilities
255  );
256 
257 /**
258  Allocates nonexistent memory, reserved memory, system memory, or memorymapped
259  I/O resources from the global coherency domain of the processor.
260 
261  @param GcdAllocateType The type of allocation to perform.
262  @param GcdMemoryType The type of memory resource being allocated.
263  @param Alignment The log base 2 of the boundary that BaseAddress must
264  be aligned on output. Align with 2^Alignment.
265  @param Length The size in bytes of the memory resource range that
266  is being allocated.
267  @param BaseAddress A pointer to a physical address to allocate.
268  @param Imagehandle The image handle of the agent that is allocating
269  the memory resource.
270  @param DeviceHandle The device handle for which the memory resource
271  is being allocated.
272 
273  @retval EFI_INVALID_PARAMETER GcdAllocateType is invalid.
274  @retval EFI_INVALID_PARAMETER GcdMemoryType is invalid.
275  @retval EFI_INVALID_PARAMETER Length is zero.
276  @retval EFI_INVALID_PARAMETER BaseAddress is NULL.
277  @retval EFI_INVALID_PARAMETER ImageHandle is NULL.
278  @retval EFI_NOT_FOUND The memory resource request could not be satisfied.
279  No descriptor contains the desired space.
280  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to allocate the memory
281  resource from the global coherency domain of the processor.
282  @retval EFI_SUCCESS The memory resource was allocated from the global coherency
283  domain of the processor.
284 
285 
286 **/
287 typedef
290  IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
291  IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
293  IN UINT64 Length,
295  IN EFI_HANDLE ImageHandle,
296  IN EFI_HANDLE DeviceHandle OPTIONAL
297  );
298 
299 /**
300  Frees nonexistent memory, reserved memory, system memory, or memory-mapped
301  I/O resources from the global coherency domain of the processor.
302 
303  @param BaseAddress The physical address that is the start address of the memory resource being freed.
304  @param Length The size in bytes of the memory resource range that is being freed.
305 
306  @retval EFI_SUCCESS The memory resource was freed from the global coherency domain of
307  the processor.
308  @retval EFI_INVALID_PARAMETER Length is zero.
309  @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
310  resource range specified by BaseAddress and Length.
311  @retval EFI_NOT_FOUND The memory resource range specified by BaseAddress and
312  Length was not allocated with previous calls to AllocateMemorySpace().
313  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to free the memory resource
314  from the global coherency domain of the processor.
315 
316 **/
317 typedef
322  );
323 
324 /**
325  Removes reserved memory, system memory, or memory-mapped I/O resources from
326  the global coherency domain of the processor.
327 
328  @param BaseAddress The physical address that is the start address of the memory resource being removed.
329  @param Length The size in bytes of the memory resource that is being removed.
330 
331  @retval EFI_SUCCESS The memory resource was removed from the global coherency
332  domain of the processor.
333  @retval EFI_INVALID_PARAMETER Length is zero.
334  @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
335  resource range specified by BaseAddress and Length.
336  @retval EFI_NOT_FOUND One or more bytes of the memory resource range specified by
337  BaseAddress and Length was not added with previous calls to
338  AddMemorySpace().
339  @retval EFI_ACCESS_DEFINED One or more bytes of the memory resource range specified by
340  BaseAddress and Length has been allocated with AllocateMemorySpace().
341  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to remove the memory
342  resource from the global coherency domain of the processor.
343 
344 **/
345 typedef
350  );
351 
352 /**
353  Retrieves the descriptor for a memory region containing a specified address.
354 
355  @param BaseAddress The physical address that is the start address of a memory region.
356  @param Descriptor A pointer to a caller allocated descriptor.
357 
358  @retval EFI_SUCCESS The descriptor for the memory resource region containing
359  BaseAddress was returned in Descriptor.
360  @retval EFI_INVALID_PARAMETER Descriptor is NULL.
361  @retval EFI_NOT_FOUND A memory resource range containing BaseAddress was not found.
362 
363 **/
364 typedef
369  );
370 
371 /**
372  Modifies the attributes for a memory region in the global coherency domain of the
373  processor.
374 
375  @param BaseAddress The physical address that is the start address of a memory region.
376  @param Length The size in bytes of the memory region.
377  @param Attributes The bit mask of attributes to set for the memory region.
378 
379  @retval EFI_SUCCESS The attributes were set for the memory region.
380  @retval EFI_INVALID_PARAMETER Length is zero.
381  @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
382  resource range specified by BaseAddress and Length.
383  @retval EFI_UNSUPPORTED The bit mask of attributes is not support for the memory resource
384  range specified by BaseAddress and Length.
385  @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
386  BaseAddress and Length cannot be modified.
387  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
388  the memory resource range.
389  @retval EFI_NOT_AVAILABLE_YET The attributes cannot be set because CPU architectural protocol is
390  not available yet.
391 **/
392 typedef
396  IN UINT64 Length,
397  IN UINT64 Attributes
398  );
399 
400 /**
401  Modifies the capabilities for a memory region in the global coherency domain of the
402  processor.
403 
404  @param BaseAddress The physical address that is the start address of a memory region.
405  @param Length The size in bytes of the memory region.
406  @param Capabilities The bit mask of capabilities that the memory region supports.
407 
408  @retval EFI_SUCCESS The capabilities were set for the memory region.
409  @retval EFI_INVALID_PARAMETER Length is zero.
410  @retval EFI_UNSUPPORTED The capabilities specified by Capabilities do not include the
411  memory region attributes currently in use.
412  @retval EFI_ACCESS_DENIED The capabilities for the memory resource range specified by
413  BaseAddress and Length cannot be modified.
414  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the capabilities
415  of the memory resource range.
416 **/
417 typedef
421  IN UINT64 Length,
422  IN UINT64 Capabilities
423  );
424 
425 /**
426  Returns a map of the memory resources in the global coherency domain of the
427  processor.
428 
429  @param NumberOfDescriptors A pointer to number of descriptors returned in the MemorySpaceMap buffer.
430  @param MemorySpaceMap A pointer to the array of EFI_GCD_MEMORY_SPACE_DESCRIPTORs.
431 
432  @retval EFI_SUCCESS The memory space map was returned in the MemorySpaceMap
433  buffer, and the number of descriptors in MemorySpaceMap was
434  returned in NumberOfDescriptors.
435  @retval EFI_INVALID_PARAMETER NumberOfDescriptors is NULL.
436  @retval EFI_INVALID_PARAMETER MemorySpaceMap is NULL.
437  @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate MemorySpaceMap.
438 
439 **/
440 typedef
443  OUT UINTN *NumberOfDescriptors,
444  OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap
445  );
446 
447 /**
448  Adds reserved I/O or I/O resources to the global coherency domain of the processor.
449 
450  @param GcdIoType The type of I/O resource being added.
451  @param BaseAddress The physical address that is the start address of the I/O resource being added.
452  @param Length The size in bytes of the I/O resource that is being added.
453 
454  @retval EFI_SUCCESS The I/O resource was added to the global coherency domain of
455  the processor.
456  @retval EFI_INVALID_PARAMETER GcdIoType is invalid.
457  @retval EFI_INVALID_PARAMETER Length is zero.
458  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to add the I/O resource to
459  the global coherency domain of the processor.
460  @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the I/O
461  resource range specified by BaseAddress and Length.
462  @retval EFI_ACCESS_DENIED One or more bytes of the I/O resource range specified by
463  BaseAddress and Length conflicts with an I/O resource
464  range that was previously added to the global coherency domain
465  of the processor.
466  @retval EFI_ACCESS_DENIED One or more bytes of the I/O resource range specified by
467  BaseAddress and Length was allocated in a prior call to
468  AllocateIoSpace().
469 
470 **/
471 typedef
474  IN EFI_GCD_IO_TYPE GcdIoType,
477  );
478 
479 /**
480  Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
481  domain of the processor.
482 
483  @param GcdAllocateType The type of allocation to perform.
484  @param GcdIoType The type of I/O resource being allocated.
485  @param Alignment The log base 2 of the boundary that BaseAddress must be aligned on output.
486  @param Length The size in bytes of the I/O resource range that is being allocated.
487  @param BaseAddress A pointer to a physical address.
488  @param Imagehandle The image handle of the agent that is allocating the I/O resource.
489  @param DeviceHandle The device handle for which the I/O resource is being allocated.
490 
491  @retval EFI_SUCCESS The I/O resource was allocated from the global coherency domain
492  of the processor.
493  @retval EFI_INVALID_PARAMETER GcdAllocateType is invalid.
494  @retval EFI_INVALID_PARAMETER GcdIoType is invalid.
495  @retval EFI_INVALID_PARAMETER Length is zero.
496  @retval EFI_INVALID_PARAMETER BaseAddress is NULL.
497  @retval EFI_INVALID_PARAMETER ImageHandle is NULL.
498  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to allocate the I/O
499  resource from the global coherency domain of the processor.
500  @retval EFI_NOT_FOUND The I/O resource request could not be satisfied.
501 
502 **/
503 typedef
506  IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
507  IN EFI_GCD_IO_TYPE GcdIoType,
509  IN UINT64 Length,
511  IN EFI_HANDLE ImageHandle,
512  IN EFI_HANDLE DeviceHandle OPTIONAL
513  );
514 
515 /**
516  Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
517  domain of the processor.
518 
519  @param BaseAddress The physical address that is the start address of the I/O resource being freed.
520  @param Length The size in bytes of the I/O resource range that is being freed.
521 
522  @retval EFI_SUCCESS The I/O resource was freed from the global coherency domain of the
523  processor.
524  @retval EFI_INVALID_PARAMETER Length is zero.
525  @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the I/O resource
526  range specified by BaseAddress and Length.
527  @retval EFI_NOT_FOUND The I/O resource range specified by BaseAddress and Length
528  was not allocated with previous calls to AllocateIoSpace().
529  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to free the I/O resource from
530  the global coherency domain of the processor.
531 
532 **/
533 typedef
538  );
539 
540 /**
541  Removes reserved I/O or I/O resources from the global coherency domain of the
542  processor.
543 
544  @param BaseAddress A pointer to a physical address that is the start address of the I/O resource being
545  removed.
546  @param Length The size in bytes of the I/O resource that is being removed.
547 
548  @retval EFI_SUCCESS The I/O resource was removed from the global coherency domain
549  of the processor.
550  @retval EFI_INVALID_PARAMETER Length is zero.
551  @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the I/O
552  resource range specified by BaseAddress and Length.
553  @retval EFI_NOT_FOUND One or more bytes of the I/O resource range specified by
554  BaseAddress and Length was not added with previous
555  calls to AddIoSpace().
556  @retval EFI_ACCESS_DENIED One or more bytes of the I/O resource range specified by
557  BaseAddress and Length has been allocated with
558  AllocateIoSpace().
559  @retval EFI_OUT_OF_RESOURCES There are not enough system resources to remove the I/O
560  resource from the global coherency domain of the processor.
561 
562 **/
563 typedef
568  );
569 
570 /**
571  Retrieves the descriptor for an I/O region containing a specified address.
572 
573  @param BaseAddress The physical address that is the start address of an I/O region.
574  @param Descriptor A pointer to a caller allocated descriptor.
575 
576  @retval EFI_SUCCESS The descriptor for the I/O resource region containing
577  BaseAddress was returned in Descriptor.
578  @retval EFI_INVALID_PARAMETER Descriptor is NULL.
579  @retval EFI_NOT_FOUND An I/O resource range containing BaseAddress was not found.
580 
581 **/
582 typedef
586  OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor
587  );
588 
589 /**
590  Returns a map of the I/O resources in the global coherency domain of the processor.
591 
592  @param NumberOfDescriptors A pointer to number of descriptors returned in the IoSpaceMap buffer.
593  @param MemorySpaceMap A pointer to the array of EFI_GCD_IO_SPACE_DESCRIPTORs.
594 
595  @retval EFI_SUCCESS The I/O space map was returned in the IoSpaceMap buffer, and
596  the number of descriptors in IoSpaceMap was returned in
597  NumberOfDescriptors.
598  @retval EFI_INVALID_PARAMETER NumberOfDescriptors is NULL.
599  @retval EFI_INVALID_PARAMETER IoSpaceMap is NULL.
600  @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate IoSpaceMap.
601 
602 
603 **/
604 typedef
607  OUT UINTN *NumberOfDescriptors,
608  OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap
609  );
610 
611 /**
612  Loads and executed DXE drivers from firmware volumes.
613 
614  The Dispatch() function searches for DXE drivers in firmware volumes that have been
615  installed since the last time the Dispatch() service was called. It then evaluates
616  the dependency expressions of all the DXE drivers and loads and executes those DXE
617  drivers whose dependency expression evaluate to TRUE. This service must interact with
618  the Security Architectural Protocol to authenticate DXE drivers before they are executed.
619  This process is continued until no more DXE drivers can be executed.
620 
621  @retval EFI_SUCCESS One or more DXE driver were dispatched.
622  @retval EFI_NOT_FOUND No DXE drivers were dispatched.
623  @retval EFI_ALREADY_STARTED An attempt is being made to start the DXE Dispatcher recursively.
624  Thus, no action was taken.
625 
626 **/
627 typedef
630  VOID
631  );
632 
633 /**
634  Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume.
635 
636  @param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.
637  @param FileName A pointer to the name of the file in a firmware volume.
638 
639  @retval EFI_SUCCESS The DXE driver was found and its SOR bit was cleared.
640  @retval EFI_NOT_FOUND The DXE driver does not exist, or the DXE driver exists and its SOR
641  bit is not set.
642 
643 **/
644 typedef
647  IN EFI_HANDLE FirmwareVolumeHandle,
649  );
650 
651 /**
652  Promotes a file stored in a firmware volume from the untrusted to the trusted state.
653 
654  @param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.
655  @param DriverName A pointer to the name of the file in a firmware volume.
656 
657  @return Status of promoting FFS from untrusted to trusted
658  state.
659  @retval EFI_NOT_FOUND The file was not found in the untrusted state.
660 
661 **/
662 typedef
665  IN EFI_HANDLE FirmwareVolumeHandle,
667  );
668 
669 /**
670  Creates a firmware volume handle for a firmware volume that is present in system memory.
671 
672  @param FirmwareVolumeHeader A pointer to the header of the firmware volume.
673  @param Size The size, in bytes, of the firmware volume.
674  @param FirmwareVolumeHandle On output, a pointer to the created handle.
675 
676  @retval EFI_SUCCESS The EFI_FIRMWARE_VOLUME_PROTOCOL and
677  EFI_DEVICE_PATH_PROTOCOL were installed onto
678  FirmwareVolumeHandle for the firmware volume described
679  by FirmwareVolumeHeader and Size.
680  @retval EFI_VOLUME_CORRUPTED The firmware volume described by FirmwareVolumeHeader
681  and Size is corrupted.
682  @retval EFI_OUT_OF_RESOURCES There are not enough system resources available to produce the
683  EFI_FIRMWARE_VOLUME_PROTOCOL and EFI_DEVICE_PATH_PROTOCOL
684  for the firmware volume described by FirmwareVolumeHeader and Size.
685 
686 **/
687 typedef
690  IN CONST VOID *FirmwareVolumeHeader,
691  IN UINTN Size,
692  OUT EFI_HANDLE *FirmwareVolumeHandle
693  );
694 
695 //
696 // DXE Services Table
697 //
698 #define DXE_SERVICES_SIGNATURE 0x565245535f455844ULL
699 #define DXE_SPECIFICATION_MAJOR_REVISION 1
700 #define DXE_SPECIFICATION_MINOR_REVISION 70
701 #define DXE_SERVICES_REVISION ((DXE_SPECIFICATION_MAJOR_REVISION<<16) | (DXE_SPECIFICATION_MINOR_REVISION))
702 
703 typedef struct {
704  ///
705  /// The table header for the DXE Services Table.
706  /// This header contains the DXE_SERVICES_SIGNATURE and DXE_SERVICES_REVISION values.
707  ///
709 
710  //
711  // Global Coherency Domain Services
712  //
726 
727  //
728  // Dispatcher Services
729  //
733  //
734  // Service to process a single firmware volume found in a capsule
735  //
737  //
738  // Extensions to Global Coherency Domain Services
739  //
741 } DXE_SERVICES;
742 
744 
745 #endif
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:292
UINT8 Alignment
Definition: Acpi10.h:185
EFI_GCD_MEMORY_TYPE
Global Coherencey Domain types - Memory type.
Definition: PiDxeCis.h:23
EFI_STATUS(EFIAPI * EFI_SET_MEMORY_SPACE_CAPABILITIES)(IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Capabilities)
Modifies the capabilities for a memory region in the global coherency domain of the processor.
Definition: PiDxeCis.h:419
UINT64 Capabilities
The bit mask of attributes that the memory region is capable of supporting.
Definition: PiDxeCis.h:147
EFI_TRUST Trust
Definition: PiDxeCis.h:732
EFI_GET_IO_SPACE_MAP GetIoSpaceMap
Definition: PiDxeCis.h:725
128 bit buffer containing a unique identifier value.
Definition: Base.h:215
A memory region that provides higher reliability relative to other memory in the system.
Definition: PiDxeCis.h:60
EFI_STATUS(EFIAPI * EFI_DISPATCH)(VOID)
Loads and executed DXE drivers from firmware volumes.
Definition: PiDxeCis.h:629
EFI_HANDLE DeviceHandle
The device handle for which the I/O resource has been allocated.
Definition: PiDxeCis.h:214
FILE_LICENCE(BSD2_PATENT)
EFI_STATUS(EFIAPI * EFI_ADD_MEMORY_SPACE)(IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Capabilities)
Adds reserved memory, system memory, or memory-mapped I/O resources to the global coherency domain of...
Definition: PiDxeCis.h:250
An I/O region that is visible to the boot processor.
Definition: PiDxeCis.h:85
EFI_GCD_MEMORY_TYPE GcdMemoryType
Type of the memory region.
Definition: PiDxeCis.h:157
A memory region that is visible to the boot processor.
Definition: PiDxeCis.h:40
UINT8 Length
Definition: Acpi10.h:134
EFI_SCHEDULE Schedule
Definition: PiDxeCis.h:731
An I/O region that is visible to the boot processor.
Definition: PiDxeCis.h:90
The GCD memory space map is searched from the lowest address up to the highest address looking for un...
Definition: PiDxeCis.h:102
A memory region that is visible to the boot processor.
Definition: PiDxeCis.h:34
EFI_STATUS(EFIAPI * EFI_TRUST)(IN EFI_HANDLE FirmwareVolumeHandle, IN CONST EFI_GUID *FileName)
Promotes a file stored in a firmware volume from the untrusted to the trusted state.
Definition: PiDxeCis.h:664
EFI_FREE_MEMORY_SPACE FreeMemorySpace
Definition: PiDxeCis.h:715
EFI_STATUS(EFIAPI * EFI_REMOVE_IO_SPACE)(IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
Removes reserved I/O or I/O resources from the global coherency domain of the processor.
Definition: PiDxeCis.h:565
EFI_STATUS(EFIAPI * EFI_GET_MEMORY_SPACE_MAP)(OUT UINTN *NumberOfDescriptors, OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap)
Returns a map of the memory resources in the global coherency domain of the processor.
Definition: PiDxeCis.h:442
EFI_GET_MEMORY_SPACE_DESCRIPTOR GetMemorySpaceDescriptor
Definition: PiDxeCis.h:717
EFI_STATUS(EFIAPI * EFI_GET_MEMORY_SPACE_DESCRIPTOR)(IN EFI_PHYSICAL_ADDRESS BaseAddress, OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor)
Retrieves the descriptor for a memory region containing a specified address.
Definition: PiDxeCis.h:366
UINT64 EFI_PHYSICAL_ADDRESS
64-bit physical memory address.
Definition: UefiBaseType.h:52
The GCD memory space map is searched from the highest address down to the lowest address looking for ...
Definition: PiDxeCis.h:117
EFI_GET_IO_SPACE_DESCRIPTOR GetIoSpaceDescriptor
Definition: PiDxeCis.h:724
EFI_TABLE_HEADER Hdr
The table header for the DXE Services Table.
Definition: PiDxeCis.h:708
The GCD memory space map is checked to see if the memory range starting at the specified Address is a...
Definition: PiDxeCis.h:112
UINT16_t Size
Size of structure.
Definition: pxe_api.h:58
EFI_STATUS(EFIAPI * EFI_ALLOCATE_MEMORY_SPACE)(IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN UINTN Alignment, IN UINT64 Length, IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE DeviceHandle OPTIONAL)
Allocates nonexistent memory, reserved memory, system memory, or memorymapped I/O resources from the ...
Definition: PiDxeCis.h:289
EFI_REMOVE_IO_SPACE RemoveIoSpace
Definition: PiDxeCis.h:723
EFI_FREE_IO_SPACE FreeIoSpace
Definition: PiDxeCis.h:722
EFI_PHYSICAL_ADDRESS BaseAddress
Physical address of the first byte in the I/O region.
Definition: PiDxeCis.h:186
#define OUT
Definition: mlx_utils.h:29
EFI_GCD_MEMORY_SPACE_DESCRIPTOR.
Definition: PiDxeCis.h:129
EFI_GCD_IO_TYPE GcdIoType
Type of the I/O region.
Definition: PiDxeCis.h:197
EFI_SET_MEMORY_SPACE_CAPABILITIES SetMemorySpaceCapabilities
Definition: PiDxeCis.h:740
UINT8_t FileName[128]
File name.
Definition: pxe_api.h:60
EFI_STATUS(EFIAPI * EFI_ALLOCATE_IO_SPACE)(IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_IO_TYPE GcdIoType, IN UINTN Alignment, IN UINT64 Length, IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE DeviceHandle OPTIONAL)
Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency domain of the pro...
Definition: PiDxeCis.h:505
EFI_HANDLE ImageHandle
The image handle of the agent that allocated the memory resource described by PhysicalStart and Numbe...
Definition: PiDxeCis.h:165
EFI_GCD_IO_SPACE_DESCRIPTOR.
Definition: PiDxeCis.h:180
EFI_HANDLE ImageHandle
The image handle of the agent that allocated the I/O resource described by PhysicalStart and NumberOf...
Definition: PiDxeCis.h:205
A memory region that is visible to the boot processor.
Definition: PiDxeCis.h:46
EFI_PHYSICAL_ADDRESS BaseAddress
The physical address of the first byte in the memory region.
Definition: PiDxeCis.h:135
Include file matches things in PI for multiple module types.
EFI_SET_MEMORY_SPACE_ATTRIBUTES SetMemorySpaceAttributes
Definition: PiDxeCis.h:718
EFI_STATUS(EFIAPI * EFI_PROCESS_FIRMWARE_VOLUME)(IN CONST VOID *FirmwareVolumeHeader, IN UINTN Size, OUT EFI_HANDLE *FirmwareVolumeHandle)
Creates a firmware volume handle for a firmware volume that is present in system memory.
Definition: PiDxeCis.h:689
#define EFIAPI
An I/O region that is visible to the boot processor.
Definition: PiDxeCis.h:80
UINT64 Attributes
The bit mask of attributes that the memory region is currently using.
Definition: PiDxeCis.h:152
This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.
EFI_STATUS(EFIAPI * EFI_FREE_IO_SPACE)(IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency domain of the process...
Definition: PiDxeCis.h:535
EFI_REMOVE_MEMORY_SPACE RemoveMemorySpace
Definition: PiDxeCis.h:716
EFI_ALLOCATE_IO_SPACE AllocateIoSpace
Definition: PiDxeCis.h:721
EFI_GET_MEMORY_SPACE_MAP GetMemorySpaceMap
Definition: PiDxeCis.h:719
EFI_GCD_IO_TYPE
Global Coherencey Domain types - IO type.
Definition: PiDxeCis.h:75
EFI_ADD_IO_SPACE AddIoSpace
Definition: PiDxeCis.h:720
UINT64 UINTN
Unsigned value of native width.
A memory region that is visible to the boot processor.
Definition: PiDxeCis.h:28
The GCD memory space map is searched from the specified MaxAddress down to the lowest address looking...
Definition: PiDxeCis.h:122
#define VOID
Undeclared type.
Definition: Base.h:271
unsigned long long UINT64
Definition: ProcessorBind.h:96
EFI_STATUS(EFIAPI * EFI_GET_IO_SPACE_MAP)(OUT UINTN *NumberOfDescriptors, OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap)
Returns a map of the I/O resources in the global coherency domain of the processor.
Definition: PiDxeCis.h:606
#define IN
Definition: mlx_utils.h:28
UINT64 Length
The number of bytes in the memory region.
Definition: PiDxeCis.h:140
EFI_STATUS(EFIAPI * EFI_SCHEDULE)(IN EFI_HANDLE FirmwareVolumeHandle, IN CONST EFI_GUID *FileName)
Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume.
Definition: PiDxeCis.h:646
EFI_STATUS(EFIAPI * EFI_REMOVE_MEMORY_SPACE)(IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
Removes reserved memory, system memory, or memory-mapped I/O resources from the global coherency doma...
Definition: PiDxeCis.h:347
The GCD memory space map is searched from the lowest address up to the specified MaxAddress looking f...
Definition: PiDxeCis.h:107
UINT16 BaseAddress
Definition: Acpi10.h:194
#define CONST
Datum is read-only.
Definition: Base.h:261
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:31
EFI_HANDLE DeviceHandle
The device handle for which the memory resource has been allocated.
Definition: PiDxeCis.h:174
A memory region that is visible to the boot processor.
Definition: PiDxeCis.h:51
Data structure that precedes all of the standard EFI table types.
EFI_PROCESS_FIRMWARE_VOLUME ProcessFirmwareVolume
Definition: PiDxeCis.h:736
EFI_STATUS(EFIAPI * EFI_FREE_MEMORY_SPACE)(IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
Frees nonexistent memory, reserved memory, system memory, or memory-mapped I/O resources from the glo...
Definition: PiDxeCis.h:319
EFI_STATUS(EFIAPI * EFI_GET_IO_SPACE_DESCRIPTOR)(IN EFI_PHYSICAL_ADDRESS BaseAddress, OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor)
Retrieves the descriptor for an I/O region containing a specified address.
Definition: PiDxeCis.h:584
EFI_DISPATCH Dispatch
Definition: PiDxeCis.h:730
EFI_GCD_ALLOCATE_TYPE
The type of allocation to perform.
Definition: PiDxeCis.h:97
DXE_SERVICES EFI_DXE_SERVICES
Definition: PiDxeCis.h:743
EFI_ADD_MEMORY_SPACE AddMemorySpace
Definition: PiDxeCis.h:713
UINT64 Length
Number of bytes in the I/O region.
Definition: PiDxeCis.h:191
EFI_STATUS(EFIAPI * EFI_SET_MEMORY_SPACE_ATTRIBUTES)(IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)
Modifies the attributes for a memory region in the global coherency domain of the processor.
Definition: PiDxeCis.h:394
Definition: efi.h:59
EFI_ALLOCATE_MEMORY_SPACE AllocateMemorySpace
Definition: PiDxeCis.h:714
EFI_STATUS(EFIAPI * EFI_ADD_IO_SPACE)(IN EFI_GCD_IO_TYPE GcdIoType, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
Adds reserved I/O or I/O resources to the global coherency domain of the processor.
Definition: PiDxeCis.h:473