EdkModulePkg/Universal/GenericMemoryTest/Pei/BaseMemoryTest.h

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