]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Ppi/ReadOnlyVariable2.h
Removed tabs and fixed some minor coding style issues. Also fixed typo in EFI_PEI_ENT...
[mirror_edk2.git] / MdePkg / Include / Ppi / ReadOnlyVariable2.h
index fb76ce29847cecfc86a72afc1f0a37696f8ebef4..fc7bf8eec86157e23b0c164b222cb9f3c6bd50a1 100644 (file)
 #define __PEI_READ_ONLY_VARIABLE2_PPI_H__\r
 \r
 #define EFI_PEI_READ_ONLY_VARIABLE2_PPI_GUID \\r
-       { 0x2ab86ef5, 0xecb5, 0x4134, { 0xb5, 0x56, 0x38, 0x54, 0xca, 0x1f, 0xe1, 0xb4 } }\r
+  { 0x2ab86ef5, 0xecb5, 0x4134, { 0xb5, 0x56, 0x38, 0x54, 0xca, 0x1f, 0xe1, 0xb4 } }\r
 \r
 \r
 typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI;\r
 \r
 /**\r
   Read the specified variable from the UEFI variable store. If the Data \r
-       buffer is too small to hold the contents of the variable, \r
-       the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the\r
-       required buffer size to obtain the data.\r
+  buffer is too small to hold the contents of the variable, \r
+  the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the\r
+  required buffer size to obtain the data.\r
 \r
-  @param  This                                 A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
+  @param  This            A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
 \r
-  @param  VariableName         A pointer to a null-terminated string that is the variable¡¯s name.\r
+  @param  VariableName    A pointer to a null-terminated string that is the variable¡¯s name.\r
 \r
-  @param  VendorGuid           A pointer to an EFI_GUID that is the variable¡¯s GUID. The combination of\r
-                                                                                                       VariableGuid and VariableName must be unique.\r
+  @param  VendorGuid      A pointer to an EFI_GUID that is the variable¡¯s GUID. The combination of\r
+                          VariableGuid and VariableName must be unique.\r
 \r
-  @param  Attributes           If non-NULL, on return, points to the variable¡¯s attributes. See ¡°Related Definitons¡±\r
-                                                                                                       below for possible attribute values.\r
+  @param  Attributes      If non-NULL, on return, points to the variable¡¯s attributes. See ¡°Related Definitons¡±\r
+                          below for possible attribute values.\r
 \r
-  @param  DataSize             On entry, points to the size in bytes of the Data buffer. On return, points to the size of\r
-                                                                                                       the data returned in Data.\r
+  @param  DataSize        On entry, points to the size in bytes of the Data buffer. On return, points to the size of\r
+                          the data returned in Data.\r
 \r
-  @param  Data                 Points to the buffer which will hold the returned variable value.\r
+  @param  Data            Points to the buffer which will hold the returned variable value.\r
 \r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
@@ -54,8 +54,8 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI
   @retval EFI_NOT_FOUND         The variable was not found.\r
 \r
   @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the resulting data. \r
-                                                                                                                               DataSize is updated with the size required for \r
-                                                                                                                               the specified variable.\r
+                                DataSize is updated with the size required for \r
+                                the specified variable.\r
 \r
   @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.\r
 \r
@@ -65,32 +65,32 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_GET_VARIABLE2)(\r
-       IN CONST        EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
-       IN CONST        CHAR16                                                                                                  *VariableName,\r
-       IN CONST        EFI_GUID                                                                                                *VariableGuid,\r
-       OUT                     UINT32                                                                                                  *Attributes,\r
-       IN OUT          UINTN                                                                                                   *DataSize,\r
-       OUT                     VOID                                                                                                            *Data\r
+  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
+  IN CONST  CHAR16                          *VariableName,\r
+  IN CONST  EFI_GUID                        *VariableGuid,\r
+  OUT       UINT32                          *Attributes,\r
+  IN OUT    UINTN                           *DataSize,\r
+  OUT       VOID                            *Data\r
 );\r
 \r
 \r
 /**\r
   This function is called multiple times to retrieve the VariableName \r
-       and VariableGuid of all variables currently available in the system. \r
-       On each call, the previous results are passed into the interface, \r
-       and, on return, the interface returns the data for the next \r
-       interface. When the entire variable list has been returned, \r
-       EFI_NOT_FOUND is returned.\r
+  and VariableGuid of all variables currently available in the system. \r
+  On each call, the previous results are passed into the interface, \r
+  and, on return, the interface returns the data for the next \r
+  interface. When the entire variable list has been returned, \r
+  EFI_NOT_FOUND is returned.\r
 \r
-  @param  This                                 A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
+  @param  This              A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
 \r
-  @param  VariableNameSize     On entry, points to the size of the buffer pointed to by VariableName.\r
+  @param  VariableNameSize  On entry, points to the size of the buffer pointed to by VariableName.\r
 \r
-  @param  VariableName         On entry, a pointer to a null-terminated string that is the variable¡¯s name.\r
-                                                                                                               On return, points to the next variable¡¯s null-terminated name string.\r
+  @param  VariableName      On entry, a pointer to a null-terminated string that is the variable¡¯s name.\r
+                            On return, points to the next variable¡¯s null-terminated name string.\r
 \r
-  @param  VendorGuid           On entry, a pointer to an UEFI _GUID that is the variable¡¯s GUID. \r
-                                                                                                               On return, a pointer to the next variable¡¯s GUID.\r
+  @param  VendorGuid        On entry, a pointer to an UEFI _GUID that is the variable¡¯s GUID. \r
+                            On return, a pointer to the next variable¡¯s GUID.\r
 \r
 \r
   @retval EFI_SUCCESS           The variable was read successfully.\r
@@ -98,11 +98,11 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The variable could not be found.\r
 \r
   @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the resulting\r
-                                                                                                                               data. VariableNameSize is updated with the size\r
-                                                                                                                               required for the specified variable.\r
+                                data. VariableNameSize is updated with the size\r
+                                required for the specified variable.\r
 \r
   @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or\r
-                                                                                                                               VariableNameSize is NULL.\r
+                                VariableNameSize is NULL.\r
 \r
   @retval EFI_DEVICE_ERROR      The variable could not be retrieved because of a device error.\r
 \r
@@ -110,10 +110,10 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_NEXT_VARIABLE_NAME2) (\r
-       IN CONST        EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
-       IN OUT          UINTN                                                                                                   *VariableNameSize,\r
-       IN OUT          CHAR16                                                                                                  *VariableName,\r
-       IN OUT          EFI_GUID                                                                                                *VariableGuid\r
+  IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r
+  IN OUT    UINTN                           *VariableNameSize,\r
+  IN OUT    CHAR16                          *VariableName,\r
+  IN OUT    EFI_GUID                        *VariableGuid\r
 );\r
 \r
 /**\r
@@ -128,8 +128,8 @@ EFI_STATUS
 \r
 **/\r
 struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI {\r
-       EFI_PEI_GET_VARIABLE2                   GetVariable;\r
-       EFI_PEI_NEXT_VARIABLE_NAME2     NextVariableName;\r
+  EFI_PEI_GET_VARIABLE2       GetVariable;\r
+  EFI_PEI_NEXT_VARIABLE_NAME2 NextVariableName;\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariable2PpiGuid;\r