]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
MdeModulePkg: Apply uncrustify changes
[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / Variable.h
index 0b2bb6ae66481e7bb5236f9fc32632d1818e7e7c..31e408976a3502a38dfabe4451d0f41479dfbbca 100644 (file)
@@ -40,12 +40,12 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 \r
 #include "PrivilegePolymorphic.h"\r
 \r
-#define NV_STORAGE_VARIABLE_BASE (EFI_PHYSICAL_ADDRESS) \\r
+#define NV_STORAGE_VARIABLE_BASE  (EFI_PHYSICAL_ADDRESS)\\r
                                    (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ? \\r
                                     PcdGet64 (PcdFlashNvStorageVariableBase64) : \\r
                                     PcdGet32 (PcdFlashNvStorageVariableBase))\r
 \r
-#define EFI_VARIABLE_ATTRIBUTES_MASK (EFI_VARIABLE_NON_VOLATILE | \\r
+#define EFI_VARIABLE_ATTRIBUTES_MASK  (EFI_VARIABLE_NON_VOLATILE |\\r
                                       EFI_VARIABLE_BOOTSERVICE_ACCESS | \\r
                                       EFI_VARIABLE_RUNTIME_ACCESS | \\r
                                       EFI_VARIABLE_HARDWARE_ERROR_RECORD | \\r
@@ -55,7 +55,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 ///\r
 /// The size of a 3 character ISO639 language code.\r
 ///\r
-#define ISO_639_2_ENTRY_SIZE    3\r
+#define ISO_639_2_ENTRY_SIZE  3\r
 \r
 typedef enum {\r
   VariableStoreTypeVolatile,\r
@@ -65,65 +65,65 @@ typedef enum {
 } VARIABLE_STORE_TYPE;\r
 \r
 typedef struct {\r
-  UINT32                  PendingUpdateOffset;\r
-  UINT32                  PendingUpdateLength;\r
-  VARIABLE_STORE_HEADER   *Store;\r
+  UINT32                   PendingUpdateOffset;\r
+  UINT32                   PendingUpdateLength;\r
+  VARIABLE_STORE_HEADER    *Store;\r
 } VARIABLE_RUNTIME_CACHE;\r
 \r
 typedef struct {\r
-  BOOLEAN                 *ReadLock;\r
-  BOOLEAN                 *PendingUpdate;\r
-  BOOLEAN                 *HobFlushComplete;\r
-  VARIABLE_RUNTIME_CACHE  VariableRuntimeHobCache;\r
-  VARIABLE_RUNTIME_CACHE  VariableRuntimeNvCache;\r
-  VARIABLE_RUNTIME_CACHE  VariableRuntimeVolatileCache;\r
+  BOOLEAN                   *ReadLock;\r
+  BOOLEAN                   *PendingUpdate;\r
+  BOOLEAN                   *HobFlushComplete;\r
+  VARIABLE_RUNTIME_CACHE    VariableRuntimeHobCache;\r
+  VARIABLE_RUNTIME_CACHE    VariableRuntimeNvCache;\r
+  VARIABLE_RUNTIME_CACHE    VariableRuntimeVolatileCache;\r
 } VARIABLE_RUNTIME_CACHE_CONTEXT;\r
 \r
 typedef struct {\r
-  VARIABLE_HEADER *CurrPtr;\r
+  VARIABLE_HEADER    *CurrPtr;\r
   //\r
   // If both ADDED and IN_DELETED_TRANSITION variable are present,\r
   // InDeletedTransitionPtr will point to the IN_DELETED_TRANSITION one.\r
   // Otherwise, CurrPtr will point to the ADDED or IN_DELETED_TRANSITION one,\r
   // and InDeletedTransitionPtr will be NULL at the same time.\r
   //\r
-  VARIABLE_HEADER *InDeletedTransitionPtr;\r
-  VARIABLE_HEADER *EndPtr;\r
-  VARIABLE_HEADER *StartPtr;\r
-  BOOLEAN         Volatile;\r
+  VARIABLE_HEADER    *InDeletedTransitionPtr;\r
+  VARIABLE_HEADER    *EndPtr;\r
+  VARIABLE_HEADER    *StartPtr;\r
+  BOOLEAN            Volatile;\r
 } VARIABLE_POINTER_TRACK;\r
 \r
 typedef struct {\r
-  EFI_PHYSICAL_ADDRESS            HobVariableBase;\r
-  EFI_PHYSICAL_ADDRESS            VolatileVariableBase;\r
-  EFI_PHYSICAL_ADDRESS            NonVolatileVariableBase;\r
-  VARIABLE_RUNTIME_CACHE_CONTEXT  VariableRuntimeCacheContext;\r
-  EFI_LOCK                        VariableServicesLock;\r
-  UINT32                          ReentrantState;\r
-  BOOLEAN                         AuthFormat;\r
-  BOOLEAN                         AuthSupport;\r
-  BOOLEAN                         EmuNvMode;\r
+  EFI_PHYSICAL_ADDRESS              HobVariableBase;\r
+  EFI_PHYSICAL_ADDRESS              VolatileVariableBase;\r
+  EFI_PHYSICAL_ADDRESS              NonVolatileVariableBase;\r
+  VARIABLE_RUNTIME_CACHE_CONTEXT    VariableRuntimeCacheContext;\r
+  EFI_LOCK                          VariableServicesLock;\r
+  UINT32                            ReentrantState;\r
+  BOOLEAN                           AuthFormat;\r
+  BOOLEAN                           AuthSupport;\r
+  BOOLEAN                           EmuNvMode;\r
 } VARIABLE_GLOBAL;\r
 \r
 typedef struct {\r
-  VARIABLE_GLOBAL VariableGlobal;\r
-  UINTN           VolatileLastVariableOffset;\r
-  UINTN           NonVolatileLastVariableOffset;\r
-  UINTN           CommonVariableSpace;\r
-  UINTN           CommonMaxUserVariableSpace;\r
-  UINTN           CommonRuntimeVariableSpace;\r
-  UINTN           CommonVariableTotalSize;\r
-  UINTN           CommonUserVariableTotalSize;\r
-  UINTN           HwErrVariableTotalSize;\r
-  UINTN           MaxVariableSize;\r
-  UINTN           MaxAuthVariableSize;\r
-  UINTN           MaxVolatileVariableSize;\r
-  UINTN           ScratchBufferSize;\r
-  CHAR8           *PlatformLangCodes;\r
-  CHAR8           *LangCodes;\r
-  CHAR8           *PlatformLang;\r
-  CHAR8           Lang[ISO_639_2_ENTRY_SIZE + 1];\r
-  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbInstance;\r
+  VARIABLE_GLOBAL                       VariableGlobal;\r
+  UINTN                                 VolatileLastVariableOffset;\r
+  UINTN                                 NonVolatileLastVariableOffset;\r
+  UINTN                                 CommonVariableSpace;\r
+  UINTN                                 CommonMaxUserVariableSpace;\r
+  UINTN                                 CommonRuntimeVariableSpace;\r
+  UINTN                                 CommonVariableTotalSize;\r
+  UINTN                                 CommonUserVariableTotalSize;\r
+  UINTN                                 HwErrVariableTotalSize;\r
+  UINTN                                 MaxVariableSize;\r
+  UINTN                                 MaxAuthVariableSize;\r
+  UINTN                                 MaxVolatileVariableSize;\r
+  UINTN                                 ScratchBufferSize;\r
+  CHAR8                                 *PlatformLangCodes;\r
+  CHAR8                                 *LangCodes;\r
+  CHAR8                                 *PlatformLang;\r
+  CHAR8                                 Lang[ISO_639_2_ENTRY_SIZE + 1];\r
+  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *FvbInstance;\r
 } VARIABLE_MODULE_GLOBAL;\r
 \r
 /**\r
@@ -135,8 +135,8 @@ typedef struct {
 **/\r
 VOID\r
 FlushHobVariableToFlash (\r
-  IN CHAR16                     *VariableName,\r
-  IN EFI_GUID                   *VendorGuid\r
+  IN CHAR16    *VariableName,\r
+  IN EFI_GUID  *VendorGuid\r
   );\r
 \r
 /**\r
@@ -218,8 +218,8 @@ FindVariable (
 BOOLEAN\r
 EFIAPI\r
 CheckRemainingSpaceForConsistencyInternal (\r
-  IN UINT32                     Attributes,\r
-  IN VA_LIST                    Marker\r
+  IN UINT32   Attributes,\r
+  IN VA_LIST  Marker\r
   );\r
 \r
 /**\r
@@ -243,18 +243,17 @@ CheckRemainingSpaceForConsistencyInternal (
 **/\r
 EFI_STATUS\r
 UpdateVariable (\r
-  IN      CHAR16          *VariableName,\r
-  IN      EFI_GUID        *VendorGuid,\r
-  IN      VOID            *Data,\r
-  IN      UINTN           DataSize,\r
-  IN      UINT32          Attributes OPTIONAL,\r
-  IN      UINT32          KeyIndex  OPTIONAL,\r
-  IN      UINT64          MonotonicCount  OPTIONAL,\r
-  IN OUT  VARIABLE_POINTER_TRACK *Variable,\r
-  IN      EFI_TIME        *TimeStamp  OPTIONAL\r
+  IN      CHAR16                  *VariableName,\r
+  IN      EFI_GUID                *VendorGuid,\r
+  IN      VOID                    *Data,\r
+  IN      UINTN                   DataSize,\r
+  IN      UINT32                  Attributes OPTIONAL,\r
+  IN      UINT32                  KeyIndex  OPTIONAL,\r
+  IN      UINT64                  MonotonicCount  OPTIONAL,\r
+  IN OUT  VARIABLE_POINTER_TRACK  *Variable,\r
+  IN      EFI_TIME                *TimeStamp  OPTIONAL\r
   );\r
 \r
-\r
 /**\r
   Return TRUE if ExitBootServices () has been called.\r
 \r
@@ -284,10 +283,9 @@ AtRuntime (
 EFI_LOCK *\r
 InitializeLock (\r
   IN OUT EFI_LOCK  *Lock,\r
-  IN EFI_TPL        Priority\r
+  IN EFI_TPL       Priority\r
   );\r
 \r
-\r
 /**\r
   Acquires lock only at boot time. Simply returns at runtime.\r
 \r
@@ -305,7 +303,6 @@ AcquireLockOnlyAtBootTime (
   IN EFI_LOCK  *Lock\r
   );\r
 \r
-\r
 /**\r
   Releases lock only at boot time. Simply returns at runtime.\r
 \r
@@ -358,8 +355,8 @@ GetFvbByHandle (
 **/\r
 EFI_STATUS\r
 GetFvbCountAndBuffer (\r
-  OUT UINTN                               *NumberHandles,\r
-  OUT EFI_HANDLE                          **Buffer\r
+  OUT UINTN       *NumberHandles,\r
+  OUT EFI_HANDLE  **Buffer\r
   );\r
 \r
 /**\r
@@ -379,7 +376,7 @@ VariableCommonInitialize (
 \r
 **/\r
 VOID\r
-ReclaimForOS(\r
+ReclaimForOS (\r
   VOID\r
   );\r
 \r
@@ -418,7 +415,7 @@ VariableWriteServiceInitialize (
 **/\r
 EFI_STATUS\r
 GetFtwProtocol (\r
-  OUT VOID                                **FtwProtocol\r
+  OUT VOID  **FtwProtocol\r
   );\r
 \r
 /**\r
@@ -461,11 +458,11 @@ GetFvbInfoByAddress (
 EFI_STATUS\r
 EFIAPI\r
 VariableServiceGetVariable (\r
-  IN      CHAR16            *VariableName,\r
-  IN      EFI_GUID          *VendorGuid,\r
-  OUT     UINT32            *Attributes OPTIONAL,\r
-  IN OUT  UINTN             *DataSize,\r
-  OUT     VOID              *Data OPTIONAL\r
+  IN      CHAR16    *VariableName,\r
+  IN      EFI_GUID  *VendorGuid,\r
+  OUT     UINT32    *Attributes OPTIONAL,\r
+  IN OUT  UINTN     *DataSize,\r
+  OUT     VOID      *Data OPTIONAL\r
   );\r
 \r
 /**\r
@@ -496,9 +493,9 @@ VariableServiceGetVariable (
 EFI_STATUS\r
 EFIAPI\r
 VariableServiceGetNextVariableName (\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
@@ -529,11 +526,11 @@ VariableServiceGetNextVariableName (
 EFI_STATUS\r
 EFIAPI\r
 VariableServiceSetVariable (\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
@@ -558,10 +555,10 @@ VariableServiceSetVariable (
 EFI_STATUS\r
 EFIAPI\r
 VariableServiceQueryVariableInfoInternal (\r
-  IN  UINT32                 Attributes,\r
-  OUT UINT64                 *MaximumVariableStorageSize,\r
-  OUT UINT64                 *RemainingVariableStorageSize,\r
-  OUT UINT64                 *MaximumVariableSize\r
+  IN  UINT32  Attributes,\r
+  OUT UINT64  *MaximumVariableStorageSize,\r
+  OUT UINT64  *RemainingVariableStorageSize,\r
+  OUT UINT64  *MaximumVariableSize\r
   );\r
 \r
 /**\r
@@ -588,10 +585,10 @@ VariableServiceQueryVariableInfoInternal (
 EFI_STATUS\r
 EFIAPI\r
 VariableServiceQueryVariableInfo (\r
-  IN  UINT32                 Attributes,\r
-  OUT UINT64                 *MaximumVariableStorageSize,\r
-  OUT UINT64                 *RemainingVariableStorageSize,\r
-  OUT UINT64                 *MaximumVariableSize\r
+  IN  UINT32  Attributes,\r
+  OUT UINT64  *MaximumVariableStorageSize,\r
+  OUT UINT64  *RemainingVariableStorageSize,\r
+  OUT UINT64  *MaximumVariableSize\r
   );\r
 \r
 /**\r
@@ -612,9 +609,9 @@ VariableServiceQueryVariableInfo (
 EFI_STATUS\r
 EFIAPI\r
 VariableLockRequestToLock (\r
-  IN CONST EDKII_VARIABLE_LOCK_PROTOCOL *This,\r
-  IN       CHAR16                       *VariableName,\r
-  IN       EFI_GUID                     *VendorGuid\r
+  IN CONST EDKII_VARIABLE_LOCK_PROTOCOL  *This,\r
+  IN       CHAR16                        *VariableName,\r
+  IN       EFI_GUID                      *VendorGuid\r
   );\r
 \r
 /**\r
@@ -634,7 +631,7 @@ VariableLockRequestToLock (
 EFI_STATUS\r
 EFIAPI\r
 VarCheckRegisterSetVariableCheckHandler (\r
-  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER   Handler\r
+  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER  Handler\r
   );\r
 \r
 /**\r
@@ -655,9 +652,9 @@ VarCheckRegisterSetVariableCheckHandler (
 EFI_STATUS\r
 EFIAPI\r
 VarCheckVariablePropertySet (\r
-  IN CHAR16                         *Name,\r
-  IN EFI_GUID                       *Guid,\r
-  IN VAR_CHECK_VARIABLE_PROPERTY    *VariableProperty\r
+  IN CHAR16                       *Name,\r
+  IN EFI_GUID                     *Guid,\r
+  IN VAR_CHECK_VARIABLE_PROPERTY  *VariableProperty\r
   );\r
 \r
 /**\r
@@ -675,9 +672,9 @@ VarCheckVariablePropertySet (
 EFI_STATUS\r
 EFIAPI\r
 VarCheckVariablePropertyGet (\r
-  IN CHAR16                         *Name,\r
-  IN EFI_GUID                       *Guid,\r
-  OUT VAR_CHECK_VARIABLE_PROPERTY   *VariableProperty\r
+  IN CHAR16                        *Name,\r
+  IN EFI_GUID                      *Guid,\r
+  OUT VAR_CHECK_VARIABLE_PROPERTY  *VariableProperty\r
   );\r
 \r
 /**\r
@@ -689,14 +686,14 @@ InitializeVariableQuota (
   VOID\r
   );\r
 \r
-extern VARIABLE_MODULE_GLOBAL       *mVariableModuleGlobal;\r
-extern EFI_FIRMWARE_VOLUME_HEADER   *mNvFvHeaderCache;\r
-extern VARIABLE_STORE_HEADER        *mNvVariableCache;\r
-extern VARIABLE_INFO_ENTRY          *gVariableInfo;\r
-extern BOOLEAN                      mEndOfDxe;\r
-extern VAR_CHECK_REQUEST_SOURCE     mRequestSource;\r
+extern VARIABLE_MODULE_GLOBAL      *mVariableModuleGlobal;\r
+extern EFI_FIRMWARE_VOLUME_HEADER  *mNvFvHeaderCache;\r
+extern VARIABLE_STORE_HEADER       *mNvVariableCache;\r
+extern VARIABLE_INFO_ENTRY         *gVariableInfo;\r
+extern BOOLEAN                     mEndOfDxe;\r
+extern VAR_CHECK_REQUEST_SOURCE    mRequestSource;\r
 \r
-extern AUTH_VAR_LIB_CONTEXT_OUT     mAuthContextOut;\r
+extern AUTH_VAR_LIB_CONTEXT_OUT  mAuthContextOut;\r
 \r
 /**\r
   Finds variable in storage blocks of volatile and non-volatile storage areas.\r
@@ -719,9 +716,9 @@ extern AUTH_VAR_LIB_CONTEXT_OUT     mAuthContextOut;
 EFI_STATUS\r
 EFIAPI\r
 VariableExLibFindVariable (\r
-  IN  CHAR16                *VariableName,\r
-  IN  EFI_GUID              *VendorGuid,\r
-  OUT AUTH_VARIABLE_INFO    *AuthVariableInfo\r
+  IN  CHAR16              *VariableName,\r
+  IN  EFI_GUID            *VendorGuid,\r
+  OUT AUTH_VARIABLE_INFO  *AuthVariableInfo\r
   );\r
 \r
 /**\r
@@ -745,9 +742,9 @@ VariableExLibFindVariable (
 EFI_STATUS\r
 EFIAPI\r
 VariableExLibFindNextVariable (\r
-  IN  CHAR16                *VariableName,\r
-  IN  EFI_GUID              *VendorGuid,\r
-  OUT AUTH_VARIABLE_INFO    *AuthVariableInfo\r
+  IN  CHAR16              *VariableName,\r
+  IN  EFI_GUID            *VendorGuid,\r
+  OUT AUTH_VARIABLE_INFO  *AuthVariableInfo\r
   );\r
 \r
 /**\r
@@ -765,7 +762,7 @@ VariableExLibFindNextVariable (
 EFI_STATUS\r
 EFIAPI\r
 VariableExLibUpdateVariable (\r
-  IN AUTH_VARIABLE_INFO     *AuthVariableInfo\r
+  IN AUTH_VARIABLE_INFO  *AuthVariableInfo\r
   );\r
 \r
 /**\r
@@ -783,8 +780,8 @@ VariableExLibUpdateVariable (
 EFI_STATUS\r
 EFIAPI\r
 VariableExLibGetScratchBuffer (\r
-  IN OUT UINTN      *ScratchBufferSize,\r
-  OUT    VOID       **ScratchBuffer\r
+  IN OUT UINTN  *ScratchBufferSize,\r
+  OUT    VOID   **ScratchBuffer\r
   );\r
 \r
 /**\r
@@ -809,7 +806,7 @@ VariableExLibGetScratchBuffer (
 BOOLEAN\r
 EFIAPI\r
 VariableExLibCheckRemainingSpaceForConsistency (\r
-  IN UINT32                     Attributes,\r
+  IN UINT32  Attributes,\r
   ...\r
   );\r
 \r