Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/BlockIo.h b/MdePkg/Include/Protocol/BlockIo.h
index c42ecc5da01f9023412cb7885c5631e5d354c59f..ecfd3a7551320ff44f5f7bd733b3cd08c2a8b6a2 100644 (file)
--- a/MdePkg/Include/Protocol/BlockIo.h
+++ b/MdePkg/Include/Protocol/BlockIo.h
@@ -4,7 +4,7 @@
   The Block IO protocol is used to abstract block devices like hard drives,\r
   DVD-ROMs and floppy drives.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
@@ -132,31 +132,51 @@ EFI_STATUS
 \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;    /**< The curent media Id. If the media changes, this value is changed.**/\r
-  BOOLEAN RemovableMedia;  /**< TRUE if the media is removable; otherwise, FALSE.**/\r
-  BOOLEAN MediaPresent;    /**< 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 LogicalPartition;  /**< 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 ReadOnly;    /**< 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 WriteCaching;    /**< TRUE if the WriteBlock () function caches write data.**/\r
-\r
-  UINT32  BlockSize;    /**< The intrinsic block size of the device. If the media changes, then\r
-                          this field is updated.\r
-                        **/\r
-  UINT32  IoAlign;      /**< Supplies the alignment requirement for any buffer to read or write block(s).**/\r
-\r
-  EFI_LBA LastBlock;    /**< The last logical block address on the device.\r
-                          If the media changes, then this field is updated.\r
-                         **/\r
+  UINT32  MediaId;    \r
+  BOOLEAN RemovableMedia;\r
+  BOOLEAN MediaPresent;\r
+  BOOLEAN LogicalPartition;\r
+  BOOLEAN ReadOnly;\r
+  BOOLEAN WriteCaching; \r
+  UINT32  BlockSize; \r
+  UINT32  IoAlign; \r
+  EFI_LBA LastBlock; \r
 } EFI_BLOCK_IO_MEDIA;\r
 \r
 #define EFI_BLOCK_IO_PROTOCOL_REVISION  0x00010000\r
@@ -165,6 +185,31 @@ typedef struct {
 // \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
+  @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
 struct _EFI_BLOCK_IO_PROTOCOL {\r
   UINT64              Revision;\r
 \r