]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/MemoryTest/NullMemoryTestDxe/NullMemoryTest.h
MdeModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdeModulePkg / Universal / MemoryTest / NullMemoryTestDxe / NullMemoryTest.h
index 1863af5bd96243cbb9bda10d9c4de01802d72297..cee9b785be5ba3047f767b0f69b315e23e5de322 100644 (file)
@@ -1,14 +1,8 @@
 /** @file\r
   Include file of the NULL memory test driver.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. 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
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -40,15 +34,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 +59,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 +92,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 +112,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