MdeModulePkg/Include/Protocol/GenericMemoryTest.h

   1 /** @file
   2   This protocol defines the EFI generic memory test interfaces in Dxe phase.
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __GENERIC_MEMORY_TEST_H__
  16 #define __GENERIC_MEMORY_TEST_H__
  17
  18 #define EFI_GENERIC_MEMORY_TEST_PROTOCOL_GUID  \
  19   { 0x309de7f1, 0x7f5e, 0x4ace, {0xb4, 0x9c, 0x53, 0x1b, 0xe5, 0xaa, 0x95, 0xef} }
  20
  21 typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL  EFI_GENERIC_MEMORY_TEST_PROTOCOL;
  22
  23 typedef enum {
  24   IGNORE,
  25   QUICK,
  26   SPARSE,
  27   EXTENSIVE,
  28   MAXLEVEL
  29 } EXTENDMEM_COVERAGE_LEVEL;
  30
  31
  32 /**
  33   Initialize the generic memory test.
  34
  35   @param  This                Protocol instance pointer.
  36   @param  Level               The coverage level of the memory test.
  37   @param  RequireSoftECCInit  Indicate if the memory need software ECC init.
  38
  39   @retval EFI_SUCCESS         The generic memory test initialized correctly.
  40   @retval EFI_NO_MEDIA        There is not any non-tested memory found, in this
  41                               function if not any non-tesed memory found means
  42                               that the memory test driver have not detect any
  43                               non-tested extended memory of current system.
  44
  45 **/
  46 typedef
  47 EFI_STATUS
  48 (EFIAPI *EFI_MEMORY_TEST_INIT)(
  49   IN EFI_GENERIC_MEMORY_TEST_PROTOCOL          *This,
  50   IN  EXTENDMEM_COVERAGE_LEVEL                 Level,
  51   OUT BOOLEAN                                  *RequireSoftECCInit
  52   );
  53
  54
  55 /**
  56   Perform the memory test.
  57
  58   @param  This                Protocol instance pointer.
  59   @param  TestedMemorySize    Return the tested extended memory size.
  60   @param  TotalMemorySize     Return the whole system physical memory size, this
  61                               value may be changed if in some case some error
  62                               DIMMs be disabled.
  63   @param  ErrorOut            Any time the memory error occurs, this will be
  64                               TRUE.
  65   @param  IfTestAbort         Indicate if the user press "ESC" to skip the memory
  66                               test.
  67
  68   @retval EFI_SUCCESS         One block of memory test ok, the block size is hide
  69                               internally.
  70   @retval EFI_NOT_FOUND       Indicate all the non-tested memory blocks have
  71                               already go through.
  72   @retval EFI_DEVICE_ERROR    Mis-compare error, and no agent can handle it
  73
  74 **/
  75 typedef
  76 EFI_STATUS
  77 (EFIAPI *EFI_PERFORM_MEMORY_TEST)(
  78   IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
  79   OUT UINT64                                   *TestedMemorySize,
  80   OUT UINT64                                   *TotalMemorySize,
  81   OUT BOOLEAN                                  *ErrorOut,
  82   IN BOOLEAN                                   IfTestAbort
  83   );
  84
  85
  86 /**
  87   The memory test finished.
  88
  89   @param  This                Protocol instance pointer.
  90
  91   @retval EFI_SUCCESS         Successful free all the generic memory test driver
  92                               allocated resource and notify to platform memory
  93                               test driver that memory test finished.
  94
  95 **/
  96 typedef
  97 EFI_STATUS
  98 (EFIAPI *EFI_MEMORY_TEST_FINISHED)(
  99   IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This
 100   );
 101
 102 /**
 103   Provide capability to test compatible range which used by some sepcial
 104   driver required using memory range before BDS perform memory test.
 105
 106   @param  This                Protocol instance pointer.
 107   @param  StartAddress        The start address of the memory range.
 108   @param  Length              The memory range's length.
 109
 110   @retval EFI_SUCCESS           The compatible memory range pass the memory test.
 111   @retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.
 112
 113 **/
 114 typedef
 115 EFI_STATUS
 116 (EFIAPI *EFI_MEMORY_TEST_COMPATIBLE_RANGE)(
 117   IN EFI_GENERIC_MEMORY_TEST_PROTOCOL          *This,
 118   IN  EFI_PHYSICAL_ADDRESS                     StartAddress,
 119   IN  UINT64                                   Length
 120   );
 121
 122 struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL {
 123   EFI_MEMORY_TEST_INIT              MemoryTestInit;
 124   EFI_PERFORM_MEMORY_TEST           PerformMemoryTest;
 125   EFI_MEMORY_TEST_FINISHED          Finished;
 126   EFI_MEMORY_TEST_COMPATIBLE_RANGE  CompatibleRangeTest;
 127 };
 128
 129 extern EFI_GUID gEfiGenericMemTestProtocolGuid;
 130
 131 #endif
 132