/** @file\r
Library to abstract runtime services\r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
+ Copyright (c) 2006, Intel Corporation\r
+ All rights reserved. This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
- Module Name: UefiRuntimeLib.h\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
BOOLEAN\r
EFIAPI\r
EfiAtRuntime (\r
- VOID \r
+ VOID\r
);\r
\r
/**\r
BOOLEAN\r
EFIAPI\r
EfiGoneVirtual (\r
- VOID \r
+ VOID\r
);\r
\r
/**\r
- Return current time and date information, and time-keeping \r
+ Return current time and date information, and time-keeping\r
capabilities of hardware platform.\r
\r
@param Time A pointer to storage to receive a snapshot of the current time.\r
@param Capabilities An optional pointer to a buffer to receive the real time clock device's\r
capabilities.\r
- \r
+\r
@retval EFI_SUCCESS Success to execute the function.\r
@retval !EFI_SUCCESS Failed to e3xecute the function.\r
\r
Set current time and date information.\r
\r
@param Time A pointer to cache of time setting.\r
- \r
+\r
@retval EFI_SUCCESS Success to execute the function.\r
@retval !EFI_SUCCESS Failed to execute the function.\r
\r
@param Enabled Indicate if the alarm clock is enabled or disabled.\r
@param Pending Indicate if the alarm signal is pending and requires acknowledgement.\r
@param Time Current alarm clock setting.\r
- \r
+\r
@retval EFI_SUCCESS Success to execute the function.\r
@retval !EFI_SUCCESS Failed to e3xecute the function.\r
\r
\r
@param Enable Enable or disable current alarm clock..\r
@param Time Point to alarm clock setting.\r
- \r
+\r
@retval EFI_SUCCESS Success to execute the function.\r
@retval !EFI_SUCCESS Failed to e3xecute the function.\r
\r
/**\r
Return value of variable.\r
\r
- @param VariableName the name of the vendor's variable, it's a \r
+ @param VariableName the name of the vendor's variable, it's a\r
Null-Terminated Unicode String\r
@param VendorGuid Unify identifier for vendor.\r
- @param Attributes Point to memory location to return the attributes of variable. If the point \r
+ @param Attributes Point to memory location to return the attributes of variable. If the point\r
is NULL, the parameter would be ignored.\r
@param DataSize As input, point to the maxinum size of return Data-Buffer.\r
As output, point to the actual size of the returned Data-Buffer.\r
@param Data Point to return Data-Buffer.\r
- \r
+\r
@retval EFI_SUCCESS Success to execute the function.\r
@retval !EFI_SUCCESS Failed to e3xecute the function.\r
\r
\r
@param VariableNameSize As input, point to maxinum size of variable name.\r
As output, point to actual size of varaible name.\r
- @param VariableName As input, supplies the last VariableName that was returned by \r
+ @param VariableName As input, supplies the last VariableName that was returned by\r
GetNextVariableName().\r
- As output, returns the name of variable. The name \r
+ As output, returns the name of variable. The name\r
string is Null-Terminated Unicode string.\r
- @param VendorGuid As input, supplies the last VendorGuid that was returned by \r
+ @param VendorGuid As input, supplies the last VendorGuid that was returned by\r
GetNextVriableName().\r
As output, returns the VendorGuid of the current variable.\r
- \r
+\r
@retval EFI_SUCCESS Success to execute the function.\r
@retval !EFI_SUCCESS Failed to e3xecute the function.\r
\r
/**\r
Sets value of variable.\r
\r
- @param VariableName the name of the vendor's variable, it's a \r
+ @param VariableName the name of the vendor's variable, it's a\r
Null-Terminated Unicode String\r
@param VendorGuid Unify identifier for vendor.\r
- @param Attributes Point to memory location to return the attributes of variable. If the point \r
+ @param Attributes Point to memory location to return the attributes of variable. If the point\r
is NULL, the parameter would be ignored.\r
@param DataSize The size in bytes of Data-Buffer.\r
@param Data Point to the content of the variable.\r
@param ResetType The type of reset to perform.\r
@param ResetStatus The status code for reset.\r
@param DataSize The size in bytes of reset data.\r
- @param ResetData Pointer to data buffer that includes \r
+ @param ResetData Pointer to data buffer that includes\r
Null-Terminated Unicode string.\r
\r
- @retval EFI_SUCCESS Success to execute the function.\r
- @retval !EFI_SUCCESS Failed to e3xecute the function.\r
-\r
**/\r
VOID\r
EfiResetSystem (\r
Determines the new virtual address that is to be used on subsequent memory accesses.\r
\r
@param DebugDisposition Supplies type information for the pointer being converted.\r
- @param Address The pointer to a pointer that is to be fixed to be the \r
- value needed for the new virtual address mapping being \r
+ @param Address The pointer to a pointer that is to be fixed to be the\r
+ value needed for the new virtual address mapping being\r
applied.\r
\r
@retval EFI_SUCCESS Success to execute the function.\r
);\r
\r
/**\r
- \r
- Passes capsules to the firmware with both virtual and physical mapping. \r
+\r
+ Passes capsules to the firmware with both virtual and physical mapping.\r
Depending on the intended consumption, the firmware may\r
process the capsule immediately. If the payload should persist across a\r
system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r
- be passed into ResetSystem() and will cause the capsule to be processed by \r
+ be passed into ResetSystem() and will cause the capsule to be processed by\r
the firmware as part of the reset process.\r
- \r
+\r
@param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r
being passed into update capsule. Each capsules is assumed to\r
stored in contiguous virtual memory. The capsules in the\r
EFI_STATUS\r
EFIAPI\r
EfiUpdateCapsule (\r
- IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
IN UINTN CapsuleCount,\r
IN EFI_PHYSICAL_ADDRESS ScatterGatherList\r
);\r
\r
\r
/**\r
- \r
+\r
The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or\r
capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and\r
size of the entire capsule is checked.\r
CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The\r
firmware sets the policy for what capsules are supported that do not have the\r
CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.\r
- \r
+\r
@param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r
being passed into update capsule. The capsules are assumed to\r
stored in contiguous virtual memory.\r
EFI_STATUS\r
EFIAPI\r
EfiQueryCapsuleCapabilities (\r
- IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
- IN UINTN CapsuleCount,\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+ IN UINTN CapsuleCount,\r
OUT UINT64 *MaximumCapsuleSize,\r
OUT EFI_RESET_TYPE *ResetType\r
);\r
\r
\r
/**\r
- \r
+\r
The QueryVariableInfo() function allows a caller to obtain the information about the\r
maximum size of the storage space available for the EFI variables, the remaining size of the storage\r
space available for the EFI variables and the maximum size of each individual EFI variable,\r
MaximumVariableSize information may change immediately after the call based on other\r
runtime activities including asynchronous error events. Also, these values associated with different\r
attributes are not additive in nature.\r
- \r
+\r
@param Attributes Attributes bitmask to specify the type of variables on\r
which to return information. Refer to the\r
GetVariable() function description.\r
- @param MaximumVariableStorageSize \r
+ @param MaximumVariableStorageSize\r
On output the maximum size of the storage space\r
available for the EFI variables associated with the\r
attributes specified.\r
- @param RemainingVariableStorageSize \r
+ @param RemainingVariableStorageSize\r
Returns the remaining size of the storage space\r
available for the EFI variables associated with the\r
attributes specified..\r
projects / mirror_edk2.git / blobdiff