]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/UefiRuntimeLib.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Include / Library / UefiRuntimeLib.h
index 0bca416a4bebf974210cbf616658843f0a42d985..2b95b63f9f051af9e7fd386496dfc989e68327b0 100644 (file)
@@ -2,14 +2,8 @@
   Provides library functions for each of the UEFI Runtime Services.\r
   Only available to DXE and UEFI module types.\r
 \r
-Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
-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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 **/\r
 \r
 #ifndef __UEFI_RUNTIME_LIB__\r
@@ -34,7 +28,7 @@ EfiAtRuntime (
   );\r
 \r
 /**\r
-  This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called. \r
+  This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.\r
 \r
   This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have\r
   executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE\r
@@ -75,8 +69,8 @@ EfiGoneVirtual (
 EFI_STATUS\r
 EFIAPI\r
 EfiGetTime (\r
-  OUT EFI_TIME                    *Time,\r
-  OUT EFI_TIME_CAPABILITIES       *Capabilities  OPTIONAL\r
+  OUT EFI_TIME               *Time,\r
+  OUT EFI_TIME_CAPABILITIES  *Capabilities  OPTIONAL\r
   );\r
 \r
 /**\r
@@ -104,7 +98,7 @@ EfiGetTime (
 EFI_STATUS\r
 EFIAPI\r
 EfiSetTime (\r
-  IN EFI_TIME                   *Time\r
+  IN EFI_TIME  *Time\r
   );\r
 \r
 /**\r
@@ -131,9 +125,9 @@ EfiSetTime (
 EFI_STATUS\r
 EFIAPI\r
 EfiGetWakeupTime (\r
-  OUT BOOLEAN                     *Enabled,\r
-  OUT BOOLEAN                     *Pending,\r
-  OUT EFI_TIME                    *Time\r
+  OUT BOOLEAN   *Enabled,\r
+  OUT BOOLEAN   *Pending,\r
+  OUT EFI_TIME  *Time\r
   );\r
 \r
 /**\r
@@ -161,8 +155,8 @@ EfiGetWakeupTime (
 EFI_STATUS\r
 EFIAPI\r
 EfiSetWakeupTime (\r
-  IN BOOLEAN                      Enable,\r
-  IN EFI_TIME                     *Time   OPTIONAL\r
+  IN BOOLEAN   Enable,\r
+  IN EFI_TIME  *Time   OPTIONAL\r
   );\r
 \r
 /**\r
@@ -198,11 +192,11 @@ EfiSetWakeupTime (
 EFI_STATUS\r
 EFIAPI\r
 EfiGetVariable (\r
-  IN      CHAR16                   *VariableName,\r
-  IN      EFI_GUID                 *VendorGuid,\r
-  OUT     UINT32                   *Attributes OPTIONAL,\r
-  IN OUT  UINTN                    *DataSize,\r
-  OUT     VOID                     *Data\r
+  IN      CHAR16    *VariableName,\r
+  IN      EFI_GUID  *VendorGuid,\r
+  OUT     UINT32    *Attributes OPTIONAL,\r
+  IN OUT  UINTN     *DataSize,\r
+  OUT     VOID      *Data\r
   );\r
 \r
 /**\r
@@ -238,9 +232,9 @@ EfiGetVariable (
 EFI_STATUS\r
 EFIAPI\r
 EfiGetNextVariableName (\r
-  IN OUT UINTN                    *VariableNameSize,\r
-  IN OUT CHAR16                   *VariableName,\r
-  IN OUT EFI_GUID                 *VendorGuid\r
+  IN OUT UINTN     *VariableNameSize,\r
+  IN OUT CHAR16    *VariableName,\r
+  IN OUT EFI_GUID  *VendorGuid\r
   );\r
 \r
 /**\r
@@ -275,11 +269,11 @@ EfiGetNextVariableName (
 EFI_STATUS\r
 EFIAPI\r
 EfiSetVariable (\r
-  IN CHAR16                       *VariableName,\r
-  IN EFI_GUID                     *VendorGuid,\r
-  IN UINT32                       Attributes,\r
-  IN UINTN                        DataSize,\r
-  IN VOID                         *Data\r
+  IN CHAR16    *VariableName,\r
+  IN EFI_GUID  *VendorGuid,\r
+  IN UINT32    Attributes,\r
+  IN UINTN     DataSize,\r
+  IN VOID      *Data\r
   );\r
 \r
 /**\r
@@ -301,7 +295,7 @@ EfiSetVariable (
 EFI_STATUS\r
 EFIAPI\r
 EfiGetNextHighMonotonicCount (\r
-  OUT UINT32                      *HighCount\r
+  OUT UINT32  *HighCount\r
   );\r
 \r
 /**\r
@@ -335,14 +329,14 @@ EfiGetNextHighMonotonicCount (
 VOID\r
 EFIAPI\r
 EfiResetSystem (\r
-  IN EFI_RESET_TYPE               ResetType,\r
-  IN EFI_STATUS                   ResetStatus,\r
-  IN UINTN                        DataSize,\r
-  IN VOID                         *ResetData OPTIONAL\r
+  IN EFI_RESET_TYPE  ResetType,\r
+  IN EFI_STATUS      ResetStatus,\r
+  IN UINTN           DataSize,\r
+  IN VOID            *ResetData OPTIONAL\r
   );\r
 \r
 /**\r
-  This service is a wrapper for the UEFI Runtime Service ConvertPointer().  \r
+  This service is a wrapper for the UEFI Runtime Service ConvertPointer().\r
 \r
   The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.\r
   ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().\r
@@ -362,15 +356,15 @@ EfiResetSystem (
 EFI_STATUS\r
 EFIAPI\r
 EfiConvertPointer (\r
-  IN UINTN                  DebugDisposition,\r
-  IN OUT VOID               **Address\r
+  IN UINTN     DebugDisposition,\r
+  IN OUT VOID  **Address\r
   );\r
 \r
 /**\r
   Determines the new virtual address that is to be used on subsequent memory accesses.\r
 \r
   For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service\r
-  ConvertPointer().  See the UEFI Specification for details. \r
+  ConvertPointer().  See the UEFI Specification for details.\r
   For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure\r
   and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical\r
   to virtiual addressing.  Since IPF allows the GP to point to an address outside\r
@@ -391,8 +385,8 @@ EfiConvertPointer (
 EFI_STATUS\r
 EFIAPI\r
 EfiConvertFunctionPointer (\r
-  IN UINTN                DebugDisposition,\r
-  IN OUT VOID             **Address\r
+  IN UINTN     DebugDisposition,\r
+  IN OUT VOID  **Address\r
   );\r
 \r
 /**\r
@@ -424,13 +418,12 @@ EfiConvertFunctionPointer (
 EFI_STATUS\r
 EFIAPI\r
 EfiSetVirtualAddressMap (\r
-  IN UINTN                          MemoryMapSize,\r
-  IN UINTN                          DescriptorSize,\r
-  IN UINT32                         DescriptorVersion,\r
-  IN CONST EFI_MEMORY_DESCRIPTOR    *VirtualMap\r
+  IN UINTN                        MemoryMapSize,\r
+  IN UINTN                        DescriptorSize,\r
+  IN UINT32                       DescriptorVersion,\r
+  IN CONST EFI_MEMORY_DESCRIPTOR  *VirtualMap\r
   );\r
 \r
-\r
 /**\r
   Convert the standard Lib double linked list to a virtual mapping.\r
 \r
@@ -448,8 +441,8 @@ EfiSetVirtualAddressMap (
 EFI_STATUS\r
 EFIAPI\r
 EfiConvertList (\r
-  IN UINTN                DebugDisposition,\r
-  IN OUT LIST_ENTRY       *ListHead\r
+  IN UINTN           DebugDisposition,\r
+  IN OUT LIST_ENTRY  *ListHead\r
   );\r
 \r
 /**\r
@@ -490,12 +483,11 @@ EfiConvertList (
 EFI_STATUS\r
 EFIAPI\r
 EfiUpdateCapsule (\r
-  IN EFI_CAPSULE_HEADER       **CapsuleHeaderArray,\r
-  IN UINTN                    CapsuleCount,\r
-  IN EFI_PHYSICAL_ADDRESS     ScatterGatherList OPTIONAL\r
+  IN EFI_CAPSULE_HEADER    **CapsuleHeaderArray,\r
+  IN UINTN                 CapsuleCount,\r
+  IN EFI_PHYSICAL_ADDRESS  ScatterGatherList OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().\r
 \r
@@ -533,13 +525,12 @@ EfiUpdateCapsule (
 EFI_STATUS\r
 EFIAPI\r
 EfiQueryCapsuleCapabilities (\r
-  IN  EFI_CAPSULE_HEADER       **CapsuleHeaderArray,\r
-  IN  UINTN                    CapsuleCount,\r
-  OUT UINT64                   *MaximumCapsuleSize,\r
-  OUT EFI_RESET_TYPE           *ResetType\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
   This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().\r
 \r
@@ -584,4 +575,3 @@ EfiQueryVariableInfo (
   );\r
 \r
 #endif\r
-\r