]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/DataHub.h
IntelFrameworkPkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / DataHub.h
index eb828fc6f0519277b0e9ff680791696e18ba5e45..dbe99ae159b3574860aed713b1a15d315ac8cb48 100644 (file)
@@ -3,13 +3,13 @@
   data and those wishing to be made aware of all information that\r
   has been logged.  This protocol may only be called <= TPL_NOTIFY.\r
 \r
-Copyright (c) 2007 - 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) 2007 - 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
@@ -33,7 +33,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //  data. The format of the data is defined by the DataRecordGuid.\r
 //\r
 // If EFI_DATA_RECORD_HEADER is extended in the future, the Version number and HeaderSize must\r
-//  change. \r
+//  change.\r
 //\r
 // The logger is responcible for initializing:\r
 //  Version, HeaderSize, RecordSize, DataRecordGuid, DataRecordClass\r
@@ -99,27 +99,27 @@ EFI_STATUS
 \r
   @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
   @param  MonotonicCount        On input, it specifies the Record to return.\r
-                                An input of zero means to return the first record, \r
+                                An input of zero means to return the first record,\r
                                 as does an input of one.\r
   @param  FilterDriver          If FilterDriver is not passed in a MonotonicCount\r
-                                of zero, it means to return the first data record. \r
-                                If FilterDriver is passed in, then a MonotonicCount \r
+                                of zero, it means to return the first data record.\r
+                                If FilterDriver is passed in, then a MonotonicCount\r
                                 of zero means to return the first data not yet read\r
                                 by FilterDriver.\r
-  @param  Record                Returns a dynamically allocated memory buffer with \r
+  @param  Record                Returns a dynamically allocated memory buffer with\r
                                 a data record that matches MonotonicCount.\r
 \r
   @retval EFI_SUCCESS           Data was returned in Record.\r
   @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.\r
   @retval EFI_NOT_FOUND         MonotonicCount does not match any data record\r
-                                in the system. If a MonotonicCount of zero was \r
+                                in the system. If a MonotonicCount of zero was\r
                                 passed in, then no data records exist in the system.\r
   @retval EFI_OUT_OF_RESOURCES  Record was not returned due to lack\r
                                 of system resources.\r
-  @note  Inconsistent with specification here: \r
-         In Framework for EFI Data Hub Specification, Version 0.9, This definition \r
-         is named as EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is \r
-         maintained for backward compatibility. \r
+  @note  Inconsistent with specification here:\r
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition\r
+         is named as EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is\r
+         maintained for backward compatibility.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -136,28 +136,28 @@ EFI_STATUS
   @param  This                  The EFI_DATA_HUB_PROTOCOL instance.\r
   @param  FilterEvent           The EFI_EVENT to signal whenever data that matches\r
                                 FilterClass is logged in the system.\r
-  @param  FilterTpl             The maximum EFI_TPL at which FilterEvent can be \r
-                                signaled. It is strongly recommended that you use  \r
-                                the lowest EFI_TPL possible. \r
+  @param  FilterTpl             The maximum EFI_TPL at which FilterEvent can be\r
+                                signaled. It is strongly recommended that you use\r
+                                the lowest EFI_TPL possible.\r
   @param  FilterClass           FilterEvent will be signaled whenever a bit\r
-                                in EFI_DATA_RECORD_HEADER.DataRecordClass is also \r
-                                set in FilterClass. If FilterClass is zero, no \r
+                                in EFI_DATA_RECORD_HEADER.DataRecordClass is also\r
+                                set in FilterClass. If FilterClass is zero, no\r
                                 class-based filtering will be performed.\r
   @param  FilterDataRecordGuid  FilterEvent will be signaled whenever\r
-                                FilterDataRecordGuid matches \r
-                                EFI_DATA_RECORD_HEADER.DataRecordGuid. \r
-                                If FilterDataRecordGuid is NULL, then no GUID-based \r
+                                FilterDataRecordGuid matches\r
+                                EFI_DATA_RECORD_HEADER.DataRecordGuid.\r
+                                If FilterDataRecordGuid is NULL, then no GUID-based\r
                                 filtering will be performed.\r
 \r
   @retval EFI_SUCCESS           The filter driver event was registered\r
-  @retval EFI_ALREADY_STARTED   FilterEvent was previously registered and cannot \r
+  @retval EFI_ALREADY_STARTED   FilterEvent was previously registered and cannot\r
                                 be registered again.\r
   @retval EFI_OUT_OF_RESOURCES  The filter driver event was not registered\r
                                 due to lack of system resources.\r
-  @note  Inconsistent with specification here: \r
-         In Framework for EFI Data Hub Specification, Version 0.9, This definition \r
-         is named as EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency \r
-         is maintained for backward compatibility. \r
+  @note  Inconsistent with specification here:\r
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition\r
+         is named as EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency\r
+         is maintained for backward compatibility.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -178,10 +178,10 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The filter driver represented by FilterEvent was shut off.\r
   @retval EFI_NOT_FOUND         FilterEvent did not exist.\r
-  @note  Inconsistent with specification here: \r
-         In Framework for EFI Data Hub Specification, Version 0.9, This definition \r
-         is named as EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency \r
-         is maintained for backward compatibility.  \r
+  @note  Inconsistent with specification here:\r
+         In Framework for EFI Data Hub Specification, Version 0.9, This definition\r
+         is named as EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency\r
+         is maintained for backward compatibility.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -198,19 +198,19 @@ struct _EFI_DATA_HUB_PROTOCOL {
   ///\r
   /// Logs a data record.\r
   ///\r
-  EFI_DATA_HUB_LOG_DATA                 LogData; \r
-  \r
+  EFI_DATA_HUB_LOG_DATA                 LogData;\r
+\r
   ///\r
   /// Gets a data record. Used both to view the memory-based log and to\r
   /// get information about which data records have been consumed by a filter driver.\r
   ///\r
   EFI_DATA_HUB_GET_NEXT_RECORD          GetNextRecord;\r
-  \r
+\r
   ///\r
   /// Allows the registration of an EFI event to act as a filter driver for all data records that are logged.\r
   ///\r
   EFI_DATA_HUB_REGISTER_FILTER_DRIVER   RegisterFilterDriver;\r
-  \r
+\r
   ///\r
   /// Used to remove a filter driver that was added with RegisterFilterDriver().\r
   ///\r