Add function headers & file header for public header files

[mirror_edk2.git] / MdeModulePkg / Include / Ppi / BaseMemoryTest.h

/** @file\r
  Pei memory test PPI used to Perform memory test in PEI phase.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __BASE_MEMORY_TEST_H__\r
#define __BASE_MEMORY_TEST_H__\r
\r
#define PEI_BASE_MEMORY_TEST_GUID \\r
  { 0xb6ec423c, 0x21d2, 0x490d, {0x85, 0xc6, 0xdd, 0x58, 0x64, 0xea, 0xa6, 0x74 } }\r
\r
typedef struct _PEI_BASE_MEMORY_TEST_PPI  PEI_BASE_MEMORY_TEST_PPI;\r
\r
typedef enum {\r
  Ignore,\r
  Quick,\r
  Sparse,\r
  Extensive\r
} PEI_MEMORY_TEST_OP;\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PEI_BASE_MEMORY_TEST) (\r
  IN  EFI_PEI_SERVICES                   **PeiServices,\r
  IN PEI_BASE_MEMORY_TEST_PPI            * This,\r
  IN  EFI_PHYSICAL_ADDRESS               BeginAddress,\r
  IN  UINT64                             MemoryLength,\r
  IN  PEI_MEMORY_TEST_OP                 Operation,\r
  OUT EFI_PHYSICAL_ADDRESS               * ErrorAddress\r
  );\r
\r
struct _PEI_BASE_MEMORY_TEST_PPI {\r
  PEI_BASE_MEMORY_TEST  BaseMemoryTest;\r
};\r
\r
extern EFI_GUID gPeiBaseMemoryTestPpiGuid;\r
\r
#endif\r