1d71e4f800d932b4e8722b9567820056d450468d
[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / RuntimeDxe / VariableDxe.c
1 /** @file
2 Implement all four UEFI Runtime Variable services for the nonvolatile
3 and volatile storage space and install variable architecture protocol.
4
5 Copyright (C) 2013, Red Hat, Inc.
6 Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #include "Variable.h"
18 #include "AuthService.h"
19
20 extern VARIABLE_STORE_HEADER *mNvVariableCache;
21 extern VARIABLE_INFO_ENTRY *gVariableInfo;
22 EFI_HANDLE mHandle = NULL;
23 EFI_EVENT mVirtualAddressChangeEvent = NULL;
24 EFI_EVENT mFtwRegistration = NULL;
25 extern LIST_ENTRY mLockedVariableList;
26 extern BOOLEAN mEndOfDxe;
27 EDKII_VARIABLE_LOCK_PROTOCOL mVariableLock = { VariableLockRequestToLock };
28
29 /**
30 Return TRUE if ExitBootServices () has been called.
31
32 @retval TRUE If ExitBootServices () has been called.
33 **/
34 BOOLEAN
35 AtRuntime (
36 VOID
37 )
38 {
39 return EfiAtRuntime ();
40 }
41
42
43 /**
44 Initializes a basic mutual exclusion lock.
45
46 This function initializes a basic mutual exclusion lock to the released state
47 and returns the lock. Each lock provides mutual exclusion access at its task
48 priority level. Since there is no preemption or multiprocessor support in EFI,
49 acquiring the lock only consists of raising to the locks TPL.
50 If Lock is NULL, then ASSERT().
51 If Priority is not a valid TPL value, then ASSERT().
52
53 @param Lock A pointer to the lock data structure to initialize.
54 @param Priority EFI TPL is associated with the lock.
55
56 @return The lock.
57
58 **/
59 EFI_LOCK *
60 InitializeLock (
61 IN OUT EFI_LOCK *Lock,
62 IN EFI_TPL Priority
63 )
64 {
65 return EfiInitializeLock (Lock, Priority);
66 }
67
68
69 /**
70 Acquires lock only at boot time. Simply returns at runtime.
71
72 This is a temperary function that will be removed when
73 EfiAcquireLock() in UefiLib can handle the call in UEFI
74 Runtimer driver in RT phase.
75 It calls EfiAcquireLock() at boot time, and simply returns
76 at runtime.
77
78 @param Lock A pointer to the lock to acquire.
79
80 **/
81 VOID
82 AcquireLockOnlyAtBootTime (
83 IN EFI_LOCK *Lock
84 )
85 {
86 if (!AtRuntime ()) {
87 EfiAcquireLock (Lock);
88 }
89 }
90
91
92 /**
93 Releases lock only at boot time. Simply returns at runtime.
94
95 This is a temperary function which will be removed when
96 EfiReleaseLock() in UefiLib can handle the call in UEFI
97 Runtimer driver in RT phase.
98 It calls EfiReleaseLock() at boot time and simply returns
99 at runtime.
100
101 @param Lock A pointer to the lock to release.
102
103 **/
104 VOID
105 ReleaseLockOnlyAtBootTime (
106 IN EFI_LOCK *Lock
107 )
108 {
109 if (!AtRuntime ()) {
110 EfiReleaseLock (Lock);
111 }
112 }
113
114 /**
115 Retrive the Fault Tolerent Write protocol interface.
116
117 @param[out] FtwProtocol The interface of Ftw protocol
118
119 @retval EFI_SUCCESS The FTW protocol instance was found and returned in FtwProtocol.
120 @retval EFI_NOT_FOUND The FTW protocol instance was not found.
121 @retval EFI_INVALID_PARAMETER SarProtocol is NULL.
122
123 **/
124 EFI_STATUS
125 GetFtwProtocol (
126 OUT VOID **FtwProtocol
127 )
128 {
129 EFI_STATUS Status;
130
131 //
132 // Locate Fault Tolerent Write protocol
133 //
134 Status = gBS->LocateProtocol (
135 &gEfiFaultTolerantWriteProtocolGuid,
136 NULL,
137 FtwProtocol
138 );
139 return Status;
140 }
141
142 /**
143 Retrive the FVB protocol interface by HANDLE.
144
145 @param[in] FvBlockHandle The handle of FVB protocol that provides services for
146 reading, writing, and erasing the target block.
147 @param[out] FvBlock The interface of FVB protocol
148
149 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
150 @retval EFI_UNSUPPORTED The device does not support the FVB protocol.
151 @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.
152
153 **/
154 EFI_STATUS
155 GetFvbByHandle (
156 IN EFI_HANDLE FvBlockHandle,
157 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock
158 )
159 {
160 //
161 // To get the FVB protocol interface on the handle
162 //
163 return gBS->HandleProtocol (
164 FvBlockHandle,
165 &gEfiFirmwareVolumeBlockProtocolGuid,
166 (VOID **) FvBlock
167 );
168 }
169
170
171 /**
172 Function returns an array of handles that support the FVB protocol
173 in a buffer allocated from pool.
174
175 @param[out] NumberHandles The number of handles returned in Buffer.
176 @param[out] Buffer A pointer to the buffer to return the requested
177 array of handles that support FVB protocol.
178
179 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
180 handles in Buffer was returned in NumberHandles.
181 @retval EFI_NOT_FOUND No FVB handle was found.
182 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
183 @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.
184
185 **/
186 EFI_STATUS
187 GetFvbCountAndBuffer (
188 OUT UINTN *NumberHandles,
189 OUT EFI_HANDLE **Buffer
190 )
191 {
192 EFI_STATUS Status;
193
194 //
195 // Locate all handles of Fvb protocol
196 //
197 Status = gBS->LocateHandleBuffer (
198 ByProtocol,
199 &gEfiFirmwareVolumeBlockProtocolGuid,
200 NULL,
201 NumberHandles,
202 Buffer
203 );
204 return Status;
205 }
206
207
208 /**
209 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
210
211 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
212 It convers pointer to new virtual address.
213
214 @param Event Event whose notification function is being invoked.
215 @param Context Pointer to the notification function's context.
216
217 **/
218 VOID
219 EFIAPI
220 VariableClassAddressChangeEvent (
221 IN EFI_EVENT Event,
222 IN VOID *Context
223 )
224 {
225 LIST_ENTRY *Link;
226 VARIABLE_ENTRY *Entry;
227 EFI_STATUS Status;
228
229 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetBlockSize);
230 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetPhysicalAddress);
231 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetAttributes);
232 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->SetAttributes);
233 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Read);
234 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Write);
235 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->EraseBlocks);
236 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance);
237 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLangCodes);
238 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->LangCodes);
239 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLang);
240 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);
241 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
242 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);
243 EfiConvertPointer (0x0, (VOID **) &mHashCtx);
244 EfiConvertPointer (0x0, (VOID **) &mSerializationRuntimeBuffer);
245 EfiConvertPointer (0x0, (VOID **) &mNvVariableCache);
246
247 //
248 // in the list of locked variables, convert the name pointers first
249 //
250 for ( Link = GetFirstNode (&mLockedVariableList)
251 ; !IsNull (&mLockedVariableList, Link)
252 ; Link = GetNextNode (&mLockedVariableList, Link)
253 ) {
254 Entry = BASE_CR (Link, VARIABLE_ENTRY, Link);
255 Status = EfiConvertPointer (0x0, (VOID **) &Entry->Name);
256 ASSERT_EFI_ERROR (Status);
257 }
258 //
259 // second, convert the list itself using UefiRuntimeLib
260 //
261 Status = EfiConvertList (0x0, &mLockedVariableList);
262 ASSERT_EFI_ERROR (Status);
263 }
264
265
266 /**
267 Notification function of EVT_GROUP_READY_TO_BOOT event group.
268
269 This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group.
270 When the Boot Manager is about to load and execute a boot option, it reclaims variable
271 storage if free size is below the threshold.
272
273 @param Event Event whose notification function is being invoked.
274 @param Context Pointer to the notification function's context.
275
276 **/
277 VOID
278 EFIAPI
279 OnReadyToBoot (
280 EFI_EVENT Event,
281 VOID *Context
282 )
283 {
284 //
285 // Set the End Of DXE bit in case the EFI_END_OF_DXE_EVENT_GROUP_GUID event is not signaled.
286 //
287 mEndOfDxe = TRUE;
288 ReclaimForOS ();
289 if (FeaturePcdGet (PcdVariableCollectStatistics)) {
290 gBS->InstallConfigurationTable (&gEfiAuthenticatedVariableGuid, gVariableInfo);
291 }
292 }
293
294 /**
295 Notification function of EFI_END_OF_DXE_EVENT_GROUP_GUID event group.
296
297 This is a notification function registered on EFI_END_OF_DXE_EVENT_GROUP_GUID event group.
298
299 @param Event Event whose notification function is being invoked.
300 @param Context Pointer to the notification function's context.
301
302 **/
303 VOID
304 EFIAPI
305 OnEndOfDxe (
306 EFI_EVENT Event,
307 VOID *Context
308 )
309 {
310 mEndOfDxe = TRUE;
311 }
312
313 /**
314 Fault Tolerant Write protocol notification event handler.
315
316 Non-Volatile variable write may needs FTW protocol to reclaim when
317 writting variable.
318
319 @param[in] Event Event whose notification function is being invoked.
320 @param[in] Context Pointer to the notification function's context.
321
322 **/
323 VOID
324 EFIAPI
325 FtwNotificationEvent (
326 IN EFI_EVENT Event,
327 IN VOID *Context
328 )
329 {
330 EFI_STATUS Status;
331 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbProtocol;
332 EFI_FAULT_TOLERANT_WRITE_PROTOCOL *FtwProtocol;
333 EFI_PHYSICAL_ADDRESS NvStorageVariableBase;
334 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor;
335 EFI_PHYSICAL_ADDRESS BaseAddress;
336 UINT64 Length;
337 EFI_PHYSICAL_ADDRESS VariableStoreBase;
338 UINT64 VariableStoreLength;
339 UINTN FtwMaxBlockSize;
340
341 //
342 // Ensure FTW protocol is installed.
343 //
344 Status = GetFtwProtocol ((VOID**) &FtwProtocol);
345 if (EFI_ERROR (Status)) {
346 return ;
347 }
348
349 Status = FtwProtocol->GetMaxBlockSize (FtwProtocol, &FtwMaxBlockSize);
350 if (!EFI_ERROR (Status)) {
351 ASSERT (PcdGet32 (PcdFlashNvStorageVariableSize) <= FtwMaxBlockSize);
352 }
353
354 //
355 // Find the proper FVB protocol for variable.
356 //
357 NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);
358 if (NvStorageVariableBase == 0) {
359 NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
360 }
361 Status = GetFvbInfoByAddress (NvStorageVariableBase, NULL, &FvbProtocol);
362 if (EFI_ERROR (Status)) {
363 return ;
364 }
365 mVariableModuleGlobal->FvbInstance = FvbProtocol;
366
367 //
368 // Mark the variable storage region of the FLASH as RUNTIME.
369 //
370 VariableStoreBase = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;
371 VariableStoreLength = ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase)->Size;
372 BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK);
373 Length = VariableStoreLength + (VariableStoreBase - BaseAddress);
374 Length = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK);
375
376 Status = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor);
377 if (EFI_ERROR (Status)) {
378 DEBUG ((DEBUG_WARN, "Variable driver failed to add EFI_MEMORY_RUNTIME attribute to Flash.\n"));
379 } else {
380 Status = gDS->SetMemorySpaceAttributes (
381 BaseAddress,
382 Length,
383 GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME
384 );
385 if (EFI_ERROR (Status)) {
386 DEBUG ((DEBUG_WARN, "Variable driver failed to add EFI_MEMORY_RUNTIME attribute to Flash.\n"));
387 }
388 }
389
390 Status = VariableWriteServiceInitialize ();
391 ASSERT_EFI_ERROR (Status);
392
393 //
394 // Install the Variable Write Architectural protocol.
395 //
396 Status = gBS->InstallProtocolInterface (
397 &mHandle,
398 &gEfiVariableWriteArchProtocolGuid,
399 EFI_NATIVE_INTERFACE,
400 NULL
401 );
402 ASSERT_EFI_ERROR (Status);
403
404 //
405 // Close the notify event to avoid install gEfiVariableWriteArchProtocolGuid again.
406 //
407 gBS->CloseEvent (Event);
408
409 }
410
411
412 /**
413 Variable Driver main entry point. The Variable driver places the 4 EFI
414 runtime services in the EFI System Table and installs arch protocols
415 for variable read and write services being available. It also registers
416 a notification function for an EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
417
418 @param[in] ImageHandle The firmware allocated handle for the EFI image.
419 @param[in] SystemTable A pointer to the EFI System Table.
420
421 @retval EFI_SUCCESS Variable service successfully initialized.
422
423 **/
424 EFI_STATUS
425 EFIAPI
426 VariableServiceInitialize (
427 IN EFI_HANDLE ImageHandle,
428 IN EFI_SYSTEM_TABLE *SystemTable
429 )
430 {
431 EFI_STATUS Status;
432 EFI_EVENT ReadyToBootEvent;
433 EFI_EVENT EndOfDxeEvent;
434
435 Status = VariableCommonInitialize ();
436 ASSERT_EFI_ERROR (Status);
437
438 Status = gBS->InstallMultipleProtocolInterfaces (
439 &mHandle,
440 &gEdkiiVariableLockProtocolGuid,
441 &mVariableLock,
442 NULL
443 );
444 ASSERT_EFI_ERROR (Status);
445
446 SystemTable->RuntimeServices->GetVariable = VariableServiceGetVariable;
447 SystemTable->RuntimeServices->GetNextVariableName = VariableServiceGetNextVariableName;
448 SystemTable->RuntimeServices->SetVariable = VariableServiceSetVariable;
449 SystemTable->RuntimeServices->QueryVariableInfo = VariableServiceQueryVariableInfo;
450
451 //
452 // Now install the Variable Runtime Architectural protocol on a new handle.
453 //
454 Status = gBS->InstallProtocolInterface (
455 &mHandle,
456 &gEfiVariableArchProtocolGuid,
457 EFI_NATIVE_INTERFACE,
458 NULL
459 );
460 ASSERT_EFI_ERROR (Status);
461
462 //
463 // Register FtwNotificationEvent () notify function.
464 //
465 EfiCreateProtocolNotifyEvent (
466 &gEfiFaultTolerantWriteProtocolGuid,
467 TPL_CALLBACK,
468 FtwNotificationEvent,
469 (VOID *)SystemTable,
470 &mFtwRegistration
471 );
472
473 Status = gBS->CreateEventEx (
474 EVT_NOTIFY_SIGNAL,
475 TPL_NOTIFY,
476 VariableClassAddressChangeEvent,
477 NULL,
478 &gEfiEventVirtualAddressChangeGuid,
479 &mVirtualAddressChangeEvent
480 );
481 ASSERT_EFI_ERROR (Status);
482
483 //
484 // Register the event handling function to reclaim variable for OS usage.
485 //
486 Status = EfiCreateEventReadyToBootEx (
487 TPL_NOTIFY,
488 OnReadyToBoot,
489 NULL,
490 &ReadyToBootEvent
491 );
492 ASSERT_EFI_ERROR (Status);
493
494 //
495 // Register the event handling function to set the End Of DXE flag.
496 //
497 Status = gBS->CreateEventEx (
498 EVT_NOTIFY_SIGNAL,
499 TPL_NOTIFY,
500 OnEndOfDxe,
501 NULL,
502 &gEfiEndOfDxeEventGroupGuid,
503 &EndOfDxeEvent
504 );
505 ASSERT_EFI_ERROR (Status);
506
507 return EFI_SUCCESS;
508 }
509