/**\r
Logs a data record to the system event log.\r
\r
- @param This The EFI_DATA_HUB_PROTOCOL instance.\r
- \r
+ @param This The EFI_DATA_HUB_PROTOCOL instance.\r
@param description\r
- \r
- @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.\r
- \r
- @param ProducerName A GUID that indicates the identity of the caller to this API.\r
- \r
- @param DataRecordClass This class indicates the generic type of the data record. \r
- \r
- @param RawData The DataRecordGuid-defined data to be logged.\r
- \r
- @param RawDataSize The size in bytes of RawData.\r
-\r
- @retval EFI_SUCCESS Data was logged.\r
- \r
+ @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.\r
+ @param ProducerName A GUID that indicates the identity of the caller to this API.\r
+ @param DataRecordClass This class indicates the generic type of the data record.\r
+ @param RawData The DataRecordGuid-defined data to be logged.\r
+ @param RawDataSize The size in bytes of RawData.\r
+\r
+ @retval EFI_SUCCESS Data was logged.\r
@retval EFI_OUT_OF_RESOURCES Data was not logged due to lack of system resources.\r
\r
**/\r
/**\r
Allows the system data log to be searched.\r
\r
- @param This The EFI_DATA_HUB_PROTOCOL instance. \r
- \r
- @param MonotonicCount On input, it specifies the Record to return. \r
- An input of zero means to return the first record.\r
- \r
- @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero, \r
- it means to return the first data record. If FilterDriver is passed in, \r
- then a MonotonicCount of zero means to return the first data not yet read \r
- by FilterDriver.\r
- \r
- @param Record Returns a dynamically allocated memory buffer with a data \r
- record that matches MonotonicCount.\r
-\r
- @retval EFI_SUCCESS Data was returned in Record.\r
- \r
- @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.\r
- \r
- @retval EFI_NOT_FOUND MonotonicCount does not match any data record \r
- in the system. If a MonotonicCount of zero was passed in, then no \r
- data records exist in the system.\r
- \r
- @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack \r
- of system resources.\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
+ @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero,\r
+ it means to return the first data record. If FilterDriver is passed in,\r
+ then a MonotonicCount of zero means to return the first data not yet read\r
+ by FilterDriver.\r
+ @param Record Returns a dynamically allocated memory buffer with a data\r
+ 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 passed in, then no\r
+ data records exist in the system.\r
+ @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack\r
+ of system resources.\r
\r
**/\r
typedef\r
/**\r
Registers an event to be signaled every time a data record is logged in the system.\r
\r
- @param This The EFI_DATA_HUB_PROTOCOL instance. \r
- \r
- @param FilterEvent The EFI_EVENT to signal whenever data that matches \r
- FilterClass is logged in the system. \r
- \r
- @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.\r
- It is strongly recommended that you use the lowest EFI_TPL possible. \r
- \r
- @param FilterClass FilterEvent will be signaled whenever a bit \r
- in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass. \r
- If FilterClass is zero, no class-based filtering will be performed. \r
- \r
- @param FilterDataRecordGuid FilterEvent will be signaled whenever \r
- FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid. \r
- If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed. \r
-\r
- @retval EFI_SUCCESS The filter driver event was registered\r
- \r
- @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.\r
- \r
+ @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 signaled.\r
+ It is strongly recommended that you use the lowest EFI_TPL possible.\r
+ @param FilterClass FilterEvent will be signaled whenever a bit\r
+ in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.\r
+ If FilterClass is zero, no class-based filtering will be performed.\r
+ @param FilterDataRecordGuid FilterEvent will be signaled whenever\r
+ FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.\r
+ If FilterDataRecordGuid is NULL, then no GUID-based 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 be registered again.\r
@retval EFI_OUT_OF_RESOURCES The filter driver event was not registered\r
- due to lack of system resources.\r
+ due to lack of system resources.\r
\r
**/\r
typedef\r
/**\r
Stops a filter driver from being notified when data records are logged.\r
\r
- @param This The EFI_DATA_HUB_PROTOCOL instance. \r
- \r
- @param FilterEvent The EFI_EVENT to remove from the list of events to be \r
- signaled every time errors are logged.\r
+ @param This The EFI_DATA_HUB_PROTOCOL instance.\r
+ @param FilterEvent The EFI_EVENT to remove from the list of events to be\r
+ signaled every time errors are logged.\r
\r
- @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.\r
- \r
- @retval EFI_NOT_FOUND FilterEvent did not exist.\r
+ @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.\r
+ @retval EFI_NOT_FOUND FilterEvent did not exist.\r
\r
**/\r
typedef\r
projects / mirror_edk2.git / blobdiff