Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h
index 8c24425ead1f3f247337a80c61d20f5734d96f1f..eb850be94f50c0e54ce4d0f2174cba617a9de11a 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleFileSystem.h
+++ b/MdePkg/Include/Protocol/SimpleFileSystem.h
@@ -7,7 +7,7 @@
 \r
   UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem\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
@@ -32,14 +32,14 @@ typedef struct _EFI_FILE_PROTOCOL         EFI_FILE_PROTOCOL;
 typedef struct _EFI_FILE_PROTOCOL         *EFI_FILE_HANDLE;\r
 \r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define SIMPLE_FILE_SYSTEM_PROTOCOL       EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   EFI_FILE_IO_INTERFACE;\r
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE;\r
 \r
@@ -63,13 +63,12 @@ EFI_STATUS
 (EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME)(\r
   IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL    *This,\r
   OUT EFI_FILE_PROTOCOL                 **Root\r
-  )\r
-;\r
+  );\r
 \r
 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION  0x00010000\r
-//\r
-// Revision defined in EFI1.1\r
-// \r
+///\r
+/// Revision defined in EFI1.1\r
+/// \r
 #define EFI_FILE_IO_INTERFACE_REVISION  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r
 \r
 struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r
@@ -105,8 +104,7 @@ EFI_STATUS
   IN CHAR16                   *FileName,\r
   IN UINT64                   OpenMode,\r
   IN UINT64                   Attributes\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // Open modes\r
@@ -138,8 +136,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_FILE_CLOSE)(\r
   IN EFI_FILE  *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Close and delete the file handle\r
@@ -154,8 +151,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_FILE_DELETE)(\r
   IN EFI_FILE  *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Read data from the file.\r
@@ -177,8 +173,7 @@ EFI_STATUS
   IN EFI_FILE_PROTOCOL        *This,\r
   IN OUT UINTN                *BufferSize,\r
   OUT VOID                    *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Write data from to the file.\r
@@ -203,8 +198,7 @@ EFI_STATUS
   IN EFI_FILE_PROTOCOL        *This,\r
   IN OUT UINTN                *BufferSize,\r
   IN VOID                     *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set a files current position\r
@@ -221,8 +215,7 @@ EFI_STATUS
 (EFIAPI *EFI_FILE_SET_POSITION)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   IN UINT64                   Position\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get a files current position\r
@@ -239,8 +232,7 @@ EFI_STATUS
 (EFIAPI *EFI_FILE_GET_POSITION)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   OUT UINT64                  *Position\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get information about a file\r
@@ -267,8 +259,7 @@ EFI_STATUS
   IN EFI_GUID                 *InformationType,\r
   IN OUT UINTN                *BufferSize,\r
   OUT VOID                    *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set information about a file\r
@@ -294,8 +285,7 @@ EFI_STATUS
   IN EFI_GUID                 *InformationType,\r
   IN UINTN                    BufferSize,\r
   IN VOID                     *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Flush data back for the file handle\r
@@ -316,8 +306,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_FILE_FLUSH)(\r
   IN EFI_FILE  *This\r
-  )\r
-;\r
+  );\r
 \r
 #define EFI_FILE_PROTOCOL_REVISION   0x00010000\r
 //\r
@@ -325,7 +314,19 @@ EFI_STATUS
 // \r
 #define EFI_FILE_REVISION   EFI_FILE_PROTOCOL_REVISION\r
 \r
+///\r
+/// The EFI_FILE_PROTOCOL provides file IO access to supported file systems.\r
+/// An EFI_FILE_PROTOCOL provides access to a file's or directory's contents, \r
+/// and is also a reference to a location in the directory tree of the file system \r
+/// in which the file resides. With any given file handle, other files may be opened \r
+/// relative to this file's location, yielding new file handles.\r
+///\r
 struct _EFI_FILE_PROTOCOL {\r
+  ///\r
+  /// The version of the EFI_FILE_PROTOCOL interface. The version specified \r
+  /// by this specification is 0x00010000. Future versions are required \r
+  /// to be backward compatible to version 1.0.\r
+  ///\r
   UINT64                Revision;\r
   EFI_FILE_OPEN         Open;\r
   EFI_FILE_CLOSE        Close;\r