MdeModulePkg/Universal/MemoryTest/BaseMemoryTestPei/BaseMemoryTest.h

   1 /** @file
   2   Internal include file for support of memory test in PEI 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 _PEI_BASE_MEMORY_TEST_H_
  16 #define _PEI_BASE_MEMORY_TEST_H_
  17
  18 #include <PiPei.h>
  19 #include <Ppi/BaseMemoryTest.h>
  20 #include <Library/DebugLib.h>
  21 #include <Library/PeimEntryPoint.h>
  22 #include <Library/ReportStatusCodeLib.h>
  23 #include <Library/PcdLib.h>
  24 #include <Library/PeiServicesLib.h>
  25
  26 #define COVER_SPAN    0x40000
  27 #define TEST_PATTERN  0x5A5A5A5A
  28
  29 /**
  30   Test base memory.
  31
  32   @param  PeiServices      An indirect pointer to the PEI Services Table published by the PEI Foundation.
  33   @param  This             Pointer to this PPI instance.
  34   @param  BeginAddress     Beginning of the memory address to be checked.
  35   @param  MemoryLength     Bytes of memory range to be checked.
  36   @param  Operation        Type of memory check operation to be performed.
  37   @param  ErrorAddress     Pointer to address of the error memory returned.
  38
  39   @retval EFI_SUCCESS      Memory test passed.
  40   @retval EFI_DEVICE_ERROR Memory test failed.
  41
  42 **/
  43 EFI_STATUS
  44 EFIAPI
  45 BaseMemoryTest (
  46   IN  EFI_PEI_SERVICES                   **PeiServices,
  47   IN PEI_BASE_MEMORY_TEST_PPI            *This,
  48   IN  EFI_PHYSICAL_ADDRESS               BeginAddress,
  49   IN  UINT64                             MemoryLength,
  50   IN  PEI_MEMORY_TEST_OP                 Operation,
  51   OUT EFI_PHYSICAL_ADDRESS               *ErrorAddress
  52   );
  53
  54 #endif