3 Implement all four UEFI Runtime Variable services for the nonvolatile
4 and volatile storage space and install variable architecture protocol.
6 Copyright (C) 2013, Red Hat, Inc.
7 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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 LIST_ENTRY mVarCheckVariableList
;
27 extern UINT32 mNumberOfHandler
;
28 extern VAR_CHECK_SET_VARIABLE_CHECK_HANDLER
*mHandlerTable
;
29 extern BOOLEAN mEndOfDxe
;
30 EDKII_VARIABLE_LOCK_PROTOCOL mVariableLock
= { VariableLockRequestToLock
};
31 EDKII_VAR_CHECK_PROTOCOL mVarCheck
= { VarCheckRegisterSetVariableCheckHandler
,
32 VarCheckVariablePropertySet
,
33 VarCheckVariablePropertyGet
};
36 Return TRUE if ExitBootServices () has been called.
38 @retval TRUE If ExitBootServices () has been called.
45 return EfiAtRuntime ();
50 Initializes a basic mutual exclusion lock.
52 This function initializes a basic mutual exclusion lock to the released state
53 and returns the lock. Each lock provides mutual exclusion access at its task
54 priority level. Since there is no preemption or multiprocessor support in EFI,
55 acquiring the lock only consists of raising to the locks TPL.
56 If Lock is NULL, then ASSERT().
57 If Priority is not a valid TPL value, then ASSERT().
59 @param Lock A pointer to the lock data structure to initialize.
60 @param Priority EFI TPL is associated with the lock.
67 IN OUT EFI_LOCK
*Lock
,
71 return EfiInitializeLock (Lock
, Priority
);
76 Acquires lock only at boot time. Simply returns at runtime.
78 This is a temperary function that will be removed when
79 EfiAcquireLock() in UefiLib can handle the call in UEFI
80 Runtimer driver in RT phase.
81 It calls EfiAcquireLock() at boot time, and simply returns
84 @param Lock A pointer to the lock to acquire.
88 AcquireLockOnlyAtBootTime (
93 EfiAcquireLock (Lock
);
99 Releases lock only at boot time. Simply returns at runtime.
101 This is a temperary function which will be removed when
102 EfiReleaseLock() in UefiLib can handle the call in UEFI
103 Runtimer driver in RT phase.
104 It calls EfiReleaseLock() at boot time and simply returns
107 @param Lock A pointer to the lock to release.
111 ReleaseLockOnlyAtBootTime (
116 EfiReleaseLock (Lock
);
121 Retrive the Fault Tolerent Write protocol interface.
123 @param[out] FtwProtocol The interface of Ftw protocol
125 @retval EFI_SUCCESS The FTW protocol instance was found and returned in FtwProtocol.
126 @retval EFI_NOT_FOUND The FTW protocol instance was not found.
127 @retval EFI_INVALID_PARAMETER SarProtocol is NULL.
132 OUT VOID
**FtwProtocol
138 // Locate Fault Tolerent Write protocol
140 Status
= gBS
->LocateProtocol (
141 &gEfiFaultTolerantWriteProtocolGuid
,
149 Retrive the FVB protocol interface by HANDLE.
151 @param[in] FvBlockHandle The handle of FVB protocol that provides services for
152 reading, writing, and erasing the target block.
153 @param[out] FvBlock The interface of FVB protocol
155 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
156 @retval EFI_UNSUPPORTED The device does not support the FVB protocol.
157 @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.
162 IN EFI_HANDLE FvBlockHandle
,
163 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
**FvBlock
167 // To get the FVB protocol interface on the handle
169 return gBS
->HandleProtocol (
171 &gEfiFirmwareVolumeBlockProtocolGuid
,
178 Function returns an array of handles that support the FVB protocol
179 in a buffer allocated from pool.
181 @param[out] NumberHandles The number of handles returned in Buffer.
182 @param[out] Buffer A pointer to the buffer to return the requested
183 array of handles that support FVB protocol.
185 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
186 handles in Buffer was returned in NumberHandles.
187 @retval EFI_NOT_FOUND No FVB handle was found.
188 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
189 @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.
193 GetFvbCountAndBuffer (
194 OUT UINTN
*NumberHandles
,
195 OUT EFI_HANDLE
**Buffer
201 // Locate all handles of Fvb protocol
203 Status
= gBS
->LocateHandleBuffer (
205 &gEfiFirmwareVolumeBlockProtocolGuid
,
215 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
217 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
218 It convers pointer to new virtual address.
220 @param Event Event whose notification function is being invoked.
221 @param Context Pointer to the notification function's context.
226 VariableClassAddressChangeEvent (
234 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->GetBlockSize
);
235 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->GetPhysicalAddress
);
236 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->GetAttributes
);
237 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->SetAttributes
);
238 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->Read
);
239 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->Write
);
240 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
->EraseBlocks
);
241 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->FvbInstance
);
242 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->PlatformLangCodes
);
243 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->LangCodes
);
244 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->PlatformLang
);
245 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->VariableGlobal
.NonVolatileVariableBase
);
246 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->VariableGlobal
.VolatileVariableBase
);
247 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
->VariableGlobal
.HobVariableBase
);
248 EfiConvertPointer (0x0, (VOID
**) &mVariableModuleGlobal
);
249 EfiConvertPointer (0x0, (VOID
**) &mNvVariableCache
);
250 EfiConvertPointer (0x0, (VOID
**) &mHandlerTable
);
251 for (Index
= 0; Index
< mNumberOfHandler
; Index
++) {
252 EfiConvertPointer (0x0, (VOID
**) &mHandlerTable
[Index
]);
255 Status
= EfiConvertList (0x0, &mLockedVariableList
);
256 ASSERT_EFI_ERROR (Status
);
258 Status
= EfiConvertList (0x0, &mVarCheckVariableList
);
259 ASSERT_EFI_ERROR (Status
);
264 Notification function of EVT_GROUP_READY_TO_BOOT event group.
266 This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group.
267 When the Boot Manager is about to load and execute a boot option, it reclaims variable
268 storage if free size is below the threshold.
270 @param Event Event whose notification function is being invoked.
271 @param Context Pointer to the notification function's context.
282 // Set the End Of DXE bit in case the EFI_END_OF_DXE_EVENT_GROUP_GUID event is not signaled.
286 // The initialization for variable quota.
288 InitializeVariableQuota ();
290 if (FeaturePcdGet (PcdVariableCollectStatistics
)) {
291 gBS
->InstallConfigurationTable (&gEfiVariableGuid
, gVariableInfo
);
296 Notification function of EFI_END_OF_DXE_EVENT_GROUP_GUID event group.
298 This is a notification function registered on EFI_END_OF_DXE_EVENT_GROUP_GUID event group.
300 @param Event Event whose notification function is being invoked.
301 @param Context Pointer to the notification function's context.
313 // The initialization for variable quota.
315 InitializeVariableQuota ();
316 if (PcdGetBool (PcdReclaimVariableSpaceAtEndOfDxe
)) {
322 Fault Tolerant Write protocol notification event handler.
324 Non-Volatile variable write may needs FTW protocol to reclaim when
327 @param[in] Event Event whose notification function is being invoked.
328 @param[in] Context Pointer to the notification function's context.
333 FtwNotificationEvent (
339 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*FvbProtocol
;
340 EFI_FAULT_TOLERANT_WRITE_PROTOCOL
*FtwProtocol
;
341 EFI_PHYSICAL_ADDRESS NvStorageVariableBase
;
342 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor
;
343 EFI_PHYSICAL_ADDRESS BaseAddress
;
345 EFI_PHYSICAL_ADDRESS VariableStoreBase
;
346 UINT64 VariableStoreLength
;
347 UINTN FtwMaxBlockSize
;
350 // Ensure FTW protocol is installed.
352 Status
= GetFtwProtocol ((VOID
**) &FtwProtocol
);
353 if (EFI_ERROR (Status
)) {
357 Status
= FtwProtocol
->GetMaxBlockSize (FtwProtocol
, &FtwMaxBlockSize
);
358 if (!EFI_ERROR (Status
)) {
359 ASSERT (PcdGet32 (PcdFlashNvStorageVariableSize
) <= FtwMaxBlockSize
);
363 // Find the proper FVB protocol for variable.
365 NvStorageVariableBase
= (EFI_PHYSICAL_ADDRESS
) PcdGet64 (PcdFlashNvStorageVariableBase64
);
366 if (NvStorageVariableBase
== 0) {
367 NvStorageVariableBase
= (EFI_PHYSICAL_ADDRESS
) PcdGet32 (PcdFlashNvStorageVariableBase
);
369 Status
= GetFvbInfoByAddress (NvStorageVariableBase
, NULL
, &FvbProtocol
);
370 if (EFI_ERROR (Status
)) {
373 mVariableModuleGlobal
->FvbInstance
= FvbProtocol
;
376 // Mark the variable storage region of the FLASH as RUNTIME.
378 VariableStoreBase
= NvStorageVariableBase
+ (((EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)(NvStorageVariableBase
))->HeaderLength
);
379 VariableStoreLength
= ((VARIABLE_STORE_HEADER
*)(UINTN
)VariableStoreBase
)->Size
;
380 BaseAddress
= VariableStoreBase
& (~EFI_PAGE_MASK
);
381 Length
= VariableStoreLength
+ (VariableStoreBase
- BaseAddress
);
382 Length
= (Length
+ EFI_PAGE_SIZE
- 1) & (~EFI_PAGE_MASK
);
384 Status
= gDS
->GetMemorySpaceDescriptor (BaseAddress
, &GcdDescriptor
);
385 if (EFI_ERROR (Status
)) {
386 DEBUG ((DEBUG_WARN
, "Variable driver failed to get flash memory attribute.\n"));
388 Status
= gDS
->SetMemorySpaceAttributes (
391 GcdDescriptor
.Attributes
| EFI_MEMORY_RUNTIME
393 if (EFI_ERROR (Status
)) {
394 DEBUG ((DEBUG_WARN
, "Variable driver failed to add EFI_MEMORY_RUNTIME attribute to Flash.\n"));
398 Status
= VariableWriteServiceInitialize ();
399 ASSERT_EFI_ERROR (Status
);
402 // Install the Variable Write Architectural protocol.
404 Status
= gBS
->InstallProtocolInterface (
406 &gEfiVariableWriteArchProtocolGuid
,
407 EFI_NATIVE_INTERFACE
,
410 ASSERT_EFI_ERROR (Status
);
413 // Close the notify event to avoid install gEfiVariableWriteArchProtocolGuid again.
415 gBS
->CloseEvent (Event
);
421 Variable Driver main entry point. The Variable driver places the 4 EFI
422 runtime services in the EFI System Table and installs arch protocols
423 for variable read and write services being availible. It also registers
424 a notification function for an EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
426 @param[in] ImageHandle The firmware allocated handle for the EFI image.
427 @param[in] SystemTable A pointer to the EFI System Table.
429 @retval EFI_SUCCESS Variable service successfully initialized.
434 VariableServiceInitialize (
435 IN EFI_HANDLE ImageHandle
,
436 IN EFI_SYSTEM_TABLE
*SystemTable
440 EFI_EVENT ReadyToBootEvent
;
441 EFI_EVENT EndOfDxeEvent
;
443 Status
= VariableCommonInitialize ();
444 ASSERT_EFI_ERROR (Status
);
446 Status
= gBS
->InstallMultipleProtocolInterfaces (
448 &gEdkiiVariableLockProtocolGuid
,
452 ASSERT_EFI_ERROR (Status
);
454 Status
= gBS
->InstallMultipleProtocolInterfaces (
456 &gEdkiiVarCheckProtocolGuid
,
460 ASSERT_EFI_ERROR (Status
);
462 SystemTable
->RuntimeServices
->GetVariable
= VariableServiceGetVariable
;
463 SystemTable
->RuntimeServices
->GetNextVariableName
= VariableServiceGetNextVariableName
;
464 SystemTable
->RuntimeServices
->SetVariable
= VariableServiceSetVariable
;
465 SystemTable
->RuntimeServices
->QueryVariableInfo
= VariableServiceQueryVariableInfo
;
468 // Now install the Variable Runtime Architectural protocol on a new handle.
470 Status
= gBS
->InstallProtocolInterface (
472 &gEfiVariableArchProtocolGuid
,
473 EFI_NATIVE_INTERFACE
,
476 ASSERT_EFI_ERROR (Status
);
479 // Register FtwNotificationEvent () notify function.
481 EfiCreateProtocolNotifyEvent (
482 &gEfiFaultTolerantWriteProtocolGuid
,
484 FtwNotificationEvent
,
489 Status
= gBS
->CreateEventEx (
492 VariableClassAddressChangeEvent
,
494 &gEfiEventVirtualAddressChangeGuid
,
495 &mVirtualAddressChangeEvent
497 ASSERT_EFI_ERROR (Status
);
500 // Register the event handling function to reclaim variable for OS usage.
502 Status
= EfiCreateEventReadyToBootEx (
508 ASSERT_EFI_ERROR (Status
);
511 // Register the event handling function to set the End Of DXE flag.
513 Status
= gBS
->CreateEventEx (
518 &gEfiEndOfDxeEventGroupGuid
,
521 ASSERT_EFI_ERROR (Status
);