#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
@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 is larger than the last block of the firmware volume. Offset is larger than the block size.\r
-
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
\r
-/**
+/**\r
Erases and initializes a firmware volume block.\r
\r
The EfiFvbEraseBlock() function erases one block specified by Lba.\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_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
);\r
\r
\r
-/**
+/**\r
Retrieves the attributes and current settings of the specified block, \r
returns resulting attributes in output parameter.\r
\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
);\r
\r
\r
-/**
+/**\r
Modify the attributes and current settings of the specified block\r
according to the input parameter.\r
\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
);\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
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
);\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
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
@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
);\r
\r
\r
-/**
+/**\r
Erases and initializes a specified range of a firmware volume.\r
\r
The EfiFvbEraseCustomBlockRange() function erases the specified range in the firmware\r
LastLba index is larger than the last block of the firmware volume, StartLba > LastLba\r
or StartLba equal to LastLba but OffsetStartLba > OffsetLastLba, this function return \r
the status code EFI_INVALID_PARAMETER.\r
-
+\r
@param[in] Instance The FV instance to be operated.\r
@param[in] StartLba The starting logical block index to be erased.\r
@param[in] OffsetStartLba Offset into the starting block at which to \r
begin erasing. \r
@param[in] LastLba The last logical block index to be erased.\r
@param[in] OffsetLastLba Offset into the last block at which to end erasing. \r
-
+\r
@retval EFI_EFI_SUCCESS Successfully erase custom block range\r
@retval EFI_INVALID_PARAMETER Invalid parameter. Instance is larger than the max FVB number. \r
@retval EFI_UNSUPPORTED Firmware volume block device has no this capability.\r
-
+\r
**/\r
EFI_STATUS\r
EFIAPI\r