2 UEFI Runtime Library implementation for non IPF processor types.
4 This library hides the global variable for the EFI Runtime Services so the
5 caller does not need to deal with the possiblitly of being called from an
6 OS virtual address space. All pointer values are different for a virtual
7 mapping than from the normal physical mapping at boot services time.
9 Copyright (c) 2006 - 2007, Intel Corporation.<BR>
10 All rights reserved. This program and the accompanying materials
11 are licensed and made available under the terms and conditions of the BSD License
12 which accompanies this distribution. The full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #include <RuntimeLibInternal.h>
26 Resets the entire platform.
28 @param ResetType The type of reset to perform.
29 @param ResetStatus The status code for reset.
30 @param DataSize The size in bytes of reset data.
31 @param ResetData Pointer to data buffer that includes
32 Null-Terminated Unicode string.
38 IN EFI_RESET_TYPE ResetType
,
39 IN EFI_STATUS ResetStatus
,
44 mRT
->ResetSystem (ResetType
, ResetStatus
, DataSize
, ResetData
);
49 Return current time and date information, and time-keeping
50 capabilities of hardware platform.
52 @param Time A pointer to storage to receive a snapshot of the current time.
53 @param Capabilities An optional pointer to a buffer to receive the real time clock device's
56 @retval EFI_SUCCESS Success to execute the function.
57 @retval !EFI_SUCCESS Failed to e3xecute the function.
64 OUT EFI_TIME_CAPABILITIES
*Capabilities
67 return mRT
->GetTime (Time
, Capabilities
);
72 Set current time and date information.
74 @param Time A pointer to cache of time setting.
76 @retval EFI_SUCCESS Success to execute the function.
77 @retval !EFI_SUCCESS Failed to execute the function.
86 return mRT
->SetTime (Time
);
91 Return current wakeup alarm clock setting.
93 @param Enabled Indicate if the alarm clock is enabled or disabled.
94 @param Pending Indicate if the alarm signal is pending and requires acknowledgement.
95 @param Time Current alarm clock setting.
97 @retval EFI_SUCCESS Success to execute the function.
98 @retval !EFI_SUCCESS Failed to e3xecute the function.
104 OUT BOOLEAN
*Enabled
,
105 OUT BOOLEAN
*Pending
,
109 return mRT
->GetWakeupTime (Enabled
, Pending
, Time
);
115 Set current wakeup alarm clock.
117 @param Enable Enable or disable current alarm clock..
118 @param Time Point to alarm clock setting.
120 @retval EFI_SUCCESS Success to execute the function.
121 @retval !EFI_SUCCESS Failed to e3xecute the function.
131 return mRT
->SetWakeupTime (Enable
, Time
);
136 Return value of variable.
138 @param VariableName the name of the vendor's variable, it's a
139 Null-Terminated Unicode String
140 @param VendorGuid Unify identifier for vendor.
141 @param Attributes Point to memory location to return the attributes of variable. If the point
142 is NULL, the parameter would be ignored.
143 @param DataSize As input, point to the maxinum size of return Data-Buffer.
144 As output, point to the actual size of the returned Data-Buffer.
145 @param Data Point to return Data-Buffer.
147 @retval EFI_SUCCESS Success to execute the function.
148 @retval !EFI_SUCCESS Failed to e3xecute the function.
154 IN CHAR16
*VariableName
,
155 IN EFI_GUID
* VendorGuid
,
156 OUT UINT32
*Attributes OPTIONAL
,
157 IN OUT UINTN
*DataSize
,
161 return mRT
->GetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
166 Enumerates variable's name.
168 @param VariableNameSize As input, point to maxinum size of variable name.
169 As output, point to actual size of varaible name.
170 @param VariableName As input, supplies the last VariableName that was returned by
171 GetNextVariableName().
172 As output, returns the name of variable. The name
173 string is Null-Terminated Unicode string.
174 @param VendorGuid As input, supplies the last VendorGuid that was returned by
175 GetNextVriableName().
176 As output, returns the VendorGuid of the current variable.
178 @retval EFI_SUCCESS Success to execute the function.
179 @retval !EFI_SUCCESS Failed to e3xecute the function.
184 EfiGetNextVariableName (
185 IN OUT UINTN
*VariableNameSize
,
186 IN OUT CHAR16
*VariableName
,
187 IN OUT EFI_GUID
*VendorGuid
190 return mRT
->GetNextVariableName (VariableNameSize
, VariableName
, VendorGuid
);
195 Sets value of variable.
197 @param VariableName the name of the vendor's variable, it's a
198 Null-Terminated Unicode String
199 @param VendorGuid Unify identifier for vendor.
200 @param Attributes Point to memory location to return the attributes of variable. If the point
201 is NULL, the parameter would be ignored.
202 @param DataSize The size in bytes of Data-Buffer.
203 @param Data Point to the content of the variable.
205 @retval EFI_SUCCESS Success to execute the function.
206 @retval !EFI_SUCCESS Failed to e3xecute the function.
212 IN CHAR16
*VariableName
,
213 IN EFI_GUID
*VendorGuid
,
214 IN UINT32 Attributes
,
219 return mRT
->SetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
224 Returns the next high 32 bits of platform's monotonic counter.
226 @param HighCount Pointer to returned value.
228 @retval EFI_SUCCESS Success to execute the function.
229 @retval !EFI_SUCCESS Failed to e3xecute the function.
234 EfiGetNextHighMonotonicCount (
235 OUT UINT32
*HighCount
238 return mRT
->GetNextHighMonotonicCount (HighCount
);
243 Determines the new virtual address that is to be used on subsequent memory accesses.
245 @param DebugDisposition Supplies type information for the pointer being converted.
246 @param Address The pointer to a pointer that is to be fixed to be the
247 value needed for the new virtual address mapping being
250 @retval EFI_SUCCESS Success to execute the function.
251 @retval !EFI_SUCCESS Failed to e3xecute the function.
257 IN UINTN DebugDisposition
,
258 IN OUT VOID
**Address
261 return mRT
->ConvertPointer (DebugDisposition
, Address
);
266 Conver the standard Lib double linked list to a virtual mapping.
268 @param DebugDisposition Supplies type information for the pointer being converted.
269 @param ListHead Head of linked list to convert.
271 @retval EFI_SUCCESS Success to execute the function.
272 @retval !EFI_SUCCESS Failed to e3xecute the function.
278 IN UINTN DebugDisposition
,
279 IN OUT LIST_ENTRY
*ListHead
283 LIST_ENTRY
*NextLink
;
286 // Convert all the ForwardLink & BackLink pointers in the list
290 NextLink
= Link
->ForwardLink
;
293 Link
->ForwardLink
== ListHead
? DebugDisposition
: 0,
294 (VOID
**) &Link
->ForwardLink
298 Link
->BackLink
== ListHead
? DebugDisposition
: 0,
299 (VOID
**) &Link
->BackLink
303 } while (Link
!= ListHead
);
309 Change the runtime addressing mode of EFI firmware from physical to virtual.
311 @param MemoryMapSize The size in bytes of VirtualMap.
312 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
313 @param DescriptorVersion The version of the structure entries in VirtualMap.
314 @param VirtualMap An array of memory descriptors which contain new virtual
315 address mapping information for all runtime ranges. Type
316 EFI_MEMORY_DESCRIPTOR is defined in the
317 GetMemoryMap() function description.
319 @retval EFI_SUCCESS The virtual address map has been applied.
320 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
321 virtual address mapped mode.
322 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
324 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
325 map that requires a mapping.
326 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
331 EfiSetVirtualAddressMap (
332 IN UINTN MemoryMapSize
,
333 IN UINTN DescriptorSize
,
334 IN UINT32 DescriptorVersion
,
335 IN CONST EFI_MEMORY_DESCRIPTOR
*VirtualMap
338 return mRT
->SetVirtualAddressMap (
342 (EFI_MEMORY_DESCRIPTOR
*) VirtualMap
348 Passes capsules to the firmware with both virtual and physical mapping.
349 Depending on the intended consumption, the firmware may
350 process the capsule immediately. If the payload should persist across a
351 system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
352 be passed into ResetSystem() and will cause the capsule to be processed by
353 the firmware as part of the reset process.
355 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
356 being passed into update capsule. Each capsules is assumed to
357 stored in contiguous virtual memory. The capsules in the
358 CapsuleHeaderArray must be the same capsules as the
359 ScatterGatherList. The CapsuleHeaderArray must
360 have the capsules in the same order as the ScatterGatherList.
361 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
363 @param ScatterGatherList Physical pointer to a set of
364 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
365 location in physical memory of a set of capsules. See Related
366 Definitions for an explanation of how more than one capsule is
367 passed via this interface. The capsules in the
368 ScatterGatherList must be in the same order as the
369 CapsuleHeaderArray. This parameter is only referenced if
370 the capsules are defined to persist across system reset.
372 @retval EFI_SUCCESS Valid capsule was passed. I Valid capsule was passed. If
373 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
374 capsule has been successfully processed by the firmware.
375 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL or ResetTye is NULL.
376 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
382 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
383 IN UINTN CapsuleCount
,
384 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
387 return mRT
->UpdateCapsule (
396 The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
397 capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
398 size of the entire capsule is checked.
399 If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
400 constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
401 (EFI_CAPSULE_HEADER). To determine reset requirements,
402 CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
404 The firmware must support any capsule that has the
405 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
406 firmware sets the policy for what capsules are supported that do not have the
407 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
409 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
410 being passed into update capsule. The capsules are assumed to
411 stored in contiguous virtual memory.
412 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
414 @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
415 support as an argument to UpdateCapsule() via
416 CapsuleHeaderArray and ScatterGatherList.
418 @param ResetType Returns the type of reset required for the capsule update.
420 @retval EFI_SUCCESS Valid answer returned..
421 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
422 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
423 MaximumCapsuleSize and ResetType are undefined.
428 EfiQueryCapsuleCapabilities (
429 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
430 IN UINTN CapsuleCount
,
431 OUT UINT64
*MaximumCapsuleSize
,
432 OUT EFI_RESET_TYPE
*ResetType
435 return mRT
->QueryCapsuleCapabilities (
445 The QueryVariableInfo() function allows a caller to obtain the information about the
446 maximum size of the storage space available for the EFI variables, the remaining size of the storage
447 space available for the EFI variables and the maximum size of each individual EFI variable,
448 associated with the attributes specified.
449 The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
450 MaximumVariableSize information may change immediately after the call based on other
451 runtime activities including asynchronous error events. Also, these values associated with different
452 attributes are not additive in nature.
454 @param Attributes Attributes bitmask to specify the type of variables on
455 which to return information. Refer to the
456 GetVariable() function description.
457 @param MaximumVariableStorageSize
458 On output the maximum size of the storage space
459 available for the EFI variables associated with the
460 attributes specified.
461 @param RemainingVariableStorageSize
462 Returns the remaining size of the storage space
463 available for the EFI variables associated with the
464 attributes specified..
465 @param MaximumVariableSize Returns the maximum size of the individual EFI
466 variables associated with the attributes specified.
468 @retval EFI_SUCCESS Valid answer returned.
469 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
470 @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
471 MaximumVariableStorageSize,
472 RemainingVariableStorageSize, MaximumVariableSize
477 EfiQueryVariableInfo (
478 IN UINT32 Attributes
,
479 OUT UINT64
*MaximumVariableStorageSize
,
480 OUT UINT64
*RemainingVariableStorageSize
,
481 OUT UINT64
*MaximumVariableSize
484 return mRT
->QueryVariableInfo (
486 MaximumVariableStorageSize
,
487 RemainingVariableStorageSize
,