FwVolRead.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Implements functions to read firmware file.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions
of the BSD License which accompanies this distribution. The
full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "FwVolDriver.h"
/**
Required Alignment Alignment Value in FFS Alignment Value in
(bytes) Attributes Field Firmware Volume Interfaces
1 0 0
16 1 4
128 2 7
512 3 9
1 KB 4 10
4 KB 5 12
32 KB 6 15
64 KB 7 16
**/
/**
Convert the FFS File Attributes to FV File Attributes.
@param FfsAttributes The attributes of UINT8 type.
@return The attributes of EFI_FV_FILE_ATTRIBUTES
**/
)
{
}
return FileAttribute;
}
/**
Given the input key, search for the next matching file in the volume.
@param This Indicates the calling context.
@param Key Key is a pointer to a caller allocated
buffer that contains implementation specific
data that is used to track where to begin
the search for the next file. The size of
the buffer must be at least This->KeySize
bytes long. To reinitialize the search and
begin from the beginning of the firmware
volume, the entire buffer must be cleared to
zero. Other than clearing the buffer to
initiate a new search, the caller must not
modify the data in the buffer between calls
to GetNextFile().
@param FileType FileType is a pointer to a caller allocated
EFI_FV_FILETYPE. The GetNextFile() API can
filter it's search for files based on the
value of *FileType input. A *FileType input
of 0 causes GetNextFile() to search for
files of all types. If a file is found, the
file's type is returned in *FileType.
*FileType is not modified if no file is
found.
@param NameGuid NameGuid is a pointer to a caller allocated
EFI_GUID. If a file is found, the file's
name is returned in *NameGuid. *NameGuid is
not modified if no file is found.
@param Attributes Attributes is a pointer to a caller
allocated EFI_FV_FILE_ATTRIBUTES. If a file
is found, the file's attributes are returned
in *Attributes. *Attributes is not modified
if no file is found.
@param Size Size is a pointer to a caller allocated
UINTN. If a file is found, the file's size
is returned in *Size. *Size is not modified
if no file is found.
@retval EFI_SUCCESS Successfully find the file.
@retval EFI_DEVICE_ERROR Device error.
@retval EFI_ACCESS_DENIED Fv could not read.
@retval EFI_NOT_FOUND No matching file found.
@retval EFI_INVALID_PARAMETER Invalid parameter
**/
)
{
return Status;
}
//
// Check if read operation is enabled
//
if ((FvAttributes & EFI_FV2_READ_STATUS) == 0) {
return EFI_ACCESS_DENIED;
}
if (*FileType > EFI_FV_FILETYPE_SMM_CORE) {
//
// File type needs to be in 0 - 0x0D
//
return EFI_NOT_FOUND;
}
do {
if (*KeyValue == 0) {
//
// Search for 1st matching file
//
return EFI_NOT_FOUND;
}
//
// remember the key
//
//
// we ignore pad files
//
continue;
}
if (*FileType == 0) {
break;
}
break;
}
} else {
//
// Getting link from last Ffs
//
return EFI_NOT_FOUND;
}
//
// remember the key
//
//
// we ignore pad files
//
continue;
}
if (*FileType == EFI_FV_FILETYPE_ALL) {
break;
}
break;
}
}
//
// Cache this file entry
//
}
//
// we need to substract the header size
//
if (IS_FFS_FILE2 (FfsFileHeader)) {
} else {
}
//
// specially deal with VTF file
//
if (IS_FFS_FILE2 (FfsFileHeader)) {
} else {
}
while (*Size >= 4) {
if (Tmp == 0) {
SrcPtr += 4;
(*Size) -= 4;
} else {
break;
}
}
}
return EFI_SUCCESS;
}
/**
Locates a file in the firmware volume and
copies it to the supplied buffer.
@param This Indicates the calling context.
@param NameGuid Pointer to an EFI_GUID, which is the
filename.
@param Buffer Buffer is a pointer to pointer to a buffer
in which the file or section contents or are
returned.
@param BufferSize BufferSize is a pointer to caller allocated
UINTN. On input *BufferSize indicates the
size in bytes of the memory region pointed
to by Buffer. On output, *BufferSize
contains the number of bytes required to
read the file.
@param FoundType FoundType is a pointer to a caller allocated
EFI_FV_FILETYPE that on successful return
from Read() contains the type of file read.
This output reflects the file type
irrespective of the value of the SectionType
input.
@param FileAttributes FileAttributes is a pointer to a caller
allocated EFI_FV_FILE_ATTRIBUTES. On
successful return from Read(),
*FileAttributes contains the attributes of
the file read.
@param AuthenticationStatus AuthenticationStatus is a pointer to a
caller allocated UINTN in which the
authentication status is returned.
@retval EFI_SUCCESS Successfully read to memory buffer.
@retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
@retval EFI_NOT_FOUND Not found.
@retval EFI_DEVICE_ERROR Device error.
@retval EFI_ACCESS_DENIED Could not read.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.
**/
)
{
return EFI_INVALID_PARAMETER;
}
return Status;
}
//
// First check to see that FV is enabled for reads...
//
if (0 == (FvAttributes & EFI_FV2_READ_STATUS)) {
return EFI_ACCESS_DENIED;
}
//
// Check if the file was read last time.
//
if (FfsFileEntry != NULL) {
}
//
// If not match or no file cached, search this file
//
Key = 0;
do {
LocalFoundType = 0;
This,
&Key,
);
return EFI_NOT_FOUND;
}
//
// Get file entry
//
//
// Update the cache
//
} else {
//
// Get File Size of the cached file
//
if (IS_FFS_FILE2 (FfsHeader)) {
} else {
}
}
//
// Get file info
//
}
*AuthenticationStatus = 0;
//
// If Buffer is NULL, we only want to get some information
//
*BufferSize = FileSize;
return EFI_SUCCESS;
}
if (IS_FFS_FILE2 (FfsHeader)) {
} else {
}
//
// specially deal with VTF file
//
while (FileSize >= 4) {
if (Tmp == 0) {
SrcPtr += 4;
FileSize -= 4;
} else {
break;
}
}
}
//
// If we drop out of the above loop, we've found the correct file header...
//
if (FileBuffer == NULL) {
return EFI_OUT_OF_RESOURCES;
}
*BufferSize = FileSize;
*Buffer = FileBuffer;
return EFI_SUCCESS;
}
//
// If the user's buffer is smaller than the file size, then copy as much
// as we can and return an appropriate status.
//
if (FileSize > *BufferSize) {
*BufferSize = FileSize;
return EFI_WARN_BUFFER_TOO_SMALL;
}
//
// User's buffer size is ok, so copy the entire file to their buffer.
//
*BufferSize = FileSize;
return EFI_SUCCESS;
}
/**
Locates a section in a given FFS File and
copies it to the supplied buffer (not including section header).
@param This Indicates the calling context.
@param NameGuid Pointer to an EFI_GUID, which is the
filename.
@param SectionType Indicates the section type to return.
@param SectionInstance Indicates which instance of sections with a
type of SectionType to return.
@param Buffer Buffer is a pointer to pointer to a buffer
in which the file or section contents or are
returned.
@param BufferSize BufferSize is a pointer to caller allocated
UINTN.
@param AuthenticationStatus AuthenticationStatus is a pointer to a
caller allocated UINT32 in which the
authentication status is returned.
@retval EFI_SUCCESS Successfully read the file section into
buffer.
@retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.
@retval EFI_NOT_FOUND Section not found.
@retval EFI_DEVICE_ERROR Device error.
@retval EFI_ACCESS_DENIED Could not read.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
)
{
return EFI_INVALID_PARAMETER;
}
return Status;
}
//
// First check to see that FV is enabled for reads...
//
if (0 == (FvAttributes & EFI_FV2_READ_STATUS)) {
return EFI_ACCESS_DENIED;
}
//
// Read the whole file into buffer
//
FileBuffer = NULL;
This,
(VOID **) &FileBuffer,
&FileSize,
&FileType,
);
return Status;
}
//
// Check to see that the file actually HAS sections before we go any further.
//
if (FileType == EFI_FV_FILETYPE_RAW) {
return EFI_NOT_FOUND;
}
//
// Located the protocol
//
NULL,
);
return Status;
}
Sep,
);
return Status;
}
if (SectionType == 0) {
//
// We need the whole section stream
//
Sep,
NULL,
NULL,
0,
);
} else {
Sep,
NULL,
);
}
//
// Handle AuthenticationStatus if necessary
//
return Status;
}