70723b320fd9d8af0e68a7a7bb6db7fe2ab32e1d
[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / VariableDxe.c
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) 2006 - 2010, 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
19 extern VARIABLE_STORE_HEADER *mNvVariableCache;
20 VARIABLE_INFO_ENTRY *gVariableInfo;
21 EFI_HANDLE mHandle = NULL;
22 EFI_EVENT mVirtualAddressChangeEvent = NULL;
23 EFI_EVENT mFtwRegistration = NULL;
24
25 /**
26 Return TRUE if ExitBootServices () has been called.
27
28 @retval TRUE If ExitBootServices () has been called.
29 **/
30 BOOLEAN
31 AtRuntime (
32 VOID
33 )
34 {
35 return EfiAtRuntime ();
36 }
37
38
39 /**
40 Initializes a basic mutual exclusion lock.
41
42 This function initializes a basic mutual exclusion lock to the released state
43 and returns the lock. Each lock provides mutual exclusion access at its task
44 priority level. Since there is no preemption or multiprocessor support in EFI,
45 acquiring the lock only consists of raising to the locks TPL.
46 If Lock is NULL, then ASSERT().
47 If Priority is not a valid TPL value, then ASSERT().
48
49 @param Lock A pointer to the lock data structure to initialize.
50 @param Priority EFI TPL is associated with the lock.
51
52 @return The lock.
53
54 **/
55 EFI_LOCK *
56 InitializeLock (
57 IN OUT EFI_LOCK *Lock,
58 IN EFI_TPL Priority
59 )
60 {
61 return EfiInitializeLock (Lock, Priority);
62 }
63
64
65 /**
66 Acquires lock only at boot time. Simply returns at runtime.
67
68 This is a temperary function that will be removed when
69 EfiAcquireLock() in UefiLib can handle the call in UEFI
70 Runtimer driver in RT phase.
71 It calls EfiAcquireLock() at boot time, and simply returns
72 at runtime.
73
74 @param Lock A pointer to the lock to acquire.
75
76 **/
77 VOID
78 AcquireLockOnlyAtBootTime (
79 IN EFI_LOCK *Lock
80 )
81 {
82 if (!AtRuntime ()) {
83 EfiAcquireLock (Lock);
84 }
85 }
86
87
88 /**
89 Releases lock only at boot time. Simply returns at runtime.
90
91 This is a temperary function which will be removed when
92 EfiReleaseLock() in UefiLib can handle the call in UEFI
93 Runtimer driver in RT phase.
94 It calls EfiReleaseLock() at boot time and simply returns
95 at runtime.
96
97 @param Lock A pointer to the lock to release.
98
99 **/
100 VOID
101 ReleaseLockOnlyAtBootTime (
102 IN EFI_LOCK *Lock
103 )
104 {
105 if (!AtRuntime ()) {
106 EfiReleaseLock (Lock);
107 }
108 }
109
110 /**
111 Retrive the Fault Tolerent Write protocol interface.
112
113 @param[out] FtwProtocol The interface of Ftw protocol
114
115 @retval EFI_SUCCESS The FTW protocol instance was found and returned in FtwProtocol.
116 @retval EFI_NOT_FOUND The FTW protocol instance was not found.
117 @retval EFI_INVALID_PARAMETER SarProtocol is NULL.
118
119 **/
120 EFI_STATUS
121 GetFtwProtocol (
122 OUT VOID **FtwProtocol
123 )
124 {
125 EFI_STATUS Status;
126
127 //
128 // Locate Fault Tolerent Write protocol
129 //
130 Status = gBS->LocateProtocol (
131 &gEfiFaultTolerantWriteProtocolGuid,
132 NULL,
133 FtwProtocol
134 );
135 return Status;
136 }
137
138 /**
139 Retrive the FVB protocol interface by HANDLE.
140
141 @param[in] FvBlockHandle The handle of FVB protocol that provides services for
142 reading, writing, and erasing the target block.
143 @param[out] FvBlock The interface of FVB protocol
144
145 @retval EFI_SUCCESS The interface information for the specified protocol was returned.
146 @retval EFI_UNSUPPORTED The device does not support the FVB protocol.
147 @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.
148
149 **/
150 EFI_STATUS
151 GetFvbByHandle (
152 IN EFI_HANDLE FvBlockHandle,
153 OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock
154 )
155 {
156 //
157 // To get the FVB protocol interface on the handle
158 //
159 return gBS->HandleProtocol (
160 FvBlockHandle,
161 &gEfiFirmwareVolumeBlockProtocolGuid,
162 (VOID **) FvBlock
163 );
164 }
165
166
167 /**
168 Function returns an array of handles that support the FVB protocol
169 in a buffer allocated from pool.
170
171 @param[out] NumberHandles The number of handles returned in Buffer.
172 @param[out] Buffer A pointer to the buffer to return the requested
173 array of handles that support FVB protocol.
174
175 @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
176 handles in Buffer was returned in NumberHandles.
177 @retval EFI_NOT_FOUND No FVB handle was found.
178 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
179 @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.
180
181 **/
182 EFI_STATUS
183 GetFvbCountAndBuffer (
184 OUT UINTN *NumberHandles,
185 OUT EFI_HANDLE **Buffer
186 )
187 {
188 EFI_STATUS Status;
189
190 //
191 // Locate all handles of Fvb protocol
192 //
193 Status = gBS->LocateHandleBuffer (
194 ByProtocol,
195 &gEfiFirmwareVolumeBlockProtocolGuid,
196 NULL,
197 NumberHandles,
198 Buffer
199 );
200 return Status;
201 }
202
203
204 /**
205 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
206
207 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
208 It convers pointer to new virtual address.
209
210 @param Event Event whose notification function is being invoked.
211 @param Context Pointer to the notification function's context.
212
213 **/
214 VOID
215 EFIAPI
216 VariableClassAddressChangeEvent (
217 IN EFI_EVENT Event,
218 IN VOID *Context
219 )
220 {
221 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetBlockSize);
222 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetPhysicalAddress);
223 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetAttributes);
224 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->SetAttributes);
225 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Read);
226 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->Write);
227 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->EraseBlocks);
228 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance);
229 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLangCodes);
230 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->LangCodes);
231 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->PlatformLang);
232 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);
233 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);
234 EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);
235 EfiConvertPointer (0x0, (VOID **) &mNvVariableCache);
236 }
237
238
239 /**
240 Notification function of EVT_GROUP_READY_TO_BOOT event group.
241
242 This is a notification function registered on EVT_GROUP_READY_TO_BOOT event group.
243 When the Boot Manager is about to load and execute a boot option, it reclaims variable
244 storage if free size is below the threshold.
245
246 @param Event Event whose notification function is being invoked.
247 @param Context Pointer to the notification function's context.
248
249 **/
250 VOID
251 EFIAPI
252 OnReadyToBoot (
253 EFI_EVENT Event,
254 VOID *Context
255 )
256 {
257 ReclaimForOS ();
258 }
259
260
261 /**
262 Fault Tolerant Write protocol notification event handler.
263
264 Non-Volatile variable write may needs FTW protocol to reclaim when
265 writting variable.
266
267 @param[in] Event Event whose notification function is being invoked.
268 @param[in] Context Pointer to the notification function's context.
269
270 **/
271 VOID
272 EFIAPI
273 FtwNotificationEvent (
274 IN EFI_EVENT Event,
275 IN VOID *Context
276 )
277 {
278 EFI_STATUS Status;
279 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbProtocol;
280 EFI_FAULT_TOLERANT_WRITE_PROTOCOL *FtwProtocol;
281 EFI_PHYSICAL_ADDRESS NvStorageVariableBase;
282
283 //
284 // Ensure FTW protocol is installed.
285 //
286 Status = GetFtwProtocol ((VOID**) &FtwProtocol);
287 if (EFI_ERROR (Status)) {
288 return ;
289 }
290
291 //
292 // Find the proper FVB protocol for variable.
293 //
294 NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageVariableBase64);
295 if (NvStorageVariableBase == 0) {
296 NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageVariableBase);
297 }
298 Status = GetFvbInfoByAddress (NvStorageVariableBase, NULL, &FvbProtocol);
299 if (EFI_ERROR (Status)) {
300 return ;
301 }
302 mVariableModuleGlobal->FvbInstance = FvbProtocol;
303
304 Status = VariableWriteServiceInitialize ();
305 ASSERT_EFI_ERROR (Status);
306
307 //
308 // Install the Variable Write Architectural protocol.
309 //
310 Status = gBS->InstallProtocolInterface (
311 &mHandle,
312 &gEfiVariableWriteArchProtocolGuid,
313 EFI_NATIVE_INTERFACE,
314 NULL
315 );
316 ASSERT_EFI_ERROR (Status);
317
318 //
319 // Close the notify event to avoid install gEfiVariableWriteArchProtocolGuid again.
320 //
321 gBS->CloseEvent (Event);
322
323 }
324
325
326 /**
327 Variable Driver main entry point. The Variable driver places the 4 EFI
328 runtime services in the EFI System Table and installs arch protocols
329 for variable read and write services being availible. It also registers
330 a notification function for an EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
331
332 @param[in] ImageHandle The firmware allocated handle for the EFI image.
333 @param[in] SystemTable A pointer to the EFI System Table.
334
335 @retval EFI_SUCCESS Variable service successfully initialized.
336
337 **/
338 EFI_STATUS
339 EFIAPI
340 VariableServiceInitialize (
341 IN EFI_HANDLE ImageHandle,
342 IN EFI_SYSTEM_TABLE *SystemTable
343 )
344 {
345 EFI_STATUS Status;
346 EFI_EVENT ReadyToBootEvent;
347
348 Status = VariableCommonInitialize ();
349 ASSERT_EFI_ERROR (Status);
350
351 SystemTable->RuntimeServices->GetVariable = VariableServiceGetVariable;
352 SystemTable->RuntimeServices->GetNextVariableName = VariableServiceGetNextVariableName;
353 SystemTable->RuntimeServices->SetVariable = VariableServiceSetVariable;
354 SystemTable->RuntimeServices->QueryVariableInfo = VariableServiceQueryVariableInfo;
355
356 //
357 // Now install the Variable Runtime Architectural protocol on a new handle.
358 //
359 Status = gBS->InstallProtocolInterface (
360 &mHandle,
361 &gEfiVariableArchProtocolGuid,
362 EFI_NATIVE_INTERFACE,
363 NULL
364 );
365 ASSERT_EFI_ERROR (Status);
366
367 //
368 // Register FtwNotificationEvent () notify function.
369 //
370 EfiCreateProtocolNotifyEvent (
371 &gEfiFaultTolerantWriteProtocolGuid,
372 TPL_CALLBACK,
373 FtwNotificationEvent,
374 (VOID *)SystemTable,
375 &mFtwRegistration
376 );
377
378 Status = gBS->CreateEventEx (
379 EVT_NOTIFY_SIGNAL,
380 TPL_NOTIFY,
381 VariableClassAddressChangeEvent,
382 NULL,
383 &gEfiEventVirtualAddressChangeGuid,
384 &mVirtualAddressChangeEvent
385 );
386 ASSERT_EFI_ERROR (Status);
387
388 //
389 // Register the event handling function to reclaim variable for OS usage.
390 //
391 Status = EfiCreateEventReadyToBootEx (
392 TPL_NOTIFY,
393 OnReadyToBoot,
394 NULL,
395 &ReadyToBootEvent
396 );
397
398 if (FeaturePcdGet (PcdVariableCollectStatistics)) {
399 gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo);
400 }
401 return EFI_SUCCESS;
402 }
403