4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Implements functions to read firmware file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, 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.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRequired Alignment Alignment Value in FFS Alignment Value in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(bytes) Attributes Field Firmware Volume Interfaces
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUINT8 mFvAttributes[] = {0, 4, 7, 9, 10, 12, 15, 16};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert the FFS File Attributes to FV File Attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FfsAttributes The attributes of UINT8 type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The attributes of EFI_FV_FILE_ATTRIBUTES
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataAlignment = (UINT8) ((FfsAttributes & FFS_ATTRIB_DATA_ALIGNMENT) >> 3);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileAttribute = (EFI_FV_FILE_ATTRIBUTES) mFvAttributes[DataAlignment];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((FfsAttributes & FFS_ATTRIB_FIXED) == FFS_ATTRIB_FIXED) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Given the input key, search for the next matching file in the volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Key Key is a pointer to a caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer that contains implementation specific
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data that is used to track where to begin
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the search for the next file. The size of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer must be at least This->KeySize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bytes long. To reinitialize the search and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync begin from the beginning of the firmware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync volume, the entire buffer must be cleared to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync zero. Other than clearing the buffer to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync initiate a new search, the caller must not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync modify the data in the buffer between calls
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to GetNextFile().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileType FileType is a pointer to a caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FV_FILETYPE. The GetNextFile() API can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filter it's search for files based on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value of *FileType input. A *FileType input
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of 0 causes GetNextFile() to search for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync files of all types. If a file is found, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file's type is returned in *FileType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileType is not modified if no file is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NameGuid NameGuid is a pointer to a caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUID. If a file is found, the file's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name is returned in *NameGuid. *NameGuid is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not modified if no file is found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes Attributes is a pointer to a caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated EFI_FV_FILE_ATTRIBUTES. If a file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is found, the file's attributes are returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in *Attributes. *Attributes is not modified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if no file is found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size Size is a pointer to a caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN. If a file is found, the file's size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned in *Size. *Size is not modified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if no file is found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully find the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Fv could not read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No matching file found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Invalid parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = FvGetVolumeAttributes (This, &FvAttributes);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if read operation is enabled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // File type needs to be in 0 - 0x0D
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*KeyValue == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search for 1st matching file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Key is pointer to FFsFileEntry, so get next one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Link->ForwardLink == &FvDevice->FfsFileListHeader) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Next is end of list so we did not find data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FfsFileEntry = (FFS_FILE_LIST_ENTRY *)Link->ForwardLink;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FfsFileHeader = (EFI_FFS_FILE_HEADER *)FfsFileEntry->FfsHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // remember the key
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FfsFileHeader->Type == EFI_FV_FILETYPE_FFS_PAD) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we ignore pad files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Process all file types so we have a match
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Found a matching file type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return FileType, NameGuid, and Attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Attributes = FfsAttributes2FvFileAttributes (FfsFileHeader->Attributes);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((FvDevice->FwVolHeader->Attributes & EFI_FVB2_MEMORY_MAPPED) == EFI_FVB2_MEMORY_MAPPED) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we need to substract the header size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Size = FFS_FILE2_SIZE (FfsFileHeader) - sizeof (EFI_FFS_FILE_HEADER2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Size = FFS_FILE_SIZE (FfsFileHeader) - sizeof (EFI_FFS_FILE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Locates a file in the firmware volume and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync copies it to the supplied buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NameGuid Pointer to an EFI_GUID, which is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Buffer is a pointer to pointer to a buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in which the file or section contents or are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize BufferSize is a pointer to caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN. On input *BufferSize indicates the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size in bytes of the memory region pointed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to by Buffer. On output, *BufferSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the number of bytes required to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync read the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FoundType FoundType is a pointer to a caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FV_FILETYPE that on successful return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from Read() contains the type of file read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This output reflects the file type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync irrespective of the value of the SectionType
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileAttributes FileAttributes is a pointer to a caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated EFI_FV_FILE_ATTRIBUTES. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successful return from Read(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileAttributes contains the attributes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the file read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AuthenticationStatus AuthenticationStatus is a pointer to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller allocated UINTN in which the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync authentication status is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully read to memory buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Could not read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Invalid parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Keep looking until we find the matching NameGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The Key is really an FfsFileEntry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } while (!CompareGuid (&SearchNameGuid, NameGuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get a pointer to the header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Remember callers buffer size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Calculate return values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileAttributes = FfsAttributes2FvFileAttributes (FfsHeader->Attributes);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((FvDevice->FwVolHeader->Attributes & EFI_FVB2_MEMORY_MAPPED) == EFI_FVB2_MEMORY_MAPPED) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileAttributes |= EFI_FV_FILE_ATTRIB_MEMORY_MAPPED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Buffer is NULL, we only want to get the information collected so far
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Skip over file header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SrcPtr = ((UINT8 *) FfsHeader) + sizeof (EFI_FFS_FILE_HEADER2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SrcPtr = ((UINT8 *) FfsHeader) + sizeof (EFI_FFS_FILE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Caller passed in a pointer so allocate buffer for them
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Callers buffer was not big enough
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy data into callers buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Locates a section in a given FFS File and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync copies it to the supplied buffer (not including section header).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NameGuid Pointer to an EFI_GUID, which is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType Indicates the section type to return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionInstance Indicates which instance of sections with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync type of SectionType to return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Buffer is a pointer to pointer to a buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in which the file or section contents or are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize BufferSize is a pointer to caller allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AuthenticationStatus AuthenticationStatus is a pointer to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller allocated UINT32 in which the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync authentication status is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully read the file section into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Section not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Could not read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Invalid parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Read the whole file into buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the last key used by our call to FvReadFile as it is the FfsEntry for this file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FfsEntry = (FFS_FILE_LIST_ENTRY *) FvDevice->LastKey;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check to see that the file actually HAS sections before we go any further.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use FfsEntry to cache Section Extraction Protocol Information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If SectionType == 0 We need the whole section stream
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Close of stream defered to close of FfsHeader list to allow SEP to cache data