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