X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FDiskIo.h;h=77517cb672747bab9efff10298ac19f5e9726f2b;hb=533403e6965cf60c9b6b18a88d1d6a2f2018c0b4;hp=2f15b705540f49548fad9482e68b56ab103805a2;hpb=4ca9b6c4e7dbbcf94f21b54f41f761cefc6b1086;p=mirror_edk2.git

diff --git a/MdePkg/Include/Protocol/DiskIo.h b/MdePkg/Include/Protocol/DiskIo.h
index 2f15b70554..77517cb672 100644
--- a/MdePkg/Include/Protocol/DiskIo.h
+++ b/MdePkg/Include/Protocol/DiskIo.h
@@ -24,16 +24,16 @@
     0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
   }
 
-//
-// Protocol GUID name defined in EFI1.1.
-// 
+///
+/// Protocol GUID name defined in EFI1.1.
+/// 
 #define DISK_IO_PROTOCOL  EFI_DISK_IO_PROTOCOL_GUID
 
 typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL;
 
-//
-// Protocol defined in EFI1.1.
-// 
+///
+/// Protocol defined in EFI1.1.
+/// 
 typedef EFI_DISK_IO_PROTOCOL  EFI_DISK_IO;
 
 /**
@@ -61,17 +61,16 @@ EFI_STATUS
   IN UINT64                       Offset,
   IN UINTN                        BufferSize,
   OUT VOID                        *Buffer
-  )
-;
+  );
 
 /**
-  Read BufferSize bytes from Offset into Buffer.
+  Writes a specified number of bytes to a device.
 
-  @param  This       Protocol instance pointer.
-  @param  MediaId    Id of the media, changes every time the media is replaced.
-  @param  Offset     The starting byte offset to read from
-  @param  BufferSize Size of Buffer
-  @param  Buffer     Buffer containing read data
+  @param  This       Indicates a pointer to the calling context.
+  @param  MediaId    ID of the medium to be written.
+  @param  Offset     The starting byte offset on the logical block I/O device to write.
+  @param  BufferSize The size in bytes of Buffer. The number of bytes to write to the device.
+  @param  Buffer     A pointer to the buffer containing the data to be written.
 
   @retval EFI_SUCCESS           The data was written correctly to the device.
   @retval EFI_WRITE_PROTECTED   The device can not be written to.
@@ -90,33 +89,24 @@ EFI_STATUS
   IN UINT64                       Offset,
   IN UINTN                        BufferSize,
   IN VOID                         *Buffer
-  )
-;
+  );
 
 #define EFI_DISK_IO_PROTOCOL_REVISION 0x00010000
 
-//
-// Revision defined in EFI1.1
-// 
+///
+/// Revision defined in EFI1.1
+/// 
 #define EFI_DISK_IO_INTERFACE_REVISION  EFI_DISK_IO_PROTOCOL_REVISION
 
-/**
-  @par Protocol Description:
-  This protocol is used to abstract Block I/O interfaces.
-
-  @param Revision 
-  The revision to which the disk I/O interface adheres. All future
-  revisions must be backwards compatible. If a future version is not
-  backwards compatible, it is not the same GUID.
-
-  @param ReadDisk 
-  Reads data from the disk.
-  
-  @param WriteDisk 
-  Writes data to the disk.
-
-**/
+///
+/// This protocol is used to abstract Block I/O interfaces.
+///
 struct _EFI_DISK_IO_PROTOCOL {
+  ///
+  /// The revision to which the disk I/O interface adheres. All future
+  /// revisions must be backwards compatible. If a future version is not
+  /// backwards compatible, it is not the same GUID.
+  ///
   UINT64          Revision;
   EFI_DISK_READ   ReadDisk;
   EFI_DISK_WRITE  WriteDisk;