+++ /dev/null
-/** @file\r
- Firmeware Volume BLock Service Library\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
-**/\r
-\r
-#ifndef __FVB_SERVICE_LIB_H__\r
-#define __FVB_SERVICE_LIB_H__\r
-\r
-/**\r
- Reads specified number of bytes into a buffer from the specified block.\r
-\r
- The EfiFvbReadBlock() function reads the requested number of bytes from\r
- the requested block in the specified firmware volume and stores them in\r
- the provided buffer. Implementations should be mindful that the firmware\r
- volume might be in the ReadDisabled state. If it is in this state, the \r
- EfiFvbReadBlock() function must return the status code EFI_ACCESS_DENIED\r
- without modifying the contents of the buffer.\r
- \r
- The EfiFvbReadBlock() function must also prevent spanning block boundaries.\r
- If a read is requested that would span a block boundary, the read must read\r
- up to the boundary but not beyond. The output parameter NumBytes must be\r
- set to correctly indicate the number of bytes actually read. \r
- The caller must be aware that a read may be partially completed.\r
-\r
- If NumBytes is NULL, then ASSERT().\r
-\r
- If Buffer is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be read from.\r
- @param[in] Lba The logical block address to be read from\r
- @param[in] Offset The offset relative to the block, at which to begin reading.\r
- @param[in, out] NumBytes Pointer to a UINTN. On input, *NumBytes contains the total\r
- size of the buffer. On output, it contains the actual number\r
- of bytes read.\r
- @param[out] Buffer Pointer to a caller allocated buffer that will be\r
- used to hold the data read.\r
-\r
- @retval EFI_SUCCESS The firmware volume was read successfully and contents are in Buffer.\r
- @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA boundary. On output, NumBytes contains\r
- the total number of bytes returned in Buffer.\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the ReadDisabled state.\r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be read.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter, Instance is larger than the max FVB number. Lba index\r
- is larger than the last block of the firmware volume. Offset is larger\r
- than the block size.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbReadBlock (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba,\r
- IN UINTN Offset,\r
- IN OUT UINTN *NumBytes,\r
- OUT UINT8 *Buffer\r
- );\r
-\r
-\r
-/**\r
- Writes specified number of bytes from the input buffer to the block\r
-\r
- The EfiFvbWriteBlock() function writes the specified number of bytes\r
- from the provided buffer to the specified block and offset in the \r
- requested firmware volume. \r
-\r
- If the firmware volume is sticky write, the caller must ensure that\r
- all the bits of the specified range to write are in the EFI_FVB_ERASE_POLARITY\r
- state before calling the EfiFvbWriteBlock() function, or else the \r
- result will be unpredictable. This unpredictability arises because,\r
- for a sticky-write firmware volume, a write may negate a bit in the \r
- EFI_FVB_ERASE_POLARITY state but it cannot flip it back again. In \r
- general, before calling the EfiFvbWriteBlock() function, the caller\r
- should call the EfiFvbEraseBlock() function first to erase the specified\r
- block to write. A block erase cycle will transition bits from the\r
- (NOT)EFI_FVB_ERASE_POLARITY state back to the EFI_FVB_ERASE_POLARITY state.\r
- Implementations should be mindful that the firmware volume might be \r
- in the WriteDisabled state. If it is in this state, the EfiFvbWriteBlock()\r
- function must return the status code EFI_ACCESS_DENIED without modifying\r
- the contents of the firmware volume.\r
- \r
- The EfiFvbWriteBlock() function must also prevent spanning block boundaries.\r
- If a write is requested that spans a block boundary, the write must store\r
- up to the boundary but not beyond. The output parameter NumBytes must be \r
- set to correctly indicate the number of bytes actually written. The caller\r
- must be aware that a write may be partially completed.\r
- All writes, partial or otherwise, must be fully flushed to the hardware \r
- before the EfiFvbWriteBlock() function returns. \r
- \r
- If NumBytes is NULL, then ASSERT().\r
-\r
- @param Instance The FV instance to be written to\r
- @param Lba The starting logical block index to write to\r
- @param Offset The offset relative to the block, at which to begin writting.\r
- @param NumBytes Pointer to a UINTN. On input, *NumBytes contains\r
- the total size of the buffer. On output, it contains\r
- the actual number of bytes written.\r
- @param Buffer Pointer to a caller allocated buffer that contains\r
- 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 bytes actually written.\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.\r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter, Instance is larger than the max FVB number. \r
- Lba index is larger than the last block of the firmware volume.\r
- Offset is larger than the block size.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbWriteBlock (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba,\r
- IN UINTN Offset,\r
- IN OUT UINTN *NumBytes,\r
- IN UINT8 *Buffer\r
- );\r
-\r
-\r
-/**\r
- Erases and initializes a firmware volume block.\r
-\r
- The EfiFvbEraseBlock() function erases one block specified by Lba.\r
- Implementations should be mindful that the firmware volume might \r
- be in the WriteDisabled state. If it is in this state, the EfiFvbEraseBlock()\r
- function must return the status code EFI_ACCESS_DENIED without \r
- modifying the contents of the firmware volume. If Instance is \r
- larger than the max FVB number, or Lba index is larger than the\r
- last block of the firmware volume, this function return the status\r
- code EFI_INVALID_PARAMETER.\r
- \r
- All calls to EfiFvbEraseBlock() must be fully flushed to the \r
- hardware before this function returns. \r
-\r
- @param[in] Instance The FV instance to be erased.\r
- @param[in] Lba The logical block index to be erased from.\r
- \r
- @retval EFI_SUCCESS The erase request was successfully completed.\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.\r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly and\r
- could not be written. The firmware device may \r
- have been partially erased.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max\r
- FVB number. Lba index is larger than the last block\r
- of the firmware volume. \r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbEraseBlock (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba\r
- );\r
-\r
-\r
-/**\r
- Retrieves the attributes and current settings of the specified block, \r
- returns resulting attributes in output parameter.\r
-\r
- The EfiFvbGetAttributes() function retrieves the attributes and current\r
- settings of the block specified by Instance. If Instance is larger than\r
- the max FVB number, this function returns the status code EFI_INVALID_PARAMETER.\r
-\r
- If Attributes is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[out] Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the\r
- attributes and current settings are returned.\r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume attributes were returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number. \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbGetVolumeAttributes (\r
- IN UINTN Instance,\r
- OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
- );\r
-\r
-\r
-/**\r
- Modify the attributes and current settings of the specified block\r
- according to the input parameter.\r
-\r
- The EfiFvbSetAttributes() function sets configurable firmware volume\r
- attributes and returns the new settings of the firmware volume specified\r
- by Instance. If Instance is larger than the max FVB number, this function\r
- returns the status code EFI_INVALID_PARAMETER.\r
-\r
- If Attributes is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[in, out]Attributes On input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2\r
- that contains the desired firmware volume settings. \r
- On successful return, it contains the new settings of the firmware volume.\r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume attributes were modified successfully.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbSetVolumeAttributes (\r
- IN UINTN Instance,\r
- IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
- );\r
-\r
-\r
-/**\r
- Retrieves the physical address of the specified memory mapped FV.\r
-\r
- Retrieve the base address of a memory-mapped firmware volume specified by Instance.\r
- If Instance is larger than the max FVB number, this function returns the status \r
- code EFI_INVALID_PARAMETER.\r
- \r
- If BaseAddress is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[out] BaseAddress Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
- that on successful return, contains the base address\r
- of the firmware volume. \r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume base address is returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number. \r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbGetPhysicalAddress (\r
- IN UINTN Instance,\r
- OUT EFI_PHYSICAL_ADDRESS *BaseAddress\r
- );\r
-\r
-\r
-/**\r
- Retrieve the block size of the specified fv.\r
- \r
- The EfiFvbGetBlockSize() function retrieves the size of the requested block. \r
- It also returns the number of additional blocks with the identical size. \r
- If Instance is larger than the max FVB number, or Lba index is larger than\r
- the last block of the firmware volume, this function return the status code\r
- EFI_INVALID_PARAMETER.\r
-\r
- If BlockSize is NULL, then ASSERT().\r
- \r
- If NumOfBlocks is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[in] Lba Indicates which block to return the size for.\r
- @param[out] BlockSize Pointer to a caller-allocated UINTN in which the\r
- size of the block is returned.\r
- @param[out] NumOfBlocks 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 size of BlockSize.\r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume base address is returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number.\r
- Lba index is larger than the last block of the firmware volume.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbGetBlockSize (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba,\r
- OUT UINTN *BlockSize,\r
- OUT UINTN *NumOfBlocks\r
- );\r
-\r
-#endif\r
+++ /dev/null
-/**@file\r
- Firmware Volume Block Protocol Runtime Interface Abstraction\r
- And FVB Extension protocol Runtime Interface Abstraction\r
-\r
- mFvbEntry is an array of Handle Fvb pairs. The Fvb Lib Instance matches the\r
- index in the mFvbEntry array. This should be the same sequence as the FVB's\r
- were described in the HOB. We have to remember the handle so we can tell if\r
- the protocol has been reinstalled and it needs updating.\r
-\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\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
-\r
-#include "Fvb.h"\r
-\r
-\r
-//\r
-// Event for Set Virtual Map Changed Event\r
-//\r
-EFI_EVENT mSetVirtualMapChangedEvent = NULL;\r
-\r
-//\r
-// Lib will ASSERT if more FVB devices than this are added to the system.\r
-//\r
-FVB_ENTRY *mFvbEntry = NULL;\r
-EFI_EVENT mFvbRegistration = NULL;\r
-UINTN mFvbCount = 0;\r
-\r
-/**\r
- Check whether an address is runtime memory or not.\r
-\r
- @param Address The Address being checked.\r
-\r
- @retval TRUE The address is runtime memory.\r
- @retval FALSE The address is not runtime memory.\r
-**/\r
-BOOLEAN\r
-IsRuntimeMemory (\r
- IN VOID *Address\r
- )\r
-{\r
- EFI_STATUS Status;\r
- UINT8 TmpMemoryMap[1];\r
- UINTN MapKey;\r
- UINTN DescriptorSize;\r
- UINT32 DescriptorVersion;\r
- UINTN MemoryMapSize;\r
- EFI_MEMORY_DESCRIPTOR *MemoryMap;\r
- EFI_MEMORY_DESCRIPTOR *MemoryMapPtr;\r
- BOOLEAN IsRuntime;\r
- UINTN Index;\r
-\r
- IsRuntime = FALSE;\r
-\r
- //\r
- // Get System MemoryMapSize\r
- //\r
- MemoryMapSize = 1;\r
- Status = gBS->GetMemoryMap (\r
- &MemoryMapSize,\r
- (EFI_MEMORY_DESCRIPTOR *)TmpMemoryMap,\r
- &MapKey,\r
- &DescriptorSize,\r
- &DescriptorVersion\r
- );\r
- ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
- //\r
- // Enlarge space here, because we will allocate pool now.\r
- //\r
- MemoryMapSize += EFI_PAGE_SIZE;\r
- MemoryMap = AllocatePool (MemoryMapSize);\r
- ASSERT (MemoryMap != NULL);\r
-\r
- //\r
- // Get System MemoryMap\r
- //\r
- Status = gBS->GetMemoryMap (\r
- &MemoryMapSize,\r
- MemoryMap,\r
- &MapKey,\r
- &DescriptorSize,\r
- &DescriptorVersion\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- MemoryMapPtr = MemoryMap;\r
- //\r
- // Search the request Address\r
- //\r
- for (Index = 0; Index < (MemoryMapSize / DescriptorSize); Index++) {\r
- if (((EFI_PHYSICAL_ADDRESS)(UINTN)Address >= MemoryMap->PhysicalStart) &&\r
- ((EFI_PHYSICAL_ADDRESS)(UINTN)Address < MemoryMap->PhysicalStart\r
- + LShiftU64 (MemoryMap->NumberOfPages, EFI_PAGE_SHIFT))) {\r
- //\r
- // Found it\r
- //\r
- if ((MemoryMap->Attribute & EFI_MEMORY_RUNTIME) != 0) {\r
- IsRuntime = TRUE;\r
- }\r
- break;\r
- }\r
- //\r
- // Get next item\r
- //\r
- MemoryMap = (EFI_MEMORY_DESCRIPTOR *)((UINTN) MemoryMap + DescriptorSize);\r
- }\r
-\r
- //\r
- // Done\r
- //\r
- FreePool (MemoryMapPtr);\r
-\r
- return IsRuntime;\r
-}\r
-\r
-\r
-/**\r
- Update mFvbEntry. Add new entry, or update existing entry if Fvb protocol is\r
- reinstalled.\r
-\r
- @param Event The Event that is being processed\r
- @param Context Event Context\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-FvbNotificationEvent (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
- EFI_STATUS Status;\r
- UINTN BufferSize;\r
- EFI_HANDLE Handle;\r
- UINTN Index;\r
- UINTN UpdateIndex;\r
-\r
- while (TRUE) {\r
- BufferSize = sizeof (Handle);\r
- Status = gBS->LocateHandle (\r
- ByRegisterNotify,\r
- &gEfiFirmwareVolumeBlockProtocolGuid,\r
- mFvbRegistration,\r
- &BufferSize,\r
- &Handle\r
- );\r
- if (EFI_ERROR (Status)) {\r
- //\r
- // Exit Path of While Loop....\r
- //\r
- break;\r
- }\r
-\r
- UpdateIndex = MAX_FVB_COUNT;\r
- for (Index = 0; Index < mFvbCount; Index++) {\r
- if (mFvbEntry[Index].Handle == Handle) {\r
- //\r
- // If the handle is already in the table just update the protocol\r
- //\r
- UpdateIndex = Index;\r
- break;\r
- }\r
- }\r
-\r
- if (UpdateIndex == MAX_FVB_COUNT) {\r
- //\r
- // Use the next free slot for a new entry\r
- //\r
- UpdateIndex = mFvbCount++;\r
- //\r
- // Check the UpdateIndex whether exceed the maximum value.\r
- //\r
- ASSERT (UpdateIndex < MAX_FVB_COUNT);\r
- mFvbEntry[UpdateIndex].Handle = Handle;\r
- }\r
- //\r
- // The array does not have enough entries\r
- //\r
- ASSERT (UpdateIndex < MAX_FVB_COUNT);\r
-\r
- //\r
- // Get the interface pointer and if it's ours, skip it\r
- //\r
- Status = gBS->HandleProtocol (\r
- Handle,\r
- &gEfiFirmwareVolumeBlockProtocolGuid,\r
- (VOID **) &mFvbEntry[UpdateIndex].Fvb\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- //\r
- // Check the FVB can be accessed in RUNTIME, The FVBs in FVB handle list come from two ways:\r
- // 1) Dxe Core. (FVB information is transferred from FV HOB). 2) FVB driver. The FVB produced\r
- // Dxe core is used to discovery DXE driver and dispatch. These FVBs can only be accessed in\r
- // boot time. FVB driver will discovery all FV in FLASH and these FVBs can be accessed in\r
- // runtime. The FVB itself produced by FVB driver is allocated in runtime memory. So we can\r
- // determine the what FVB can be accessed in RUNTIME by judging whether FVB itself is allocated\r
- // in RUNTIME memory.\r
- //\r
- mFvbEntry[UpdateIndex].IsRuntimeAccess = IsRuntimeMemory (mFvbEntry[UpdateIndex].Fvb);\r
- }\r
-}\r
-\r
-/**\r
- Convert all pointers in mFvbEntry after ExitBootServices.\r
-\r
- @param Event The Event that is being processed\r
- @param Context Event Context\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-FvbVirtualAddressChangeNotifyEvent (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
- UINTN Index;\r
-\r
- if (mFvbEntry != NULL) {\r
- for (Index = 0; Index < MAX_FVB_COUNT; Index++) {\r
- if (!mFvbEntry[Index].IsRuntimeAccess) {\r
- continue;\r
- }\r
-\r
- if (mFvbEntry[Index].Fvb != NULL) {\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->GetBlockSize);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->GetPhysicalAddress);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->GetAttributes);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->SetAttributes);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->Read);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->Write);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->EraseBlocks);\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb);\r
- }\r
- }\r
-\r
- EfiConvertPointer (0x0, (VOID **) &mFvbEntry);\r
- }\r
-}\r
-\r
-\r
-/**\r
- Library constructor function entry.\r
-\r
- @param ImageHandle The handle of image who call this library.\r
- @param SystemTable The point of System Table.\r
-\r
- @retval EFI_SUCESS Success construct this library.\r
- @retval Others Fail to construct this library.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-FvbLibInitialize (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-{\r
- EFI_STATUS Status;\r
- \r
- mFvbEntry = AllocateRuntimeZeroPool (sizeof (FVB_ENTRY) * MAX_FVB_COUNT);\r
- ASSERT (mFvbEntry != NULL);\r
-\r
- //\r
- // Register FvbNotificationEvent () notify function.\r
- // \r
- EfiCreateProtocolNotifyEvent (\r
- &gEfiFirmwareVolumeBlockProtocolGuid,\r
- TPL_CALLBACK,\r
- FvbNotificationEvent,\r
- NULL,\r
- &mFvbRegistration\r
- );\r
-\r
- //\r
- // Register SetVirtualAddressMap () notify function\r
- //\r
- Status = gBS->CreateEventEx (\r
- EVT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- FvbVirtualAddressChangeNotifyEvent,\r
- NULL,\r
- &gEfiEventVirtualAddressChangeGuid,\r
- &mSetVirtualMapChangedEvent\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return Status;\r
-}\r
-\r
-//\r
-// =============================================================================\r
-// The following functions wrap Fvb protocol in the Runtime Lib functions.\r
-// The Instance translates into Fvb instance. The Fvb order defined by HOBs and\r
-// thus the sequence of FVB protocol addition define Instance.\r
-//\r
-\r
-/**\r
- Reads specified number of bytes into a buffer from the specified block.\r
-\r
- The EfiFvbReadBlock() function reads the requested number of bytes from\r
- the requested block in the specified firmware volume and stores them in\r
- the provided buffer. Implementations should be mindful that the firmware\r
- volume might be in the ReadDisabled state. If it is in this state, the \r
- EfiFvbReadBlock() function must return the status code EFI_ACCESS_DENIED\r
- without modifying the contents of the buffer.\r
- \r
- The EfiFvbReadBlock() function must also prevent spanning block boundaries.\r
- If a read is requested that would span a block boundary, the read must read\r
- up to the boundary but not beyond. The output parameter NumBytes must be\r
- set to correctly indicate the number of bytes actually read. \r
- The caller must be aware that a read may be partially completed.\r
-\r
- If NumBytes is NULL, then ASSERT().\r
-\r
- If Buffer is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be read from.\r
- @param[in] Lba The logical block address to be read from\r
- @param[in] Offset The offset relative to the block, at which to begin reading.\r
- @param[in, out] NumBytes Pointer to a UINTN. On input, *NumBytes contains the total\r
- size of the buffer. On output, it contains the actual number\r
- of bytes read.\r
- @param[out] Buffer Pointer to a caller allocated buffer that will be\r
- used to hold the data read.\r
-\r
- @retval EFI_SUCCESS The firmware volume was read successfully and contents are in Buffer.\r
- @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA boundary. On output, NumBytes contains\r
- the total number of bytes returned in Buffer.\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the ReadDisabled state.\r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be read.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter, Instance is larger than the max FVB number. Lba index\r
- is larger than the last block of the firmware volume. Offset is larger\r
- than the block size.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbReadBlock (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba,\r
- IN UINTN Offset,\r
- IN OUT UINTN *NumBytes,\r
- OUT UINT8 *Buffer\r
- )\r
-{\r
- ASSERT (NumBytes != NULL);\r
- ASSERT (Buffer != NULL);\r
- \r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->Read (mFvbEntry[Instance].Fvb, Lba, Offset, NumBytes, Buffer);\r
-}\r
-\r
-/**\r
- Writes specified number of bytes from the input buffer to the block\r
-\r
- The EfiFvbWriteBlock() function writes the specified number of bytes\r
- from the provided buffer to the specified block and offset in the \r
- requested firmware volume. \r
-\r
- If the firmware volume is sticky write, the caller must ensure that\r
- all the bits of the specified range to write are in the EFI_FVB_ERASE_POLARITY\r
- state before calling the EfiFvbWriteBlock() function, or else the \r
- result will be unpredictable. This unpredictability arises because,\r
- for a sticky-write firmware volume, a write may negate a bit in the \r
- EFI_FVB_ERASE_POLARITY state but it cannot flip it back again. In \r
- general, before calling the EfiFvbWriteBlock() function, the caller\r
- should call the EfiFvbEraseBlock() function first to erase the specified\r
- block to write. A block erase cycle will transition bits from the\r
- (NOT)EFI_FVB_ERASE_POLARITY state back to the EFI_FVB_ERASE_POLARITY state.\r
- Implementations should be mindful that the firmware volume might be \r
- in the WriteDisabled state. If it is in this state, the EfiFvbWriteBlock()\r
- function must return the status code EFI_ACCESS_DENIED without modifying\r
- the contents of the firmware volume.\r
- \r
- The EfiFvbWriteBlock() function must also prevent spanning block boundaries.\r
- If a write is requested that spans a block boundary, the write must store\r
- up to the boundary but not beyond. The output parameter NumBytes must be \r
- set to correctly indicate the number of bytes actually written. The caller\r
- must be aware that a write may be partially completed.\r
- All writes, partial or otherwise, must be fully flushed to the hardware \r
- before the EfiFvbWriteBlock() function returns. \r
- \r
- If NumBytes is NULL, then ASSERT().\r
-\r
- @param Instance The FV instance to be written to.\r
- @param Lba The starting logical block index to write.\r
- @param Offset The offset relative to the block to write.\r
- @param NumBytes Pointer to a UINTN. On input, *NumBytes contains\r
- the total size of the buffer. On output, it contains\r
- the actual number of bytes written.\r
- @param Buffer Pointer to a caller allocated buffer that contains\r
- 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 bytes actually written.\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.\r
- @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not be written.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter, Instance is larger than the max FVB number. \r
- Lba index is larger than the last block of the firmware volume.\r
- Offset is larger than the block size.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbWriteBlock (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba,\r
- IN UINTN Offset,\r
- IN OUT UINTN *NumBytes,\r
- IN UINT8 *Buffer\r
- )\r
-{\r
- ASSERT (NumBytes != NULL);\r
- \r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->Write (mFvbEntry[Instance].Fvb, Lba, Offset, NumBytes, Buffer);\r
-}\r
-\r
-\r
-/**\r
- Erases and initializes a firmware volume block.\r
-\r
- The EfiFvbEraseBlock() function erases one block specified by Lba.\r
- Implementations should be mindful that the firmware volume might \r
- be in the WriteDisabled state. If it is in this state, the EfiFvbEraseBlock()\r
- function must return the status code EFI_ACCESS_DENIED without \r
- modifying the contents of the firmware volume. If Instance is \r
- larger than the max FVB number, or Lba index is larger than the\r
- last block of the firmware volume, this function return the status\r
- code EFI_INVALID_PARAMETER.\r
- \r
- All calls to EfiFvbEraseBlock() must be fully flushed to the \r
- hardware before this function returns. \r
-\r
- @param[in] Instance The FV instance to be erased.\r
- @param[in] Lba The logical block index to be erased from.\r
- \r
- @retval EFI_SUCCESS The erase request was successfully completed.\r
- @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled state.\r
- @retval EFI_DEVICE_ERROR The block device is not functioning correctly and\r
- could not be written. The firmware device may \r
- have been partially erased.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max\r
- FVB number. Lba index is larger than the last block\r
- of the firmware volume. \r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbEraseBlock (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba\r
- )\r
-{\r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->EraseBlocks (mFvbEntry[Instance].Fvb, Lba, 1, EFI_LBA_LIST_TERMINATOR);\r
-}\r
-\r
-\r
-/**\r
- Retrieves the attributes and current settings of the specified block, \r
- returns resulting attributes in output parameter.\r
-\r
- The EfiFvbGetAttributes() function retrieves the attributes and current\r
- settings of the block specified by Instance. If Instance is larger than\r
- the max FVB number, this function returns the status code EFI_INVALID_PARAMETER.\r
-\r
- If Attributes is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[out] Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the\r
- attributes and current settings are returned.\r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume attributes were returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number. \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbGetVolumeAttributes (\r
- IN UINTN Instance,\r
- OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
- )\r
-{\r
- ASSERT (Attributes != NULL);\r
- \r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->GetAttributes (mFvbEntry[Instance].Fvb, Attributes);\r
-}\r
-\r
-\r
-/**\r
- Modify the attributes and current settings of the specified block\r
- according to the input parameter.\r
-\r
- The EfiFvbSetAttributes() function sets configurable firmware volume\r
- attributes and returns the new settings of the firmware volume specified\r
- by Instance. If Instance is larger than the max FVB number, this function\r
- returns the status code EFI_INVALID_PARAMETER.\r
-\r
- If Attributes is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[in, out]Attributes On input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2\r
- that contains the desired firmware volume settings. \r
- On successful return, it contains the new settings of the firmware volume.\r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume attributes were modified successfully.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbSetVolumeAttributes (\r
- IN UINTN Instance,\r
- IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
- )\r
-{\r
- ASSERT (Attributes != NULL);\r
- \r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->SetAttributes (mFvbEntry[Instance].Fvb, Attributes);\r
-}\r
-\r
-\r
-/**\r
- Retrieves the physical address of the specified memory mapped FV.\r
-\r
- Retrieve the base address of a memory-mapped firmware volume specified by Instance.\r
- If Instance is larger than the max FVB number, this function returns the status \r
- code EFI_INVALID_PARAMETER.\r
- \r
- If BaseAddress is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[out] BaseAddress Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
- that on successful return, contains the base address\r
- of the firmware volume. \r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume base address is returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number. \r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbGetPhysicalAddress (\r
- IN UINTN Instance,\r
- OUT EFI_PHYSICAL_ADDRESS *BaseAddress\r
- )\r
-{\r
- ASSERT (BaseAddress != NULL);\r
- \r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->GetPhysicalAddress (mFvbEntry[Instance].Fvb, BaseAddress);\r
-}\r
-\r
-\r
-/**\r
- Retrieve the block size of the specified fv.\r
- \r
- The EfiFvbGetBlockSize() function retrieves the size of the requested block. \r
- It also returns the number of additional blocks with the identical size. \r
- If Instance is larger than the max FVB number, or Lba index is larger than\r
- the last block of the firmware volume, this function return the status code\r
- EFI_INVALID_PARAMETER.\r
-\r
- If BlockSize is NULL, then ASSERT().\r
- \r
- If NumOfBlocks is NULL, then ASSERT().\r
-\r
- @param[in] Instance The FV instance to be operated.\r
- @param[in] Lba Indicates which block to return the size for.\r
- @param[out] BlockSize Pointer to a caller-allocated UINTN in which the\r
- size of the block is returned.\r
- @param[out] NumOfBlocks 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 size of BlockSize.\r
-\r
- @retval EFI_EFI_SUCCESS The firmware volume base address is returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number.\r
- Lba index is larger than the last block of the firmware volume.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EfiFvbGetBlockSize (\r
- IN UINTN Instance,\r
- IN EFI_LBA Lba,\r
- OUT UINTN *BlockSize,\r
- OUT UINTN *NumOfBlocks\r
- )\r
-{\r
- ASSERT (BlockSize != NULL);\r
- ASSERT (NumOfBlocks != NULL);\r
- \r
- if (Instance >= mFvbCount) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (EfiAtRuntime() && !mFvbEntry[Instance].IsRuntimeAccess) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- return mFvbEntry[Instance].Fvb->GetBlockSize (mFvbEntry[Instance].Fvb, Lba, BlockSize, NumOfBlocks);\r
-}\r
projects / mirror_edk2.git / commitdiff