+++ /dev/null
-/** @file\r
- This file declares Section Extraction PPI.\r
-\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
- Module Name: SectionExtraction.h\r
-\r
- @par Revision Reference:\r
- This PPI is defined in PEI CIS.\r
- Version 0.91.\r
-\r
-**/\r
-\r
-#ifndef __SECTION_EXTRACTION_PPI_H__\r
-#define __SECTION_EXTRACTION_PPI_H__\r
-\r
-#define EFI_PEI_SECTION_EXTRACTION_PPI_GUID \\r
- { \\r
- 0x4F89E208, 0xE144, 0x4804, {0x9E, 0xC8, 0x0F, 0x89, 0x4F, 0x7E, 0x36, 0xD7 } \\r
- }\r
-\r
-typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;\r
-\r
-//\r
-// Bit values for AuthenticationStatus\r
-//\r
-#define EFI_PEI_AUTH_STATUS_PLATFORM_OVERRIDE 0x01\r
-#define EFI_PEI_AUTH_STATUS_IMAGE_SIGNED 0x02\r
-#define EFI_PEI_AUTH_STATUS_NOT_TESTED 0x04\r
-#define EFI_PEI_AUTH_STATUS_TEST_FAILED 0x08\r
-\r
-/**\r
- The function is used to retrieve a section from within a section file.\r
- It will retrieve both encapsulation sections and leaf sections in their entirety,\r
- exclusive of the section header.\r
-\r
- @param PeiServices Pointer to the PEI Services Table.\r
- @param This Indicates the calling context\r
- @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,\r
- the contents of the entire section are returned in Buffer. If SectionType\r
- is not NULL, only the requested section is returned.\r
- @param SectionDefinitionGuid \r
- Pointer to an EFI_GUID.\r
- If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
- indicates for which section GUID to search.\r
- If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
- is unused and is ignored.\r
- @param SectionInstance If SectionType is not NULL, indicates which\r
- instance of the requested section type to return.\r
- @param Buffer Pointer to a pointer to a buffer in which the section\r
- contents are returned.\r
- @param BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize\r
- indicates the size in bytes of the memory region pointed to by Buffer.On output,\r
- *BufferSize contains the number of bytes required to read the section.\r
- @param AuthenticationStatus \r
- A pointer to a caller-allocated UINT32 in\r
- which any metadata from encapsulating GUID-defined sections is returned.\r
-\r
- @retval EFI_SUCCESS The section was successfully processed and the section\r
- contents were returned in Buffer.\r
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in\r
- the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but\r
- there was no corresponding GUIDed Section Extraction Protocol in the\r
- handle database.*Buffer is unmodified.\r
- @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.\r
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.\r
- @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
- @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to\r
- contain the requested section. The input buffer is filled and contents are\r
- section contents are truncated.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_PEI_GET_SECTION) (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_PEI_SECTION_EXTRACTION_PPI *This,\r
- IN EFI_SECTION_TYPE *SectionType,\r
- IN EFI_GUID *SectionDefinitionGuid, OPTIONAL\r
- IN UINTN SectionInstance,\r
- IN VOID **Buffer,\r
- IN OUT UINT32 *BufferSize,\r
- OUT UINT32 *AuthenticationStatus\r
- );\r
-\r
-/**\r
- @par Ppi Description:\r
- This PPI supports encapsulating sections, such as GUIDed sections used to \r
- authenticate the file encapsulation of other domain-specific wrapping.\r
-\r
- @param GetSection\r
- Retrieves a section from within a section file.\r
-\r
-**/\r
-struct _EFI_PEI_SECTION_EXTRACTION_PPI {\r
- EFI_PEI_GET_SECTION PeiGetSection;\r
-};\r
-\r
-extern EFI_GUID gEfiPeiSectionExtractionPpiGuid;\r
-\r
-#endif\r