]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/MemoryTest/NullMemoryTestDxe/NullMemoryTest.h
MdeModulePkg: Clean up source files
[mirror_edk2.git] / MdeModulePkg / Universal / MemoryTest / NullMemoryTestDxe / NullMemoryTest.h
index 77c18eb331a52f0e506ad687538d36ce47429bc3..d09c84354ef543b7ab22b79ae6fdbd0496565c17 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Include file of the NULL memory test driver.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 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
@@ -40,15 +40,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   This function implements EFI_GENERIC_MEMORY_TEST_PROTOCOL.MemoryTestInit.\r
   It simply promotes untested reserved memory to system memory without real test.\r
 \r
-  @param  This                Protocol instance pointer. \r
-  @param  Level               The coverage level of the memory test. \r
-  @param  RequireSoftECCInit  Indicate if the memory need software ECC init. \r
+  @param  This                Protocol instance pointer.\r
+  @param  Level               The coverage level of the memory test.\r
+  @param  RequireSoftECCInit  Indicate if the memory need software ECC init.\r
 \r
-  @retval EFI_SUCCESS         The generic memory test initialized correctly. \r
-  @retval EFI_NO_MEDIA        There is not any non-tested memory found, in this \r
-                              function if not any non-tesed memory found means  \r
-                              that the memory test driver have not detect any \r
-                              non-tested extended memory of current system. \r
+  @retval EFI_SUCCESS         The generic memory test initialized correctly.\r
+  @retval EFI_NO_MEDIA        There is not any non-tested memory found, in this\r
+                              function if not any non-tesed memory found means\r
+                              that the memory test driver have not detect any\r
+                              non-tested extended memory of current system.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -65,20 +65,20 @@ InitializeMemoryTest (
   This function implements EFI_GENERIC_MEMORY_TEST_PROTOCOL.PerformMemoryTest.\r
   It simply returns EFI_NOT_FOUND.\r
 \r
-  @param  This                Protocol instance pointer. \r
-  @param  TestedMemorySize    Return the tested extended memory size. \r
-  @param  TotalMemorySize     Return the whole system physical memory size, this  \r
-                              value may be changed if in some case some error  \r
-                              DIMMs be disabled. \r
-  @param  ErrorOut            Any time the memory error occurs, this will be \r
-                              TRUE. \r
-  @param  IfTestAbort         Indicate if the user press "ESC" to skip the memory \r
-                              test. \r
-\r
-  @retval EFI_SUCCESS         One block of memory test ok, the block size is hide \r
-                              internally. \r
-  @retval EFI_NOT_FOUND       Indicate all the non-tested memory blocks have  \r
-                              already go through. \r
+  @param  This                Protocol instance pointer.\r
+  @param  TestedMemorySize    Return the tested extended memory size.\r
+  @param  TotalMemorySize     Return the whole system physical memory size, this\r
+                              value may be changed if in some case some error\r
+                              DIMMs be disabled.\r
+  @param  ErrorOut            Any time the memory error occurs, this will be\r
+                              TRUE.\r
+  @param  IfTestAbort         Indicate if the user press "ESC" to skip the memory\r
+                              test.\r
+\r
+  @retval EFI_SUCCESS         One block of memory test ok, the block size is hide\r
+                              internally.\r
+  @retval EFI_NOT_FOUND       Indicate all the non-tested memory blocks have\r
+                              already go through.\r
   @retval EFI_DEVICE_ERROR    Mis-compare error, and no agent can handle it\r
 \r
 **/\r
@@ -98,11 +98,11 @@ GenPerformMemoryTest (
   This function implements EFI_GENERIC_MEMORY_TEST_PROTOCOL.Finished.\r
   It simply returns EFI_SUCCESS.\r
 \r
-  @param  This                Protocol instance pointer. \r
+  @param  This                Protocol instance pointer.\r
 \r
-  @retval EFI_SUCCESS         Successful free all the generic memory test driver \r
-                              allocated resource and notify to platform memory \r
-                              test driver that memory test finished. \r
+  @retval EFI_SUCCESS         Successful free all the generic memory test driver\r
+                              allocated resource and notify to platform memory\r
+                              test driver that memory test finished.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -118,11 +118,11 @@ GenMemoryTestFinished (
   This function implements EFI_GENERIC_MEMORY_TEST_PROTOCOL.CompatibleRangeTest.\r
   It simply set the memory range to system memory.\r
 \r
-  @param  This                Protocol instance pointer. \r
-  @param  StartAddress        The start address of the memory range. \r
-  @param  Length              The memory range's length. \r
-  \r
-  @retval EFI_SUCCESS           The compatible memory range pass the memory test. \r
+  @param  This                Protocol instance pointer.\r
+  @param  StartAddress        The start address of the memory range.\r
+  @param  Length              The 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 must be below 16M.\r
 \r
 **/\r