]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/MemoryTest/GenericMemoryTestDxe/LightMemoryTest.h
MdeModulePkg: Clean up source files
[mirror_edk2.git] / MdeModulePkg / Universal / MemoryTest / GenericMemoryTestDxe / LightMemoryTest.h
index 391c8a4c81eb9c05c101bec97441cc7abd81a38a..defe9f28ead553ad430d6cd067c7e2c3280cf09a 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   The generic memory test driver definition\r
 \r
-  Copyright (c) 2006 - 2010, 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\r
   are licensed and made available under the terms and conditions\r
@@ -139,7 +139,7 @@ typedef struct {
   @retval EFI_SUCCESS          Successful construct the base memory range through GCD service.\r
   @retval EFI_OUT_OF_RESOURCE  Could not allocate needed resource from base memory.\r
   @retval Others               Failed to construct base memory range through GCD service.\r
-                            \r
+\r
 **/\r
 EFI_STATUS\r
 ConstructBaseMemoryRange (\r
@@ -154,7 +154,7 @@ ConstructBaseMemoryRange (
   @retval EFI_SUCCESS          Successful construct the non-tested memory range through GCD service.\r
   @retval EFI_OUT_OF_RESOURCE  Could not allocate needed resource from base memory.\r
   @retval Others               Failed to construct non-tested memory range through GCD service.\r
-                            \r
+\r
 **/\r
 EFI_STATUS\r
 ConstructNonTestedMemoryRange (\r
@@ -165,9 +165,9 @@ ConstructNonTestedMemoryRange (
   Perform the address line walking ones test.\r
 \r
   @param[in] Private  Point to generic memory test driver's private data.\r
-  \r
-  @retval EFI_SUCCESS          Successful finished walking ones test. \r
-  @retval EFI_OUT_OF_RESOURCE  Could not get resource in base memory. \r
+\r
+  @retval EFI_SUCCESS          Successful finished walking ones test.\r
+  @retval EFI_OUT_OF_RESOURCE  Could not get resource in base memory.\r
   @retval EFI_ACCESS_DENIED    Code may can not run here because if walking one test\r
                                failed, system may be already halt.\r
 \r
@@ -181,7 +181,7 @@ PerformAddressDataLineTest (
   Destroy the link list base on the correspond link list type.\r
 \r
   @param[in] Private  Point to generic memory test driver's private data.\r
-                            \r
+\r
 **/\r
 VOID\r
 DestroyLinkList (\r
@@ -195,7 +195,7 @@ DestroyLinkList (
 \r
   @retval EFI_SUCCESS Successful add all the extended memory to system memory map.\r
   @retval Others      Failed to add the tested extended memory.\r
-                            \r
+\r
 **/\r
 EFI_STATUS\r
 UpdateMemoryMap (\r
@@ -211,7 +211,7 @@ UpdateMemoryMap (
 \r
   @retval EFI_SUCCESS Successful write the test pattern into the non-tested memory.\r
   @retval Others      The test pattern may not really write into the physical memory.\r
-                            \r
+\r
 **/\r
 EFI_STATUS\r
 WriteMemory (\r
@@ -232,7 +232,7 @@ WriteMemory (
 \r
   @retval EFI_SUCCESS Successful verify the range of memory, no errors' location found.\r
   @retval Others      The range of memory have errors contained.\r
-                            \r
+\r
 **/\r
 EFI_STATUS\r
 VerifyMemory (\r
@@ -251,7 +251,7 @@ VerifyMemory (
 \r
   @retval EFI_SUCCESS      Successful test the range of memory.\r
   @retval Others           Failed to test the range of memory.\r
-                            \r
+\r
 **/\r
 EFI_STATUS\r
 DirectRangeTest (\r
@@ -264,12 +264,12 @@ DirectRangeTest (
 /**\r
   Initialize the generic memory test.\r
 \r
-  @param[in]  This                The protocol instance pointer. \r
-  @param[in]  Level               The coverage level of the memory test. \r
-  @param[out] RequireSoftECCInit  Indicate if the memory need software ECC init. \r
+  @param[in]  This                The protocol instance pointer.\r
+  @param[in]  Level               The coverage level of the memory test.\r
+  @param[out] RequireSoftECCInit  Indicate if the memory need software ECC init.\r
 \r
-  @retval EFI_SUCCESS         The generic memory test is initialized correctly. \r
-  @retval EFI_NO_MEDIA        The system had no memory to be tested. \r
+  @retval EFI_SUCCESS         The generic memory test is initialized correctly.\r
+  @retval EFI_NO_MEDIA        The system had no memory to be tested.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -283,12 +283,12 @@ InitializeMemoryTest (
 /**\r
   Perform the memory test.\r
 \r
-  @param[in]  This              The protocol instance pointer. \r
-  @param[out] TestedMemorySize  Return the tested extended memory size. \r
-  @param[out] TotalMemorySize   Return the whole system physical memory size. \r
-                                The total memory size does not include memory in a slot with a disabled DIMM.  \r
+  @param[in]  This              The protocol instance pointer.\r
+  @param[out] TestedMemorySize  Return the tested extended memory size.\r
+  @param[out] TotalMemorySize   Return the whole system physical memory size.\r
+                                The total memory size does not include memory in a slot with a disabled DIMM.\r
   @param[out] ErrorOut          TRUE if the memory error occured.\r
-  @param[in]  IfTestAbort       Indicates that the user pressed "ESC" to skip the memory test. \r
+  @param[in]  IfTestAbort       Indicates that the user pressed "ESC" to skip the memory test.\r
 \r
   @retval EFI_SUCCESS         One block of memory passed the test.\r
   @retval EFI_NOT_FOUND       All memory blocks have already been tested.\r
@@ -308,7 +308,7 @@ GenPerformMemoryTest (
 /**\r
   Finish the memory test.\r
 \r
-  @param[in] This             The protocol instance pointer. \r
+  @param[in] This             The protocol instance pointer.\r
 \r
   @retval EFI_SUCCESS         Success. All resources used in the memory test are freed.\r
 \r
@@ -322,12 +322,12 @@ GenMemoryTestFinished (
 /**\r
   Provides the capability to test the compatible range used by some special drivers.\r
 \r
-  @param[in]  This              The protocol instance pointer. \r
+  @param[in]  This              The protocol instance pointer.\r
   @param[in]  StartAddress      The start address of the compatible memory range that\r
                                 must be below 16M.\r
-  @param[in]  Length            The compatible memory range's length. \r
-  \r
-  @retval EFI_SUCCESS           The compatible memory range pass the memory test. \r
+  @param[in]  Length            The compatible memory range's length.\r
+\r
+  @retval EFI_SUCCESS           The compatible memory range pass the memory test.\r
   @retval EFI_INVALID_PARAMETER The compatible memory range are not below Low 16M.\r
 \r
 **/\r