]>
Commit | Line | Data |
---|---|---|
5879b875 | 1 | /** @file\r |
2 | This file declares Sec Platform Information PPI.\r | |
3 | \r | |
d7132512 LG |
4 | This service is the primary handoff state into the PEI Foundation. \r |
5 | The Security (SEC) component creates the early, transitory memory \r | |
6 | environment and also encapsulates knowledge of at least the \r | |
7 | location of the Boot Firmware Volume (BFV).\r | |
8 | \r | |
9 | Copyright (c) 2006 - 2008, Intel Corporation \r | |
5879b875 | 10 | All rights reserved. This program and the accompanying materials \r |
11 | are licensed and made available under the terms and conditions of the BSD License \r | |
12 | which accompanies this distribution. The full text of the license may be found at \r | |
13 | http://opensource.org/licenses/bsd-license.php \r | |
14 | \r | |
15 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
16 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
17 | \r | |
5879b875 | 18 | @par Revision Reference:\r |
0047820e | 19 | This PPI is introduced in PI Version 1.0.\r |
5879b875 | 20 | \r |
21 | **/\r | |
22 | \r | |
23 | #ifndef __SEC_PLATFORM_INFORMATION_PPI_H__\r | |
24 | #define __SEC_PLATFORM_INFORMATION_PPI_H__\r | |
25 | \r | |
26 | #define EFI_SEC_PLATFORM_INFORMATION_GUID \\r | |
27 | { \\r | |
28 | 0x6f8c2b35, 0xfef4, 0x448d, {0x82, 0x56, 0xe1, 0x1b, 0x19, 0xd6, 0x10, 0x77 } \\r | |
29 | }\r | |
30 | \r | |
31 | typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;\r | |
32 | \r | |
33 | \r | |
06889842 | 34 | ///\r |
35 | /// EFI_HEALTH_FLAGS\r | |
36 | /// Contains information generated by microcode, hardware, and/or the Itanium\r | |
37 | /// processor PAL code about the state of the processor upon reset.\r | |
38 | ///\r | |
5879b875 | 39 | typedef union {\r |
40 | struct {\r | |
13c38031 | 41 | ///\r |
42 | /// A 2-bit field indicating self-test state after reset.\r | |
43 | ///\r | |
5879b875 | 44 | UINT32 Status : 2;\r |
13c38031 | 45 | ///\r |
46 | /// A 1-bit field indicating whether testing has occurred.\r | |
47 | /// If this field is zero, the processor has not been tested,\r | |
48 | /// and no further fields in the self-test State parameter are valid.\r | |
49 | ///\r | |
5879b875 | 50 | UINT32 Tested : 1;\r |
13c38031 | 51 | ///\r |
52 | /// Reserved 13 bits.\r | |
53 | ///\r | |
5879b875 | 54 | UINT32 Reserved1 :13;\r |
13c38031 | 55 | ///\r |
56 | /// A 1-bit field. If set to 1, indicates that virtual\r | |
57 | /// memory features are not available.\r | |
58 | ///\r | |
5879b875 | 59 | UINT32 VirtualMemoryUnavailable : 1;\r |
13c38031 | 60 | ///\r |
61 | /// A 1-bit field. If set to 1, indicates that IA-32 execution\r | |
62 | /// is not available.\r | |
63 | ///\r | |
5879b875 | 64 | UINT32 Ia32ExecutionUnavailable : 1;\r |
13c38031 | 65 | ///\r |
66 | /// A 1-bit field. If set to 1, indicates that the floating\r | |
67 | /// point unit is not available.\r | |
68 | ///\r | |
5879b875 | 69 | UINT32 FloatingPointUnavailable : 1;\r |
13c38031 | 70 | ///\r |
71 | /// A 1-bit field. If set to 1, indicates miscellaneous\r | |
72 | /// functional failure other than vm, ia, or fp.\r | |
73 | /// The test status field provides additional information on\r | |
74 | /// test failures when the State field returns a value of\r | |
75 | /// performance restricted or functionally restricted.\r | |
76 | /// The value returned is implementation dependent.\r | |
77 | ///\r | |
5879b875 | 78 | UINT32 MiscFeaturesUnavailable : 1;\r |
13c38031 | 79 | ///\r |
80 | /// Reserved 12 bits.\r | |
81 | ///\r | |
5879b875 | 82 | UINT32 Reserved2 :12;\r |
83 | } Bits;\r | |
84 | UINT32 Uint32;\r | |
85 | } EFI_HEALTH_FLAGS;\r | |
86 | \r | |
d936a70c | 87 | #define NORMAL_BOOT_CALL 0x0\r |
88 | #define RECOVERY_CHECK_CALL 0x3\r | |
89 | \r | |
90 | typedef struct {\r | |
91 | UINT8 BootPhase;\r | |
92 | UINT8 FWStatus;\r | |
93 | UINT16 Reserved1;\r | |
94 | UINT32 Reserved2;\r | |
95 | \r | |
96 | UINT16 ProcId;\r | |
97 | UINT16 Reserved3;\r | |
98 | UINT8 IdMask;\r | |
99 | UINT8 EidMask;\r | |
100 | UINT16 Reserved4;\r | |
101 | \r | |
102 | UINT64 PalCallAddress;\r | |
103 | UINT64 PalSpecialAddress;\r | |
104 | UINT64 SelfTestStatus;\r | |
105 | UINT64 SelfTestControl;\r | |
106 | UINT64 MemoryBufferRequired;\r | |
107 | \r | |
108 | } IPF_HANDOFF_STATUS;\r | |
109 | \r | |
13c38031 | 110 | ///\r |
111 | /// EFI_SEC_PLATFORM_INFORMATION_RECORD\r | |
112 | ///\r | |
5879b875 | 113 | typedef struct {\r |
13c38031 | 114 | ///\r |
115 | /// Contains information generated by microcode, hardware,\r | |
116 | /// and/or the Itanium processor PAL code about the state\r | |
117 | /// of the processor upon reset.\r | |
118 | ///\r | |
5879b875 | 119 | EFI_HEALTH_FLAGS HealthFlags;\r |
120 | } EFI_SEC_PLATFORM_INFORMATION_RECORD;\r | |
121 | \r | |
122 | \r | |
123 | \r | |
124 | /**\r | |
125 | This interface conveys state information out of the Security (SEC) phase into PEI.\r | |
126 | \r | |
13c38031 | 127 | This service is published by the SEC phase. The SEC phase handoff has an optional\r |
128 | EFI_PEI_PPI_DESCRIPTOR list as its final argument when control is passed from SEC into the\r | |
129 | PEI Foundation. As such, if the platform supports the built-in self test (BIST) on IA-32 Intel\r | |
130 | architecture or the PAL-A handoff state for Itanium architecture, this information is encapsulated\r | |
131 | into the data structure abstracted by this service. This information is collected for the boot-strap\r | |
132 | processor (BSP) on IA-32, and for Itanium architecture, it is available on all processors that execute\r | |
133 | the PEI Foundation.\r | |
134 | \r | |
5879b875 | 135 | @param PeiServices Pointer to the PEI Services Table.\r |
136 | @param StructureSize Pointer to the variable describing size of the input buffer.\r | |
137 | @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r | |
138 | \r | |
13c38031 | 139 | @retval EFI_SUCCESS The data was successfully returned.\r |
140 | @retval EFI_BUFFER_TOO_SMALL The buffer was too small.\r | |
5879b875 | 141 | \r |
142 | **/\r | |
143 | typedef\r | |
144 | EFI_STATUS\r | |
8b13229b | 145 | (EFIAPI *EFI_SEC_PLATFORM_INFORMATION)(\r |
00edb218 A |
146 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
147 | IN OUT UINT64 *StructureSize,\r | |
148 | OUT EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord\r | |
5879b875 | 149 | );\r |
150 | \r | |
151 | \r | |
13c38031 | 152 | ///\r |
153 | /// This service abstracts platform-specific information. It is necessary \r | |
154 | /// to convey this information to the PEI Foundation so that it can \r | |
155 | /// discover where to begin dispatching PEIMs.\r | |
156 | ///\r | |
5879b875 | 157 | struct _EFI_SEC_PLATFORM_INFORMATION_PPI {\r |
158 | EFI_SEC_PLATFORM_INFORMATION PlatformInformation;\r | |
159 | };\r | |
160 | \r | |
161 | \r | |
162 | extern EFI_GUID gEfiSecPlatformInformationPpiGuid;\r | |
163 | \r | |
164 | #endif\r |