MdeModulePkg/Universal/MemoryTest/BaseMemoryTestPei/BaseMemoryTest.h

   1 /*++
   2
   3 Copyright (c) 2006 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   BaseMemoryTest.h
  15
  16 Abstract:
  17
  18   Tiano PEIM to provide a PEI memory test service.
  19
  20 --*/
  21
  22 #ifndef _PEI_BASE_MEMORY_TEST_H_
  23 #define _PEI_BASE_MEMORY_TEST_H_
  24
  25 #include <PiPei.h>
  26 #include <Ppi/BaseMemoryTest.h>
  27 #include <Library/DebugLib.h>
  28 #include <Library/PeimEntryPoint.h>
  29 #include <Library/ReportStatusCodeLib.h>
  30 #include <Library/PcdLib.h>
  31
  32
  33 //
  34 // Some global define
  35 //
  36 #define COVER_SPAN    0x40000
  37 #define TEST_PATTERN  0x5A5A5A5A
  38
  39 EFI_STATUS
  40 EFIAPI
  41 PeiBaseMemoryTestInit (
  42   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  43   IN EFI_PEI_SERVICES          **PeiServices
  44   )
  45 /*++
  46
  47 Routine Description:
  48
  49   TODO: Add function description
  50
  51 Arguments:
  52
  53   FfsHeader   - TODO: add argument description
  54   PeiServices - TODO: add argument description
  55
  56 Returns:
  57
  58   TODO: add return values
  59
  60 --*/
  61 ;
  62
  63 EFI_STATUS
  64 EFIAPI
  65 BaseMemoryTest (
  66   IN  EFI_PEI_SERVICES                   **PeiServices,
  67   IN PEI_BASE_MEMORY_TEST_PPI            *This,
  68   IN  EFI_PHYSICAL_ADDRESS               BeginAddress,
  69   IN  UINT64                             MemoryLength,
  70   IN  PEI_MEMORY_TEST_OP                 Operation,
  71   OUT EFI_PHYSICAL_ADDRESS               *ErrorAddress
  72   )
  73 /*++
  74
  75 Routine Description:
  76
  77   TODO: Add function description
  78
  79 Arguments:
  80
  81   PeiServices   - TODO: add argument description
  82   This          - TODO: add argument description
  83   BeginAddress  - TODO: add argument description
  84   MemoryLength  - TODO: add argument description
  85   Operation     - TODO: add argument description
  86   ErrorAddress  - TODO: add argument description
  87
  88 Returns:
  89
  90   TODO: add return values
  91
  92 --*/
  93 ;
  94
  95 #endif