UefiCpuPkg/CpuDxe: Enable protection for newly added page table
[mirror_edk2.git] / UefiCpuPkg / SecCore / SecMain.h
1 /** @file
2 Master header file for SecCore.
3
4 Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef _SEC_CORE_H_
16 #define _SEC_CORE_H_
17
18 #include <PiPei.h>
19
20 #include <Ppi/SecPlatformInformation.h>
21 #include <Ppi/SecPlatformInformation2.h>
22 #include <Ppi/TemporaryRamDone.h>
23 #include <Ppi/SecPerformance.h>
24
25 #include <Guid/FirmwarePerformance.h>
26
27 #include <Library/BaseLib.h>
28 #include <Library/DebugLib.h>
29 #include <Library/PcdLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/PlatformSecLib.h>
32 #include <Library/UefiCpuLib.h>
33 #include <Library/PeCoffGetEntryPointLib.h>
34 #include <Library/PeCoffExtraActionLib.h>
35 #include <Library/DebugAgentLib.h>
36 #include <Library/CpuExceptionHandlerLib.h>
37 #include <Library/ReportStatusCodeLib.h>
38 #include <Library/PeiServicesTablePointerLib.h>
39 #include <Library/HobLib.h>
40 #include <Library/PeiServicesLib.h>
41
42 #define SEC_IDT_ENTRY_COUNT 34
43
44 typedef struct _SEC_IDT_TABLE {
45 //
46 // Reserved 8 bytes preceding IDT to store EFI_PEI_SERVICES**, since IDT base
47 // address should be 8-byte alignment.
48 // Note: For IA32, only the 4 bytes immediately preceding IDT is used to store
49 // EFI_PEI_SERVICES**
50 //
51 UINT64 PeiService;
52 UINT64 IdtTable[SEC_IDT_ENTRY_COUNT];
53 } SEC_IDT_TABLE;
54
55 /**
56 TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked
57 by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.
58
59 @retval EFI_SUCCESS Use of Temporary RAM was disabled.
60 @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.
61
62 **/
63 EFI_STATUS
64 EFIAPI
65 SecTemporaryRamDone (
66 VOID
67 );
68
69 /**
70 Entry point to the C language phase of SEC. After the SEC assembly
71 code has initialized some temporary memory and set up the stack,
72 the control is transferred to this function.
73
74 @param SizeOfRam Size of the temporary memory available for use.
75 @param TempRamBase Base address of temporary ram
76 @param BootFirmwareVolume Base address of the Boot Firmware Volume.
77 **/
78 VOID
79 EFIAPI
80 SecStartup (
81 IN UINT32 SizeOfRam,
82 IN UINT32 TempRamBase,
83 IN VOID *BootFirmwareVolume
84 );
85
86 /**
87 Find and return Pei Core entry point.
88
89 It also find SEC and PEI Core file debug information. It will report them if
90 remote debug is enabled.
91
92 @param BootFirmwareVolumePtr Point to the boot firmware volume.
93 @param PeiCoreEntryPoint Point to the PEI core entry point.
94
95 **/
96 VOID
97 EFIAPI
98 FindAndReportEntryPoints (
99 IN EFI_FIRMWARE_VOLUME_HEADER *BootFirmwareVolumePtr,
100 OUT EFI_PEI_CORE_ENTRY_POINT *PeiCoreEntryPoint
101 );
102
103 /**
104 Auto-generated function that calls the library constructors for all of the module's
105 dependent libraries. This function must be called by the SEC Core once a stack has
106 been established.
107
108 **/
109 VOID
110 EFIAPI
111 ProcessLibraryConstructorList (
112 VOID
113 );
114
115 /**
116 Implementation of the PlatformInformation service in EFI_SEC_PLATFORM_INFORMATION_PPI.
117
118 @param PeiServices Pointer to the PEI Services Table.
119 @param StructureSize Pointer to the variable describing size of the input buffer.
120 @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
121
122 @retval EFI_SUCCESS The data was successfully returned.
123 @retval EFI_BUFFER_TOO_SMALL The buffer was too small.
124
125 **/
126 EFI_STATUS
127 EFIAPI
128 SecPlatformInformationBist (
129 IN CONST EFI_PEI_SERVICES **PeiServices,
130 IN OUT UINT64 *StructureSize,
131 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord
132 );
133
134 /**
135 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
136
137 @param PeiServices The pointer to the PEI Services Table.
138 @param StructureSize The pointer to the variable describing size of the input buffer.
139 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
140
141 @retval EFI_SUCCESS The data was successfully returned.
142 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
143 hold the record is returned in StructureSize.
144
145 **/
146 EFI_STATUS
147 EFIAPI
148 SecPlatformInformation2Bist (
149 IN CONST EFI_PEI_SERVICES **PeiServices,
150 IN OUT UINT64 *StructureSize,
151 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2 *PlatformInformationRecord2
152 );
153
154 /**
155 Republish SecPlatformInformationPpi/SecPlatformInformation2Ppi.
156
157 **/
158 VOID
159 RepublishSecPlatformInformationPpi (
160 VOID
161 );
162
163 /**
164 Entry point of the notification callback function itself within the PEIM.
165 It is to get SEC performance data and build HOB to convey the SEC performance
166 data to DXE phase.
167
168 @param PeiServices Indirect reference to the PEI Services Table.
169 @param NotifyDescriptor Address of the notification descriptor data structure.
170 @param Ppi Address of the PPI that was installed.
171
172 @return Status of the notification.
173 The status code returned from this function is ignored.
174 **/
175 EFI_STATUS
176 EFIAPI
177 SecPerformancePpiCallBack (
178 IN EFI_PEI_SERVICES **PeiServices,
179 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,
180 IN VOID *Ppi
181 );
182
183 #endif