4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This code produces the Data Hub protocol. It preloads the data hub
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with status information copied in from PEI HOBs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "DataHub.h"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCONST EFI_GUID gZeroGuid = { 0, 0, 0, { 0, 0, 0, 0, 0, 0, 0, 0 } };
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Since this driver will only ever produce one instance of the Logging Hub
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// protocol you are not required to dynamically allocate the PrivateData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDATA_HUB_INSTANCE mPrivateData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Log data record into the data logging hub
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Protocol instance structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataRecordGuid GUID that defines record contents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ProducerName GUID that defines the name of the producer of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataRecordClass Class that defines generic record type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RawData Data Log record as defined by DataRecordGuid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RawDataSize Size of Data Log data in bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS If data was logged
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES If data was not logged due to lack of system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDataHubLogData (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DATA_HUB_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_GUID *DataRecordGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_GUID *ProducerName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 DataRecordClass,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *RawData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 RawDataSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_INSTANCE *Private;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_ENTRY *LogEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 TotalSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RecordSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_HEADER *Record;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *Raw;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_FILTER_DRIVER *FilterEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY *Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY *Head;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_TIME LogTime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = DATA_HUB_INSTANCE_FROM_THIS (This);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Combine the storage for the internal structs and a copy of the log record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Record follows PrivateLogEntry. The consumer will be returned a pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // to Record so we don't what it to be the thing that was allocated from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // pool, so the consumer can't free an data record by mistake.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RecordSize = sizeof (EFI_DATA_RECORD_HEADER) + RawDataSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TotalSize = sizeof (EFI_DATA_ENTRY) + RecordSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // First try to get log time at TPL level <= TPL_CALLBACK.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&LogTime, sizeof (LogTime));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EfiGetCurrentTpl() <= TPL_CALLBACK) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gRT->GetTime (&LogTime, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The Logging action is the critical section, so it is locked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The MTC asignment & update and logging must be an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // atomic operation, so use the lock.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EfiAcquireLockOrFail (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reentrancy detected so exit!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LogEntry = AllocatePool (TotalSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (LogEntry == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiReleaseLock (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_OUT_OF_RESOURCES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (LogEntry, TotalSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record = (EFI_DATA_RECORD_HEADER *) (LogEntry + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Raw = (VOID *) (Record + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build Standard Log Header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record->Version = EFI_DATA_RECORD_HEADER_VERSION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record->HeaderSize = (UINT16) sizeof (EFI_DATA_RECORD_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record->RecordSize = RecordSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Record->DataRecordGuid, DataRecordGuid, sizeof (EFI_GUID));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Record->ProducerName, ProducerName, sizeof (EFI_GUID));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record->DataRecordClass = DataRecordClass;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Ensure LogMonotonicCount is not zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record->LogMonotonicCount = ++Private->GlobalMonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Record->LogTime, &LogTime, sizeof (LogTime));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Insert log into the internal linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LogEntry->Signature = EFI_DATA_ENTRY_SIGNATURE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LogEntry->Record = Record;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LogEntry->RecordSize = sizeof (EFI_DATA_ENTRY) + RawDataSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InsertTailList (&Private->DataListHead, &LogEntry->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (Raw, RawData, RawDataSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiReleaseLock (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send Signal to all the filter drivers which are interested
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // in the record's class and guid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Head = &Private->FilterDriverListHead;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterEntry = FILTER_ENTRY_FROM_LINK (Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((FilterEntry->ClassFilter & DataRecordClass) != 0) &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (CompareGuid (&FilterEntry->FilterDataRecordGuid, &gZeroGuid) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CompareGuid (&FilterEntry->FilterDataRecordGuid, DataRecordGuid))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->SignalEvent (FilterEntry->Event);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Search the Head doubly linked list for the passed in MTC. Return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync matching element in Head and the MTC on the next entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Head Head of Data Log linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ClassFilter Only match the MTC if it is in the same Class as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ClassFilter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PtrCurrentMTC On IN contians MTC to search for. On OUT contians next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTC in the data log list or zero if at end of the list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DATA_LOG_ENTRY Return pointer to data log data from Head list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If no data record exists.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_DATA_RECORD_HEADER *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncGetNextDataRecord (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN LIST_ENTRY *Head,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 ClassFilter,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT64 *PtrCurrentMTC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_ENTRY *LogEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY *Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN ReturnFirstEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_HEADER *Record;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_ENTRY *NextLogEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If MonotonicCount == 0 just return the first one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReturnFirstEntry = (BOOLEAN) (*PtrCurrentMTC == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LogEntry = DATA_ENTRY_FROM_LINK (Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((LogEntry->Record->DataRecordClass & ClassFilter) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Skip any entry that does not have the correct ClassFilter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync continue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((LogEntry->Record->LogMonotonicCount == *PtrCurrentMTC) || ReturnFirstEntry) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return record to the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Record = LogEntry->Record;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Calculate the next MTC value. If there is no next entry set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // MTC to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *PtrCurrentMTC = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Link = GetNextNode(Head, Link); Link != Head; Link = GetNextNode(Head, Link)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NextLogEntry = DATA_ENTRY_FROM_LINK (Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((NextLogEntry->Record->DataRecordClass & ClassFilter) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return the MTC of the next thing to search for if found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *PtrCurrentMTC = NextLogEntry->Record->LogMonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync break;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Record found exit loop and return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync break;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Record;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Search the Head list for a EFI_DATA_HUB_FILTER_DRIVER member that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync represents Event and return it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Head Pointer to head of dual linked list of EFI_DATA_HUB_FILTER_DRIVER structures.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event Event to be search for in the Head list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DATA_HUB_FILTER_DRIVER Returned if Event stored in the Head doubly linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If Event is not in the list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDATA_HUB_FILTER_DRIVER *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncFindFilterDriverByEvent (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN LIST_ENTRY *Head,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_FILTER_DRIVER *FilterEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY *Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterEntry = FILTER_ENTRY_FROM_LINK (Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterEntry->Event == Event) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return FilterEntry;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get a previously logged data record and the MonotonicCount for the next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync availible Record. This allows all records or all records later
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than a give MonotonicCount to be returned. If an optional FilterDriverEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is passed in with a MonotonicCout of zero return the first record
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not yet read by the filter driver. If FilterDriverEvent is NULL and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MonotonicCount is zero return the first data record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to the EFI_DATA_HUB_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MonotonicCount Specifies the Record to return. On input, zero means
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return the first record. On output, contains the next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync record to availible. Zero indicates no more records.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilterDriverEvent If FilterDriverEvent is not passed in a MonotonicCount
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of zero, it means to return the first data record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FilterDriverEvent is passed in, then a MonotonicCount
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of zero means to return the first data not yet read by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriverEvent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Record Returns a dynamically allocated memory buffer with a data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync record that matches MonotonicCount.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was returned in Record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FilterDriverEvent was passed in but does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND MonotonicCount does not match any data record in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system. If a MonotonicCount of zero was passed in, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync no data records exist in the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack of system resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDataHubGetNextRecord (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DATA_HUB_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINT64 *MonotonicCount,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT *FilterDriverEvent, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_DATA_RECORD_HEADER **Record
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_INSTANCE *Private;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_FILTER_DRIVER *FilterDriver;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 ClassFilter;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = DATA_HUB_INSTANCE_FROM_THIS (This);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ClassFilter = EFI_DATA_RECORD_CLASS_DEBUG |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_CLASS_ERROR |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_CLASS_DATA |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_CLASS_PROGRESS_CODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If FilterDriverEvent is NULL, then return the next record
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterDriverEvent == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Record = GetNextDataRecord (&Private->DataListHead, ClassFilter, MonotonicCount);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*Record == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // For events the beginning is the last unread record. This info is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // stored in the instance structure, so we must look up the event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // to get the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver = FindFilterDriverByEvent (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &Private->FilterDriverListHead,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FilterDriverEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterDriver == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use the Class filter the event was created with.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ClassFilter = FilterDriver->ClassFilter;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the next record or the first record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*MonotonicCount != 0 || FilterDriver->GetNextMonotonicCount == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Record = GetNextDataRecord (&Private->DataListHead, ClassFilter, MonotonicCount);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*Record == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*MonotonicCount != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If this was not the last record then update the count associated with the filter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->GetNextMonotonicCount = *MonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save the MonotonicCount of the last record which has been read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->GetNextMonotonicCount = (*Record)->LogMonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // This is a request to read the first record that has not been read yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set MonotoicCount to the last record successfuly read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *MonotonicCount = FilterDriver->GetNextMonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the last record successfuly read again, but do not return it since
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // it has already been returned before.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Record = GetNextDataRecord (&Private->DataListHead, ClassFilter, MonotonicCount);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*Record == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*MonotonicCount != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update the count associated with the filter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->GetNextMonotonicCount = *MonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Retrieve the record after the last record successfuly read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Record = GetNextDataRecord (&Private->DataListHead, ClassFilter, MonotonicCount);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*Record == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function registers the data hub filter driver that is represented
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by FilterEvent. Only one instance of each FilterEvent can be registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync After the FilterEvent is registered, it will be signaled so it can sync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with data records that have been recorded prior to the FilterEvent being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Pointer to The EFI_DATA_HUB_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilterEvent The EFI_EVENT to signal whenever data that matches
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterClass is logged in the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilterTpl The maximum EFI_TPL at which FilterEvent can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync signaled. It is strongly recommended that you use the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync lowest EFI_TPL possible.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilterClass FilterEvent will be signaled whenever a bit in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_HEADER.DataRecordClass is also set in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterClass. If FilterClass is zero, no class-based
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filtering will be performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilterDataRecordGuid FilterEvent will be signaled whenever FilterDataRecordGuid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync matches EFI_DATA_RECORD_HEADER.DataRecordGuid. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDataRecordGuid is NULL, then no GUID-based filtering
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The filter driver event was registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The filter driver event was not registered due to lack of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDataHubRegisterFilterDriver (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DATA_HUB_PROTOCOL * This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT FilterEvent,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_TPL FilterTpl,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 FilterClass,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_GUID * FilterDataRecordGuid OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_INSTANCE *Private;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_FILTER_DRIVER *FilterDriver;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = DATA_HUB_INSTANCE_FROM_THIS (This);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver = (DATA_HUB_FILTER_DRIVER *) AllocateZeroPool (sizeof (DATA_HUB_FILTER_DRIVER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterDriver == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_OUT_OF_RESOURCES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize filter driver info
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->Signature = EFI_DATA_HUB_FILTER_DRIVER_SIGNATURE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->Event = FilterEvent;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->Tpl = FilterTpl;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->GetNextMonotonicCount = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterClass == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->ClassFilter = EFI_DATA_RECORD_CLASS_DEBUG |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_CLASS_ERROR |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_CLASS_DATA |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DATA_RECORD_CLASS_PROGRESS_CODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver->ClassFilter = FilterClass;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterDataRecordGuid != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&FilterDriver->FilterDataRecordGuid, FilterDataRecordGuid, sizeof (EFI_GUID));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search for duplicate entries
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FindFilterDriverByEvent (&Private->FilterDriverListHead, FilterEvent) != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FreePool (FilterDriver);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_ALREADY_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make insertion an atomic operation with the lock.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiAcquireLock (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InsertTailList (&Private->FilterDriverListHead, &FilterDriver->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiReleaseLock (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Signal the Filter driver we just loaded so they will recieve all the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // previous history. If we did not signal here we would have to wait until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the next data was logged to get the history. In a case where no next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // data was logged we would never get synced up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->SignalEvent (FilterEvent);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove a Filter Driver, so it no longer gets called when data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information is logged.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Protocol instance structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilterEvent Event that represents a filter driver that is to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS If FilterEvent was unregistered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND If FilterEvent does not exist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDataHubUnregisterFilterDriver (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DATA_HUB_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT FilterEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_INSTANCE *Private;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DATA_HUB_FILTER_DRIVER *FilterDriver;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = DATA_HUB_INSTANCE_FROM_THIS (This);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search for duplicate entries
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterDriver = FindFilterDriverByEvent (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &Private->FilterDriverListHead,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilterEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilterDriver == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make removal an atomic operation with the lock
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiAcquireLock (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemoveEntryList (&FilterDriver->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiReleaseLock (&Private->DataLock);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Driver's Entry point routine that install Driver to produce Data Hub protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle Module's image handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SystemTable Pointer of EFI_SYSTEM_TABLE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Logging Hub protocol installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Other No protocol installed, unload driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDataHubInstall (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_HANDLE ImageHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SYSTEM_TABLE *SystemTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 HighMontonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.Signature = DATA_HUB_INSTANCE_SIGNATURE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.DataHub.LogData = DataHubLogData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.DataHub.GetNextRecord = DataHubGetNextRecord;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.DataHub.RegisterFilterDriver = DataHubRegisterFilterDriver;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.DataHub.UnregisterFilterDriver = DataHubUnregisterFilterDriver;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize Private Data in CORE_LOGGING_HUB_INSTANCE that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // required by this protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InitializeListHead (&mPrivateData.DataListHead);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InitializeListHead (&mPrivateData.FilterDriverListHead);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiInitializeLock (&mPrivateData.DataLock, TPL_NOTIFY);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make sure we get a bigger MTC number on every boot!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gRT->GetNextHighMonotonicCount (&HighMontonicCount);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if system service fails pick a sane value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.GlobalMonotonicCount = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.GlobalMonotonicCount = LShiftU64 ((UINT64) HighMontonicCount, 32);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make a new handle and install the protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivateData.Handle = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->InstallProtocolInterface (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &mPrivateData.Handle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &gEfiDataHubProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NATIVE_INTERFACE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &mPrivateData.DataHub
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync