\r
**/\r
\r
-#ifndef __EDK_FVB_SERVICE_LIB_H__\r
-#define __EDK_FVB_SERVICE_LIB_H__\r
+#ifndef __FVB_SERVICE_LIB_H__\r
+#define __FVB_SERVICE_LIB_H__\r
\r
/**
- Reads specified number of bytes into a buffer from the specified block\r
+ Reads specified number of bytes into a buffer from the specified block.\r
- @param[in] Instance The FV instance to be read from
+ @param[in] Instance The FV instance to be read from.\r
@param[in] Lba The logical block address to be read from
@param[in] Offset Offset into the block at which to begin reading
- @param[in,out] NumBytes Pointer that on input contains the total size of\r
+ @param[in, out] NumBytes Pointer that on input contains the total size of\r
the buffer. On output, it contains the total number\r
- of bytes read
+ of bytes read.\r
@param[in] Buffer Pointer to a caller allocated buffer that will be\r
- used to hold the data read
+ used to hold the data read.\r
@retval EFI_EFI_SUCCESS Buffer contains data read from FVB
@retval EFI_INVALID_PARAMETER invalid parameter
**/\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
- IN UINT8 *Buffer\r
+ OUT UINT8 *Buffer\r
);\r
\r
\r
/**
- Writes specified number of bytes from the input buffer to the block\r
+ Writes specified number of bytes from the input buffer to the block.\r
- @param[in] Instance The FV instance to be read from
+ @param[in] Instance The FV instance to be read from.\r
@param[in] Lba The logical block address to be write to
@param[in] Offset Offset into the block at which to begin writing
- @param[in,out] NumBytes Pointer that on input contains the total size of\r
+ @param[in, out] NumBytes Pointer that on input contains the total size of\r
the buffer. On output, it contains the total number\r
of bytes actually written.
@param[in] Buffer Pointer to a caller allocated buffer that contains\r
- the source for the write
+ the source for the write.\r
@retval EFI_EFI_SUCCESS Buffer written to FVB
@retval EFI_INVALID_PARAMETER invalid parameter
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbWriteBlock (\r
IN UINTN Instance,\r
IN EFI_LBA Lba,\r
\r
\r
/**
- Erases and initializes a firmware volume block\r
+ Erases and initializes a firmware volume block.\r
- @param[in] Instance The FV instance to be erased
- @param[in] Lba The logical block address to be erased
+ @param[in] Instance The FV instance to be erased.\r
+ @param[in] Lba The logical block address to be erased.\r
@retval EFI_EFI_SUCCESS Lba was erased
@retval EFI_INVALID_PARAMETER invalid parameter
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbEraseBlock (\r
IN UINTN Instance,\r
IN EFI_LBA Lba\r
\r
/**
Retrieves attributes, insures positive polarity of attribute bits, returns\r
- resulting attributes in output parameter\r
+ resulting attributes in output parameter.\r
- @param[in] Instance The FV instance
+ @param[in] Instance The FV instance.\r
@param[out] Attributes The FV instance whose attributes is going to be \r
- returned
+ returned.\r
@retval EFI_EFI_SUCCESS Valid Attributes were returned
@retval EFI_INVALID_PARAMETER invalid parameter
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbGetVolumeAttributes (\r
IN UINTN Instance,\r
OUT EFI_FVB_ATTRIBUTES *Attributes\r
\r
/**
Modifies the current settings of the firmware volume according to the \r
- input parameter, and returns the new setting of the volume\r
+ input parameter, and returns the new setting of the volume.\r
- @param[in] Instance The FV instance
- @param[in] Attributes On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
+ @param[in] Instance The FV instance.\r
+ @param[in, out]Attributes On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
containing the desired firmware volume settings.\r
On successful return, it contains the new settings\r
- of the firmware volume
+ of the firmware volume.\r
@retval EFI_EFI_SUCCESS Attributes were updated
@retval EFI_INVALID_PARAMETER invalid parameter
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbSetVolumeAttributes (\r
- IN UINTN Instance,\r
- IN EFI_FVB_ATTRIBUTES Attributes\r
+ IN UINTN Instance,\r
+ IN OUT EFI_FVB_ATTRIBUTES *Attributes\r
);\r
\r
\r
/**
- Retrieves the physical address of a memory mapped FV\r
+ Retrieves the physical address of a memory mapped FV.\r
@param[in] Instance The FV instance
@param[out] BaseAddress Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbGetPhysicalAddress (\r
IN UINTN Instance,\r
OUT EFI_PHYSICAL_ADDRESS *BaseAddress\r
\r
\r
/**
- Retrieve the size of a logical block\r
+ Retrieve the size of a logical block.\r
@param[in] Instance The FV instance
@param[in] Lba Indicates which block to return the size for.
- @param[out] BlockSizze A pointer to a caller allocated UINTN in which\r
- the size of the block is returned
+ @param[out] BlockSize A pointer to a caller allocated UINTN in which\r
+ the size of the block is returned.\r
@param[out] NumOfBlocks a pointer to a caller allocated UINTN in which the\r
number of consecutive blocks starting with Lba is\r
returned. All blocks in this range have a size of\r
- BlockSize
+ BlockSize.\r
@retval EFI_EFI_SUCCESS BlockSize and NumOfBlocks returned
@retval EFI_INVALID_PARAMETER invalid parameter
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbGetBlockSize (\r
IN UINTN Instance,\r
IN EFI_LBA Lba,\r
\r
\r
/**
- Erases and initializes a specified range of a firmware volume\r
+ Erases and initializes a specified range of a firmware volume.\r
- @param[in] Instance The FV instance
- @param[in] StartLba The starting logical block index to be erased
+ @param[in] Instance The FV instance.\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
- @param[in] LastLba The last logical block index to be erased
- @param[in] OffsetLastLba Offset into the last block at which to end erasing
+ 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
@retval EFI_EFI_SUCCESS Range was erased
@retval EFI_INVALID_PARAMETER invalid parameter
**/\r
EFI_STATUS\r
+EFIAPI\r
EfiFvbEraseCustomBlockRange (\r
IN UINTN Instance,\r
IN EFI_LBA StartLba,\r
projects / mirror_edk2.git / blobdiff