/** @file\r
Implements functions to read firmware file\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
**/\r
\r
-#include <DxeMain.h>\r
+#include "DxeMain.h"\r
+#include "FwVolDriver.h"\r
\r
-/*++\r
-\r
-Required Alignment Alignment Value in FFS Alignment Value in\r
+/**\r
+Required Alignment Alignment Value in FFS Alignment Value in\r
(bytes) Attributes Field Firmware Volume Interfaces\r
1 0 0\r
-2 0 1\r
-4 0 2\r
-8 0 3\r
16 1 4\r
128 2 7\r
512 3 9\r
4 KB 5 12\r
32 KB 6 15\r
64 KB 7 16\r
-\r
---*/\r
-\r
-UINT8 mFvAttributes[] = {0, 4, 7, 9, 10, 12, 15, 16}; \r
-\r
-\r
+**/\r
+UINT8 mFvAttributes[] = {0, 4, 7, 9, 10, 12, 15, 16};\r
\r
/**\r
Convert the FFS File Attributes to FV File Attributes\r
\r
- @param FfsAttributes The attributes of UINT8 type. \r
+ @param FfsAttributes The attributes of UINT8 type.\r
\r
@return The attributes of EFI_FV_FILE_ATTRIBUTES\r
\r
IN EFI_FFS_FILE_ATTRIBUTES FfsAttributes\r
)\r
{\r
- FfsAttributes = (EFI_FFS_FILE_ATTRIBUTES)((FfsAttributes & FFS_ATTRIB_DATA_ALIGNMENT) >> 3);\r
- ASSERT (FfsAttributes < 8);\r
+ UINT8 DataAlignment;\r
+ EFI_FV_FILE_ATTRIBUTES FileAttribute;\r
\r
- return (EFI_FV_FILE_ATTRIBUTES) mFvAttributes[FfsAttributes];\r
-}\r
+ DataAlignment = (UINT8) ((FfsAttributes & FFS_ATTRIB_DATA_ALIGNMENT) >> 3);\r
+ ASSERT (DataAlignment < 8);\r
\r
+ FileAttribute = (EFI_FV_FILE_ATTRIBUTES) mFvAttributes[DataAlignment];\r
\r
+ if ((FfsAttributes & FFS_ATTRIB_FIXED) == FFS_ATTRIB_FIXED) {\r
+ FileAttribute |= EFI_FV_FILE_ATTRIB_FIXED;\r
+ }\r
+\r
+ return FileAttribute;\r
+}\r
\r
/**\r
Given the input key, search for the next matching file in the volume.\r
\r
- @param This Indicates the calling context. \r
- @param Key Key is a pointer to a caller allocated \r
- buffer that contains implementation specific \r
- data that is used to track where to begin \r
- the search for the next file. The size of \r
- the buffer must be at least This->KeySize \r
- bytes long. To reinitialize the search and \r
- begin from the beginning of the firmware \r
- volume, the entire buffer must be cleared to \r
- zero. Other than clearing the buffer to \r
- initiate a new search, the caller must not \r
- modify the data in the buffer between calls \r
- to GetNextFile(). \r
- @param FileType FileType is a pointer to a caller allocated \r
- EFI_FV_FILETYPE. The GetNextFile() API can \r
- filter it's search for files based on the \r
- value of *FileType input. A *FileType input \r
- of 0 causes GetNextFile() to search for \r
- files of all types. If a file is found, the \r
- file's type is returned in *FileType. \r
- *FileType is not modified if no file is \r
- found. \r
- @param NameGuid NameGuid is a pointer to a caller allocated \r
- EFI_GUID. If a file is found, the file's \r
- name is returned in *NameGuid. *NameGuid is \r
- not modified if no file is found. \r
- @param Attributes Attributes is a pointer to a caller \r
- allocated EFI_FV_FILE_ATTRIBUTES. If a file \r
- is found, the file's attributes are returned \r
- in *Attributes. *Attributes is not modified \r
- if no file is found. \r
- @param Size Size is a pointer to a caller allocated \r
- UINTN. If a file is found, the file's size \r
- is returned in *Size. *Size is not modified \r
- if no file is found. \r
-\r
- @retval EFI_SUCCESS Successfully find the file. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Fv could not read. \r
- @retval EFI_NOT_FOUND No matching file found. \r
+ @param This Indicates the calling context.\r
+ @param Key Key is a pointer to a caller allocated\r
+ buffer that contains implementation specific\r
+ data that is used to track where to begin\r
+ the search for the next file. The size of\r
+ the buffer must be at least This->KeySize\r
+ bytes long. To reinitialize the search and\r
+ begin from the beginning of the firmware\r
+ volume, the entire buffer must be cleared to\r
+ zero. Other than clearing the buffer to\r
+ initiate a new search, the caller must not\r
+ modify the data in the buffer between calls\r
+ to GetNextFile().\r
+ @param FileType FileType is a pointer to a caller allocated\r
+ EFI_FV_FILETYPE. The GetNextFile() API can\r
+ filter it's search for files based on the\r
+ value of *FileType input. A *FileType input\r
+ of 0 causes GetNextFile() to search for\r
+ files of all types. If a file is found, the\r
+ file's type is returned in *FileType.\r
+ *FileType is not modified if no file is\r
+ found.\r
+ @param NameGuid NameGuid is a pointer to a caller allocated\r
+ EFI_GUID. If a file is found, the file's\r
+ name is returned in *NameGuid. *NameGuid is\r
+ not modified if no file is found.\r
+ @param Attributes Attributes is a pointer to a caller\r
+ allocated EFI_FV_FILE_ATTRIBUTES. If a file\r
+ is found, the file's attributes are returned\r
+ in *Attributes. *Attributes is not modified\r
+ if no file is found.\r
+ @param Size Size is a pointer to a caller allocated\r
+ UINTN. If a file is found, the file's size\r
+ is returned in *Size. *Size is not modified\r
+ if no file is found.\r
+\r
+ @retval EFI_SUCCESS Successfully find the file.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Fv could not read.\r
+ @retval EFI_NOT_FOUND No matching file found.\r
@retval EFI_INVALID_PARAMETER Invalid parameter\r
\r
**/\r
UINTN *KeyValue;\r
LIST_ENTRY *Link;\r
FFS_FILE_LIST_ENTRY *FfsFileEntry;\r
- UINTN FileLength;\r
\r
FvDevice = FV_DEVICE_FROM_THIS (This);\r
\r
return EFI_ACCESS_DENIED;\r
}\r
\r
- if (*FileType > EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) {\r
+ if (*FileType > EFI_FV_FILETYPE_SMM_CORE) {\r
//\r
- // File type needs to be in 0 - 0x0B\r
+ // File type needs to be in 0 - 0x0D\r
//\r
return EFI_NOT_FOUND;\r
}\r
break;\r
}\r
\r
- } \r
+ }\r
\r
//\r
// Return FileType, NameGuid, and Attributes\r
*FileType = FfsFileHeader->Type;\r
CopyGuid (NameGuid, &FfsFileHeader->Name);\r
*Attributes = FfsAttributes2FvFileAttributes (FfsFileHeader->Attributes);\r
-\r
- //\r
- // Read four bytes out of the 3 byte array and throw out extra data\r
- //\r
- FileLength = *(UINT32 *)&FfsFileHeader->Size[0] & 0x00FFFFFF;\r
+ if ((FvDevice->FwVolHeader->Attributes & EFI_FVB2_MEMORY_MAPPED) == EFI_FVB2_MEMORY_MAPPED) {\r
+ *Attributes |= EFI_FV_FILE_ATTRIB_MEMORY_MAPPED;\r
+ }\r
\r
//\r
// we need to substract the header size\r
//\r
- *Size = FileLength - sizeof(EFI_FFS_FILE_HEADER);\r
+ if (IS_FFS_FILE2 (FfsFileHeader)) {\r
+ *Size = FFS_FILE2_SIZE (FfsFileHeader) - sizeof (EFI_FFS_FILE_HEADER2);\r
+ } else {\r
+ *Size = FFS_FILE_SIZE (FfsFileHeader) - sizeof (EFI_FFS_FILE_HEADER);\r
+ }\r
\r
return EFI_SUCCESS;\r
}\r
Locates a file in the firmware volume and\r
copies it to the supplied buffer.\r
\r
- @param This Indicates the calling context. \r
- @param NameGuid Pointer to an EFI_GUID, which is the \r
- filename. \r
- @param Buffer Buffer is a pointer to pointer to a buffer \r
- in which the file or section contents or are \r
- returned. \r
- @param BufferSize BufferSize is a pointer to caller allocated \r
- UINTN. On input *BufferSize indicates the \r
- size in bytes of the memory region pointed \r
- to by Buffer. On output, *BufferSize \r
- contains the number of bytes required to \r
- read the file. \r
- @param FoundType FoundType is a pointer to a caller allocated \r
- EFI_FV_FILETYPE that on successful return \r
- from Read() contains the type of file read. \r
- This output reflects the file type \r
- irrespective of the value of the SectionType \r
- input. \r
- @param FileAttributes FileAttributes is a pointer to a caller \r
- allocated EFI_FV_FILE_ATTRIBUTES. On \r
- successful return from Read(), \r
- *FileAttributes contains the attributes of \r
- the file read. \r
- @param AuthenticationStatus AuthenticationStatus is a pointer to a \r
- caller allocated UINTN in which the \r
- authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Successfully read to memory buffer. \r
- @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small. \r
- @retval EFI_NOT_FOUND Not found. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Could not read. \r
- @retval EFI_INVALID_PARAMETER Invalid parameter. \r
+ @param This Indicates the calling context.\r
+ @param NameGuid Pointer to an EFI_GUID, which is the\r
+ filename.\r
+ @param Buffer Buffer is a pointer to pointer to a buffer\r
+ in which the file or section contents or are\r
+ returned.\r
+ @param BufferSize BufferSize is a pointer to caller allocated\r
+ UINTN. On input *BufferSize indicates the\r
+ size in bytes of the memory region pointed\r
+ to by Buffer. On output, *BufferSize\r
+ contains the number of bytes required to\r
+ read the file.\r
+ @param FoundType FoundType is a pointer to a caller allocated\r
+ EFI_FV_FILETYPE that on successful return\r
+ from Read() contains the type of file read.\r
+ This output reflects the file type\r
+ irrespective of the value of the SectionType\r
+ input.\r
+ @param FileAttributes FileAttributes is a pointer to a caller\r
+ allocated EFI_FV_FILE_ATTRIBUTES. On\r
+ successful return from Read(),\r
+ *FileAttributes contains the attributes of\r
+ the file read.\r
+ @param AuthenticationStatus AuthenticationStatus is a pointer to a\r
+ caller allocated UINTN in which the\r
+ authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Successfully read to memory buffer.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.\r
+ @retval EFI_NOT_FOUND Not found.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Could not read.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
@retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.\r
\r
**/\r
UINT8 *SrcPtr;\r
EFI_FFS_FILE_HEADER *FfsHeader;\r
UINTN InputBufferSize;\r
- \r
+\r
if (NameGuid == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
FvDevice = FV_DEVICE_FROM_THIS (This);\r
- \r
+\r
\r
//\r
// Keep looking until we find the matching NameGuid.\r
//\r
*FoundType = FfsHeader->Type;\r
*FileAttributes = FfsAttributes2FvFileAttributes (FfsHeader->Attributes);\r
+ if ((FvDevice->FwVolHeader->Attributes & EFI_FVB2_MEMORY_MAPPED) == EFI_FVB2_MEMORY_MAPPED) {\r
+ *FileAttributes |= EFI_FV_FILE_ATTRIB_MEMORY_MAPPED;\r
+ }\r
*AuthenticationStatus = 0;\r
*BufferSize = FileSize;\r
\r
if (Buffer == NULL) {\r
//\r
- // If Buffer is NULL, we only want to get the information colected so far\r
+ // If Buffer is NULL, we only want to get the information collected so far\r
//\r
return EFI_SUCCESS;\r
}\r
//\r
// Skip over file header\r
//\r
- SrcPtr = ((UINT8 *)FfsHeader) + sizeof (EFI_FFS_FILE_HEADER);\r
+ if (IS_FFS_FILE2 (FfsHeader)) {\r
+ SrcPtr = ((UINT8 *) FfsHeader) + sizeof (EFI_FFS_FILE_HEADER2);\r
+ } else {\r
+ SrcPtr = ((UINT8 *) FfsHeader) + sizeof (EFI_FFS_FILE_HEADER);\r
+ }\r
\r
Status = EFI_SUCCESS;\r
if (*Buffer == NULL) {\r
//\r
// Caller passed in a pointer so allocate buffer for them\r
//\r
- *Buffer = CoreAllocateBootServicesPool (FileSize);\r
+ *Buffer = AllocatePool (FileSize);\r
if (*Buffer == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
} else if (FileSize > InputBufferSize) {\r
//\r
// Callers buffer was not big enough\r
- // \r
+ //\r
Status = EFI_WARN_BUFFER_TOO_SMALL;\r
FileSize = InputBufferSize;\r
}\r
- \r
+\r
//\r
- // Copy data into callers buffer \r
+ // Copy data into callers buffer\r
//\r
CopyMem (*Buffer, SrcPtr, FileSize);\r
\r
Locates a section in a given FFS File and\r
copies it to the supplied buffer (not including section header).\r
\r
- @param This Indicates the calling context. \r
- @param NameGuid Pointer to an EFI_GUID, which is the \r
- filename. \r
- @param SectionType Indicates the section type to return. \r
- @param SectionInstance Indicates which instance of sections with a \r
- type of SectionType to return. \r
- @param Buffer Buffer is a pointer to pointer to a buffer \r
- in which the file or section contents or are \r
- returned. \r
- @param BufferSize BufferSize is a pointer to caller allocated \r
+ @param This Indicates the calling context.\r
+ @param NameGuid Pointer to an EFI_GUID, which is the\r
+ filename.\r
+ @param SectionType Indicates the section type to return.\r
+ @param SectionInstance Indicates which instance of sections with a\r
+ type of SectionType to return.\r
+ @param Buffer Buffer is a pointer to pointer to a buffer\r
+ in which the file or section contents or are\r
+ returned.\r
+ @param BufferSize BufferSize is a pointer to caller allocated\r
UINTN.\r
- @param AuthenticationStatus AuthenticationStatus is a pointer to a \r
- caller allocated UINT32 in which the \r
- authentication status is returned. \r
-\r
- @retval EFI_SUCCESS Successfully read the file section into \r
- buffer. \r
- @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small. \r
- @retval EFI_NOT_FOUND Section not found. \r
- @retval EFI_DEVICE_ERROR Device error. \r
- @retval EFI_ACCESS_DENIED Could not read. \r
+ @param AuthenticationStatus AuthenticationStatus is a pointer to a\r
+ caller allocated UINT32 in which the\r
+ authentication status is returned.\r
+\r
+ @retval EFI_SUCCESS Successfully read the file section into\r
+ buffer.\r
+ @retval EFI_WARN_BUFFER_TOO_SMALL Buffer too small.\r
+ @retval EFI_NOT_FOUND Section not found.\r
+ @retval EFI_DEVICE_ERROR Device error.\r
+ @retval EFI_ACCESS_DENIED Could not read.\r
@retval EFI_INVALID_PARAMETER Invalid parameter.\r
\r
**/\r
UINTN FileSize;\r
UINT8 *FileBuffer;\r
FFS_FILE_LIST_ENTRY *FfsEntry;\r
- \r
+\r
if (NameGuid == NULL || Buffer == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
&FileType,\r
&FileAttributes,\r
AuthenticationStatus\r
- ); \r
+ );\r
//\r
// Get the last key used by our call to FvReadFile as it is the FfsEntry for this file.\r
- // \r
+ //\r
FfsEntry = (FFS_FILE_LIST_ENTRY *) FvDevice->LastKey;\r
\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- \r
+ ASSERT (FileBuffer != NULL);\r
+\r
//\r
// Check to see that the file actually HAS sections before we go any further.\r
//\r
}\r
\r
//\r
- // Use FfsEntry to cache Section Extraction Protocol Inforomation\r
+ // Use FfsEntry to cache Section Extraction Protocol Information\r
//\r
if (FfsEntry->StreamHandle == 0) {\r
Status = OpenSectionStream (\r
(SectionType == 0) ? 0 : SectionInstance,\r
Buffer,\r
BufferSize,\r
- AuthenticationStatus\r
+ AuthenticationStatus,\r
+ FvDevice->IsFfs3Fv\r
);\r
\r
+ if (!EFI_ERROR (Status)) {\r
+ //\r
+ // Inherit the authentication status.\r
+ //\r
+ *AuthenticationStatus |= FvDevice->AuthenticationStatus;\r
+ }\r
+\r
//\r
// Close of stream defered to close of FfsHeader list to allow SEP to cache data\r
//\r
projects / mirror_edk2.git / blobdiff