Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h
index 725958dd040086be2a8f93e2c52c4954d1e0cf88..dfc8bc31fb1b6ec5a04efd6dcfeec971e3958211 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
@@ -60,7 +60,7 @@ typedef struct _EFI_FILE_PROTOCOL         EFI_FILE;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME) (\r
+(EFIAPI *EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME)(\r
   IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL    *This,\r
   OUT EFI_FILE_PROTOCOL                 **Root\r
   )\r
@@ -99,7 +99,7 @@ struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_OPEN) (\r
+(EFIAPI *EFI_FILE_OPEN)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   OUT EFI_FILE_PROTOCOL       **NewHandle,\r
   IN CHAR16                   *FileName,\r
@@ -136,7 +136,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_CLOSE) (\r
+(EFIAPI *EFI_FILE_CLOSE)(\r
   IN EFI_FILE  *This\r
   )\r
 ;\r
@@ -152,7 +152,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_DELETE) (\r
+(EFIAPI *EFI_FILE_DELETE)(\r
   IN EFI_FILE  *This\r
   )\r
 ;\r
@@ -173,7 +173,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_READ) (\r
+(EFIAPI *EFI_FILE_READ)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   IN OUT UINTN                *BufferSize,\r
   OUT VOID                    *Buffer\r
@@ -199,7 +199,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_WRITE) (\r
+(EFIAPI *EFI_FILE_WRITE)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   IN OUT UINTN                *BufferSize,\r
   IN VOID                     *Buffer\r
@@ -218,7 +218,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_SET_POSITION) (\r
+(EFIAPI *EFI_FILE_SET_POSITION)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   IN UINT64                   Position\r
   )\r
@@ -236,7 +236,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_GET_POSITION) (\r
+(EFIAPI *EFI_FILE_GET_POSITION)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   OUT UINT64                  *Position\r
   )\r
@@ -262,7 +262,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_GET_INFO) (\r
+(EFIAPI *EFI_FILE_GET_INFO)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   IN EFI_GUID                 *InformationType,\r
   IN OUT UINTN                *BufferSize,\r
@@ -289,7 +289,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_SET_INFO) (\r
+(EFIAPI *EFI_FILE_SET_INFO)(\r
   IN EFI_FILE_PROTOCOL        *This,\r
   IN EFI_GUID                 *InformationType,\r
   IN UINTN                    BufferSize,\r
@@ -314,7 +314,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_FILE_FLUSH) (\r
+(EFIAPI *EFI_FILE_FLUSH)(\r
   IN EFI_FILE  *This\r
   )\r
 ;\r
@@ -325,6 +325,49 @@ EFI_STATUS
 // \r
 #define EFI_FILE_REVISION   EFI_FILE_PROTOCOL_REVISION\r
 \r
+/**  \r
+  @par Protocol Description:\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
+  @param Revision\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
+  @param Open\r
+  Opens or creates a new file. \r
+\r
+  @param Close\r
+  Closes the current file handle. \r
+\r
+  @param Delete\r
+  Deletes a file. \r
+\r
+  @param Read\r
+  Reads bytes from a file. \r
+\r
+  @param Write\r
+  Writes bytes to a file. \r
+\r
+  @param GetPosition\r
+  Returns the current file position. \r
+\r
+  @param SetPosition\r
+  Sets the current file position. \r
+\r
+  @param GetInfo\r
+  Gets the requested file or volume information. \r
+\r
+  @param SetInfo\r
+  Sets the requested file information. \r
+\r
+  @param Flush\r
+  Flushes all modified data associated with the file to the device. \r
+**/\r
 struct _EFI_FILE_PROTOCOL {\r
   UINT64                Revision;\r
   EFI_FILE_OPEN         Open;\r