3 Copyright (c) 2004, 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 These functions assist in parsing and manipulating a Firmware Volume.
30 #include <Common/UefiBaseTypes.h>
31 #include <Common/EfiImage.h>
32 #include <Common/FirmwareVolumeImageFormat.h>
33 #include <Common/FirmwareFileSystem.h>
34 #include <Common/FirmwareVolumeHeader.h>
35 #include <Common/MultiPhase.h>
46 OUT EFI_FIRMWARE_VOLUME_HEADER
**FvHeader
,
53 IN EFI_FFS_FILE_HEADER
*CurrentFile
,
54 OUT EFI_FFS_FILE_HEADER
**NextFile
60 IN EFI_GUID
*FileName
,
61 OUT EFI_FFS_FILE_HEADER
**File
67 IN EFI_FV_FILETYPE FileType
,
69 OUT EFI_FFS_FILE_HEADER
**File
75 IN EFI_FFS_FILE_HEADER
*File
,
76 IN EFI_SECTION_TYPE SectionType
,
78 OUT EFI_FILE_SECTION_POINTER
*Section
82 // will not parse compressed sections
86 IN EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
92 IN EFI_FFS_FILE_HEADER
*FfsHeader
100 Verify the current pointer points to a FFS file header.
104 FfsHeader Pointer to an alleged FFS file.
108 EFI_SUCCESS The Ffs header is valid.
109 EFI_NOT_FOUND This "file" is the beginning of free space.
110 EFI_VOLUME_CORRUPTED The Ffs header is not valid.
115 UINT8
*ThreeByteLength
123 Converts a three byte length value into a UINT32.
127 ThreeByteLength Pointer to the first of the 3 byte length.
131 UINT32 Size of the section
136 OUT BOOLEAN
*ErasePolarity
144 This function returns with the FV erase polarity. If the erase polarity
145 for a bit is 1, the function return TRUE.
149 ErasePolarity A pointer to the erase polarity.
153 EFI_SUCCESS The function completed successfully.
154 EFI_INVALID_PARAMETER One of the input parameters was invalid.
159 IN BOOLEAN ErasePolarity
,
160 IN EFI_FFS_FILE_HEADER
*FfsHeader
168 This function returns a the highest state bit in the FFS that is set.
169 It in no way validate the FFS file.
173 ErasePolarity The erase polarity for the file state bits.
174 FfsHeader Pointer to a FFS file.
178 UINT8 The hightest set state of the file.