FatPkg: Clean up source files
[mirror_edk2.git] / FatPkg / FatPei / FatLiteLib.c
index 109789a..947fee4 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   General purpose supporting routines for FAT recovery PEIM\r
 \r
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \r
 This program and the accompanying materials are licensed and made available\r
 under the terms and conditions of the BSD License which accompanies this\r
@@ -25,7 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   If the input Letter is not a lower-cased letter,\r
   the original value is returned.\r
 \r
-  @param  Letter            The input unicode character. \r
+  @param  Letter            The input unicode character.\r
 \r
   @return The upper cased letter.\r
 \r
@@ -47,15 +47,15 @@ ToUpper (
   Reads a block of data from the block device by calling\r
   underlying Block I/O service.\r
 \r
-  @param  PrivateData       Global memory map for accessing global variables \r
-  @param  BlockDeviceNo     The index for the block device number. \r
-  @param  Lba               The logic block address to read data from. \r
-  @param  BufferSize        The size of data in byte to read. \r
-  @param  Buffer            The buffer of the \r
+  @param  PrivateData       Global memory map for accessing global variables\r
+  @param  BlockDeviceNo     The index for the block device number.\r
+  @param  Lba               The logic block address to read data from.\r
+  @param  BufferSize        The size of data in byte to read.\r
+  @param  Buffer            The buffer of the\r
 \r
-  @retval EFI_DEVICE_ERROR  The specified block device number exceeds the maximum \r
-                            device number. \r
-  @retval EFI_DEVICE_ERROR  The maximum address has exceeded the maximum address \r
+  @retval EFI_DEVICE_ERROR  The specified block device number exceeds the maximum\r
+                            device number.\r
+  @retval EFI_DEVICE_ERROR  The maximum address has exceeded the maximum address\r
                             of the block device.\r
 \r
 **/\r
@@ -125,11 +125,11 @@ FatReadBlock (
   Find a cache block designated to specific Block device and Lba.\r
   If not found, invalidate an oldest one and use it. (LRU cache)\r
 \r
-  @param  PrivateData       the global memory map. \r
-  @param  BlockDeviceNo     the Block device. \r
-  @param  Lba               the Logical Block Address \r
-  @param  CachePtr          Ptr to the starting address of the memory holding the \r
-                            data; \r
+  @param  PrivateData       the global memory map.\r
+  @param  BlockDeviceNo     the Block device.\r
+  @param  Lba               the Logical Block Address\r
+  @param  CachePtr          Ptr to the starting address of the memory holding the\r
+                            data;\r
 \r
   @retval EFI_SUCCESS       The function completed successfully.\r
   @retval EFI_DEVICE_ERROR  Something error while accessing media.\r
@@ -179,9 +179,9 @@ FatGetCacheBlock (
   if (Index == PEI_FAT_CACHE_SIZE) {\r
     Index = (Seed++) % PEI_FAT_CACHE_SIZE;\r
   }\r
-  \r
+\r
   //\r
-  // Current device ID should be less than maximum device ID. \r
+  // Current device ID should be less than maximum device ID.\r
   //\r
   if (BlockDeviceNo >= PEI_FAT_MAX_BLOCK_DEVICE) {\r
     return EFI_DEVICE_ERROR;\r
@@ -217,11 +217,11 @@ FatGetCacheBlock (
 /**\r
   Disk reading.\r
 \r
-  @param  PrivateData       the global memory map; \r
-  @param  BlockDeviceNo     the block device to read; \r
-  @param  StartingAddress   the starting address. \r
-  @param  Size              the amount of data to read. \r
-  @param  Buffer            the buffer holding the data \r
+  @param  PrivateData       the global memory map;\r
+  @param  BlockDeviceNo     the block device to read;\r
+  @param  StartingAddress   the starting address.\r
+  @param  Size              the amount of data to read.\r
+  @param  Buffer            the buffer holding the data\r
 \r
   @retval EFI_SUCCESS       The function completed successfully.\r
   @retval EFI_DEVICE_ERROR  Something error.\r
@@ -306,11 +306,11 @@ FatReadDisk (
   to a Null-terminated Unicode string.\r
   Here does not expand DBCS FAT chars.\r
 \r
-  @param  FatSize           The size of the string Fat in bytes. \r
-  @param  Fat               A pointer to a Null-terminated string that contains \r
-                            an 8.3 file name using an OEM character set. \r
-  @param  Str               A pointer to a Null-terminated Unicode string. The \r
-                            string must be allocated in advance to hold FatSize \r
+  @param  FatSize           The size of the string Fat in bytes.\r
+  @param  Fat               A pointer to a Null-terminated string that contains\r
+                            an 8.3 file name using an OEM character set.\r
+  @param  Str               A pointer to a Null-terminated Unicode string. The\r
+                            string must be allocated in advance to hold FatSize\r
                             Unicode characters\r
 \r
 **/\r
@@ -344,8 +344,8 @@ EngFatToStr (
 /**\r
   Performs a case-insensitive comparison of two Null-terminated Unicode strings.\r
 \r
-  @param  PrivateData       Global memory map for accessing global variables \r
-  @param  Str1              First string to perform case insensitive comparison. \r
+  @param  PrivateData       Global memory map for accessing global variables\r
+  @param  Str1              First string to perform case insensitive comparison.\r
   @param  Str2              Second string to perform case insensitive comparison.\r
 \r
 **/\r