]>
Commit | Line | Data |
---|---|---|
87a34ca0 GD |
1 | /** @file\r |
2 | This driver publishes the SMM Access 2 Protocol.\r | |
3 | \r | |
4 | Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>\r | |
5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
6 | \r | |
7 | **/\r | |
8 | \r | |
9 | #include "SmmAccessDxe.h"\r | |
10 | \r | |
e5efcf8b | 11 | SMM_ACCESS_PRIVATE_DATA mSmmAccess;\r |
87a34ca0 GD |
12 | \r |
13 | /**\r | |
14 | Update region state from SMRAM description\r | |
15 | \r | |
16 | @param[in] OrLogic Indicate to use OR if true or AND if false.\r | |
17 | @param[in] Value The value to set to region state based on OrLogic.\r | |
18 | \r | |
19 | **/\r | |
20 | VOID\r | |
e5efcf8b MK |
21 | SyncRegionState2SmramDesc (\r |
22 | IN BOOLEAN OrLogic,\r | |
23 | IN UINT64 Value\r | |
87a34ca0 GD |
24 | )\r |
25 | {\r | |
e5efcf8b | 26 | UINT32 Index;\r |
87a34ca0 GD |
27 | \r |
28 | for (Index = 0; Index < mSmmAccess.NumberRegions; Index++) {\r | |
29 | if (OrLogic) {\r | |
30 | mSmmAccess.SmramDesc[Index].RegionState |= Value;\r | |
31 | } else {\r | |
32 | mSmmAccess.SmramDesc[Index].RegionState &= Value;\r | |
33 | }\r | |
34 | }\r | |
35 | }\r | |
36 | \r | |
37 | /**\r | |
38 | This routine accepts a request to "open" a region of SMRAM. The\r | |
39 | region could be legacy ABSEG, HSEG, or TSEG near top of physical memory.\r | |
40 | The use of "open" means that the memory is visible from all boot-service\r | |
41 | and SMM agents.\r | |
42 | \r | |
43 | @param This Pointer to the SMM Access Interface.\r | |
44 | \r | |
45 | @retval EFI_SUCCESS The region was successfully opened.\r | |
46 | @retval EFI_DEVICE_ERROR The region could not be opened because locked by chipset.\r | |
47 | @retval EFI_INVALID_PARAMETER The descriptor index was out of bounds.\r | |
48 | \r | |
49 | **/\r | |
50 | EFI_STATUS\r | |
51 | EFIAPI\r | |
52 | Open (\r | |
e5efcf8b | 53 | IN EFI_SMM_ACCESS2_PROTOCOL *This\r |
87a34ca0 GD |
54 | )\r |
55 | {\r | |
56 | if ((mSmmAccess.SmmRegionState & EFI_SMRAM_LOCKED) != 0) {\r | |
57 | //\r | |
58 | // Cannot open a "locked" region\r | |
59 | //\r | |
60 | DEBUG ((DEBUG_INFO, "Cannot open the locked SMRAM Region\n"));\r | |
61 | return EFI_DEVICE_ERROR;\r | |
62 | }\r | |
63 | \r | |
64 | mSmmAccess.SmmRegionState &= ~(EFI_SMRAM_CLOSED | EFI_ALLOCATED);\r | |
e5efcf8b | 65 | SyncRegionState2SmramDesc (FALSE, (UINT64)(UINTN)(~(EFI_SMRAM_CLOSED | EFI_ALLOCATED)));\r |
87a34ca0 GD |
66 | \r |
67 | mSmmAccess.SmmRegionState |= EFI_SMRAM_OPEN;\r | |
e5efcf8b | 68 | SyncRegionState2SmramDesc (TRUE, EFI_SMRAM_OPEN);\r |
87a34ca0 GD |
69 | mSmmAccess.SmmAccess.OpenState = TRUE;\r |
70 | \r | |
71 | return EFI_SUCCESS;\r | |
72 | }\r | |
73 | \r | |
74 | /**\r | |
75 | This routine accepts a request to "close" a region of SMRAM. The region\r | |
76 | could be legacy AB or TSEG near top of physical memory.\r | |
77 | The use of "close" means that the memory is only visible from SMM agents,\r | |
78 | not from BS or RT code.\r | |
79 | \r | |
80 | @param This Pointer to the SMM Access Interface.\r | |
81 | \r | |
82 | @retval EFI_SUCCESS The region was successfully closed.\r | |
83 | @retval EFI_DEVICE_ERROR The region could not be closed because locked by\r | |
84 | chipset.\r | |
85 | @retval EFI_INVALID_PARAMETER The descriptor index was out of bounds.\r | |
86 | \r | |
87 | **/\r | |
88 | EFI_STATUS\r | |
89 | EFIAPI\r | |
90 | Close (\r | |
e5efcf8b | 91 | IN EFI_SMM_ACCESS2_PROTOCOL *This\r |
87a34ca0 GD |
92 | )\r |
93 | {\r | |
94 | if ((mSmmAccess.SmmRegionState & EFI_SMRAM_LOCKED) != 0) {\r | |
95 | //\r | |
96 | // Cannot close a "locked" region\r | |
97 | //\r | |
98 | DEBUG ((DEBUG_INFO, "Cannot close the locked SMRAM Region\n"));\r | |
99 | return EFI_DEVICE_ERROR;\r | |
100 | }\r | |
101 | \r | |
102 | if ((mSmmAccess.SmmRegionState & EFI_SMRAM_CLOSED) != 0) {\r | |
103 | return EFI_DEVICE_ERROR;\r | |
104 | }\r | |
105 | \r | |
106 | mSmmAccess.SmmRegionState &= ~EFI_SMRAM_OPEN;\r | |
e5efcf8b | 107 | SyncRegionState2SmramDesc (FALSE, (UINT64)(UINTN)(~EFI_SMRAM_OPEN));\r |
87a34ca0 GD |
108 | \r |
109 | mSmmAccess.SmmRegionState |= (EFI_SMRAM_CLOSED | EFI_ALLOCATED);\r | |
e5efcf8b | 110 | SyncRegionState2SmramDesc (TRUE, EFI_SMRAM_CLOSED | EFI_ALLOCATED);\r |
87a34ca0 GD |
111 | \r |
112 | mSmmAccess.SmmAccess.OpenState = FALSE;\r | |
113 | \r | |
114 | return EFI_SUCCESS;\r | |
115 | }\r | |
116 | \r | |
117 | /**\r | |
118 | This routine accepts a request to "lock" SMRAM. The\r | |
119 | region could be legacy AB or TSEG near top of physical memory.\r | |
120 | The use of "lock" means that the memory can no longer be opened\r | |
121 | to BS state.\r | |
122 | \r | |
123 | @param This Pointer to the SMM Access Interface.\r | |
124 | \r | |
125 | @retval EFI_SUCCESS The region was successfully locked.\r | |
126 | @retval EFI_DEVICE_ERROR The region could not be locked because at least\r | |
127 | one range is still open.\r | |
128 | @retval EFI_INVALID_PARAMETER The descriptor index was out of bounds.\r | |
129 | \r | |
130 | **/\r | |
131 | EFI_STATUS\r | |
132 | EFIAPI\r | |
133 | Lock (\r | |
e5efcf8b | 134 | IN EFI_SMM_ACCESS2_PROTOCOL *This\r |
87a34ca0 GD |
135 | )\r |
136 | {\r | |
137 | if (mSmmAccess.SmmAccess.OpenState) {\r | |
138 | DEBUG ((DEBUG_INFO, "Cannot lock SMRAM when it is still open\n"));\r | |
139 | return EFI_DEVICE_ERROR;\r | |
140 | }\r | |
141 | \r | |
142 | mSmmAccess.SmmRegionState |= EFI_SMRAM_LOCKED;\r | |
e5efcf8b | 143 | SyncRegionState2SmramDesc (TRUE, EFI_SMRAM_LOCKED);\r |
87a34ca0 GD |
144 | mSmmAccess.SmmAccess.LockState = TRUE;\r |
145 | return EFI_SUCCESS;\r | |
146 | }\r | |
147 | \r | |
148 | /**\r | |
149 | This routine services a user request to discover the SMRAM\r | |
150 | capabilities of this platform. This will report the possible\r | |
151 | ranges that are possible for SMRAM access, based upon the\r | |
152 | memory controller capabilities.\r | |
153 | \r | |
154 | @param This Pointer to the SMRAM Access Interface.\r | |
155 | @param SmramMapSize Pointer to the variable containing size of the\r | |
156 | buffer to contain the description information.\r | |
157 | @param SmramMap Buffer containing the data describing the Smram\r | |
158 | region descriptors.\r | |
159 | \r | |
160 | @retval EFI_BUFFER_TOO_SMALL The user did not provide a sufficient buffer.\r | |
161 | @retval EFI_SUCCESS The user provided a sufficiently-sized buffer.\r | |
162 | \r | |
163 | **/\r | |
164 | EFI_STATUS\r | |
165 | EFIAPI\r | |
166 | GetCapabilities (\r | |
e5efcf8b MK |
167 | IN CONST EFI_SMM_ACCESS2_PROTOCOL *This,\r |
168 | IN OUT UINTN *SmramMapSize,\r | |
169 | IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap\r | |
87a34ca0 GD |
170 | )\r |
171 | {\r | |
e5efcf8b MK |
172 | EFI_STATUS Status;\r |
173 | UINTN NecessaryBufferSize;\r | |
87a34ca0 | 174 | \r |
e5efcf8b | 175 | NecessaryBufferSize = mSmmAccess.NumberRegions * sizeof (EFI_SMRAM_DESCRIPTOR);\r |
87a34ca0 GD |
176 | if (*SmramMapSize < NecessaryBufferSize) {\r |
177 | Status = EFI_BUFFER_TOO_SMALL;\r | |
178 | } else {\r | |
e5efcf8b | 179 | CopyMem (SmramMap, mSmmAccess.SmramDesc, NecessaryBufferSize);\r |
87a34ca0 GD |
180 | Status = EFI_SUCCESS;\r |
181 | }\r | |
182 | \r | |
183 | *SmramMapSize = NecessaryBufferSize;\r | |
184 | return Status;\r | |
185 | }\r | |
186 | \r | |
187 | /**\r | |
188 | This function installs EFI_SMM_ACCESS_PROTOCOL.\r | |
189 | \r | |
190 | @param ImageHandle Handle for the image of this driver\r | |
191 | @param SystemTable Pointer to the EFI System Table\r | |
192 | \r | |
193 | @retval EFI_UNSUPPORTED There's no Intel ICH on this platform\r | |
194 | @return The status returned from InstallProtocolInterface().\r | |
195 | \r | |
196 | **/\r | |
197 | EFI_STATUS\r | |
198 | EFIAPI\r | |
199 | SmmAccessEntryPoint (\r | |
e5efcf8b MK |
200 | IN EFI_HANDLE ImageHandle,\r |
201 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
87a34ca0 GD |
202 | )\r |
203 | {\r | |
204 | EFI_STATUS Status;\r | |
205 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
206 | UINT32 SmmRegionNum;\r | |
207 | EFI_SMRAM_HOB_DESCRIPTOR_BLOCK *SmramHob;\r | |
208 | UINT32 Index;\r | |
209 | \r | |
210 | //\r | |
211 | // Get SMRAM info HOB\r | |
212 | //\r | |
213 | GuidHob = GetFirstGuidHob (&gEfiSmmSmramMemoryGuid);\r | |
214 | if (GuidHob == NULL) {\r | |
215 | DEBUG ((DEBUG_INFO, "SMRAM HOB NOT found\n"));\r | |
216 | return EFI_NOT_FOUND;\r | |
217 | }\r | |
e5efcf8b MK |
218 | \r |
219 | SmramHob = (EFI_SMRAM_HOB_DESCRIPTOR_BLOCK *)GET_GUID_HOB_DATA (GuidHob);\r | |
220 | SmmRegionNum = SmramHob->NumberOfSmmReservedRegions;\r | |
87a34ca0 GD |
221 | mSmmAccess.SmramDesc = AllocateZeroPool (sizeof (EFI_SMRAM_DESCRIPTOR) * SmmRegionNum);\r |
222 | if (mSmmAccess.SmramDesc == NULL) {\r | |
223 | return EFI_OUT_OF_RESOURCES;\r | |
224 | }\r | |
e5efcf8b | 225 | \r |
87a34ca0 GD |
226 | CopyMem (mSmmAccess.SmramDesc, &SmramHob->Descriptor, sizeof (EFI_SMRAM_DESCRIPTOR) * SmmRegionNum);\r |
227 | \r | |
228 | DEBUG ((DEBUG_INFO, "NumberOfSmmReservedRegions = 0x%x\n", SmmRegionNum));\r | |
229 | for (Index = 0; Index < SmmRegionNum; Index++) {\r | |
e5efcf8b MK |
230 | DEBUG ((\r |
231 | DEBUG_INFO,\r | |
232 | "%d: base=0x%x, size = 0x%x, State=0x%x\n",\r | |
233 | Index,\r | |
234 | SmramHob->Descriptor[Index].PhysicalStart,\r | |
235 | SmramHob->Descriptor[Index].PhysicalSize,\r | |
236 | SmramHob->Descriptor[Index].RegionState\r | |
237 | ));\r | |
238 | mSmmAccess.SmramDesc[Index].RegionState &= EFI_ALLOCATED;\r | |
239 | mSmmAccess.SmramDesc[Index].RegionState |= EFI_SMRAM_CLOSED | EFI_CACHEABLE;\r | |
87a34ca0 GD |
240 | }\r |
241 | \r | |
e5efcf8b MK |
242 | mSmmAccess.Signature = SMM_ACCESS_PRIVATE_DATA_SIGNATURE;\r |
243 | mSmmAccess.NumberRegions = SmmRegionNum;\r | |
244 | mSmmAccess.SmmAccess.Open = Open;\r | |
245 | mSmmAccess.SmmAccess.Close = Close;\r | |
246 | mSmmAccess.SmmAccess.Lock = Lock;\r | |
247 | mSmmAccess.SmmAccess.GetCapabilities = GetCapabilities;\r | |
248 | mSmmAccess.SmmAccess.LockState = FALSE;\r | |
249 | mSmmAccess.SmmAccess.OpenState = FALSE;\r | |
250 | mSmmAccess.SmmRegionState = EFI_SMRAM_CLOSED;\r | |
87a34ca0 GD |
251 | \r |
252 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
253 | &mSmmAccess.Handle,\r | |
254 | &gEfiSmmAccess2ProtocolGuid,\r | |
255 | &mSmmAccess.SmmAccess,\r | |
256 | NULL\r | |
257 | );\r | |
258 | \r | |
259 | return Status;\r | |
260 | }\r |