4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Master header file for DxeIpl PEIM. All source files in this module should
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync include this file for common definitions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This PPI is installed to indicate the end of the PEI usage of memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Searches DxeCore in all firmware Volumes and loads the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance that contains DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return FileHandle of DxeCore to load DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Main entry point to last PEIM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Entry point for DXE IPL PPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PeiServices General purpose services available to every PEIM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HobList Address to the Pei HOB list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return EFI_SUCCESS DXE core was successfully loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transfers control to DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function performs a CPU architecture specific operations to execute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the entry point of DxeCore with the parameters of HobList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DxeCoreEntryPoint The entry point of DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HobList The start of HobList passed to DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Updates the Stack HOB passed to DXE phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function traverses the whole HOB list and update the stack HOB to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflect the real stack that is used by DXE core.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The lower address of stack used by DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The length of stack used by DxeCore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ExtractSection() function processes the input section and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns a pointer to the section contents. If the section being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync extracted does not require processing (if the section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GuidedSectionHeader.Attributes has the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutputBuffer is just updated to point to the start of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section's contents. Otherwise, *Buffer must be allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from PEI permanent memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer containing the input GUIDed section to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync processed. OutputBuffer OutputBuffer is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated from PEI permanent memory and contains
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the new section stream.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InputSection A pointer to the input buffer, which contains
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the input section to be processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OutputBuffer A pointer to a caller-allocated buffer, whose
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size is specified by the contents of OutputSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OutputSize A pointer to a caller-allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN in which the size of *OutputBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocation is stored. If the function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns anything other than EFI_SUCCESS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the value of OutputSize is undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AuthenticationStatus A pointer to a caller-allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 that indicates the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync authentication status of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync output buffer. If the input
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section's GuidedSectionHeader.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attributes field has the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUIDED_SECTION_AUTH_STATUS_VALID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bit as clear,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AuthenticationStatus must return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync zero. These bits reflect the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync status of the extraction
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operation. If the function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns anything other than
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS, the value of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AuthenticationStatus is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The InputSection was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully processed and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section contents were returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The system has insufficient
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resources to process the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The GUID in InputSection does
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not match this instance of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GUIDed Section Extraction PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Decompresses a section to the output buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function looks up the compression type field in the input section and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync applies the appropriate compression algorithm to compress the section to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync callee allocated buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Points to this instance of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_DECOMPRESS_PEI PPI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CompressionSection Points to the compressed section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OutputBuffer Holds the returned pointer to the decompressed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OutputSize Holds the returned size of the decompress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section streams.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The section was decompressed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutputBuffer contains the resulting data and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutputSize contains the resulting size.