2 Provides library functions for each of the UEFI Runtime Services.
3 Only available to DXE and UEFI module types.
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __UEFI_RUNTIME_LIB__
16 #define __UEFI_RUNTIME_LIB__
19 extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent
[];
21 extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent
[];
24 Check to see if the execute context is in Runtime phase or not.
28 @retval TRUE The driver is in SMM.
29 @retval FALSE The driver is not in SMM.
39 Check to see if the SetVirtualAddressMsp() is invoked or not.
41 @retval TRUE SetVirtualAddressMsp() has been called.
42 @retval FALSE SetVirtualAddressMsp() has not been called.
52 Return current time and date information, and time-keeping
53 capabilities of hardware platform.
55 @param Time A pointer to storage to receive a snapshot of the current time.
56 @param Capabilities An optional pointer to a buffer to receive the real time clock device's
59 @retval EFI_SUCCESS Success to execute the function.
60 @retval !EFI_SUCCESS Failed to e3xecute the function.
67 OUT EFI_TIME_CAPABILITIES
*Capabilities
71 Set current time and date information.
73 @param Time A pointer to cache of time setting.
75 @retval EFI_SUCCESS Success to execute the function.
76 @retval !EFI_SUCCESS Failed to execute the function.
86 Return current wakeup alarm clock setting.
88 @param Enabled Indicate if the alarm clock is enabled or disabled.
89 @param Pending Indicate if the alarm signal is pending and requires acknowledgement.
90 @param Time Current alarm clock setting.
92 @retval EFI_SUCCESS Success to execute the function.
93 @retval !EFI_SUCCESS Failed to e3xecute the function.
100 OUT BOOLEAN
*Pending
,
105 Set current wakeup alarm clock.
107 @param Enable Enable or disable current alarm clock..
108 @param Time Point to alarm clock setting.
110 @retval EFI_SUCCESS Success to execute the function.
111 @retval !EFI_SUCCESS Failed to e3xecute the function.
122 Return value of variable.
124 @param VariableName the name of the vendor's variable, it's a
125 Null-Terminated Unicode String
126 @param VendorGuid Unify identifier for vendor.
127 @param Attributes Point to memory location to return the attributes of variable. If the point
128 is NULL, the parameter would be ignored.
129 @param DataSize As input, point to the maxinum size of return Data-Buffer.
130 As output, point to the actual size of the returned Data-Buffer.
131 @param Data Point to return Data-Buffer.
133 @retval EFI_SUCCESS Success to execute the function.
134 @retval !EFI_SUCCESS Failed to e3xecute the function.
140 IN CHAR16
*VariableName
,
141 IN EFI_GUID
*VendorGuid
,
142 OUT UINT32
*Attributes OPTIONAL
,
143 IN OUT UINTN
*DataSize
,
148 Enumerates variable's name.
150 @param VariableNameSize As input, point to maxinum size of variable name.
151 As output, point to actual size of varaible name.
152 @param VariableName As input, supplies the last VariableName that was returned by
153 GetNextVariableName().
154 As output, returns the name of variable. The name
155 string is Null-Terminated Unicode string.
156 @param VendorGuid As input, supplies the last VendorGuid that was returned by
157 GetNextVriableName().
158 As output, returns the VendorGuid of the current variable.
160 @retval EFI_SUCCESS Success to execute the function.
161 @retval !EFI_SUCCESS Failed to e3xecute the function.
166 EfiGetNextVariableName (
167 IN OUT UINTN
*VariableNameSize
,
168 IN OUT CHAR16
*VariableName
,
169 IN OUT EFI_GUID
*VendorGuid
173 Sets value of variable.
175 @param VariableName the name of the vendor's variable, it's a
176 Null-Terminated Unicode String
177 @param VendorGuid Unify identifier for vendor.
178 @param Attributes Point to memory location to return the attributes of variable. If the point
179 is NULL, the parameter would be ignored.
180 @param DataSize The size in bytes of Data-Buffer.
181 @param Data Point to the content of the variable.
183 @retval EFI_SUCCESS Success to execute the function.
184 @retval !EFI_SUCCESS Failed to e3xecute the function.
190 IN CHAR16
*VariableName
,
191 IN EFI_GUID
*VendorGuid
,
192 IN UINT32 Attributes
,
198 Returns the next high 32 bits of platform's monotonic counter.
200 @param HighCount Pointer to returned value.
202 @retval EFI_SUCCESS Success to execute the function.
203 @retval !EFI_SUCCESS Failed to e3xecute the function.
208 EfiGetNextHighMonotonicCount (
209 OUT UINT32
*HighCount
213 Resets the entire platform.
215 @param ResetType The type of reset to perform.
216 @param ResetStatus The status code for reset.
217 @param DataSize The size in bytes of reset data.
218 @param ResetData Pointer to data buffer that includes
219 Null-Terminated Unicode string.
225 IN EFI_RESET_TYPE ResetType
,
226 IN EFI_STATUS ResetStatus
,
232 This service converts a function pointer from physical to virtual addressing.
234 @param DebugDisposition Supplies type information for the pointer being converted.
235 @param Address The pointer to a pointer that is to be fixed to be the
236 value needed for the new virtual address mapping being
239 @retval EFI_SUCCESS Success to execute the function.
240 @retval !EFI_SUCCESS Failed to execute the function.
246 IN UINTN DebugDisposition
,
247 IN OUT VOID
**Address
251 Determines the new virtual address that is to be used on subsequent memory accesses.
253 For IA32, X64, and EBC, this service is a wrapper for the UEFI Runtime Service
254 ConvertPointer(). See the UEFI Specification for details.
255 For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure
256 and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical
257 to virtiual addressing. Since IPF allows the GP to point to an address outside
258 a PE/COFF image, the physical to virtual offset for the EntryPoint field is used
259 to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert
260 EntryPoint and the status code for this conversion is always returned. If the convertion
261 of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI
262 Specification for details on the UEFI Runtime Service ConvertPointer().
264 @param DebugDisposition Supplies type information for the pointer being converted.
265 @param Address The pointer to a pointer that is to be fixed to be the
266 value needed for the new virtual address mapping being
269 @retval EFI_SUCCESS Success to execute the function.
270 @retval !EFI_SUCCESS Failed to execute the function.
275 EfiConvertFunctionPointer (
276 IN UINTN DebugDisposition
,
277 IN OUT VOID
**Address
281 Change the runtime addressing mode of EFI firmware from physical to virtual.
283 @param MemoryMapSize The size in bytes of VirtualMap.
284 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
285 @param DescriptorVersion The version of the structure entries in VirtualMap.
286 @param VirtualMap An array of memory descriptors which contain new virtual
287 address mapping information for all runtime ranges. Type
288 EFI_MEMORY_DESCRIPTOR is defined in the
289 GetMemoryMap() function description.
291 @retval EFI_SUCCESS The virtual address map has been applied.
292 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
293 virtual address mapped mode.
294 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
296 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
297 map that requires a mapping.
298 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
303 EfiSetVirtualAddressMap (
304 IN UINTN MemoryMapSize
,
305 IN UINTN DescriptorSize
,
306 IN UINT32 DescriptorVersion
,
307 IN CONST EFI_MEMORY_DESCRIPTOR
*VirtualMap
312 Convert the standard Lib double linked list to a virtual mapping.
314 @param DebugDisposition Supplies type information for the pointer being converted.
315 @param ListHead Head of linked list to convert.
317 @retval EFI_SUCCESS Success to execute the function.
318 @retval !EFI_SUCCESS Failed to e3xecute the function.
324 IN UINTN DebugDisposition
,
325 IN OUT LIST_ENTRY
*ListHead
329 Passes capsules to the firmware with both virtual and physical mapping.
330 Depending on the intended consumption, the firmware may
331 process the capsule immediately. If the payload should persist across a
332 system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
333 be passed into ResetSystem() and will cause the capsule to be processed by
334 the firmware as part of the reset process.
336 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
337 being passed into update capsule. Each capsules is assumed to
338 stored in contiguous virtual memory. The capsules in the
339 CapsuleHeaderArray must be the same capsules as the
340 ScatterGatherList. The CapsuleHeaderArray must
341 have the capsules in the same order as the ScatterGatherList.
342 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
344 @param ScatterGatherList Physical pointer to a set of
345 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
346 location in physical memory of a set of capsules. See Related
347 Definitions for an explanation of how more than one capsule is
348 passed via this interface. The capsules in the
349 ScatterGatherList must be in the same order as the
350 CapsuleHeaderArray. This parameter is only referenced if
351 the capsules are defined to persist across system reset.
353 @retval EFI_SUCCESS Valid capsule was passed. I Valid capsule was passed. If
354 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
355 capsule has been successfully processed by the firmware.
356 @retval EFI_INVALID_PARAMETER CapsuleSize is NULL or ResetTye is NULL.
357 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
363 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
364 IN UINTN CapsuleCount
,
365 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
370 The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
371 capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
372 size of the entire capsule is checked.
373 If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
374 constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
375 (EFI_CAPSULE_HEADER). To determine reset requirements,
376 CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
378 The firmware must support any capsule that has the
379 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
380 firmware sets the policy for what capsules are supported that do not have the
381 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
383 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
384 being passed into update capsule. The capsules are assumed to
385 stored in contiguous virtual memory.
386 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
388 @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can
389 support as an argument to UpdateCapsule() via
390 CapsuleHeaderArray and ScatterGatherList.
392 @param ResetType Returns the type of reset required for the capsule update.
394 @retval EFI_SUCCESS Valid answer returned..
395 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
396 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
397 MaximumCapsuleSize and ResetType are undefined.
402 EfiQueryCapsuleCapabilities (
403 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
404 IN UINTN CapsuleCount
,
405 OUT UINT64
*MaximumCapsuleSize
,
406 OUT EFI_RESET_TYPE
*ResetType
411 The QueryVariableInfo() function allows a caller to obtain the information about the
412 maximum size of the storage space available for the EFI variables, the remaining size of the storage
413 space available for the EFI variables and the maximum size of each individual EFI variable,
414 associated with the attributes specified.
415 The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
416 MaximumVariableSize information may change immediately after the call based on other
417 runtime activities including asynchronous error events. Also, these values associated with different
418 attributes are not additive in nature.
420 @param Attributes Attributes bitmask to specify the type of variables on
421 which to return information. Refer to the
422 GetVariable() function description.
423 @param MaximumVariableStorageSize
424 On output the maximum size of the storage space
425 available for the EFI variables associated with the
426 attributes specified.
427 @param RemainingVariableStorageSize
428 Returns the remaining size of the storage space
429 available for the EFI variables associated with the
430 attributes specified..
431 @param MaximumVariableSize Returns the maximum size of the individual EFI
432 variables associated with the attributes specified.
434 @retval EFI_SUCCESS Valid answer returned.
435 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
436 @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
437 MaximumVariableStorageSize,
438 RemainingVariableStorageSize, MaximumVariableSize
443 EfiQueryVariableInfo (
444 IN UINT32 Attributes
,
445 OUT UINT64
*MaximumVariableStorageSize
,
446 OUT UINT64
*RemainingVariableStorageSize
,
447 OUT UINT64
*MaximumVariableSize