]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/FirmwareVolume2.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolume2.h
index 07923246094cdf29a2ea2859ee9793ae624b1e77..93749c82fdc2d065ab8d93299afe3b5a67c12728 100644 (file)
 \r
 typedef struct _EFI_FIRMWARE_VOLUME2_PROTOCOL EFI_FIRMWARE_VOLUME2_PROTOCOL;\r
 \r
-\r
 ///\r
 /// EFI_FV_ATTRIBUTES\r
 ///\r
-typedef UINT64  EFI_FV_ATTRIBUTES;\r
+typedef UINT64 EFI_FV_ATTRIBUTES;\r
 \r
 //\r
 // EFI_FV_ATTRIBUTES bit definitions\r
 //\r
 // EFI_FV_ATTRIBUTES bit semantics\r
-#define EFI_FV2_READ_DISABLE_CAP        0x0000000000000001ULL\r
-#define EFI_FV2_READ_ENABLE_CAP         0x0000000000000002ULL\r
-#define EFI_FV2_READ_STATUS             0x0000000000000004ULL\r
-#define EFI_FV2_WRITE_DISABLE_CAP       0x0000000000000008ULL\r
-#define EFI_FV2_WRITE_ENABLE_CAP        0x0000000000000010ULL\r
-#define EFI_FV2_WRITE_STATUS            0x0000000000000020ULL\r
-#define EFI_FV2_LOCK_CAP                0x0000000000000040ULL\r
-#define EFI_FV2_LOCK_STATUS             0x0000000000000080ULL\r
-#define EFI_FV2_WRITE_POLICY_RELIABLE   0x0000000000000100ULL\r
-#define EFI_FV2_READ_LOCK_CAP           0x0000000000001000ULL\r
-#define EFI_FV2_READ_LOCK_STATUS        0x0000000000002000ULL\r
-#define EFI_FV2_WRITE_LOCK_CAP          0x0000000000004000ULL\r
-#define EFI_FV2_WRITE_LOCK_STATUS       0x0000000000008000ULL\r
-#define EFI_FV2_ALIGNMENT               0x00000000001F0000ULL\r
-#define EFI_FV2_ALIGNMENT_1             0x0000000000000000ULL\r
-#define EFI_FV2_ALIGNMENT_2             0x0000000000010000ULL\r
-#define EFI_FV2_ALIGNMENT_4             0x0000000000020000ULL\r
-#define EFI_FV2_ALIGNMENT_8             0x0000000000030000ULL\r
-#define EFI_FV2_ALIGNMENT_16            0x0000000000040000ULL\r
-#define EFI_FV2_ALIGNMENT_32            0x0000000000050000ULL\r
-#define EFI_FV2_ALIGNMENT_64            0x0000000000060000ULL\r
-#define EFI_FV2_ALIGNMENT_128           0x0000000000070000ULL\r
-#define EFI_FV2_ALIGNMENT_256           0x0000000000080000ULL\r
-#define EFI_FV2_ALIGNMENT_512           0x0000000000090000ULL\r
-#define EFI_FV2_ALIGNMENT_1K            0x00000000000A0000ULL\r
-#define EFI_FV2_ALIGNMENT_2K            0x00000000000B0000ULL\r
-#define EFI_FV2_ALIGNMENT_4K            0x00000000000C0000ULL\r
-#define EFI_FV2_ALIGNMENT_8K            0x00000000000D0000ULL\r
-#define EFI_FV2_ALIGNMENT_16K           0x00000000000E0000ULL\r
-#define EFI_FV2_ALIGNMENT_32K           0x00000000000F0000ULL\r
-#define EFI_FV2_ALIGNMENT_64K           0x0000000000100000ULL\r
-#define EFI_FV2_ALIGNMENT_128K          0x0000000000110000ULL\r
-#define EFI_FV2_ALIGNMENT_256K          0x0000000000120000ULL\r
-#define EFI_FV2_ALIGNMENT_512K          0x0000000000130000ULL\r
-#define EFI_FV2_ALIGNMENT_1M            0x0000000000140000ULL\r
-#define EFI_FV2_ALIGNMENT_2M            0x0000000000150000ULL\r
-#define EFI_FV2_ALIGNMENT_4M            0x0000000000160000ULL\r
-#define EFI_FV2_ALIGNMENT_8M            0x0000000000170000ULL\r
-#define EFI_FV2_ALIGNMENT_16M           0x0000000000180000ULL\r
-#define EFI_FV2_ALIGNMENT_32M           0x0000000000190000ULL\r
-#define EFI_FV2_ALIGNMENT_64M           0x00000000001A0000ULL\r
-#define EFI_FV2_ALIGNMENT_128M          0x00000000001B0000ULL\r
-#define EFI_FV2_ALIGNMENT_256M          0x00000000001C0000ULL\r
-#define EFI_FV2_ALIGNMENT_512M          0x00000000001D0000ULL\r
-#define EFI_FV2_ALIGNMENT_1G            0x00000000001E0000ULL\r
-#define EFI_FV2_ALIGNMENT_2G            0x00000000001F0000ULL\r
+#define EFI_FV2_READ_DISABLE_CAP       0x0000000000000001ULL\r
+#define EFI_FV2_READ_ENABLE_CAP        0x0000000000000002ULL\r
+#define EFI_FV2_READ_STATUS            0x0000000000000004ULL\r
+#define EFI_FV2_WRITE_DISABLE_CAP      0x0000000000000008ULL\r
+#define EFI_FV2_WRITE_ENABLE_CAP       0x0000000000000010ULL\r
+#define EFI_FV2_WRITE_STATUS           0x0000000000000020ULL\r
+#define EFI_FV2_LOCK_CAP               0x0000000000000040ULL\r
+#define EFI_FV2_LOCK_STATUS            0x0000000000000080ULL\r
+#define EFI_FV2_WRITE_POLICY_RELIABLE  0x0000000000000100ULL\r
+#define EFI_FV2_READ_LOCK_CAP          0x0000000000001000ULL\r
+#define EFI_FV2_READ_LOCK_STATUS       0x0000000000002000ULL\r
+#define EFI_FV2_WRITE_LOCK_CAP         0x0000000000004000ULL\r
+#define EFI_FV2_WRITE_LOCK_STATUS      0x0000000000008000ULL\r
+#define EFI_FV2_ALIGNMENT              0x00000000001F0000ULL\r
+#define EFI_FV2_ALIGNMENT_1            0x0000000000000000ULL\r
+#define EFI_FV2_ALIGNMENT_2            0x0000000000010000ULL\r
+#define EFI_FV2_ALIGNMENT_4            0x0000000000020000ULL\r
+#define EFI_FV2_ALIGNMENT_8            0x0000000000030000ULL\r
+#define EFI_FV2_ALIGNMENT_16           0x0000000000040000ULL\r
+#define EFI_FV2_ALIGNMENT_32           0x0000000000050000ULL\r
+#define EFI_FV2_ALIGNMENT_64           0x0000000000060000ULL\r
+#define EFI_FV2_ALIGNMENT_128          0x0000000000070000ULL\r
+#define EFI_FV2_ALIGNMENT_256          0x0000000000080000ULL\r
+#define EFI_FV2_ALIGNMENT_512          0x0000000000090000ULL\r
+#define EFI_FV2_ALIGNMENT_1K           0x00000000000A0000ULL\r
+#define EFI_FV2_ALIGNMENT_2K           0x00000000000B0000ULL\r
+#define EFI_FV2_ALIGNMENT_4K           0x00000000000C0000ULL\r
+#define EFI_FV2_ALIGNMENT_8K           0x00000000000D0000ULL\r
+#define EFI_FV2_ALIGNMENT_16K          0x00000000000E0000ULL\r
+#define EFI_FV2_ALIGNMENT_32K          0x00000000000F0000ULL\r
+#define EFI_FV2_ALIGNMENT_64K          0x0000000000100000ULL\r
+#define EFI_FV2_ALIGNMENT_128K         0x0000000000110000ULL\r
+#define EFI_FV2_ALIGNMENT_256K         0x0000000000120000ULL\r
+#define EFI_FV2_ALIGNMENT_512K         0x0000000000130000ULL\r
+#define EFI_FV2_ALIGNMENT_1M           0x0000000000140000ULL\r
+#define EFI_FV2_ALIGNMENT_2M           0x0000000000150000ULL\r
+#define EFI_FV2_ALIGNMENT_4M           0x0000000000160000ULL\r
+#define EFI_FV2_ALIGNMENT_8M           0x0000000000170000ULL\r
+#define EFI_FV2_ALIGNMENT_16M          0x0000000000180000ULL\r
+#define EFI_FV2_ALIGNMENT_32M          0x0000000000190000ULL\r
+#define EFI_FV2_ALIGNMENT_64M          0x00000000001A0000ULL\r
+#define EFI_FV2_ALIGNMENT_128M         0x00000000001B0000ULL\r
+#define EFI_FV2_ALIGNMENT_256M         0x00000000001C0000ULL\r
+#define EFI_FV2_ALIGNMENT_512M         0x00000000001D0000ULL\r
+#define EFI_FV2_ALIGNMENT_1G           0x00000000001E0000ULL\r
+#define EFI_FV2_ALIGNMENT_2G           0x00000000001F0000ULL\r
 \r
 /**\r
   Returns the attributes and current settings of the firmware volume.\r
@@ -104,11 +103,10 @@ typedef UINT64  EFI_FV_ATTRIBUTES;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * EFI_FV_GET_ATTRIBUTES)(\r
+(EFIAPI *EFI_FV_GET_ATTRIBUTES)(\r
   IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   OUT       EFI_FV_ATTRIBUTES             *FvAttributes\r
-);\r
-\r
+  );\r
 \r
 /**\r
   Modifies the current settings of the firmware volume according to the input parameter.\r
@@ -199,11 +197,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * EFI_FV_SET_ATTRIBUTES)(\r
+(EFIAPI *EFI_FV_SET_ATTRIBUTES)(\r
   IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   IN OUT    EFI_FV_ATTRIBUTES             *FvAttributes\r
-);\r
-\r
+  );\r
 \r
 /**\r
   Retrieves a file and/or file information from the firmware volume.\r
@@ -294,7 +291,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * EFI_FV_READ_FILE)(\r
+(EFIAPI *EFI_FV_READ_FILE)(\r
   IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   IN CONST  EFI_GUID                      *NameGuid,\r
   IN OUT    VOID                          **Buffer,\r
@@ -302,9 +299,7 @@ EFI_STATUS
   OUT       EFI_FV_FILETYPE               *FoundType,\r
   OUT       EFI_FV_FILE_ATTRIBUTES        *FileAttributes,\r
   OUT       UINT32                        *AuthenticationStatus\r
-);\r
-\r
-\r
+  );\r
 \r
 /**\r
   Locates the requested section within a file and returns it in a buffer.\r
@@ -402,7 +397,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * EFI_FV_READ_SECTION)(\r
+(EFIAPI *EFI_FV_READ_SECTION)(\r
   IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   IN CONST  EFI_GUID                      *NameGuid,\r
   IN        EFI_SECTION_TYPE              SectionType,\r
@@ -410,14 +405,14 @@ EFI_STATUS
   IN OUT    VOID                          **Buffer,\r
   IN OUT    UINTN                         *BufferSize,\r
   OUT       UINT32                        *AuthenticationStatus\r
-);\r
+  );\r
 \r
 ///\r
 /// EFI_FV_WRITE_POLICY, two policies (unreliable write and reliable write) are defined.\r
 ///\r
 typedef UINT32 EFI_FV_WRITE_POLICY;\r
-#define EFI_FV_UNRELIABLE_WRITE   0x00000000\r
-#define EFI_FV_RELIABLE_WRITE     0x00000001\r
+#define EFI_FV_UNRELIABLE_WRITE  0x00000000\r
+#define EFI_FV_RELIABLE_WRITE    0x00000001\r
 \r
 //\r
 // EFI_FV_WRITE_FILE_DATA\r
@@ -426,23 +421,23 @@ typedef struct {
   ///\r
   /// Pointer to a GUID, which is the file name to be written.\r
   ///\r
-  EFI_GUID                *NameGuid;\r
+  EFI_GUID                  *NameGuid;\r
   ///\r
   /// Indicates the type of file to be written.\r
   ///\r
-  EFI_FV_FILETYPE         Type;\r
+  EFI_FV_FILETYPE           Type;\r
   ///\r
   /// Indicates the attributes for the file to be written.\r
   ///\r
-  EFI_FV_FILE_ATTRIBUTES  FileAttributes;\r
+  EFI_FV_FILE_ATTRIBUTES    FileAttributes;\r
   ///\r
   /// Pointer to a buffer containing the file to be written.\r
   ///\r
-  VOID                    *Buffer;\r
+  VOID                      *Buffer;\r
   ///\r
   /// Indicates the size of the file image contained in Buffer.\r
   ///\r
-  UINT32                  BufferSize;\r
+  UINT32                    BufferSize;\r
 } EFI_FV_WRITE_FILE_DATA;\r
 \r
 /**\r
@@ -513,13 +508,12 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * EFI_FV_WRITE_FILE)(\r
+(EFIAPI *EFI_FV_WRITE_FILE)(\r
   IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   IN        UINT32                        NumberOfFiles,\r
   IN        EFI_FV_WRITE_POLICY           WritePolicy,\r
   IN        EFI_FV_WRITE_FILE_DATA        *FileData\r
-);\r
-\r
+  );\r
 \r
 /**\r
   Retrieves information about the next file in the firmware volume store\r
@@ -598,14 +592,14 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI * EFI_FV_GET_NEXT_FILE)(\r
+(EFIAPI *EFI_FV_GET_NEXT_FILE)(\r
   IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   IN OUT    VOID                          *Key,\r
   IN OUT    EFI_FV_FILETYPE               *FileType,\r
   OUT       EFI_GUID                      *NameGuid,\r
   OUT       EFI_FV_FILE_ATTRIBUTES        *Attributes,\r
   OUT       UINTN                         *Size\r
-);\r
+  );\r
 \r
 /**\r
   Return information about a firmware volume.\r
@@ -661,8 +655,7 @@ EFI_STATUS
   IN CONST  EFI_GUID                      *InformationType,\r
   IN OUT    UINTN                         *BufferSize,\r
   OUT       VOID                          *Buffer\r
-);\r
-\r
+  );\r
 \r
 /**\r
   Sets information about a firmware volume.\r
@@ -711,8 +704,7 @@ EFI_STATUS
   IN CONST  EFI_GUID                      *InformationType,\r
   IN        UINTN                         BufferSize,\r
   IN CONST  VOID                          *Buffer\r
-);\r
-\r
+  );\r
 \r
 ///\r
 /// The Firmware Volume Protocol contains the file-level\r
@@ -728,29 +720,28 @@ EFI_STATUS
 /// Protocol.\r
 ///\r
 struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {\r
-  EFI_FV_GET_ATTRIBUTES   GetVolumeAttributes;\r
-  EFI_FV_SET_ATTRIBUTES   SetVolumeAttributes;\r
-  EFI_FV_READ_FILE        ReadFile;\r
-  EFI_FV_READ_SECTION     ReadSection;\r
-  EFI_FV_WRITE_FILE       WriteFile;\r
-  EFI_FV_GET_NEXT_FILE    GetNextFile;\r
+  EFI_FV_GET_ATTRIBUTES    GetVolumeAttributes;\r
+  EFI_FV_SET_ATTRIBUTES    SetVolumeAttributes;\r
+  EFI_FV_READ_FILE         ReadFile;\r
+  EFI_FV_READ_SECTION      ReadSection;\r
+  EFI_FV_WRITE_FILE        WriteFile;\r
+  EFI_FV_GET_NEXT_FILE     GetNextFile;\r
 \r
   ///\r
   /// Data field that indicates the size in bytes\r
   /// of the Key input buffer for the\r
   /// GetNextFile() API.\r
   ///\r
-  UINT32                  KeySize;\r
+  UINT32                   KeySize;\r
 \r
   ///\r
   /// Handle of the parent firmware volume.\r
   ///\r
-  EFI_HANDLE              ParentHandle;\r
-  EFI_FV_GET_INFO         GetInfo;\r
-  EFI_FV_SET_INFO         SetInfo;\r
+  EFI_HANDLE               ParentHandle;\r
+  EFI_FV_GET_INFO          GetInfo;\r
+  EFI_FV_SET_INFO          SetInfo;\r
 };\r
 \r
-\r
-extern EFI_GUID gEfiFirmwareVolume2ProtocolGuid;\r
+extern EFI_GUID  gEfiFirmwareVolume2ProtocolGuid;\r
 \r
 #endif\r