]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
IntelFrameworkPkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / ReadOnlyVariable.h
index 167e3a889240e81ad4bd607551369383e64fd699..67c6477020e8fb9cb2650c4146fe2ef42911a2a6 100644 (file)
@@ -7,13 +7,13 @@
   storage. As such, a write command to certain technologies would alter the contents of the entire part,\r
   making the PEIM execution in the original position not follow the required flow.\r
 \r
-Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2018, 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
+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
 \r
   @par Revision Reference:\r
@@ -38,17 +38,17 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
 #define EFI_VARIABLE_RUNTIME_ACCESS     0x00000004\r
 ///\r
-/// Inconsistent with specification here: \r
+/// Inconsistent with specification here:\r
 /// In Framework Spec, PeiCis0.91, neither the macro or its value is defined.\r
 /// Keeping this inconsistancy for backward compatibility.\r
-/// \r
+///\r
 #define EFI_VARIABLE_READ_ONLY          0x00000008\r
 ///@}\r
 \r
 /**\r
   Get Variable value by Name and GUID pair.\r
 \r
-  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published \r
+  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published\r
                              by the PEI Foundation.\r
   @param[in]  VariableName   A NULL-terminated Unicode string that is the name of the vendor's variable.\r
   @param[in]  VendorGuid     A unique identifier for the vendor.\r
@@ -84,22 +84,22 @@ EFI_STATUS
   and on output the interface returns the next variable name data.  When the\r
   entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r
 \r
-  @param[in]  PeiServices       An indirect pointer to the PEI Services Table \r
+  @param[in]  PeiServices       An indirect pointer to the PEI Services Table\r
                                 published by the PEI Foundation.\r
   @param[in]  VariableNameSize  The size of the VariableName buffer.\r
   @param[in]  VariableName      On input, supplies the last VariableName that was\r
-                                returned by GetNextVariableName(). On output, \r
-                                returns the Null-terminated Unicode string of the \r
+                                returned by GetNextVariableName(). On output,\r
+                                returns the Null-terminated Unicode string of the\r
                                 current variable.\r
   @param[in]  VendorGuid        On input, supplies the last VendorGuid that was\r
-                                returned by GetNextVariableName(). On output, \r
+                                returned by GetNextVariableName(). On output,\r
                                 returns the VendorGuid of the current variable.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The next variable was not found.\r
   @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to \r
+  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to\r
                                 a hardware error.\r
 \r
 **/\r
@@ -114,19 +114,19 @@ EFI_STATUS
 \r
 ///\r
 /// This PPI provides a lightweight, read-only variant of the full EFI\r
-/// variable services.  \r
+/// variable services.\r
 ///\r
 struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r
-       ///\r
-  /// Inconsistent with specification here: \r
+  ///\r
+  /// Inconsistent with specification here:\r
   /// In Framework Spec, PeiCis0.91, the field is named as GetVariable and GetNextVariableName.\r
   /// Keeping this inconsistancy for backward compatibility.\r
-       /// \r
+  ///\r
   EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.\r
   EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r
 \r
-#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */\r
+#endif  /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */\r
 \r