From f22f941ed273753a0426d1234869857f19c28664 Mon Sep 17 00:00:00 2001 From: myronporter Date: Tue, 16 Mar 2010 01:53:11 +0000 Subject: Grammatical and disclaimer changes (does not follow internal C coding stds.) git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10249 6f19259b-4bc3-4df7-8a09-765794883524 --- IntelFrameworkPkg/Include/Protocol/DataHub.h | 68 ++++++++++++++++------------ 1 file changed, 39 insertions(+), 29 deletions(-) (limited to 'IntelFrameworkPkg/Include/Protocol/DataHub.h') diff --git a/IntelFrameworkPkg/Include/Protocol/DataHub.h b/IntelFrameworkPkg/Include/Protocol/DataHub.h index 4b51e7a..c3bc6f9 100644 --- a/IntelFrameworkPkg/Include/Protocol/DataHub.h +++ b/IntelFrameworkPkg/Include/Protocol/DataHub.h @@ -3,14 +3,14 @@ data and those wishing to be made aware of all information that has been logged. - Copyright (c) 2007 - 2010, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved
+This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. +The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: The Data Hub Protocol is defined in Framework for EFI Data Hub Specification @@ -99,24 +99,27 @@ EFI_STATUS @param This The EFI_DATA_HUB_PROTOCOL instance. @param MonotonicCount On input, it specifies the Record to return. - An input of zero means to return the first record, as does an input of one. - @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero, - it means to return the first data record. If FilterDriver is passed in, - then a MonotonicCount of zero means to return the first data not yet read + An input of zero means to return the first record, + as does an input of one. + @param FilterDriver If FilterDriver is not passed in a MonotonicCount + of zero, it means to return the first data record. + If FilterDriver is passed in, then a MonotonicCount + of zero means to return the first data not yet read by FilterDriver. - @param Record Returns a dynamically allocated memory buffer with a data - record that matches MonotonicCount. + @param Record Returns a dynamically allocated memory buffer with + a data record that matches MonotonicCount. @retval EFI_SUCCESS Data was returned in Record. @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist. @retval EFI_NOT_FOUND MonotonicCount does not match any data record - in the system. If a MonotonicCount of zero was passed in, then no - data records exist in the system. + in the system. If a MonotonicCount of zero was + passed in, then no data records exist in the system. @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack of system resources. @note Inconsistent with specification here: - In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as - EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is maintained for backward compatibility. + In Framework for EFI Data Hub Specification, Version 0.9, This definition + is named as EFI_DATA_HUB_GET_NEXT_DATA_RECORD. The inconsistency is + maintained for backward compatibility. **/ typedef EFI_STATUS @@ -133,22 +136,28 @@ EFI_STATUS @param This The EFI_DATA_HUB_PROTOCOL instance. @param FilterEvent The EFI_EVENT to signal whenever data that matches FilterClass is logged in the system. - @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled. - It is strongly recommended that you use the lowest EFI_TPL possible. + @param FilterTpl The maximum EFI_TPL at which FilterEvent can be + signaled. It is strongly recommended that you use + the lowest EFI_TPL possible. @param FilterClass FilterEvent will be signaled whenever a bit - in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass. - If FilterClass is zero, no class-based filtering will be performed. + in EFI_DATA_RECORD_HEADER.DataRecordClass is also + set in FilterClass. If FilterClass is zero, no + class-based filtering will be performed. @param FilterDataRecordGuid FilterEvent will be signaled whenever - FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid. - If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed. + FilterDataRecordGuid matches + EFI_DATA_RECORD_HEADER.DataRecordGuid. + If FilterDataRecordGuid is NULL, then no GUID-based + filtering will be performed. @retval EFI_SUCCESS The filter driver event was registered - @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again. + @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot + be registered again. @retval EFI_OUT_OF_RESOURCES The filter driver event was not registered due to lack of system resources. @note Inconsistent with specification here: - In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as - EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency is maintained for backward compatibility. + In Framework for EFI Data Hub Specification, Version 0.9, This definition + is named as EFI_DATA_HUB_REGISTER_DATA_FILTER_DRIVER. The inconsistency + is maintained for backward compatibility. **/ typedef EFI_STATUS @@ -170,8 +179,9 @@ EFI_STATUS @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off. @retval EFI_NOT_FOUND FilterEvent did not exist. @note Inconsistent with specification here: - In Framework for EFI Data Hub Specification, Version 0.9, This definition is named as - EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency is maintained for backward compatibility. + In Framework for EFI Data Hub Specification, Version 0.9, This definition + is named as EFI_DATA_HUB_UNREGISTER_DATA_FILTER_DRIVER. The inconsistency + is maintained for backward compatibility. **/ typedef EFI_STATUS -- cgit v1.1