3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Header file for Crc32SectionExtract.c
19 Please refer to the Framewokr Firmware Volume Specification 0.9.
23 #ifndef _CRC32_GUIDED_SECTION_EXTRACTION_H
24 #define _CRC32_GUIDED_SECTION_EXTRACTION_H
27 // The package level header files this module uses
30 #include <Common/FrameworkFirmwareVolumeImageFormat.h>
32 // The protocols, PPI and GUID defintions for this module
34 #include <Protocol/SecurityPolicy.h>
35 #include <Protocol/GuidedSectionExtaction.h>
36 #include <Protocol/Crc32GuidedSectionExtraction.h>
38 // The Library classes this module consumes
40 #include <Library/MemoryAllocationLib.h>
41 #include <Library/DebugLib.h>
42 #include <Library/UefiDriverEntryPoint.h>
43 #include <Library/BaseMemoryLib.h>
44 #include <Library/UefiBootServicesTableLib.h>
47 EFI_GUID_DEFINED_SECTION GuidedSectionHeader
;
49 } CRC32_SECTION_HEADER
;
52 // Function prototype declarations
58 IN EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL
*This
,
59 IN VOID
*InputSection
,
60 OUT VOID
**OutputBuffer
,
61 OUT UINTN
*OutputSize
,
62 OUT UINT32
*AuthenticationStatus
68 TODO: Add function description
72 This - TODO: add argument description
73 InputSection - TODO: add argument description
74 OutputBuffer - TODO: add argument description
75 OutputSize - TODO: add argument description
76 AuthenticationStatus - TODO: add argument description
80 TODO: add return values
87 InitializeCrc32GuidedSectionExtractionProtocol (
88 IN EFI_HANDLE ImageHandle
,
89 IN EFI_SYSTEM_TABLE
*SystemTable
95 Entry point of the CRC32 GUIDed section extraction protocol.
96 Creates and initializes an instance of the GUIDed section
97 extraction protocol with CRC32 GUID.
101 ImageHandle EFI_HANDLE: A handle for the image that is initializing
103 SystemTable EFI_SYSTEM_TABLE: A pointer to the EFI system table
107 EFI_SUCCESS: Driver initialized successfully
108 EFI_LOAD_ERROR: Failed to Initialize or has been loaded
109 EFI_OUT_OF_RESOURCES: Could not allocate needed resources