ArmPkg/SemihostFs: Fix open file issues revealed by SCT

[mirror_edk2.git] / ArmPkg / Filesystem / SemihostFs / Arm / SemihostFs.h

diff --git a/ArmPkg/Filesystem/SemihostFs/Arm/SemihostFs.h b/ArmPkg/Filesystem/SemihostFs/Arm/SemihostFs.h
index a9b200b2a0fe977675551ad0680f27b77a38d59d..c02b36ae5f617a3dccb14622df672f6ca5439873 100644 (file)
--- a/ArmPkg/Filesystem/SemihostFs/Arm/SemihostFs.h
+++ b/ArmPkg/Filesystem/SemihostFs/Arm/SemihostFs.h
@@ -22,9 +22,35 @@ VolumeOpen (
   OUT EFI_FILE                        **Root\r
   );\r
 \r
+/**\r
+  Open a file on the host system by means of the semihosting interface.\r
+\r
+  @param[in]   This        A pointer to the EFI_FILE_PROTOCOL instance that is\r
+                           the file handle to source location.\r
+  @param[out]  NewHandle   A pointer to the location to return the opened\r
+                           handle for the new file.\r
+  @param[in]   FileName    The Null-terminated string of the name of the file\r
+                           to be opened.\r
+  @param[in]   OpenMode    The mode to open the file : Read or Read/Write or\r
+                           Read/Write/Create\r
+  @param[in]   Attributes  Only valid for EFI_FILE_MODE_CREATE, in which case these\r
+                           are the attribute bits for the newly created file. The\r
+                           mnemonics of the attribute bits are : EFI_FILE_READ_ONLY,\r
+                           EFI_FILE_HIDDEN, EFI_FILE_SYSTEM, EFI_FILE_RESERVED,\r
+                           EFI_FILE_DIRECTORY and EFI_FILE_ARCHIVE.\r
+\r
+  @retval  EFI_SUCCESS            The file was open.\r
+  @retval  EFI_NOT_FOUND          The specified file could not be found.\r
+  @retval  EFI_DEVICE_ERROR       The last issued semi-hosting operation failed.\r
+  @retval  EFI_WRITE_PROTECTED    Attempt to create a directory. This is not possible\r
+                                  with the semi-hosting interface.\r
+  @retval  EFI_OUT_OF_RESOURCES   Not enough resources were available to open the file.\r
+  @retval  EFI_INVALID_PARAMETER  At least one of the parameters is invalid.\r
+\r
+**/\r
 EFI_STATUS\r
 FileOpen (\r
-  IN  EFI_FILE  *File,\r
+  IN  EFI_FILE  *This,\r
   OUT EFI_FILE  **NewHandle,\r
   IN  CHAR16    *FileName,\r
   IN  UINT64    OpenMode,\r