]>
Commit | Line | Data |
---|---|---|
9199cb9c LE |
1 | /** @file |
2 | ||
3 | Implement all four UEFI Runtime Variable services for the nonvolatile | |
4 | and volatile storage space and install variable architecture protocol. | |
5 | ||
6 | Copyright (C) 2013, Red Hat, Inc. | |
7 | Copyright (c) 2006 - 2013, 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 | |
12 | ||
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. | |
15 | ||
16 | **/ | |
17 | ||
18 | #include "Variable.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->VariableGlobal.HobVariableBase); | |
243 | EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal); | |
244 | EfiConvertPointer (0x0, (VOID **) &mNvVariableCache); | |
245 | ||
246 | // | |
247 | // in the list of locked variables, convert the name pointers first | |
248 | // | |
249 | for ( Link = GetFirstNode (&mLockedVariableList) | |
250 | ; !IsNull (&mLockedVariableList, Link) | |
251 | ; Link = GetNextNode (&mLockedVariableList, Link) | |
252 | ) { | |
253 | Entry = BASE_CR (Link, VARIABLE_ENTRY, Link); | |
254 | Status = EfiConvertPointer (0x0, (VOID **) &Entry->Name); | |
255 | ASSERT_EFI_ERROR (Status); | |
256 | } | |
257 | // | |
258 | // second, convert the list itself using UefiRuntimeLib | |
259 | // | |
260 | Status = EfiConvertList (0x0, &mLockedVariableList); | |
261 | ASSERT_EFI_ERROR (Status); | |
262 | } | |
263 | ||
264 | ||
265 | /** | |
266 | Notification function of EVT_GROUP_READY_TO_BOOT event group. | |
267 | ||
268 | This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group. | |
269 | When the Boot Manager is about to load and execute a boot option, it reclaims variable | |
270 | storage if free size is below the threshold. | |
271 | ||
272 | @param Event Event whose notification function is being invoked. | |
273 | @param Context Pointer to the notification function's context. | |
274 | ||
275 | **/ | |
276 | VOID | |
277 | EFIAPI | |
278 | OnReadyToBoot ( | |
279 | EFI_EVENT Event, | |
280 | VOID *Context | |
281 | ) | |
282 | { | |
283 | // | |
284 | // Set the End Of DXE bit in case the EFI_END_OF_DXE_EVENT_GROUP_GUID event is not signaled. | |
285 | // | |
286 | mEndOfDxe = TRUE; | |
287 | ReclaimForOS (); | |
288 | if (FeaturePcdGet (PcdVariableCollectStatistics)) { | |
289 | gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo); | |
290 | } | |
291 | } | |
292 | ||
293 | /** | |
294 | Notification function of EFI_END_OF_DXE_EVENT_GROUP_GUID event group. | |
295 | ||
296 | This is a notification function registered on EFI_END_OF_DXE_EVENT_GROUP_GUID event group. | |
297 | ||
298 | @param Event Event whose notification function is being invoked. | |
299 | @param Context Pointer to the notification function's context. | |
300 | ||
301 | **/ | |
302 | VOID | |
303 | EFIAPI | |
304 | OnEndOfDxe ( | |
305 | EFI_EVENT Event, | |
306 | VOID *Context | |
307 | ) | |
308 | { | |
309 | mEndOfDxe = TRUE; | |
310 | } | |
311 | ||
312 | /** | |
313 | Fault Tolerant Write protocol notification event handler. | |
314 | ||
315 | Non-Volatile variable write may needs FTW protocol to reclaim when | |
316 | writting variable. | |
317 | ||
318 | @param[in] Event Event whose notification function is being invoked. | |
319 | @param[in] Context Pointer to the notification function's context. | |
320 | ||
321 | **/ | |
322 | VOID | |
323 | EFIAPI | |
324 | FtwNotificationEvent ( | |
325 | IN EFI_EVENT Event, | |
326 | IN VOID *Context | |
327 | ) | |
328 | { | |
329 | EFI_STATUS Status; | |
330 | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbProtocol; | |
331 | EFI_FAULT_TOLERANT_WRITE_PROTOCOL *FtwProtocol; | |
332 | EFI_PHYSICAL_ADDRESS NvStorageVariableBase; | |
333 | EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor; | |
334 | EFI_PHYSICAL_ADDRESS BaseAddress; | |
335 | UINT64 Length; | |
336 | EFI_PHYSICAL_ADDRESS VariableStoreBase; | |
337 | UINT64 VariableStoreLength; | |
338 | ||
339 | // | |
340 | // Ensure FTW protocol is installed. | |
341 | // | |
342 | Status = GetFtwProtocol ((VOID**) &FtwProtocol); | |
343 | if (EFI_ERROR (Status)) { | |
344 | return ; | |
345 | } | |
346 | ||
347 | // | |
348 | // Find the proper FVB protocol for variable. | |
349 | // | |
350 | NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64); | |
351 | if (NvStorageVariableBase == 0) { | |
352 | NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase); | |
353 | } | |
354 | Status = GetFvbInfoByAddress (NvStorageVariableBase, NULL, &FvbProtocol); | |
355 | if (EFI_ERROR (Status)) { | |
356 | return ; | |
357 | } | |
358 | mVariableModuleGlobal->FvbInstance = FvbProtocol; | |
359 | ||
360 | // | |
361 | // Mark the variable storage region of the FLASH as RUNTIME. | |
362 | // | |
363 | VariableStoreBase = mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase; | |
364 | VariableStoreLength = ((VARIABLE_STORE_HEADER *)(UINTN)VariableStoreBase)->Size; | |
365 | BaseAddress = VariableStoreBase & (~EFI_PAGE_MASK); | |
366 | Length = VariableStoreLength + (VariableStoreBase - BaseAddress); | |
367 | Length = (Length + EFI_PAGE_SIZE - 1) & (~EFI_PAGE_MASK); | |
368 | ||
369 | Status = gDS->GetMemorySpaceDescriptor (BaseAddress, &GcdDescriptor); | |
370 | if (EFI_ERROR (Status)) { | |
371 | DEBUG ((DEBUG_WARN, "Variable driver failed to add EFI_MEMORY_RUNTIME attribute to Flash.\n")); | |
372 | } else { | |
373 | Status = gDS->SetMemorySpaceAttributes ( | |
374 | BaseAddress, | |
375 | Length, | |
376 | GcdDescriptor.Attributes | EFI_MEMORY_RUNTIME | |
377 | ); | |
378 | if (EFI_ERROR (Status)) { | |
379 | DEBUG ((DEBUG_WARN, "Variable driver failed to add EFI_MEMORY_RUNTIME attribute to Flash.\n")); | |
380 | } | |
381 | } | |
382 | ||
383 | Status = VariableWriteServiceInitialize (); | |
384 | ASSERT_EFI_ERROR (Status); | |
385 | ||
386 | // | |
387 | // Install the Variable Write Architectural protocol. | |
388 | // | |
389 | Status = gBS->InstallProtocolInterface ( | |
390 | &mHandle, | |
391 | &gEfiVariableWriteArchProtocolGuid, | |
392 | EFI_NATIVE_INTERFACE, | |
393 | NULL | |
394 | ); | |
395 | ASSERT_EFI_ERROR (Status); | |
396 | ||
397 | // | |
398 | // Close the notify event to avoid install gEfiVariableWriteArchProtocolGuid again. | |
399 | // | |
400 | gBS->CloseEvent (Event); | |
401 | ||
402 | } | |
403 | ||
404 | ||
405 | /** | |
406 | Variable Driver main entry point. The Variable driver places the 4 EFI | |
407 | runtime services in the EFI System Table and installs arch protocols | |
408 | for variable read and write services being availible. It also registers | |
409 | a notification function for an EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event. | |
410 | ||
411 | @param[in] ImageHandle The firmware allocated handle for the EFI image. | |
412 | @param[in] SystemTable A pointer to the EFI System Table. | |
413 | ||
414 | @retval EFI_SUCCESS Variable service successfully initialized. | |
415 | ||
416 | **/ | |
417 | EFI_STATUS | |
418 | EFIAPI | |
419 | VariableServiceInitialize ( | |
420 | IN EFI_HANDLE ImageHandle, | |
421 | IN EFI_SYSTEM_TABLE *SystemTable | |
422 | ) | |
423 | { | |
424 | EFI_STATUS Status; | |
425 | EFI_EVENT ReadyToBootEvent; | |
426 | EFI_EVENT EndOfDxeEvent; | |
427 | ||
428 | Status = VariableCommonInitialize (); | |
429 | ASSERT_EFI_ERROR (Status); | |
430 | ||
431 | Status = gBS->InstallMultipleProtocolInterfaces ( | |
432 | &mHandle, | |
433 | &gEdkiiVariableLockProtocolGuid, | |
434 | &mVariableLock, | |
435 | NULL | |
436 | ); | |
437 | ASSERT_EFI_ERROR (Status); | |
438 | ||
439 | SystemTable->RuntimeServices->GetVariable = VariableServiceGetVariable; | |
440 | SystemTable->RuntimeServices->GetNextVariableName = VariableServiceGetNextVariableName; | |
441 | SystemTable->RuntimeServices->SetVariable = VariableServiceSetVariable; | |
442 | SystemTable->RuntimeServices->QueryVariableInfo = VariableServiceQueryVariableInfo; | |
443 | ||
444 | // | |
445 | // Now install the Variable Runtime Architectural protocol on a new handle. | |
446 | // | |
447 | Status = gBS->InstallProtocolInterface ( | |
448 | &mHandle, | |
449 | &gEfiVariableArchProtocolGuid, | |
450 | EFI_NATIVE_INTERFACE, | |
451 | NULL | |
452 | ); | |
453 | ASSERT_EFI_ERROR (Status); | |
454 | ||
455 | // | |
456 | // Register FtwNotificationEvent () notify function. | |
457 | // | |
458 | EfiCreateProtocolNotifyEvent ( | |
459 | &gEfiFaultTolerantWriteProtocolGuid, | |
460 | TPL_CALLBACK, | |
461 | FtwNotificationEvent, | |
462 | (VOID *)SystemTable, | |
463 | &mFtwRegistration | |
464 | ); | |
465 | ||
466 | Status = gBS->CreateEventEx ( | |
467 | EVT_NOTIFY_SIGNAL, | |
468 | TPL_NOTIFY, | |
469 | VariableClassAddressChangeEvent, | |
470 | NULL, | |
471 | &gEfiEventVirtualAddressChangeGuid, | |
472 | &mVirtualAddressChangeEvent | |
473 | ); | |
474 | ASSERT_EFI_ERROR (Status); | |
475 | ||
476 | // | |
477 | // Register the event handling function to reclaim variable for OS usage. | |
478 | // | |
479 | Status = EfiCreateEventReadyToBootEx ( | |
480 | TPL_NOTIFY, | |
481 | OnReadyToBoot, | |
482 | NULL, | |
483 | &ReadyToBootEvent | |
484 | ); | |
485 | ASSERT_EFI_ERROR (Status); | |
486 | ||
487 | // | |
488 | // Register the event handling function to set the End Of DXE flag. | |
489 | // | |
490 | Status = gBS->CreateEventEx ( | |
491 | EVT_NOTIFY_SIGNAL, | |
492 | TPL_NOTIFY, | |
493 | OnEndOfDxe, | |
494 | NULL, | |
495 | &gEfiEndOfDxeEventGroupGuid, | |
496 | &EndOfDxeEvent | |
497 | ); | |
498 | ASSERT_EFI_ERROR (Status); | |
499 | ||
500 | return EFI_SUCCESS; | |
501 | } | |
502 |