FvLib.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2004 - 2008, 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.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncModule Name:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync These functions assist in parsing and manipulating a Firmware Volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Include files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// will not parse compressed sections
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Verify the current pointer points to a FFS file header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FfsHeader Pointer to an alleged FFS file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS The Ffs header is valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND This "file" is the beginning of free space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_VOLUME_CORRUPTED The Ffs header is not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a three byte length value into a UINT32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ThreeByteLength Pointer to the first of the 3 byte length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Size of the section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns with the FV erase polarity. If the erase polarity
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for a bit is 1, the function return TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ErasePolarity A pointer to the erase polarity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER One of the input parameters was invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRoutine Description:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns a the highest state bit in the FFS that is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It in no way validate the FFS file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ErasePolarity The erase polarity for the file state bits.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FfsHeader Pointer to a FFS file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 The hightest set state of the file.