/** @file\r
- Firmware Volume Block protocol. Consumes FV hobs and creates\r
- appropriate block protocols.\r
+ Implementations for Firmware Volume Block protocol.\r
\r
- Also consumes NT_NON_MM_FV envinronment variable and produces appropriate\r
- block protocols fro them also... (this is TBD)\r
+ It consumes FV HOBs and creates read-lonly Firmare Volume Block protocol\r
+ instances for each of them.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
\r
**/\r
\r
-#include <DxeMain.h>\r
+#include "DxeMain.h"\r
\r
\r
EFI_FW_VOL_BLOCK_DEVICE mFwVolBlock = {\r
{\r
HARDWARE_DEVICE_PATH,\r
HW_MEMMAP_DP,\r
- { (UINT8)(sizeof (MEMMAP_DEVICE_PATH)), (UINT8)(sizeof (MEMMAP_DEVICE_PATH) >> 8) }\r
+ {\r
+ (UINT8)(sizeof (MEMMAP_DEVICE_PATH)),\r
+ (UINT8)(sizeof (MEMMAP_DEVICE_PATH) >> 8)\r
+ }\r
},\r
EfiMemoryMappedIO,\r
- (EFI_PHYSICAL_ADDRESS)0,\r
- (EFI_PHYSICAL_ADDRESS)0,\r
+ (EFI_PHYSICAL_ADDRESS) 0,\r
+ (EFI_PHYSICAL_ADDRESS) 0,\r
},\r
{\r
END_DEVICE_PATH_TYPE,\r
END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
- { END_DEVICE_PATH_LENGTH, 0 } \r
+ {\r
+ END_DEVICE_PATH_LENGTH,\r
+ 0\r
+ }\r
},\r
},\r
{\r
FwVolBlockReadBlock,\r
(EFI_FVB_WRITE)FwVolBlockWriteBlock,\r
(EFI_FVB_ERASE_BLOCKS)FwVolBlockEraseBlock,\r
- NULL \r
+ NULL\r
},\r
0,\r
NULL,\r
\r
\r
\r
-\r
-\r
/**\r
Retrieves Volume attributes. No polarity translations are done.\r
\r
- @param This Calling context \r
- @param Attributes output buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes output buffer which contains attributes\r
\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
\r
)\r
{\r
EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
//\r
/**\r
Modifies the current settings of the firmware volume according to the input parameter.\r
\r
- @param This Calling context \r
- @param Attributes input buffer which contains attributes \r
+ @param This Calling context\r
+ @param Attributes input buffer which contains attributes\r
\r
- @retval EFI_SUCCESS The firmware volume attributes were returned. \r
- @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with \r
- the capabilities as declared in the firmware \r
- volume header. \r
+ @retval EFI_SUCCESS The firmware volume attributes were returned.\r
+ @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with\r
+ the capabilities as declared in the firmware\r
+ volume header.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
block of the firmware volume), the EraseBlock() function must return\r
EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.\r
\r
- @param This Calling context \r
- @param ... Starting LBA followed by Number of Lba to erase. \r
- a -1 to terminate the list. \r
-\r
- @retval EFI_SUCCESS The erase request was successfully completed. \r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled \r
- state. \r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly \r
- and could not be written. The firmware device \r
- may have been partially erased. \r
- @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable \r
- argument list do \r
+ @param This Calling context\r
+ @param ... Starting LBA followed by Number of Lba to erase.\r
+ a -1 to terminate the list.\r
+\r
+ @retval EFI_SUCCESS The erase request was successfully completed.\r
+ @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled\r
+ state.\r
+ @retval EFI_DEVICE_ERROR The block device is not functioning correctly\r
+ and could not be written. The firmware device\r
+ may have been partially erased.\r
+ @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable\r
+ argument list do\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
/**\r
Read the specified number of bytes from the block to the input buffer.\r
\r
- @param This Indicates the calling context. \r
- @param Lba The starting logical block index to read. \r
- @param Offset Offset into the block at which to begin reading. \r
- @param NumBytes Pointer to a UINT32. At entry, *NumBytes \r
- contains the total size of the buffer. At exit, \r
- *NumBytes contains the total number of bytes \r
- actually read. \r
- @param Buffer Pinter to a caller-allocated buffer that \r
- contains the destine for the read. \r
-\r
- @retval EFI_SUCCESS The firmware volume was read successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary. \r
- @retval EFI_ACCESS_DENIED Access denied. \r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not \r
+ @param This Indicates the calling context.\r
+ @param Lba The starting logical block index to read.\r
+ @param Offset Offset into the block at which to begin reading.\r
+ @param NumBytes Pointer to a UINT32. At entry, *NumBytes\r
+ contains the total size of the buffer. At exit,\r
+ *NumBytes contains the total number of bytes\r
+ actually read.\r
+ @param Buffer Pinter to a caller-allocated buffer that\r
+ contains the destine for the read.\r
+\r
+ @retval EFI_SUCCESS The firmware volume was read successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary.\r
+ @retval EFI_ACCESS_DENIED Access denied.\r
+ @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not\r
be read.\r
\r
**/\r
UINTN LbaStart;\r
UINTN NumOfBytesRead;\r
UINTN LbaIndex;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
\r
//\r
if ((FvbDevice->FvbAttributes & EFI_FVB2_READ_STATUS) == 0) {\r
return EFI_ACCESS_DENIED;\r
}\r
- \r
- LbaIndex = (UINTN)Lba;\r
+\r
+ LbaIndex = (UINTN) Lba;\r
if (LbaIndex >= FvbDevice->NumBlocks) {\r
//\r
// Invalid Lba, read nothing.\r
*NumBytes = 0;\r
return EFI_BAD_BUFFER_SIZE;\r
}\r
- \r
+\r
if (Offset > FvbDevice->LbaCache[LbaIndex].Length) {\r
//\r
// all exceed boundry, read nothing.\r
*NumBytes = 0;\r
return EFI_BAD_BUFFER_SIZE;\r
}\r
- \r
+\r
NumOfBytesRead = *NumBytes;\r
if (Offset + NumOfBytesRead > FvbDevice->LbaCache[LbaIndex].Length) {\r
//\r
//\r
NumOfBytesRead = FvbDevice->LbaCache[LbaIndex].Length - Offset;\r
}\r
- \r
+\r
LbaStart = FvbDevice->LbaCache[LbaIndex].Base;\r
- FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)((UINTN)FvbDevice->BaseAddress);\r
- LbaOffset = (UINT8 *)FwVolHeader + LbaStart + Offset;\r
+ FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)((UINTN) FvbDevice->BaseAddress);\r
+ LbaOffset = (UINT8 *) FwVolHeader + LbaStart + Offset;\r
\r
//\r
// Perform read operation\r
//\r
CopyMem (Buffer, LbaOffset, NumOfBytesRead);\r
- \r
+\r
if (NumOfBytesRead == *NumBytes) {\r
return EFI_SUCCESS;\r
}\r
- \r
+\r
*NumBytes = NumOfBytesRead;\r
return EFI_BAD_BUFFER_SIZE;\r
}\r
- \r
+\r
\r
\r
/**\r
Writes the specified number of bytes from the input buffer to the block.\r
\r
- @param This Indicates the calling context. \r
- @param Lba The starting logical block index to write to. \r
- @param Offset Offset into the block at which to begin writing. \r
- @param NumBytes Pointer to a UINT32. At entry, *NumBytes \r
- contains the total size of the buffer. At exit, \r
- *NumBytes contains the total number of bytes \r
- actually written. \r
- @param Buffer Pinter to a caller-allocated buffer that \r
- contains the source for the write. \r
-\r
- @retval EFI_SUCCESS The firmware volume was written successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary. \r
- On output, NumBytes contains the total number of \r
- bytes actually written. \r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled \r
- state. \r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not \r
- be written. \r
+ @param This Indicates the calling context.\r
+ @param Lba The starting logical block index to write to.\r
+ @param Offset Offset into the block at which to begin writing.\r
+ @param NumBytes Pointer to a UINT32. At entry, *NumBytes\r
+ contains the total size of the buffer. At exit,\r
+ *NumBytes contains the total number of bytes\r
+ actually written.\r
+ @param Buffer Pinter to a caller-allocated buffer that\r
+ contains the source for the write.\r
+\r
+ @retval EFI_SUCCESS The firmware volume was written successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.\r
+ On output, NumBytes contains the total number of\r
+ bytes actually written.\r
+ @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled\r
+ state.\r
+ @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not\r
+ be written.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
{\r
return EFI_UNSUPPORTED;\r
}\r
- \r
+\r
\r
\r
/**\r
Get Fvb's base address.\r
\r
- @param This Indicates the calling context. \r
- @param Address Fvb device base address. \r
+ @param This Indicates the calling context.\r
+ @param Address Fvb device base address.\r
\r
- @retval EFI_SUCCESS Successfully got Fvb's base address. \r
+ @retval EFI_SUCCESS Successfully got Fvb's base address.\r
@retval EFI_UNSUPPORTED Not supported.\r
\r
**/\r
)\r
{\r
EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
- \r
+\r
if (FvbDevice->FvbAttributes & EFI_FVB2_MEMORY_MAPPED) {\r
*Address = FvbDevice->BaseAddress;\r
return EFI_SUCCESS;\r
}\r
- \r
+\r
return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
Retrieves the size in bytes of a specific block within a firmware volume.\r
\r
- @param This Indicates the calling context. \r
- @param Lba Indicates the block for which to return the \r
- size. \r
- @param BlockSize Pointer to a caller-allocated UINTN in which the \r
- size of the block is returned. \r
- @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the \r
- number of consecutive blocks starting with Lba \r
- is returned. All blocks in this range have a \r
- size of BlockSize. \r
-\r
- @retval EFI_SUCCESS The firmware volume base address is returned. \r
+ @param This Indicates the calling context.\r
+ @param Lba Indicates the block for which to return the\r
+ size.\r
+ @param BlockSize Pointer to a caller-allocated UINTN in which the\r
+ size of the block is returned.\r
+ @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the\r
+ number of consecutive blocks starting with Lba\r
+ is returned. All blocks in this range have a\r
+ size of BlockSize.\r
+\r
+ @retval EFI_SUCCESS The firmware volume base address is returned.\r
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
\r
**/\r
EFI_FW_VOL_BLOCK_DEVICE *FvbDevice;\r
EFI_FV_BLOCK_MAP_ENTRY *PtrBlockMapEntry;\r
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
- \r
+\r
FvbDevice = FVB_DEVICE_FROM_THIS (This);\r
- \r
+\r
//\r
// Do parameter checking\r
//\r
if (Lba >= FvbDevice->NumBlocks) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)((UINTN)FvbDevice->BaseAddress);\r
- \r
+\r
PtrBlockMapEntry = FwVolHeader->BlockMap;\r
- \r
+\r
//\r
// Search the block map for the given block\r
//\r
//\r
break;\r
}\r
- \r
+\r
PtrBlockMapEntry++;\r
}\r
- \r
+\r
*BlockSize = PtrBlockMapEntry->Length;\r
*NumberOfBlocks = TotalBlocks - (UINTN)Lba;\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
\r
This routine produces a firmware volume block protocol on a given\r
buffer.\r
\r
- @param BaseAddress base address of the firmware volume image \r
- @param Length length of the firmware volume image \r
- @param ParentHandle handle of parent firmware volume, if this image \r
- came from an FV image file in another firmware \r
- volume (ala capsules) \r
- @param FvProtocol Firmware volume block protocol produced. \r
+ @param BaseAddress base address of the firmware volume image\r
+ @param Length length of the firmware volume image\r
+ @param ParentHandle handle of parent firmware volume, if this image\r
+ came from an FV image file in another firmware\r
+ volume (ala capsules)\r
+ @param FvProtocol Firmware volume block protocol produced.\r
\r
- @retval EFI_VOLUME_CORRUPTED Volume corrupted. \r
- @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated. \r
- @retval EFI_SUCCESS Successfully produced a FVB protocol on given \r
+ @retval EFI_VOLUME_CORRUPTED Volume corrupted.\r
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to be allocated.\r
+ @retval EFI_SUCCESS Successfully produced a FVB protocol on given\r
buffer.\r
\r
**/\r
UINTN LinearOffset;\r
UINT32 FvAlignment;\r
EFI_FV_BLOCK_MAP_ENTRY *PtrBlockMapEntry;\r
- \r
+\r
FvAlignment = 0;\r
- FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)BaseAddress;\r
+ FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)(UINTN) BaseAddress;\r
//\r
// Validate FV Header, if not as expected, return\r
//\r
return EFI_VOLUME_CORRUPTED;\r
}\r
//\r
- // Allocate EFI_FW_VOL_BLOCK_DEVICE \r
+ // Allocate EFI_FW_VOL_BLOCK_DEVICE\r
//\r
- FvbDev = CoreAllocateCopyPool (sizeof (EFI_FW_VOL_BLOCK_DEVICE), &mFwVolBlock);\r
+ FvbDev = AllocateCopyPool (sizeof (EFI_FW_VOL_BLOCK_DEVICE), &mFwVolBlock);\r
if (FvbDev == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
//\r
FvbDev->NumBlocks = 0;\r
for (PtrBlockMapEntry = FwVolHeader->BlockMap;\r
- PtrBlockMapEntry->NumBlocks != 0;\r
- PtrBlockMapEntry++) {\r
+ PtrBlockMapEntry->NumBlocks != 0;\r
+ PtrBlockMapEntry++) {\r
FvbDev->NumBlocks += PtrBlockMapEntry->NumBlocks;\r
}\r
//\r
// Second, allocate the cache\r
//\r
- FvbDev->LbaCache = CoreAllocateBootServicesPool (FvbDev->NumBlocks * sizeof (LBA_CACHE));\r
+ FvbDev->LbaCache = AllocatePool (FvbDev->NumBlocks * sizeof (LBA_CACHE));\r
if (FvbDev->LbaCache == NULL) {\r
CoreFreePool (FvbDev);\r
return EFI_OUT_OF_RESOURCES;\r
BlockIndex = 0;\r
LinearOffset = 0;\r
for (PtrBlockMapEntry = FwVolHeader->BlockMap;\r
- PtrBlockMapEntry->NumBlocks != 0; PtrBlockMapEntry++) {\r
+ PtrBlockMapEntry->NumBlocks != 0; PtrBlockMapEntry++) {\r
for (BlockIndex2 = 0; BlockIndex2 < PtrBlockMapEntry->NumBlocks; BlockIndex2++) {\r
FvbDev->LbaCache[BlockIndex].Base = LinearOffset;\r
FvbDev->LbaCache[BlockIndex].Length = PtrBlockMapEntry->Length;\r
// Attach FvVolBlock Protocol to new handle\r
//\r
Status = CoreInstallMultipleProtocolInterfaces (\r
- &FvbDev->Handle,\r
- &gEfiFirmwareVolumeBlockProtocolGuid, &FvbDev->FwVolBlockInstance,\r
- &gEfiDevicePathProtocolGuid, &FvbDev->DevicePath,\r
- &gEfiFirmwareVolumeDispatchProtocolGuid, NULL,\r
- NULL\r
- );\r
+ &FvbDev->Handle,\r
+ &gEfiFirmwareVolumeBlockProtocolGuid, &FvbDev->FwVolBlockInstance,\r
+ &gEfiDevicePathProtocolGuid, &FvbDev->DevicePath,\r
+ &gEfiFirmwareVolumeDispatchProtocolGuid, NULL,\r
+ NULL\r
+ );\r
\r
//\r
// If they want the handle back, set it.\r
libraries, consumes FV hobs and NT_NON_MM_FV environment variable and\r
produces instances of FW_VOL_BLOCK_PROTOCOL as appropriate.\r
\r
- @param ImageHandle The image handle. \r
- @param SystemTable The system table. \r
+ @param ImageHandle The image handle.\r
+ @param SystemTable The system table.\r
\r
- @retval EFI_SUCCESS Successfully initialized firmware volume block \r
+ @retval EFI_SUCCESS Successfully initialized firmware volume block\r
driver.\r
\r
**/\r
)\r
{\r
EFI_PEI_HOB_POINTERS FvHob;\r
+\r
//\r
// Core Needs Firmware Volumes to function\r
//\r
//\r
// Produce an FVB protocol for it\r
//\r
- ProduceFVBProtocolOnBuffer (FvHob.FirmwareVolume->BaseAddress, FvHob.FirmwareVolume->Length, NULL, NULL); \r
+ ProduceFVBProtocolOnBuffer (FvHob.FirmwareVolume->BaseAddress, FvHob.FirmwareVolume->Length, NULL, NULL);\r
FvHob.Raw = GET_NEXT_HOB (FvHob);\r
}\r
+\r
return EFI_SUCCESS;\r
}\r
\r
particular, it can be called by BDS to process a single firmware\r
volume found in a capsule.\r
\r
- @param FvHeader pointer to a firmware volume header \r
- @param Size the size of the buffer pointed to by FvHeader \r
- @param FVProtocolHandle the handle on which a firmware volume protocol \r
- was produced for the firmware volume passed in. \r
+ @param FvHeader pointer to a firmware volume header\r
+ @param Size the size of the buffer pointed to by FvHeader\r
+ @param FVProtocolHandle the handle on which a firmware volume protocol\r
+ was produced for the firmware volume passed in.\r
\r
- @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of \r
- system resources \r
- @retval EFI_VOLUME_CORRUPTED if the volume was corrupted \r
- @retval EFI_SUCCESS a firmware volume protocol was produced for the \r
+ @retval EFI_OUT_OF_RESOURCES if an FVB could not be produced due to lack of\r
+ system resources\r
+ @retval EFI_VOLUME_CORRUPTED if the volume was corrupted\r
+ @retval EFI_SUCCESS a firmware volume protocol was produced for the\r
firmware volume\r
\r
**/\r
EFI_STATUS\r
CoreProcessFirmwareVolume (\r
IN VOID *FvHeader,\r
- IN UINTN Size, \r
+ IN UINTN Size,\r
OUT EFI_HANDLE *FVProtocolHandle\r
)\r
{\r
EFI_STATUS Status;\r
\r
*FVProtocolHandle = NULL;\r
- Status = ProduceFVBProtocolOnBuffer ( \r
- (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader, \r
- (UINT64)Size, \r
- NULL, \r
+ Status = ProduceFVBProtocolOnBuffer (\r
+ (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
+ (UINT64)Size,\r
+ NULL,\r
FVProtocolHandle\r
);\r
//\r
// Since in our implementation we use register-protocol-notify to put a\r
// FV protocol on the FVB protocol handle, we can't directly verify that\r
// the FV protocol was produced. Therefore here we will check the handle\r
- // and make sure an FV protocol is on it. This indicates that all went \r
- // well. Otherwise we have to assume that the volume was corrupted \r
+ // and make sure an FV protocol is on it. This indicates that all went\r
+ // well. Otherwise we have to assume that the volume was corrupted\r
// somehow.\r
//\r
if (!EFI_ERROR(Status)) {\r
Ptr = NULL;\r
- Status = CoreHandleProtocol (*FVProtocolHandle, &gEfiFirmwareVolume2ProtocolGuid, (VOID **)&Ptr);\r
+ Status = CoreHandleProtocol (*FVProtocolHandle, &gEfiFirmwareVolume2ProtocolGuid, (VOID **) &Ptr);\r
if (EFI_ERROR(Status) || (Ptr == NULL)) {\r
return EFI_VOLUME_CORRUPTED;\r
}\r
projects / mirror_edk2.git / blobdiff