clean up the un-suitable ';' location when declaring the functions.

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

diff --git a/MdePkg/Include/Protocol/DiskIo.h b/MdePkg/Include/Protocol/DiskIo.h
index e36792c7cd8b5b117c2d9a1d42f1b3400961808f..fbf4384874d6fe241d08c8b1e268021e4cca23ff 100644 (file)
--- a/MdePkg/Include/Protocol/DiskIo.h
+++ b/MdePkg/Include/Protocol/DiskIo.h
@@ -1,11 +1,11 @@
 /** @file\r
-  Disk IO protocol as defined in the EFI 1.0 specification.\r
+  Disk IO protocol as defined in the UEFI 2.0 specification.\r
 \r
   The Disk IO protocol is used to convert block oriented devices into byte\r
   oriented devices. The Disk IO protocol is intended to layer on top of the\r
   Block IO protocol.\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
@@ -14,8 +14,6 @@
   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
-  Module Name:  DiskIo.h\r
-\r
 **/\r
 \r
 #ifndef __DISK_IO_H__\r
@@ -26,8 +24,18 @@
     0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\r
+/// \r
+#define DISK_IO_PROTOCOL  EFI_DISK_IO_PROTOCOL_GUID\r
+\r
 typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL;\r
 \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
+typedef EFI_DISK_IO_PROTOCOL  EFI_DISK_IO;\r
+\r
 /**\r
   Read BufferSize bytes from Offset into Buffer.\r
 \r
@@ -47,14 +55,13 @@ typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DISK_READ) (\r
+(EFIAPI *EFI_DISK_READ)(\r
   IN EFI_DISK_IO_PROTOCOL         *This,\r
   IN UINT32                       MediaId,\r
   IN UINT64                       Offset,\r
   IN UINTN                        BufferSize,\r
   OUT VOID                        *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Read BufferSize bytes from Offset into Buffer.\r
@@ -76,17 +83,37 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DISK_WRITE) (\r
+(EFIAPI *EFI_DISK_WRITE)(\r
   IN EFI_DISK_IO_PROTOCOL         *This,\r
   IN UINT32                       MediaId,\r
   IN UINT64                       Offset,\r
   IN UINTN                        BufferSize,\r
   IN VOID                         *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 #define EFI_DISK_IO_PROTOCOL_REVISION 0x00010000\r
 \r
+///\r
+/// Revision defined in EFI1.1\r
+/// \r
+#define EFI_DISK_IO_INTERFACE_REVISION  EFI_DISK_IO_PROTOCOL_REVISION\r
+\r
+/**\r
+  @par Protocol Description:\r
+  This protocol is used to abstract Block I/O interfaces.\r
+\r
+  @param Revision \r
+  The revision to which the disk I/O interface adheres. All future\r
+  revisions must be backwards compatible. If a future version is not\r
+  backwards compatible, it is not the same GUID.\r
+\r
+  @param ReadDisk \r
+  Reads data from the disk.\r
+  \r
+  @param WriteDisk \r
+  Writes data to the disk.\r
+\r
+**/\r
 struct _EFI_DISK_IO_PROTOCOL {\r
   UINT64          Revision;\r
   EFI_DISK_READ   ReadDisk;\r