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