MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / GenericMemoryTest.h

/** @file\r
  This protocol defines the generic memory test interfaces in Dxe phase.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __GENERIC_MEMORY_TEST_H__\r
#define __GENERIC_MEMORY_TEST_H__\r
\r
#define EFI_GENERIC_MEMORY_TEST_PROTOCOL_GUID  \\r
  { 0x309de7f1, 0x7f5e, 0x4ace, {0xb4, 0x9c, 0x53, 0x1b, 0xe5, 0xaa, 0x95, 0xef} }\r
\r
typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL  EFI_GENERIC_MEMORY_TEST_PROTOCOL;\r
\r
///\r
/// Memory test coverage level.\r
/// Ignore chooses not to test memory. Quick and Sparse test some memory, and Extensive performs a detailed memory test.\r
///\r
typedef enum {\r
  IGNORE,\r
  QUICK,\r
  SPARSE,\r
  EXTENSIVE,\r
  MAXLEVEL\r
} EXTENDMEM_COVERAGE_LEVEL;\r
\r
\r
/**\r
  Initialize the generic memory test.\r
\r
  @param  This                The 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 is initialized correctly.\r
  @retval EFI_NO_MEDIA        The system had no memory to be tested.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_INIT)(\r
  IN EFI_GENERIC_MEMORY_TEST_PROTOCOL          *This,\r
  IN  EXTENDMEM_COVERAGE_LEVEL                 Level,\r
  OUT BOOLEAN                                  *RequireSoftECCInit\r
  );\r
\r
\r
/**\r
  Perform the memory test.\r
\r
  @param  This                The protocol instance pointer.\r
  @param  TestedMemorySize    Return the tested extended memory size.\r
  @param  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  ErrorOut            TRUE if the memory error occured.\r
  @param  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
  @retval EFI_DEVICE_ERROR    Memory device error occured, and no agent can handle it.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PERFORM_MEMORY_TEST)(\r
  IN EFI_GENERIC_MEMORY_TEST_PROTOCOL          *This,\r
  OUT UINT64                                   *TestedMemorySize,\r
  OUT UINT64                                   *TotalMemorySize,\r
  OUT BOOLEAN                                  *ErrorOut,\r
  IN BOOLEAN                                   IfTestAbort\r
  );\r
\r
\r
/**\r
  Finish the memory test.\r
\r
  @param  This                The protocol instance pointer.\r
\r
  @retval EFI_SUCCESS         Success. All resources used in the memory test are freed.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_FINISHED)(\r
  IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This\r
  );\r
\r
/**\r
  Provides the capability to test the compatible range used by some special drivers.\r
\r
  @param  This                The protocol instance pointer.\r
  @param  StartAddress        The start address of the compatible memory range that\r
                              must be below 16M.\r
  @param  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
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_COMPATIBLE_RANGE)(\r
  IN EFI_GENERIC_MEMORY_TEST_PROTOCOL          *This,\r
  IN  EFI_PHYSICAL_ADDRESS                     StartAddress,\r
  IN  UINT64                                   Length\r
  );\r
\r
struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL {\r
  EFI_MEMORY_TEST_INIT              MemoryTestInit;\r
  EFI_PERFORM_MEMORY_TEST           PerformMemoryTest;\r
  EFI_MEMORY_TEST_FINISHED          Finished;\r
  EFI_MEMORY_TEST_COMPATIBLE_RANGE  CompatibleRangeTest;\r
};\r
\r
extern EFI_GUID gEfiGenericMemTestProtocolGuid;\r
\r
#endif\r
\r