3 Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>
4 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.
28 #include "TianoCommon.h"
29 #include "EfiFirmwareVolumeHeader.h"
30 #include "EfiFirmwareFileSystem.h"
41 OUT EFI_FIRMWARE_VOLUME_HEADER
**FvHeader
,
47 IN EFI_FFS_FILE_HEADER
*CurrentFile
,
48 OUT EFI_FFS_FILE_HEADER
**NextFile
53 IN EFI_GUID
*FileName
,
54 OUT EFI_FFS_FILE_HEADER
**File
59 IN EFI_FV_FILETYPE FileType
,
61 OUT EFI_FFS_FILE_HEADER
**File
66 IN EFI_FFS_FILE_HEADER
*File
,
67 IN EFI_SECTION_TYPE SectionType
,
69 OUT EFI_FILE_SECTION_POINTER
*Section
72 // will not parse compressed sections
76 IN EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
81 IN EFI_FFS_FILE_HEADER
*FfsHeader
88 Verify the current pointer points to a FFS file header.
92 FfsHeader Pointer to an alleged FFS file.
96 EFI_SUCCESS The Ffs header is valid.
97 EFI_NOT_FOUND This "file" is the beginning of free space.
98 EFI_VOLUME_CORRUPTED The Ffs header is not valid.
103 UINT8
*ThreeByteLength
110 Converts a three byte length value into a UINT32.
114 ThreeByteLength Pointer to the first of the 3 byte length.
118 UINT32 Size of the section
123 OUT BOOLEAN
*ErasePolarity
130 This function returns with the FV erase polarity. If the erase polarity
131 for a bit is 1, the function return TRUE.
135 ErasePolarity A pointer to the erase polarity.
139 EFI_SUCCESS The function completed successfully.
140 EFI_INVALID_PARAMETER One of the input parameters was invalid.
145 IN BOOLEAN ErasePolarity
,
146 IN EFI_FFS_FILE_HEADER
*FfsHeader
153 This function returns a the highest state bit in the FFS that is set.
154 It in no way validate the FFS file.
158 ErasePolarity The erase polarity for the file state bits.
159 FfsHeader Pointer to a FFS file.
163 UINT8 The hightest set state of the file.