]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/UefiLib.h
projects / mirror_edk2.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Include / Library / UefiLib.h
diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index e0f7eb9b571b3a53a7b4221fec21a2fa053c1567..be7da7fdf7dac177fad096b01ac13de07b5ac1ed 100644 (file)
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -39,8 +39,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 /// Unicode String Table\r
 ///\r
 typedef struct {\r
-  CHAR8   *Language;\r
-  CHAR16  *UnicodeString;\r
+  CHAR8     *Language;\r
+  CHAR16    *UnicodeString;\r
 } EFI_UNICODE_STRING_TABLE;\r
 \r
 ///\r
@@ -56,9 +56,9 @@ typedef enum {
 /// EFI Lock\r
 ///\r
 typedef struct {\r
-  EFI_TPL         Tpl;\r
-  EFI_TPL         OwnerTpl;\r
-  EFI_LOCK_STATE  Lock;\r
+  EFI_TPL           Tpl;\r
+  EFI_TPL           OwnerTpl;\r
+  EFI_LOCK_STATE    Lock;\r
 } EFI_LOCK;\r
 \r
 /**\r
@@ -71,7 +71,7 @@ typedef struct {
           by Microseconds.\r
 \r
 **/\r
-#define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds) MultU64x32((UINT64)(Microseconds), 10)\r
+#define EFI_TIMER_PERIOD_MICROSECONDS(Microseconds)  MultU64x32((UINT64)(Microseconds), 10)\r
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of milliseconds.\r
@@ -83,7 +83,7 @@ typedef struct {
           by Milliseconds.\r
 \r
 **/\r
-#define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds) MultU64x32((UINT64)(Milliseconds), 10000)\r
+#define EFI_TIMER_PERIOD_MILLISECONDS(Milliseconds)  MultU64x32((UINT64)(Milliseconds), 10000)\r
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of seconds.\r
@@ -95,7 +95,7 @@ typedef struct {
           by Seconds.\r
 \r
 **/\r
-#define EFI_TIMER_PERIOD_SECONDS(Seconds)           MultU64x32((UINT64)(Seconds), 10000000)\r
+#define EFI_TIMER_PERIOD_SECONDS(Seconds)  MultU64x32((UINT64)(Seconds), 10000000)\r
 \r
 /**\r
   Macro that returns the a pointer to the next EFI_MEMORY_DESCRIPTOR in an array\r
@@ -165,7 +165,7 @@ EfiGetSystemConfigurationTable (
 **/\r
 EFI_EVENT\r
 EFIAPI\r
-EfiCreateProtocolNotifyEvent(\r
+EfiCreateProtocolNotifyEvent (\r
   IN  EFI_GUID          *ProtocolGuid,\r
   IN  EFI_TPL           NotifyTpl,\r
   IN  EFI_EVENT_NOTIFY  NotifyFunction,\r
@@ -237,7 +237,7 @@ EfiNamedEventSignal (
 EFI_STATUS\r
 EFIAPI\r
 EfiEventGroupSignal (\r
-  IN CONST EFI_GUID *EventGroup\r
+  IN CONST EFI_GUID  *EventGroup\r
   );\r
 \r
 /**\r
@@ -252,8 +252,8 @@ EfiEventGroupSignal (
 VOID\r
 EFIAPI\r
 EfiEventEmptyFunction (\r
-  IN EFI_EVENT              Event,\r
-  IN VOID                   *Context\r
+  IN EFI_EVENT  Event,\r
+  IN VOID       *Context\r
   );\r
 \r
 /**\r
@@ -294,7 +294,7 @@ EFI_LOCK *
 EFIAPI\r
 EfiInitializeLock (\r
   IN OUT EFI_LOCK  *Lock,\r
-  IN EFI_TPL        Priority\r
+  IN EFI_TPL       Priority\r
   );\r
 \r
 /**\r
@@ -313,7 +313,6 @@ EfiInitializeLock (
 #define EFI_INITIALIZE_LOCK_VARIABLE(Priority) \\r
   {Priority, TPL_APPLICATION, EfiLockReleased }\r
 \r
-\r
 /**\r
   Macro that calls DebugAssert() if an EFI_LOCK structure is not in the locked state.\r
 \r
@@ -328,8 +327,8 @@ EfiInitializeLock (
   @param  LockParameter  A pointer to the lock to acquire.\r
 \r
 **/\r
-#if !defined(MDEPKG_NDEBUG)\r
-  #define ASSERT_LOCKED(LockParameter)                  \\r
+#if !defined (MDEPKG_NDEBUG)\r
+#define ASSERT_LOCKED(LockParameter)                  \\r
     do {                                                \\r
       if (DebugAssertEnabled ()) {                      \\r
         ASSERT (LockParameter != NULL);                 \\r
@@ -339,10 +338,9 @@ EfiInitializeLock (
       }                                                 \\r
     } while (FALSE)\r
 #else\r
-  #define ASSERT_LOCKED(LockParameter)\r
+#define ASSERT_LOCKED(LockParameter)\r
 #endif\r
 \r
-\r
 /**\r
   Acquires ownership of a lock.\r
 \r
@@ -429,9 +427,9 @@ EfiReleaseLock (
 EFI_STATUS\r
 EFIAPI\r
 EfiTestManagedDevice (\r
-  IN CONST EFI_HANDLE       ControllerHandle,\r
-  IN CONST EFI_HANDLE       DriverBindingHandle,\r
-  IN CONST EFI_GUID         *ProtocolGuid\r
+  IN CONST EFI_HANDLE  ControllerHandle,\r
+  IN CONST EFI_HANDLE  DriverBindingHandle,\r
+  IN CONST EFI_GUID    *ProtocolGuid\r
   );\r
 \r
 /**\r
@@ -456,9 +454,9 @@ EfiTestManagedDevice (
 EFI_STATUS\r
 EFIAPI\r
 EfiTestChildHandle (\r
-  IN CONST EFI_HANDLE       ControllerHandle,\r
-  IN CONST EFI_HANDLE       ChildHandle,\r
-  IN CONST EFI_GUID         *ProtocolGuid\r
+  IN CONST EFI_HANDLE  ControllerHandle,\r
+  IN CONST EFI_HANDLE  ChildHandle,\r
+  IN CONST EFI_GUID    *ProtocolGuid\r
   );\r
 \r
 /**\r
@@ -475,8 +473,8 @@ EfiTestChildHandle (
 EFI_STATUS\r
 EFIAPI\r
 IsLanguageSupported (\r
-  IN CONST CHAR8 *SupportedLanguages,\r
-  IN CONST CHAR8 *TargetLanguage\r
+  IN CONST CHAR8  *SupportedLanguages,\r
+  IN CONST CHAR8  *TargetLanguage\r
   );\r
 \r
 /**\r
@@ -680,7 +678,6 @@ FreeUnicodeStringTable (
   IN EFI_UNICODE_STRING_TABLE  *UnicodeStringTable\r
   );\r
 \r
-\r
 /**\r
   Returns the status whether get the variable success. The function retrieves\r
   variable  through the UEFI Runtime Service GetVariable().  The\r
@@ -732,9 +729,9 @@ GetVariable2 (
 EFI_STATUS\r
 EFIAPI\r
 GetEfiGlobalVariable2 (\r
-  IN CONST CHAR16    *Name,\r
-  OUT VOID           **Value,\r
-  OUT UINTN          *Size OPTIONAL\r
+  IN CONST CHAR16  *Name,\r
+  OUT VOID         **Value,\r
+  OUT UINTN        *Size OPTIONAL\r
   );\r
 \r
 /** Return the attributes of the variable.\r
@@ -762,12 +759,12 @@ GetEfiGlobalVariable2 (
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-GetVariable3(\r
-  IN CONST CHAR16       *Name,\r
-  IN CONST EFI_GUID     *Guid,\r
-     OUT VOID           **Value,\r
-     OUT UINTN          *Size OPTIONAL,\r
-     OUT UINT32         *Attr OPTIONAL\r
+GetVariable3 (\r
+  IN CONST CHAR16    *Name,\r
+  IN CONST EFI_GUID  *Guid,\r
+  OUT VOID           **Value,\r
+  OUT UINTN          *Size OPTIONAL,\r
+  OUT UINT32         *Attr OPTIONAL\r
   );\r
 \r
 /**\r
@@ -889,6 +886,7 @@ UnicodeStringDisplayLength (
 //\r
 // Functions that abstract early Framework contamination of UEFI.\r
 //\r
+\r
 /**\r
   Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().\r
 \r
@@ -1174,7 +1172,6 @@ AsciiErrorPrint (
   ...\r
   );\r
 \r
-\r
 /**\r
   Prints a formatted Unicode string to a graphics console device specified by\r
   ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r
@@ -1218,11 +1215,11 @@ AsciiErrorPrint (
 UINTN\r
 EFIAPI\r
 PrintXY (\r
-  IN UINTN                            PointX,\r
-  IN UINTN                            PointY,\r
-  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround  OPTIONAL,\r
-  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround  OPTIONAL,\r
-  IN CONST CHAR16                     *Format,\r
+  IN UINTN                          PointX,\r
+  IN UINTN                          PointY,\r
+  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *ForeGround  OPTIONAL,\r
+  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *BackGround  OPTIONAL,\r
+  IN CONST CHAR16                   *Format,\r
   ...\r
   );\r
 \r
@@ -1268,15 +1265,14 @@ PrintXY (
 UINTN\r
 EFIAPI\r
 AsciiPrintXY (\r
-  IN UINTN                            PointX,\r
-  IN UINTN                            PointY,\r
-  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround  OPTIONAL,\r
-  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround  OPTIONAL,\r
-  IN CONST CHAR8                      *Format,\r
+  IN UINTN                          PointX,\r
+  IN UINTN                          PointY,\r
+  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *ForeGround  OPTIONAL,\r
+  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *BackGround  OPTIONAL,\r
+  IN CONST CHAR8                    *Format,\r
   ...\r
   );\r
 \r
-\r
 /**\r
   Installs and completes the initialization of a Driver Binding Protocol instance.\r
 \r
@@ -1308,7 +1304,6 @@ EfiLibInstallDriverBinding (
   IN EFI_HANDLE                   DriverBindingHandle\r
   );\r
 \r
-\r
 /**\r
   Uninstalls a Driver Binding Protocol instance.\r
 \r
@@ -1327,7 +1322,6 @@ EfiLibUninstallDriverBinding (
   IN EFI_DRIVER_BINDING_PROTOCOL  *DriverBinding\r
   );\r
 \r
-\r
 /**\r
   Installs and completes the initialization of a Driver Binding Protocol instance and\r
   optionally installs the Component Name, Driver Configuration and Driver Diagnostics Protocols.\r
@@ -1366,7 +1360,6 @@ EfiLibInstallAllDriverProtocols (
   IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL    *DriverDiagnostics    OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Uninstalls a Driver Binding Protocol instance and optionally uninstalls the\r
   Component Name, Driver Configuration and Driver Diagnostics Protocols.\r
@@ -1392,7 +1385,6 @@ EfiLibUninstallAllDriverProtocols (
   IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL    *DriverDiagnostics    OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Installs Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.\r
 \r
@@ -1419,15 +1411,14 @@ EfiLibUninstallAllDriverProtocols (
 EFI_STATUS\r
 EFIAPI\r
 EfiLibInstallDriverBindingComponentName2 (\r
-  IN CONST EFI_HANDLE                         ImageHandle,\r
-  IN CONST EFI_SYSTEM_TABLE                   *SystemTable,\r
-  IN EFI_DRIVER_BINDING_PROTOCOL              *DriverBinding,\r
-  IN EFI_HANDLE                               DriverBindingHandle,\r
-  IN CONST EFI_COMPONENT_NAME_PROTOCOL        *ComponentName        OPTIONAL,\r
-  IN CONST EFI_COMPONENT_NAME2_PROTOCOL       *ComponentName2       OPTIONAL\r
+  IN CONST EFI_HANDLE                    ImageHandle,\r
+  IN CONST EFI_SYSTEM_TABLE              *SystemTable,\r
+  IN EFI_DRIVER_BINDING_PROTOCOL         *DriverBinding,\r
+  IN EFI_HANDLE                          DriverBindingHandle,\r
+  IN CONST EFI_COMPONENT_NAME_PROTOCOL   *ComponentName        OPTIONAL,\r
+  IN CONST EFI_COMPONENT_NAME2_PROTOCOL  *ComponentName2       OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Uninstalls Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.\r
 \r
@@ -1445,12 +1436,11 @@ EfiLibInstallDriverBindingComponentName2 (
 EFI_STATUS\r
 EFIAPI\r
 EfiLibUninstallDriverBindingComponentName2 (\r
-  IN EFI_DRIVER_BINDING_PROTOCOL              *DriverBinding,\r
-  IN CONST EFI_COMPONENT_NAME_PROTOCOL        *ComponentName        OPTIONAL,\r
-  IN CONST EFI_COMPONENT_NAME2_PROTOCOL       *ComponentName2       OPTIONAL\r
+  IN EFI_DRIVER_BINDING_PROTOCOL         *DriverBinding,\r
+  IN CONST EFI_COMPONENT_NAME_PROTOCOL   *ComponentName        OPTIONAL,\r
+  IN CONST EFI_COMPONENT_NAME2_PROTOCOL  *ComponentName2       OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Installs Driver Binding Protocol with optional Component Name, Component Name 2, Driver\r
   Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.\r
@@ -1483,19 +1473,18 @@ EfiLibUninstallDriverBindingComponentName2 (
 EFI_STATUS\r
 EFIAPI\r
 EfiLibInstallAllDriverProtocols2 (\r
-  IN CONST EFI_HANDLE                         ImageHandle,\r
-  IN CONST EFI_SYSTEM_TABLE                   *SystemTable,\r
-  IN EFI_DRIVER_BINDING_PROTOCOL              *DriverBinding,\r
-  IN EFI_HANDLE                               DriverBindingHandle,\r
-  IN CONST EFI_COMPONENT_NAME_PROTOCOL        *ComponentName         OPTIONAL,\r
-  IN CONST EFI_COMPONENT_NAME2_PROTOCOL       *ComponentName2        OPTIONAL,\r
-  IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL  *DriverConfiguration   OPTIONAL,\r
-  IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2  OPTIONAL,\r
-  IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL    *DriverDiagnostics     OPTIONAL,\r
-  IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL   *DriverDiagnostics2    OPTIONAL\r
+  IN CONST EFI_HANDLE                          ImageHandle,\r
+  IN CONST EFI_SYSTEM_TABLE                    *SystemTable,\r
+  IN EFI_DRIVER_BINDING_PROTOCOL               *DriverBinding,\r
+  IN EFI_HANDLE                                DriverBindingHandle,\r
+  IN CONST EFI_COMPONENT_NAME_PROTOCOL         *ComponentName         OPTIONAL,\r
+  IN CONST EFI_COMPONENT_NAME2_PROTOCOL        *ComponentName2        OPTIONAL,\r
+  IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL   *DriverConfiguration   OPTIONAL,\r
+  IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL  *DriverConfiguration2  OPTIONAL,\r
+  IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL     *DriverDiagnostics     OPTIONAL,\r
+  IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL    *DriverDiagnostics2    OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Uninstalls Driver Binding Protocol with optional Component Name, Component Name 2, Driver\r
   Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.\r
@@ -1519,16 +1508,15 @@ EfiLibInstallAllDriverProtocols2 (
 EFI_STATUS\r
 EFIAPI\r
 EfiLibUninstallAllDriverProtocols2 (\r
-  IN EFI_DRIVER_BINDING_PROTOCOL              *DriverBinding,\r
-  IN CONST EFI_COMPONENT_NAME_PROTOCOL        *ComponentName         OPTIONAL,\r
-  IN CONST EFI_COMPONENT_NAME2_PROTOCOL       *ComponentName2        OPTIONAL,\r
-  IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL  *DriverConfiguration   OPTIONAL,\r
-  IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL *DriverConfiguration2  OPTIONAL,\r
-  IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL    *DriverDiagnostics     OPTIONAL,\r
-  IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL   *DriverDiagnostics2    OPTIONAL\r
+  IN EFI_DRIVER_BINDING_PROTOCOL               *DriverBinding,\r
+  IN CONST EFI_COMPONENT_NAME_PROTOCOL         *ComponentName         OPTIONAL,\r
+  IN CONST EFI_COMPONENT_NAME2_PROTOCOL        *ComponentName2        OPTIONAL,\r
+  IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL   *DriverConfiguration   OPTIONAL,\r
+  IN CONST EFI_DRIVER_CONFIGURATION2_PROTOCOL  *DriverConfiguration2  OPTIONAL,\r
+  IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL     *DriverDiagnostics     OPTIONAL,\r
+  IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL    *DriverDiagnostics2    OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Appends a formatted Unicode string to a Null-terminated Unicode string\r
 \r
@@ -1550,10 +1538,10 @@ EfiLibUninstallAllDriverProtocols2 (
   @return         Null-terminated Unicode string is that is the formatted\r
                   string appended to String.\r
 **/\r
-CHAR16*\r
+CHAR16 *\r
 EFIAPI\r
 CatVSPrint (\r
-  IN  CHAR16  *String  OPTIONAL,\r
+  IN  CHAR16        *String  OPTIONAL,\r
   IN  CONST CHAR16  *FormatString,\r
   IN  VA_LIST       Marker\r
   );\r
@@ -1584,7 +1572,7 @@ CatVSPrint (
 CHAR16 *\r
 EFIAPI\r
 CatSPrint (\r
-  IN  CHAR16  *String  OPTIONAL,\r
+  IN  CHAR16        *String  OPTIONAL,\r
   IN  CONST CHAR16  *FormatString,\r
   ...\r
   );\r
@@ -1731,8 +1719,8 @@ EfiOpenFileByDevicePath (
 EFI_ACPI_COMMON_HEADER *\r
 EFIAPI\r
 EfiLocateNextAcpiTable (\r
-  IN UINT32                     Signature,\r
-  IN EFI_ACPI_COMMON_HEADER     *PreviousTable OPTIONAL\r
+  IN UINT32                  Signature,\r
+  IN EFI_ACPI_COMMON_HEADER  *PreviousTable OPTIONAL\r
   );\r
 \r
 /**\r
@@ -1755,7 +1743,7 @@ EfiLocateNextAcpiTable (
 EFI_ACPI_COMMON_HEADER *\r
 EFIAPI\r
 EfiLocateFirstAcpiTable (\r
-  IN UINT32                     Signature\r
+  IN UINT32  Signature\r
   );\r
 \r
 #endif\r
EFI Development Kit II mirror for PVE