/** @file\r
This file provides control over block-oriented firmware devices.\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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
+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
+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
- @par Revision Reference: \r
- This protocol is defined in framework spec: Firmware Volume Block specification\r
+ @par Revision Reference:\r
+ This protocol is defined in framework spec: Firmware Volume Block Specification.\r
\r
**/\r
\r
#ifndef __FRAMEWORK_FIRMWARE_VOLUME_BLOCK_H__\r
#define __FRAMEWORK_FIRMWARE_VOLUME_BLOCK_H__\r
\r
+#define FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL_GUID \\r
+{ 0xDE28BC59, 0x6228, 0x41BD, {0xBD, 0xF6, 0xA3, 0xB9, 0xAD,0xB5, 0x8D, 0xA1 } }\r
\r
typedef struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL;\r
///\r
-/// type of EFI FVB attribute per Frameowrk spec\r
-/// \r
+/// The type of EFI FVB attribute per the Framework specification.\r
+///\r
typedef UINT32 EFI_FVB_ATTRIBUTES;\r
\r
/**\r
The GetAttributes() function retrieves the attributes and\r
- current settings of the block. \r
+ current settings of the block.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
\r
@param Attributes Pointer to EFI_FVB_ATTRIBUTES in which the\r
attributes and current settings are\r
- returned. \r
+ returned.\r
\r
@retval EFI_SUCCESS The firmware volume attributes were\r
returned.\r
EFI_FVB_ATTRIBUTES that contains the\r
desired firmware volume settings. On\r
successful return, it contains the new\r
- settings of the firmware volume. \r
- \r
+ settings of the firmware volume.\r
+\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
\r
@retval EFI_INVALID_PARAMETER The attributes requested are in\r
only for memory-mapped firmware volumes.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
- \r
+\r
@param Address Pointer to a caller-allocated\r
EFI_PHYSICAL_ADDRESS that, on successful\r
return from GetPhysicalAddress(), contains the\r
base address of the firmware volume.\r
- \r
+\r
@retval EFI_SUCCESS The firmware volume base address is returned.\r
- \r
+\r
@retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
\r
**/\r
\r
@param Lba Indicates the block for which to return the size.\r
\r
- @param BlockSize Pointer to a caller-allocated UINTN in which\r
+ @param BlockSize The pointer to a caller-allocated UINTN in which\r
the size of the block is returned.\r
\r
- @param NumberOfBlocks Pointer to a caller-allocated UINTN in\r
+ @param NumberOfBlocks The pointer to a caller-allocated UINTN in\r
which the number of consecutive blocks,\r
starting with Lba, is returned. All\r
blocks in this range have a size of\r
BlockSize.\r
\r
- \r
- @retval EFI_SUCCESS The firmware volume base address is returned.\r
- \r
+\r
+ @retval EFI_SUCCESS The firmware volume base address was returned.\r
+\r
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
\r
**/\r
aware that a read may be partially completed.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
- \r
+\r
@param Lba The starting logical block index\r
from which to read.\r
\r
@param Offset Offset into the block at which to begin reading.\r
\r
- @param NumBytes Pointer to a UINTN. At entry, *NumBytes\r
+ @param NumBytes The pointer to a UINTN. At entry, *NumBytes\r
contains the total size of the buffer. At\r
exit, *NumBytes contains the total number of\r
bytes read.\r
\r
- @param Buffer Pointer to a caller-allocated buffer that will\r
+ @param Buffer The pointer to a caller-allocated buffer that will\r
be used to hold the data that is read.\r
\r
@retval EFI_SUCCESS The firmware volume was read successfully\r
and contents are in Buffer.\r
- \r
- @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA\r
+\r
+ @retval EFI_BAD_BUFFER_SIZE A read was attempted across an LBA\r
boundary. On output, NumBytes\r
contains the total number of bytes\r
returned in Buffer.\r
- \r
+\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
ReadDisabled state.\r
- \r
+\r
@retval EFI_DEVICE_ERROR The block device is not\r
functioning correctly and could\r
not be read.\r
EraseBlocks() function first to erase the specified block to\r
write. A block erase cycle will transition bits from the\r
(NOT)EFI_FVB_ERASE_POLARITY state back to the\r
- EFI_FVB_ERASE_POLARITY state. Implementations should be\r
- mindful that the firmware volume might be in the WriteDisabled\r
+ EFI_FVB_ERASE_POLARITY state. Implementors should note\r
+ that the firmware volume might be in the WriteDisabled\r
state. If it is in this state, the Write() function must\r
return the status code EFI_ACCESS_DENIED without modifying the\r
contents of the firmware volume. The Write() function must\r
returns.\r
\r
@param This Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
- \r
+\r
@param Lba The starting logical block index to write to.\r
- \r
+\r
@param Offset Offset into the block at which to begin writing.\r
- \r
- @param NumBytes Pointer to a UINTN. Input: the total size of the buffer.\r
+\r
+ @param NumBytes The pointer to a UINTN. Input: the total size of the buffer.\r
Output: the total number of bytes actually written.\r
- \r
- @param Buffer Pointer to a caller-allocated buffer that\r
+\r
+ @param Buffer The pointer to a caller-allocated buffer that\r
contains the source for the write.\r
- \r
+\r
@retval EFI_SUCCESS The firmware volume was written successfully.\r
- \r
+\r
@retval EFI_BAD_BUFFER_SIZE The write was attempted across an\r
LBA boundary. On output, NumBytes\r
contains the total number of bytes\r
actually written.\r
- \r
+\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
WriteDisabled state.\r
- \r
+\r
@retval EFI_DEVICE_ERROR The block device is malfunctioning\r
and could not be written.\r
\r
\r
\r
///\r
-/// EFI_LBA_LIST_TERMINATOR\r
+/// EFI_LBA_LIST_TERMINATOR.\r
///\r
#define FRAMEWORK_EFI_LBA_LIST_TERMINATOR 0xFFFFFFFFFFFFFFFFULL\r
\r
volume (it has a larger index than the last block of the\r
firmware volume), the EraseBlocks() function must return the\r
status code EFI_INVALID_PARAMETER without modifying the contents\r
- of the firmware volume. Implementations should be mindful that\r
+ of the firmware volume. Implementors should note that\r
the firmware volume might be in the WriteDisabled state. If it\r
is in this state, the EraseBlocks() function must return the\r
status code EFI_ACCESS_DENIED without modifying the contents of\r
(5-7 and 10-11) are to be erased: EraseBlocks\r
(This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);\r
\r
- @retval EFI_SUCCESS The erase request was successfully\r
+ @retval EFI_SUCCESS The erase request successfully\r
completed.\r
- \r
+\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
WriteDisabled state.\r
@retval EFI_DEVICE_ERROR The block device is not functioning\r
partially erased.\r
@retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r
in the variable argument list do\r
- not exist in the firmware volume. \r
+ not exist in the firmware volume.\r
\r
**/\r
typedef\r
FRAMEWORK_EFI_FVB_WRITE Write;\r
FRAMEWORK_EFI_FVB_ERASE_BLOCKS EraseBlocks;\r
///\r
- /// Handle of the parent firmware volume.\r
- /// \r
+ /// The handle of the parent firmware volume.\r
+ ///\r
EFI_HANDLE ParentHandle;\r
};\r
\r
-\r
+extern EFI_GUID gFramerworkEfiFirmwareVolumeBlockProtocolGuid;\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff