Update comments for Protocol definitions to match UEFI spec.

[mirror_edk2.git] / MdePkg / Include / Protocol / BlockIo.h

diff --git a/MdePkg/Include/Protocol/BlockIo.h b/MdePkg/Include/Protocol/BlockIo.h
index 32fe4ef41fb89ca8a37f112683d8853cc6e491dd..adbeedc2895c24949a03dcc92f79617009fe9d1a 100644 (file)
--- a/MdePkg/Include/Protocol/BlockIo.h
+++ b/MdePkg/Include/Protocol/BlockIo.h
@@ -51,8 +51,7 @@ EFI_STATUS
 (EFIAPI *EFI_BLOCK_RESET)(\r
   IN EFI_BLOCK_IO_PROTOCOL          *This,\r
   IN BOOLEAN                        ExtendedVerification\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Read BufferSize bytes from Lba into Buffer.\r
@@ -80,8 +79,7 @@ EFI_STATUS
   IN EFI_LBA                        Lba,\r
   IN UINTN                          BufferSize,\r
   OUT VOID                          *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Write BufferSize bytes from Lba into Buffer.\r
@@ -110,8 +108,7 @@ EFI_STATUS
   IN EFI_LBA                        Lba,\r
   IN UINTN                          BufferSize,\r
   IN VOID                           *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Flush the Block Device.\r
@@ -127,92 +124,84 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_BLOCK_FLUSH)(\r
   IN EFI_BLOCK_IO_PROTOCOL  *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Block IO read only mode data and updated only via members of BlockIO\r
-  \r
-  @param MediaId\r
-  The curent media Id. If the media changes, this value is changed.\r
-  \r
-  @param RemovableMedia\r
-  TRUE if the media is removable; otherwise, FALSE.\r
-  \r
-  @param MediaPresent\r
-  TRUE if there is a media currently present in the device;\r
-  othersise, FALSE. THis field shows the media present status\r
-  as of the most recent ReadBlocks() or WriteBlocks() call.\r
-\r
-  @param LogicalPartition\r
-  TRUE if LBA 0 is the first block of a partition; otherwise\r
-  FALSE. For media with only one partition this would be TRUE.\r
-  \r
-  @param ReadOnly\r
-  TRUE if the media is marked read-only otherwise, FALSE.\r
-  This field shows the read-only status as of the most recent WriteBlocks () call.\r
-  \r
-  @param WriteCaching\r
-  TRUE if the WriteBlock () function caches write data.\r
-\r
-  @param BlockSize\r
-  The intrinsic block size of the device. If the media changes, then\r
-  this field is updated.  \r
-\r
-  @param IoAlign\r
-  Supplies the alignment requirement for any buffer to read or write block(s).\r
-  \r
-  @param LastBlock\r
-  The last logical block address on the device.\r
-  If the media changes, then this field is updated.   \r
-\r
 **/\r
 typedef struct {\r
-  UINT32  MediaId;    \r
+  ///\r
+  /// The curent media Id. If the media changes, this value is changed.\r
+  ///\r
+  UINT32  MediaId;         \r
+   \r
+  ///\r
+  /// TRUE if the media is removable; otherwise, FALSE.\r
+  ///    \r
   BOOLEAN RemovableMedia;\r
+  \r
+  ///\r
+  /// TRUE if there is a media currently present in the device;\r
+  /// othersise, FALSE. THis field shows the media present status\r
+  /// as of the most recent ReadBlocks() or WriteBlocks() call.  \r
+  ///\r
   BOOLEAN MediaPresent;\r
+\r
+  ///\r
+  /// TRUE if LBA 0 is the first block of a partition; otherwise\r
+  /// FALSE. For media with only one partition this would be TRUE.\r
+  ///\r
   BOOLEAN LogicalPartition;\r
+  \r
+  ///\r
+  /// TRUE if the media is marked read-only otherwise, FALSE.\r
+  /// This field shows the read-only status as of the most recent WriteBlocks () call.\r
+  ///\r
   BOOLEAN ReadOnly;\r
+  \r
+  ///\r
+  /// TRUE if the WriteBlock () function caches write data.\r
+  ///\r
   BOOLEAN WriteCaching; \r
+  \r
+  ///\r
+  /// The intrinsic block size of the device. If the media changes, then\r
+  /// this field is updated.  \r
+  ///\r
   UINT32  BlockSize; \r
+  \r
+  ///\r
+  /// Supplies the alignment requirement for any buffer to read or write block(s).\r
+  ///\r
   UINT32  IoAlign; \r
+  \r
+  ///\r
+  /// The last logical block address on the device.\r
+  /// If the media changes, then this field is updated. \r
+  ///\r
   EFI_LBA LastBlock; \r
 } EFI_BLOCK_IO_MEDIA;\r
 \r
 #define EFI_BLOCK_IO_PROTOCOL_REVISION  0x00010000\r
-//\r
-// Revision defined in EFI1.1.\r
-// \r
-#define EFI_BLOCK_IO_INTERFACE_REVISION   EFI_BLOCK_IO_PROTOCOL_REVISION\r
-\r
-/**\r
-  @par Protocol Description:\r
-  This protocol provides control over block devices.\r
-\r
-  @param Revision \r
-  The revision to which the block IO interface adheres. All future\r
-  revisions must be backwards compatible. If a future version is not\r
-  back wards compatible, it is not the same GUID.\r
-  \r
-  @param Media \r
-  A pointer to the EFI_BLOCK_IO_MEDIA data for this device.\r
-\r
-  @param Reset \r
-  Resets the block device hardware.\r
-\r
-  @param ReadBlocks \r
-  Reads the requested number of blocks from the device. \r
 \r
-  @param WriteBlocks \r
-  Writes the requested number of blocks to the device. \r
+///\r
+/// Revision defined in EFI1.1.\r
+/// \r
+#define EFI_BLOCK_IO_INTERFACE_REVISION   EFI_BLOCK_IO_PROTOCOL_REVISION\r
 \r
-  @param FlushBlocks \r
-  Flushes and cache blocks. This function is optional and only\r
-  needs to be supported on block devices that cache writes. \r
-**/\r
+///\r
+///  This protocol provides control over block devices.\r
+///\r
 struct _EFI_BLOCK_IO_PROTOCOL {\r
+  ///\r
+  /// The revision to which the block IO interface adheres. All future\r
+  /// revisions must be backwards compatible. If a future version is not\r
+  /// back wards compatible, it is not the same GUID.\r
+  ///\r
   UINT64              Revision;\r
-\r
+  ///\r
+  /// Pointer to the EFI_BLOCK_IO_MEDIA data for this device.\r
+  ///\r
   EFI_BLOCK_IO_MEDIA  *Media;\r
 \r
   EFI_BLOCK_RESET     Reset;\r