MdeModulePkg/Universal/MemoryTest/BaseMemoryTestPei/BaseMemoryTest.h

   1 /** @file
   2   Tiano PEIM to provide a PEI memory test service.
   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
  25
  26 //
  27 // Some global define
  28 //
  29 #define COVER_SPAN    0x40000
  30 #define TEST_PATTERN  0x5A5A5A5A
  31
  32 EFI_STATUS
  33 EFIAPI
  34 PeiBaseMemoryTestInit (
  35   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  36   IN EFI_PEI_SERVICES          **PeiServices
  37   )
  38 /*++
  39
  40 Routine Description:
  41
  42   TODO: Add function description
  43
  44 Arguments:
  45
  46   FfsHeader   - TODO: add argument description
  47   PeiServices - TODO: add argument description
  48
  49 Returns:
  50
  51   TODO: add return values
  52
  53 --*/
  54 ;
  55
  56 EFI_STATUS
  57 EFIAPI
  58 BaseMemoryTest (
  59   IN  EFI_PEI_SERVICES                   **PeiServices,
  60   IN PEI_BASE_MEMORY_TEST_PPI            *This,
  61   IN  EFI_PHYSICAL_ADDRESS               BeginAddress,
  62   IN  UINT64                             MemoryLength,
  63   IN  PEI_MEMORY_TEST_OP                 Operation,
  64   OUT EFI_PHYSICAL_ADDRESS               *ErrorAddress
  65   )
  66 /*++
  67
  68 Routine Description:
  69
  70   TODO: Add function description
  71
  72 Arguments:
  73
  74   PeiServices   - TODO: add argument description
  75   This          - TODO: add argument description
  76   BeginAddress  - TODO: add argument description
  77   MemoryLength  - TODO: add argument description
  78   Operation     - TODO: add argument description
  79   ErrorAddress  - TODO: add argument description
  80
  81 Returns:
  82
  83   TODO: add return values
  84
  85 --*/
  86 ;
  87
  88 #endif