-/**@file\r
+/** @file\r
Firmware File System driver that produce Firmware Volume protocol.\r
- Layers on top of Firmware Block protocol to produce a file abstraction \r
+ Layers on top of Firmware Block protocol to produce a file abstraction\r
of FV based files.\r
- \r
-Copyright (c) 2006 - 2007 Intel Corporation. <BR>\r
-All rights reserved. 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
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+All rights reserved. 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
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
-#include <DxeMain.h>\r
+#include "DxeMain.h"\r
+#include "FwVolDriver.h"\r
\r
-#define KEYSIZE sizeof (UINTN)\r
\r
//\r
// Protocol notify related globals\r
EFI_EVENT gEfiFwVolBlockEvent;\r
\r
FV_DEVICE mFvDevice = {\r
- FV_DEVICE_SIGNATURE,\r
+ FV2_DEVICE_SIGNATURE,\r
NULL,\r
NULL,\r
{\r
FvReadFile,\r
FvReadFileSection,\r
FvWriteFile,\r
- FvGetNextFile,\r
- KEYSIZE\r
+ FvGetNextFile, \r
+ sizeof (UINTN),\r
+ NULL,\r
+ FvGetVolumeInfo,\r
+ FvSetVolumeInfo\r
},\r
NULL,\r
NULL,\r
//\r
// FFS helper functions\r
//\r
+/**\r
+ given the supplied FW_VOL_BLOCK_PROTOCOL, allocate a buffer for output and\r
+ copy the volume header into it.\r
+\r
+ @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to\r
+ read the volume header\r
+ @param FwVolHeader Pointer to pointer to allocated buffer in which\r
+ the volume header is returned.\r
\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.\r
+ @retval EFI_SUCCESS Successfully read volume header to the allocated\r
+ buffer.\r
+\r
+**/\r
EFI_STATUS\r
GetFwVolHeader (\r
IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb,\r
OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader\r
)\r
-/*++\r
-\r
-Routine Description:\r
- given the supplied FW_VOL_BLOCK_PROTOCOL, allocate a buffer for output and\r
- copy the volume header into it.\r
-\r
-Arguments:\r
- Fvb - The FW_VOL_BLOCK_PROTOCOL instance from which to read the volume\r
- header\r
- FwVolHeader - Pointer to pointer to allocated buffer in which the volume\r
- header is returned.\r
-\r
-Returns:\r
- EFI_OUT_OF_RESOURCES - No enough buffer could be allocated.\r
- EFI_SUCCESS - Successfully read volume header to the allocated buffer.\r
-\r
---*/\r
-\r
{\r
EFI_STATUS Status;\r
EFI_FIRMWARE_VOLUME_HEADER TempFvh;\r
//\r
FvhLength = sizeof (EFI_FIRMWARE_VOLUME_HEADER);\r
Status = Fvb->Read (Fvb, 0, 0, &FvhLength, (UINT8 *)&TempFvh);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
//\r
// Allocate a buffer for the caller\r
//\r
- *FwVolHeader = CoreAllocateBootServicesPool (TempFvh.HeaderLength);\r
+ *FwVolHeader = AllocatePool (TempFvh.HeaderLength);\r
if (*FwVolHeader == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
//\r
CoreFreePool (*FwVolHeader);\r
}\r
- \r
+\r
return Status;\r
}\r
\r
\r
-STATIC\r
-VOID\r
-FreeFvDeviceResource (\r
- IN FV_DEVICE *FvDevice\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Free FvDevice resource when error happens\r
\r
-Arguments:\r
- FvDevice - pointer to the FvDevice to be freed.\r
+ @param FvDevice pointer to the FvDevice to be freed.\r
\r
-Returns:\r
- None.\r
-\r
---*/\r
+**/\r
+VOID\r
+FreeFvDeviceResource (\r
+ IN FV_DEVICE *FvDevice\r
+ )\r
{\r
FFS_FILE_LIST_ENTRY *FfsFileEntry;\r
LIST_ENTRY *NextEntry;\r
FfsFileEntry = (FFS_FILE_LIST_ENTRY *)FvDevice->FfsFileListHeader.ForwardLink;\r
while (&FfsFileEntry->Link != &FvDevice->FfsFileListHeader) {\r
NextEntry = (&FfsFileEntry->Link)->ForwardLink;\r
- \r
+\r
if (FfsFileEntry->StreamHandle != 0) {\r
//\r
// Close stream and free resources from SEP\r
//\r
- FfsFileEntry->Sep->CloseSectionStream (FfsFileEntry->Sep, FfsFileEntry->StreamHandle);\r
+ CloseSectionStream (FfsFileEntry->StreamHandle);\r
}\r
\r
CoreFreePool (FfsFileEntry);\r
\r
- FfsFileEntry = (FFS_FILE_LIST_ENTRY *)NextEntry;\r
+ FfsFileEntry = (FFS_FILE_LIST_ENTRY *) NextEntry;\r
}\r
\r
\r
}\r
\r
\r
-EFI_STATUS\r
-FvCheck (\r
- IN OUT FV_DEVICE *FvDevice\r
- )\r
-/*++\r
\r
-Routine Description:\r
- Check if a FV is consistent and allocate cache\r
+/**\r
+ Check if an FV is consistent and allocate cache for it.\r
\r
-Arguments:\r
- FvDevice - pointer to the FvDevice to be checked.\r
+ @param FvDevice A pointer to the FvDevice to be checked.\r
\r
-Returns:\r
- EFI_OUT_OF_RESOURCES - No enough buffer could be allocated.\r
- EFI_SUCCESS - FV is consistent and cache is allocated.\r
- EFI_VOLUME_CORRUPTED - File system is corrupted.\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.\r
+ @retval EFI_SUCCESS FV is consistent and cache is allocated.\r
+ @retval EFI_VOLUME_CORRUPTED File system is corrupted.\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+FvCheck (\r
+ IN OUT FV_DEVICE *FvDevice\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;\r
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
- EFI_FVB_ATTRIBUTES FvbAttributes;\r
+ EFI_FVB_ATTRIBUTES_2 FvbAttributes;\r
EFI_FV_BLOCK_MAP_ENTRY *BlockMap;\r
FFS_FILE_LIST_ENTRY *FfsFileEntry;\r
EFI_FFS_FILE_HEADER *FfsHeader;\r
\r
Fvb = FvDevice->Fvb;\r
FwVolHeader = FvDevice->FwVolHeader;\r
- \r
+\r
Status = Fvb->GetAttributes (Fvb, &FvbAttributes);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
// the header to check to make sure the volume is valid\r
//\r
Size = (UINTN)(FwVolHeader->FvLength - FwVolHeader->HeaderLength);\r
- FvDevice->CachedFv = CoreAllocateBootServicesPool (Size);\r
+ FvDevice->CachedFv = AllocatePool (Size);\r
\r
if (FvDevice->CachedFv == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
LbaIndex = 0;\r
LbaOffset = FwVolHeader->HeaderLength;\r
while ((BlockMap->NumBlocks != 0) || (BlockMap->Length != 0)) {\r
- \r
+\r
for (Index = 0; Index < BlockMap->NumBlocks; Index ++) {\r
\r
Size = BlockMap->Length;\r
Size -= LbaOffset;\r
}\r
Status = Fvb->Read (Fvb,\r
- LbaIndex,\r
- LbaOffset,\r
- &Size,\r
- CacheLocation\r
- );\r
+ LbaIndex,\r
+ LbaOffset,\r
+ &Size,\r
+ CacheLocation\r
+ );\r
//\r
// Not check EFI_BAD_BUFFER_SIZE, for Size = BlockMap->Length\r
//\r
if (EFI_ERROR (Status)) {\r
goto Done;\r
}\r
- \r
+\r
//\r
// After we skip Fv Header always read from start of block\r
//\r
//\r
// Scan to check the free space & File list\r
//\r
- if (FvbAttributes & EFI_FVB_ERASE_POLARITY) {\r
+ if ((FvbAttributes & EFI_FVB2_ERASE_POLARITY) != 0) {\r
FvDevice->ErasePolarity = 1;\r
} else {\r
FvDevice->ErasePolarity = 0;\r
- } \r
+ }\r
\r
\r
//\r
//\r
// Build FFS list\r
//\r
- FfsHeader = (EFI_FFS_FILE_HEADER *)FvDevice->CachedFv;\r
+ FfsHeader = (EFI_FFS_FILE_HEADER *) FvDevice->CachedFv;\r
TopFvAddress = FvDevice->EndOfCachedFv;\r
- while ((UINT8 *)FfsHeader < TopFvAddress) {\r
+ while ((UINT8 *) FfsHeader < TopFvAddress) {\r
\r
- TestLength = TopFvAddress - ((UINT8 *)FfsHeader);\r
+ TestLength = TopFvAddress - ((UINT8 *) FfsHeader);\r
if (TestLength > sizeof (EFI_FFS_FILE_HEADER)) {\r
TestLength = sizeof (EFI_FFS_FILE_HEADER);\r
}\r
}\r
\r
if (!IsValidFfsHeader (FvDevice->ErasePolarity, FfsHeader, &FileState)) {\r
- if ((FileState == EFI_FILE_HEADER_INVALID) || \r
+ if ((FileState == EFI_FILE_HEADER_INVALID) ||\r
(FileState == EFI_FILE_HEADER_CONSTRUCTION)) {\r
FfsHeader++;\r
- \r
continue;\r
- \r
} else {\r
//\r
// File system is corrputed\r
FileLength = *(UINT32 *)&FfsHeader->Size[0] & 0x00FFFFFF;\r
\r
FileState = GetFileState (FvDevice->ErasePolarity, FfsHeader);\r
- \r
+\r
//\r
// check for non-deleted file\r
//\r
//\r
// Create a FFS list entry for each non-deleted file\r
//\r
- FfsFileEntry = CoreAllocateZeroBootServicesPool (sizeof (FFS_FILE_LIST_ENTRY));\r
+ FfsFileEntry = AllocateZeroPool (sizeof (FFS_FILE_LIST_ENTRY));\r
if (FfsFileEntry == NULL) {\r
Status = EFI_OUT_OF_RESOURCES;\r
goto Done;\r
}\r
- \r
+\r
FfsFileEntry->FfsHeader = FfsHeader;\r
InsertTailList (&FvDevice->FfsFileListHeader, &FfsFileEntry->Link);\r
}\r
\r
FfsHeader = (EFI_FFS_FILE_HEADER *)(((UINT8 *)FfsHeader) + FileLength);\r
- \r
+\r
//\r
// Adjust pointer to the next 8-byte aligned boundry.\r
//\r
FfsHeader = (EFI_FFS_FILE_HEADER *)(((UINTN)FfsHeader + 7) & ~0x07);\r
- \r
+\r
}\r
\r
Done:\r
}\r
\r
\r
-STATIC\r
+\r
+/**\r
+ This notification function is invoked when an instance of the\r
+ EFI_FW_VOLUME_BLOCK_PROTOCOL is produced. It layers an instance of the\r
+ EFI_FIRMWARE_VOLUME2_PROTOCOL on the same handle. This is the function where\r
+ the actual initialization of the EFI_FIRMWARE_VOLUME2_PROTOCOL is done.\r
+\r
+ @param Event The event that occured\r
+ @param Context For EFI compatiblity. Not used.\r
+\r
+**/\r
VOID\r
EFIAPI\r
NotifyFwVolBlock (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
- This notification function is invoked when an instance of the\r
- EFI_FW_VOLUME_BLOCK_PROTOCOL is produced. It layers an instance of the\r
- EFI_FIRMWARE_VOLUME_PROTOCOL on the same handle. This is the function where\r
- the actual initialization of the EFI_FIRMWARE_VOLUME_PROTOCOL is done.\r
-\r
-Arguments:\r
- Event - The event that occured\r
- Context - For EFI compatiblity. Not used.\r
-\r
-Returns:\r
-\r
- None.\r
-\r
---*/\r
{\r
EFI_HANDLE Handle;\r
EFI_STATUS Status;\r
UINTN BufferSize;\r
EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;\r
- EFI_FIRMWARE_VOLUME_PROTOCOL *Fv;\r
+ EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
FV_DEVICE *FvDevice;\r
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
//\r
if (EFI_ERROR (Status)) {\r
continue;\r
}\r
- \r
+\r
//\r
// Get the FirmwareVolumeBlock protocol on that handle\r
//\r
- Status = CoreHandleProtocol (Handle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb); \r
+ Status = CoreHandleProtocol (Handle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb);\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
\r
//\r
// Make sure the Fv Header is O.K.\r
// Check to see that the file system is indeed formatted in a way we can\r
// understand it...\r
//\r
- if (!CompareGuid (&FwVolHeader->FileSystemGuid, &gEfiFirmwareFileSystemGuid)) {\r
+ if (!CompareGuid (&FwVolHeader->FileSystemGuid, &gEfiFirmwareFileSystem2Guid)) {\r
continue;\r
}\r
\r
//\r
// Check if there is an FV protocol already installed in that handle\r
//\r
- Status = CoreHandleProtocol (Handle, &gEfiFirmwareVolumeProtocolGuid, (VOID **)&Fv);\r
+ Status = CoreHandleProtocol (Handle, &gEfiFirmwareVolume2ProtocolGuid, (VOID **)&Fv);\r
if (!EFI_ERROR (Status)) {\r
//\r
// Update Fv to use a new Fvb\r
//\r
FvDevice = _CR (Fv, FV_DEVICE, Fv);\r
- if (FvDevice->Signature == FV_DEVICE_SIGNATURE) {\r
+ if (FvDevice->Signature == FV2_DEVICE_SIGNATURE) {\r
//\r
// Only write into our device structure if it's our device structure\r
//\r
//\r
// No FwVol protocol on the handle so create a new one\r
//\r
- FvDevice = CoreAllocateCopyPool (sizeof (FV_DEVICE), &mFvDevice);\r
+ FvDevice = AllocateCopyPool (sizeof (FV_DEVICE), &mFvDevice);\r
if (FvDevice == NULL) {\r
return;\r
}\r
- \r
- FvDevice->Fvb = Fvb;\r
- FvDevice->Handle = Handle;\r
- FvDevice->FwVolHeader = FwVolHeader;\r
+\r
+ FvDevice->Fvb = Fvb;\r
+ FvDevice->Handle = Handle;\r
+ FvDevice->FwVolHeader = FwVolHeader;\r
FvDevice->Fv.ParentHandle = Fvb->ParentHandle;\r
- \r
+\r
//\r
// Install an New FV protocol on the existing handle\r
//\r
Status = CoreInstallProtocolInterface (\r
&Handle,\r
- &gEfiFirmwareVolumeProtocolGuid,\r
+ &gEfiFirmwareVolume2ProtocolGuid,\r
EFI_NATIVE_INTERFACE,\r
&FvDevice->Fv\r
);\r
ASSERT_EFI_ERROR (Status);\r
}\r
}\r
- \r
+\r
return;\r
}\r
\r
\r
+\r
+/**\r
+ This routine is the driver initialization entry point. It registers\r
+ a notification function. This notification function are responsible\r
+ for building the FV stack dynamically.\r
+\r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
+\r
+ @retval EFI_SUCCESS Function successfully returned.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FwVolDriverInit (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
- This routine is the driver initialization entry point. It initializes the\r
- libraries, and registers two notification functions. These notification\r
- functions are responsible for building the FV stack dynamically.\r
- \r
-Arguments:\r
- ImageHandle - The image handle.\r
- SystemTable - The system table.\r
- \r
-Returns:\r
- EFI_SUCCESS - Function successfully returned.\r
-\r
---*/\r
{\r
- gEfiFwVolBlockEvent = CoreCreateProtocolNotifyEvent (\r
+ gEfiFwVolBlockEvent = EfiCreateProtocolNotifyEvent (\r
&gEfiFirmwareVolumeBlockProtocolGuid,\r
TPL_CALLBACK,\r
NotifyFwVolBlock,\r
NULL,\r
- &gEfiFwVolBlockNotifyReg,\r
- TRUE\r
+ &gEfiFwVolBlockNotifyReg\r
);\r
return EFI_SUCCESS;\r
}\r
\r
+\r