diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2016-12-08 16:01:15 +0800 |
|---|---|---|
| committer | Ruiyu Ni <ruiyu.ni@intel.com> | 2016-12-09 11:02:09 +0800 |
| commit | 205cc663778b5f5ae273065733b8080f64d3f324 (patch) | |
| tree | d02838b9a198ec1c8282de4974bfc2f059f41d5e /FatPkg/EnhancedFatDxe/Info.c | |
| parent | cae7420b4bd015b78f915c4ba766dbee15da0468 (diff) | |
| download | edk2-205cc663778b5f5ae273065733b8080f64d3f324.tar.gz edk2-205cc663778b5f5ae273065733b8080f64d3f324.tar.bz2 edk2-205cc663778b5f5ae273065733b8080f64d3f324.zip | |
FatPkg/EnhancedFatDxe: Add comments for functions
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
Diffstat (limited to 'FatPkg/EnhancedFatDxe/Info.c')
| -rw-r--r-- | FatPkg/EnhancedFatDxe/Info.c | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/FatPkg/EnhancedFatDxe/Info.c b/FatPkg/EnhancedFatDxe/Info.c index 1a7f8280ba..50b840b961 100644 --- a/FatPkg/EnhancedFatDxe/Info.c +++ b/FatPkg/EnhancedFatDxe/Info.c @@ -16,6 +16,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "Fat.h"
+/**
+
+ Get the volume's info into Buffer.
+
+ @param Volume - FAT file system volume.
+ @param BufferSize - Size of Buffer.
+ @param Buffer - Buffer containing volume info.
+
+ @retval EFI_SUCCESS - Get the volume info successfully.
+ @retval EFI_BUFFER_TOO_SMALL - The buffer is too small.
+
+**/
EFI_STATUS
FatGetVolumeInfo (
IN FAT_VOLUME *Volume,
@@ -23,6 +35,20 @@ FatGetVolumeInfo ( OUT VOID *Buffer
);
+/**
+
+ Set the volume's info.
+
+ @param Volume - FAT file system volume.
+ @param BufferSize - Size of Buffer.
+ @param Buffer - Buffer containing the new volume info.
+
+ @retval EFI_SUCCESS - Set the volume info successfully.
+ @retval EFI_BAD_BUFFER_SIZE - The buffer size is error.
+ @retval EFI_WRITE_PROTECTED - The volume is read only.
+ @return other - An error occurred when operation the disk.
+
+**/
EFI_STATUS
FatSetVolumeInfo (
IN FAT_VOLUME *Volume,
@@ -30,6 +56,20 @@ FatSetVolumeInfo ( IN VOID *Buffer
);
+/**
+
+ Set or Get the some types info of the file into Buffer.
+
+ @param IsSet - TRUE:The access is set, else is get
+ @param FHand - The handle of file
+ @param Type - The type of the info
+ @param BufferSize - Size of Buffer
+ @param Buffer - Buffer containing volume info
+
+ @retval EFI_SUCCESS - Get the info successfully
+ @retval EFI_DEVICE_ERROR - Can not find the OFile for the file
+
+**/
EFI_STATUS
FatSetOrGetInfo (
IN BOOLEAN IsSet,
|