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 - 2008, 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.
20 #include "RuntimeLibInternal.h"
24 Resets the entire platform.
26 @param ResetType The type of reset to perform.
27 @param ResetStatus The status code for the reset. If the system reset is part of a
28 normal operation, the status code would be EFI_SUCCESS. If the system
29 reset is due to some type of failure the most appropriate EFI Status
31 @param DataSizeThe size, in bytes, of ResetData.
32 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
33 the data buffer starts with a Null-terminated Unicode string, optionally
34 followed by additional binary data. The string is a description that the
35 caller may use to further indicate the reason for the system reset. ResetData
36 is only valid if ResetStatus is something other then EFI_SUCCESS. This
37 pointer must be a physical address. For a ResetType of EfiRestUpdate the
38 data buffer also starts with a Null-terminated string that is followed by
39 a physical VOID * to an EFI_CAPSULE_HEADER.
45 IN EFI_RESET_TYPE ResetType
,
46 IN EFI_STATUS ResetStatus
,
51 mRT
->ResetSystem (ResetType
, ResetStatus
, DataSize
, ResetData
);
56 This service is a wrapper for the UEFI Runtime Service GetTime().
58 The GetTime() function returns a time that was valid sometime during the call to the function.
59 While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,
60 the actual clock does not maintain these values. The current time zone and daylight saving time
61 information returned by GetTime() are the values that were last set via SetTime().
62 The GetTime() function should take approximately the same amount of time to read the time each
63 time it is called. All reported device capabilities are to be rounded up.
64 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
65 access to the device before calling GetTime().
67 @param Time A pointer to storage to receive a snapshot of the current time.
68 @param Capabilities An optional pointer to a buffer to receive the real time clock device's
71 @retval EFI_SUCCESS The operation completed successfully.
72 @retval EFI_INVALID_PARAMETER Time is NULL.
73 @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.
80 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
83 return mRT
->GetTime (Time
, Capabilities
);
88 This service is a wrapper for the UEFI Runtime Service SetTime().
90 The SetTime() function sets the real time clock device to the supplied time, and records the
91 current time zone and daylight savings time information. The SetTime() function is not allowed
92 to loop based on the current time. For example, if the device does not support a hardware reset
93 for the sub-resolution time, the code is not to implement the feature by waiting for the time to
95 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
96 access to the device before calling SetTime().
98 @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
99 function description. Full error checking is performed on the different
100 fields of the EFI_TIME structure (refer to the EFI_TIME definition in the
101 GetTime() function description for full details), and EFI_INVALID_PARAMETER
102 is returned if any field is out of range.
104 @retval EFI_SUCCESS The operation completed successfully.
105 @retval EFI_INVALID_PARAMETER A time field is out of range.
106 @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.
115 return mRT
->SetTime (Time
);
120 Returns the current wakeup alarm clock setting.
122 The alarm clock time may be rounded from the set alarm clock time to be within the resolution
123 of the alarm clock device. The resolution of the alarm clock device is defined to be one second.
124 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
125 access to the device before calling GetWakeupTime().
127 @param Enabled Indicates if the alarm is currently enabled or disabled.
128 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
129 @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()
130 function description.
132 @retval EFI_SUCCESS The alarm settings were returned.
133 @retval EFI_INVALID_PARAMETER Enabled is NULL.
134 @retval EFI_INVALID_PARAMETER Pending is NULL.
135 @retval EFI_INVALID_PARAMETER Time is NULL.
136 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
137 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
143 OUT BOOLEAN
*Enabled
,
144 OUT BOOLEAN
*Pending
,
148 return mRT
->GetWakeupTime (Enabled
, Pending
, Time
);
154 Sets the system wakeup alarm clock time.
156 @param Enable Enable or disable the wakeup alarm.
157 @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME
158 is defined in the GetTime() function description. If Enable is FALSE,
159 then this parameter is optional, and may be NULL.
161 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
162 If Enable is FALSE, then the wakeup alarm was disabled.
163 @retval EFI_INVALID_PARAMETER A time field is out of range.
164 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
165 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
172 IN EFI_TIME
*Time OPTIONAL
175 return mRT
->SetWakeupTime (Enable
, Time
);
180 Return value of variable.
182 @param VariableName the name of the vendor's variable, it's a
183 Null-Terminated Unicode String
184 @param VendorGuid Unify identifier for vendor.
185 @param Attributes Point to memory location to return the attributes of variable. If the point
186 is NULL, the parameter would be ignored.
187 @param DataSize As input, point to the maxinum size of return Data-Buffer.
188 As output, point to the actual size of the returned Data-Buffer.
189 @param Data Point to return Data-Buffer.
191 @retval EFI_SUCCESS The function completed successfully.
192 @retval EFI_NOT_FOUND The variable was not found.
193 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has
194 been updated with the size needed to complete the request.
195 @retval EFI_INVALID_PARAMETER VariableName is NULL.
196 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
197 @retval EFI_INVALID_PARAMETER DataSize is NULL.
198 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
199 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
200 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
205 IN CHAR16
*VariableName
,
206 IN EFI_GUID
* VendorGuid
,
207 OUT UINT32
*Attributes OPTIONAL
,
208 IN OUT UINTN
*DataSize
,
212 return mRT
->GetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
217 Enumerates variable's name.
219 @param VariableNameSize As input, point to maxinum size of variable name.
220 As output, point to actual size of varaible name.
221 @param VariableName As input, supplies the last VariableName that was returned by
222 GetNextVariableName().
223 As output, returns the name of variable. The name
224 string is Null-Terminated Unicode string.
225 @param VendorGuid As input, supplies the last VendorGuid that was returned by
226 GetNextVriableName().
227 As output, returns the VendorGuid of the current variable.
229 @retval EFI_SUCCESS The function completed successfully.
230 @retval EFI_NOT_FOUND The next variable was not found.
231 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
232 VariableNameSize has been updated with the size needed
233 to complete the request.
234 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
235 @retval EFI_INVALID_PARAMETER VariableName is NULL.
236 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
237 @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
242 EfiGetNextVariableName (
243 IN OUT UINTN
*VariableNameSize
,
244 IN OUT CHAR16
*VariableName
,
245 IN OUT EFI_GUID
*VendorGuid
248 return mRT
->GetNextVariableName (VariableNameSize
, VariableName
, VendorGuid
);
253 Sets value of variable.
255 @param VariableName the name of the vendor's variable, it's a
256 Null-Terminated Unicode String
257 @param VendorGuid Unify identifier for vendor.
258 @param Attributes Point to memory location to return the attributes of variable. If the point
259 is NULL, the parameter would be ignored.
260 @param DataSize The size in bytes of Data-Buffer.
261 @param Data Point to the content of the variable.
263 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
264 defined by the Attributes.
265 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
266 DataSize exceeds the maximum allowed.
267 @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
268 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
269 @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
270 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
271 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
272 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
273 set but the AuthInfo does NOT pass the validation check carried
275 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
281 IN CHAR16
*VariableName
,
282 IN EFI_GUID
*VendorGuid
,
283 IN UINT32 Attributes
,
288 return mRT
->SetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
293 Returns the next high 32 bits of platform's monotonic counter.
295 @param HighCount Pointer to returned value.
297 @retval EFI_SUCCESS The next high monotonic count was returned.
298 @retval EFI_DEVICE_ERROR The device is not functioning properly.
299 @retval EFI_INVALID_PARAMETER HighCount is NULL.
304 EfiGetNextHighMonotonicCount (
305 OUT UINT32
*HighCount
308 return mRT
->GetNextHighMonotonicCount (HighCount
);
313 This service converts a function pointer from physical to virtual addressing.
315 @param DebugDisposition Supplies type information for the pointer being converted.
316 @param Address The pointer to a pointer that is to be fixed to be the
317 value needed for the new virtual address mapping being
320 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
321 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of
322 the current memory map. This is normally fatal.
323 @retval EFI_INVALID_PARAMETER Address is NULL.
324 @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio
330 IN UINTN DebugDisposition
,
331 IN OUT VOID
**Address
334 return gRT
->ConvertPointer (DebugDisposition
, Address
);
339 Determines the new virtual address that is to be used on subsequent memory accesses.
341 For IA32, X64, and EBC, this service is a wrapper for the UEFI Runtime Service
342 ConvertPointer(). See the UEFI Specification for details.
343 For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure
344 and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical
345 to virtiual addressing. Since IPF allows the GP to point to an address outside
346 a PE/COFF image, the physical to virtual offset for the EntryPoint field is used
347 to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert
348 EntryPoint and the status code for this conversion is always returned. If the convertion
349 of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI
350 Specification for details on the UEFI Runtime Service ConvertPointer().
352 @param DebugDisposition Supplies type information for the pointer being converted.
353 @param Address The pointer to a pointer that is to be fixed to be the
354 value needed for the new virtual address mapping being
357 @return EFI_STATUS value from EfiConvertPointer().
362 EfiConvertFunctionPointer (
363 IN UINTN DebugDisposition
,
364 IN OUT VOID
**Address
367 return EfiConvertPointer (DebugDisposition
, Address
);
372 Convert the standard Lib double linked list to a virtual mapping.
374 This service uses EfiConvertPointer() to walk a double linked list and convert all the link
375 pointers to their virtual mappings. This function is only guaranteed to work during the
376 EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.
378 @param DebugDisposition Supplies type information for the pointer being converted.
379 @param ListHead Head of linked list to convert.
381 @retval EFI_SUCCESS Success to execute the function.
382 @retval !EFI_SUCCESS Failed to e3xecute the function.
388 IN UINTN DebugDisposition
,
389 IN OUT LIST_ENTRY
*ListHead
393 LIST_ENTRY
*NextLink
;
396 // For NULL List, return EFI_SUCCESS
398 if (ListHead
== NULL
) {
403 // Convert all the ForwardLink & BackLink pointers in the list
407 NextLink
= Link
->ForwardLink
;
410 Link
->ForwardLink
== ListHead
? DebugDisposition
: 0,
411 (VOID
**) &Link
->ForwardLink
415 Link
->BackLink
== ListHead
? DebugDisposition
: 0,
416 (VOID
**) &Link
->BackLink
420 } while (Link
!= ListHead
);
426 Change the runtime addressing mode of EFI firmware from physical to virtual.
428 @param MemoryMapSize The size in bytes of VirtualMap.
429 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
430 @param DescriptorVersion The version of the structure entries in VirtualMap.
431 @param VirtualMap An array of memory descriptors which contain new virtual
432 address mapping information for all runtime ranges. Type
433 EFI_MEMORY_DESCRIPTOR is defined in the
434 GetMemoryMap() function description.
436 @retval EFI_SUCCESS The virtual address map has been applied.
437 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
438 virtual address mapped mode.
439 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
441 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
442 map that requires a mapping.
443 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
448 EfiSetVirtualAddressMap (
449 IN UINTN MemoryMapSize
,
450 IN UINTN DescriptorSize
,
451 IN UINT32 DescriptorVersion
,
452 IN CONST EFI_MEMORY_DESCRIPTOR
*VirtualMap
455 return mRT
->SetVirtualAddressMap (
459 (EFI_MEMORY_DESCRIPTOR
*) VirtualMap
465 Passes capsules to the firmware with both virtual and physical mapping.
466 Depending on the intended consumption, the firmware may
467 process the capsule immediately. If the payload should persist across a
468 system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
469 be passed into ResetSystem() and will cause the capsule to be processed by
470 the firmware as part of the reset process.
472 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
473 being passed into update capsule. Each capsules is assumed to
474 stored in contiguous virtual memory. The capsules in the
475 CapsuleHeaderArray must be the same capsules as the
476 ScatterGatherList. The CapsuleHeaderArray must
477 have the capsules in the same order as the ScatterGatherList.
478 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
480 @param ScatterGatherList Physical pointer to a set of
481 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
482 location in physical memory of a set of capsules. See Related
483 Definitions for an explanation of how more than one capsule is
484 passed via this interface. The capsules in the
485 ScatterGatherList must be in the same order as the
486 CapsuleHeaderArray. This parameter is only referenced if
487 the capsules are defined to persist across system reset.
489 @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,
490 the capsule has been successfully processed by the firmware.
491 @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.
492 @retval EFI_INVALID_PARAMETER CapsuleCount is 0
493 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
494 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
495 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
501 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
502 IN UINTN CapsuleCount
,
503 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
506 return mRT
->UpdateCapsule (
515 The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
516 capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
517 size of the entire capsule is checked.
518 If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
519 constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
520 (EFI_CAPSULE_HEADER). To determine reset requirements,
521 CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
523 The firmware must support any capsule that has the
524 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
525 firmware sets the policy for what capsules are supported that do not have the
526 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
528 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
529 being passed into update capsule. The capsules are assumed to
530 stored in contiguous virtual memory.
531 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
533 @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can
534 support as an argument to UpdateCapsule() via
535 CapsuleHeaderArray and ScatterGatherList.
537 @param ResetType Returns the type of reset required for the capsule update.
539 @retval EFI_SUCCESS Valid answer returned..
540 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
541 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
542 MaximumCapsuleSize and ResetType are undefined.
547 EfiQueryCapsuleCapabilities (
548 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
549 IN UINTN CapsuleCount
,
550 OUT UINT64
*MaximumCapsuleSize
,
551 OUT EFI_RESET_TYPE
*ResetType
554 return mRT
->QueryCapsuleCapabilities (
564 Returns information about the EFI variables.
566 The QueryVariableInfo() function allows a caller to obtain the information about the
567 maximum size of the storage space available for the EFI variables, the remaining size of the storage
568 space available for the EFI variables and the maximum size of each individual EFI variable,
569 associated with the attributes specified.
570 The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
571 MaximumVariableSize information may change immediately after the call based on other
572 runtime activities including asynchronous error events. Also, these values associated with different
573 attributes are not additive in nature.
575 @param Attributes Attributes bitmask to specify the type of variables on
576 which to return information. Refer to the
577 GetVariable() function description.
578 @param MaximumVariableStorageSize
579 On output the maximum size of the storage space
580 available for the EFI variables associated with the
581 attributes specified.
582 @param RemainingVariableStorageSize
583 Returns the remaining size of the storage space
584 available for the EFI variables associated with the
585 attributes specified..
586 @param MaximumVariableSize Returns the maximum size of the individual EFI
587 variables associated with the attributes specified.
589 @retval EFI_SUCCESS Valid answer returned.
590 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
591 @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
592 MaximumVariableStorageSize,
593 RemainingVariableStorageSize, MaximumVariableSize
598 EfiQueryVariableInfo (
599 IN UINT32 Attributes
,
600 OUT UINT64
*MaximumVariableStorageSize
,
601 OUT UINT64
*RemainingVariableStorageSize
,
602 OUT UINT64
*MaximumVariableSize
605 return mRT
->QueryVariableInfo (
607 MaximumVariableStorageSize
,
608 RemainingVariableStorageSize
,