Fix EdkII tracker 223 to enhance genfvimage tool to support TE image format. If so...

[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / Dxe / DataHubStatusCodeWorker.c

/** @file\r
  Data Hub status code worker in DXE.\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  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
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  Module Name:  DataHubStatusCodeWorker.c\r
\r
**/\r
#include "DxeStatusCode.h"\r
\r
//\r
// Initialize FIFO to cache records.\r
//\r
STATIC \r
EFI_LOCK                  mFifoLock        = EFI_INITIALIZE_LOCK_VARIABLE  (EFI_TPL_HIGH_LEVEL);\r
STATIC\r
LIST_ENTRY                mRecordsFifo     = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsFifo);\r
STATIC\r
UINTN                     mNumberOfRecords = 0;\r
STATIC\r
EFI_EVENT                 mLogDataHubEvent;\r
//\r
// Cache data hub protocol.\r
//\r
STATIC\r
EFI_DATA_HUB_PROTOCOL     *mDataHubProtocol;\r
\r
\r
/**\r
  Return buffer of length DATAHUB_STATUSCODE_RECORD\r
 \r
  @retval  NULL   Can not allocate free memeory for record.\r
  @retval  !NULL  Point to buffer of record.\r
\r
**/\r
DATAHUB_STATUSCODE_RECORD *\r
AcquireRecordBuffer (\r
  VOID\r
  )\r
{\r
  DATAHUB_STATUSCODE_RECORD *Record;\r
\r
  Record   = (DATAHUB_STATUSCODE_RECORD *) AllocateZeroPool (sizeof (DATAHUB_STATUSCODE_RECORD));\r
  if (NULL == Record) {\r
    return NULL;\r
  }\r
  Record->Signature = DATAHUB_STATUS_CODE_SIGNATURE;\r
\r
  EfiAcquireLock (&mFifoLock);\r
  InsertTailList (&mRecordsFifo, &Record->Node);\r
  mNumberOfRecords++;\r
  EfiReleaseLock (&mFifoLock);\r
\r
  return Record;\r
}\r
\r
\r
/**\r
  Release a mRecordBuffer entry allocated by AcquirRecordBuffer ().\r
\r
  @param   Record        Point to record buffer which is acquired by AcquirRecordBuffer()\r
 \r
  @retval  EFI_SUCCESS   If DataRecord is valid.\r
  @retval  !EFI_SUCCESS  The record list has empty.\r
\r
**/\r
VOID\r
FreeRecordBuffer (\r
  IN  DATAHUB_STATUSCODE_RECORD  *Record\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Release a mRecordBuffer entry allocated by AquireEmptyRecordBuffer ().\r
\r
Arguments:\r
\r
  RecordBuffer          - Data to free\r
\r
Returns:\r
\r
  EFI_SUCCESS           - If DataRecord is valid\r
  EFI_UNSUPPORTED       - The record list has empty\r
\r
--*/\r
{\r
  ASSERT (Record != NULL);\r
  ASSERT (mNumberOfRecords != 0);\r
\r
  EfiAcquireLock (&mFifoLock);\r
  RemoveEntryList (&Record->Node);\r
  mNumberOfRecords--;\r
  EfiReleaseLock (&mFifoLock);\r
\r
  FreePool (Record);\r
}\r
\r
\r
/**\r
  Report status code into DataHub.\r
 \r