[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
**/\r
VOID\r
FreeRecordBuffer (\r
  IN  DATAHUB_STATUSCODE_RECORD  *Record\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
  @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
 \r
  @param  Value         Describes the current status of a hardware or software entity.  \r
                        This included information about the class and subclass that is used to classify the entity \r
                        as well as an operation.  For progress codes, the operation is the current activity. \r
                        For error codes, it is the exception.  For debug codes, it is not defined at this time. \r
                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
 \r
  @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                        A system may contain multiple entities that match a class/subclass pairing. \r
                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable, \r
                        not meaningful, or not relevant.  Valid instance numbers start with 1.\r
\r
\r
  @param  CallerId      This optional parameter may be used to identify the caller. \r
                        This parameter allows the status code driver to apply different rules to different callers. \r
                        Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
\r
\r
  @param  Data          This optional parameter may be used to pass additional data\r
 \r
  @retval EFI_OUT_OF_RESOURCES   Can not acquire record buffer.\r
  @retval EFI_DEVICE_ERROR       EFI serial device can not work after ExitBootService() is called .\r
  @retval EFI_SUCCESS            Success to cache status code and signal log data event.\r
\r
**/\r
EFI_STATUS\r
DataHubStatusCodeReportWorker (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId,\r
  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  )\r
{\r
  DATAHUB_STATUSCODE_RECORD  *Record;\r
  UINT32                     ErrorLevel;\r
  VA_LIST                    Marker;\r
  CHAR8                      *Format;\r
  UINTN                      CharCount;\r
\r
  //\r
  // See whether in runtime phase or not.\r
  //\r
  if (EfiAtRuntime ()) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Record = AcquireRecordBuffer ();\r
  if (Record == NULL) {\r
    //\r
    // There are no empty record buffer in private buffers\r
    //\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  //\r
  // Construct Data Hub Extended Data\r
  //\r
  Record->CodeType = CodeType;\r
  Record->Value    = Value;\r
  Record->Instance = Instance;\r
\r
  if (CallerId != NULL) {\r
    CopyMem (&Record->CallerId, CallerId, sizeof (EFI_GUID));\r
  }\r
\r
  if (Data != NULL) {\r
    if (ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {\r
      CharCount = UnicodeVSPrintAsciiFormat (\r
                    (CHAR16 *) Record->ExtendData,\r
                    EFI_STATUS_CODE_DATA_MAX_SIZE,\r
                    Format,\r
                    Marker\r
                    );\r
      //\r
      // Change record data type from DebugType to String Type.\r
      //\r
      CopyGuid (&Record->Data.Type, &gEfiStatusCodeDataTypeStringGuid);\r
      Record->Data.HeaderSize = Data->HeaderSize;\r
      Record->Data.Size = (UINT16) ((CharCount + 1) * sizeof (CHAR16));\r
    } else {\r
      //\r
      // Copy status code data header\r
      //\r
      CopyMem (&Record->Data, Data, sizeof (EFI_STATUS_CODE_DATA));\r
\r
      if (Data->Size > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
        Record->Data.Size = EFI_STATUS_CODE_DATA_MAX_SIZE;\r
      } \r
      CopyMem (Record->ExtendData, Data + 1, Record->Data.Size);\r
    }\r
  }\r
\r
  gBS->SignalEvent (mLogDataHubEvent);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  The Event handler which will be notified to log data in Data Hub.\r
\r
  @param  Event       Instance of the EFI_EVENT to signal whenever data is\r
                      available to be logged in the system.\r
  @param  Context     Context of the event.\r
\r
**/\r
VOID\r
EFIAPI\r
LogDataHubEventCallBack (\r
  IN  EFI_EVENT     Event,\r
  IN  VOID          *Context\r
  )\r
{\r
  DATAHUB_STATUSCODE_RECORD         *Record;\r
  UINT32                            Size;\r
  UINT64                            DataRecordClass;\r
  LIST_ENTRY                        *Node;\r
\r
  //\r
  // Log DataRecord in Data Hub.\r
  // Journal records fifo to find all record entry.\r
  //\r
  //\r
  for (Node = mRecordsFifo.ForwardLink; Node != &mRecordsFifo;) {\r
    Record = CR (Node, DATAHUB_STATUSCODE_RECORD, Node, DATAHUB_STATUS_CODE_SIGNATURE);\r
    Node   = Node->ForwardLink;\r
\r
    //\r
    // Add in the size of the header we added.\r
    //\r
    Size = sizeof (DATAHUB_STATUSCODE_RECORD) + (UINT32) Record->Data.Size;\r
\r
    if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {\r
      DataRecordClass = EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
    } else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {\r
      DataRecordClass = EFI_DATA_RECORD_CLASS_ERROR;\r
    } else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {\r
      DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG;\r
    } else {\r
      //\r
      // Should never get here.\r
      //\r
      DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG |\r
        EFI_DATA_RECORD_CLASS_ERROR |\r
        EFI_DATA_RECORD_CLASS_DATA |\r
        EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
    }\r
\r
    //\r
    // Log DataRecord in Data Hub\r
    //\r
    \r
    mDataHubProtocol->LogData (\r
                        mDataHubProtocol,\r
                        &gEfiStatusCodeGuid,\r
                        &gEfiStatusCodeRuntimeProtocolGuid,\r
                        DataRecordClass,\r
                        Record,\r
                        Size\r
                        );\r
\r
    FreeRecordBuffer (Record);\r
  }\r
}\r
\r
\r
/**\r
  Initialize data hubstatus code.\r
  Create a data hub listener.\r
 \r
  @return  The function always return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
DataHubStatusCodeInitializeWorker (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiDataHubProtocolGuid, \r
                  NULL, \r
                  (VOID **) &mDataHubProtocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Create a Notify Event to log data in Data Hub\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_NOTIFY_SIGNAL,\r
                  EFI_TPL_CALLBACK,\r
                  LogDataHubEventCallBack,\r
                  NULL,\r
                  &mLogDataHubEvent\r
                  );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
Commit	Line	Data
56836fe9	1	/** @file\r
	2	Data Hub status code worker in DXE.\r
	3	\r
161c26a7	4	Copyright (c) 2006, Intel Corporation \r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
56836fe9	12	\r
	13	Module Name: DataHubStatusCodeWorker.c\r
	14	\r
	15	**/\r
	16	#include "DxeStatusCode.h"\r
	17	\r
	18	//\r
	19	// Initialize FIFO to cache records.\r
	20	//\r
a93763b7	21	STATIC \r
56836fe9	22	EFI_LOCK mFifoLock = EFI_INITIALIZE_LOCK_VARIABLE (EFI_TPL_HIGH_LEVEL);\r
a93763b7	23	STATIC\r
56836fe9	24	LIST_ENTRY mRecordsFifo = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsFifo);\r
a93763b7	25	STATIC\r
56836fe9	26	UINTN mNumberOfRecords = 0;\r
a93763b7	27	STATIC\r
56836fe9	28	EFI_EVENT mLogDataHubEvent;\r
	29	//\r
	30	// Cache data hub protocol.\r
	31	//\r
a93763b7	32	STATIC\r
56836fe9	33	EFI_DATA_HUB_PROTOCOL *mDataHubProtocol;\r
	34	\r
	35	\r
	36	/**\r
	37	Return buffer of length DATAHUB_STATUSCODE_RECORD\r
	38	\r
	39	@retval NULL Can not allocate free memeory for record.\r
	40	@retval !NULL Point to buffer of record.\r
	41	\r
	42	**/\r
	43	DATAHUB_STATUSCODE_RECORD *\r
	44	AcquireRecordBuffer (\r
	45	VOID\r
	46	)\r
	47	{\r
	48	DATAHUB_STATUSCODE_RECORD *Record;\r
	49	\r
	50	Record = (DATAHUB_STATUSCODE_RECORD *) AllocateZeroPool (sizeof (DATAHUB_STATUSCODE_RECORD));\r
	51	if (NULL == Record) {\r
	52	return NULL;\r
	53	}\r
	54	Record->Signature = DATAHUB_STATUS_CODE_SIGNATURE;\r
	55	\r
	56	EfiAcquireLock (&mFifoLock);\r
	57	InsertTailList (&mRecordsFifo, &Record->Node);\r
	58	mNumberOfRecords++;\r
	59	EfiReleaseLock (&mFifoLock);\r
	60	\r
	61	return Record;\r
	62	}\r
	63	\r
	64	\r
	65	/**\r
	66	Release a mRecordBuffer entry allocated by AcquirRecordBuffer ().\r
	67	\r
	68	@param Record Point to record buffer which is acquired by AcquirRecordBuffer()\r
	69	\r
56836fe9	70	**/\r
	71	VOID\r
	72	FreeRecordBuffer (\r
	73	IN DATAHUB_STATUSCODE_RECORD *Record\r
	74	)\r
56836fe9	75	{\r
	76	ASSERT (Record != NULL);\r
	77	ASSERT (mNumberOfRecords != 0);\r
	78	\r
	79	EfiAcquireLock (&mFifoLock);\r
	80	RemoveEntryList (&Record->Node);\r
	81	mNumberOfRecords--;\r
	82	EfiReleaseLock (&mFifoLock);\r
	83	\r
	84	FreePool (Record);\r
	85	}\r
	86	\r
	87	\r
	88	/**\r
	89	Report status code into DataHub.\r
	90	\r
511710d6	91	@param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
56836fe9	92	\r
	93	@param Value Describes the current status of a hardware or software entity. \r
	94	This included information about the class and subclass that is used to classify the entity \r
	95	as well as an operation. For progress codes, the operation is the current activity. \r
	96	For error codes, it is the exception. For debug codes, it is not defined at this time. \r
511710d6	97	Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
56836fe9	98	Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
	99	\r
	100	@param Instance The enumeration of a hardware or software entity within the system. \r
	101	A system may contain multiple entities that match a class/subclass pairing. \r
	102	The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
	103	not meaningful, or not relevant. Valid instance numbers start with 1.\r
	104	\r
	105	\r
	106	@param CallerId This optional parameter may be used to identify the caller. \r
	107	This parameter allows the status code driver to apply different rules to different callers. \r
	108	Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
	109	\r
	110	\r
	111	@param Data This optional parameter may be used to pass additional data\r
	112	\r
	113	@retval EFI_OUT_OF_RESOURCES Can not acquire record buffer.\r
afaa1b87	114	@retval EFI_DEVICE_ERROR EFI serial device can not work after ExitBootService() is called .\r
56836fe9	115	@retval EFI_SUCCESS Success to cache status code and signal log data event.\r
	116	\r
	117	**/\r
	118	EFI_STATUS\r
	119	DataHubStatusCodeReportWorker (\r
	120	IN EFI_STATUS_CODE_TYPE CodeType,\r
	121	IN EFI_STATUS_CODE_VALUE Value,\r
	122	IN UINT32 Instance,\r
	123	IN EFI_GUID *CallerId,\r
	124	IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
	125	)\r
	126	{\r
	127	DATAHUB_STATUSCODE_RECORD *Record;\r
	128	UINT32 ErrorLevel;\r
	129	VA_LIST Marker;\r
	130	CHAR8 *Format;\r
	131	UINTN CharCount;\r
	132	\r
	133	//\r
	134	// See whether in runtime phase or not.\r
	135	//\r
	136	if (EfiAtRuntime ()) {\r
afaa1b87	137	return EFI_DEVICE_ERROR;\r
56836fe9	138	}\r
56836fe9	139	\r
afaa1b87	140	Record = AcquireRecordBuffer ();\r
56836fe9	141	if (Record == NULL) {\r
	142	//\r
	143	// There are no empty record buffer in private buffers\r
	144	//\r
	145	return EFI_OUT_OF_RESOURCES;\r
	146	}\r
	147	//\r
	148	// Construct Data Hub Extended Data\r
	149	//\r
	150	Record->CodeType = CodeType;\r
	151	Record->Value = Value;\r
	152	Record->Instance = Instance;\r
	153	\r
	154	if (CallerId != NULL) {\r
	155	CopyMem (&Record->CallerId, CallerId, sizeof (EFI_GUID));\r
	156	}\r
	157	\r
	158	if (Data != NULL) {\r
	159	if (ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {\r
	160	CharCount = UnicodeVSPrintAsciiFormat (\r
	161	(CHAR16 *) Record->ExtendData,\r
	162	EFI_STATUS_CODE_DATA_MAX_SIZE,\r
	163	Format,\r
	164	Marker\r
	165	);\r
	166	//\r
	167	// Change record data type from DebugType to String Type.\r
	168	//\r
	169	CopyGuid (&Record->Data.Type, &gEfiStatusCodeDataTypeStringGuid);\r
	170	Record->Data.HeaderSize = Data->HeaderSize;\r
	171	Record->Data.Size = (UINT16) ((CharCount + 1) * sizeof (CHAR16));\r
	172	} else {\r
	173	//\r
	174	// Copy status code data header\r
	175	//\r
	176	CopyMem (&Record->Data, Data, sizeof (EFI_STATUS_CODE_DATA));\r
	177	\r
	178	if (Data->Size > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
	179	Record->Data.Size = EFI_STATUS_CODE_DATA_MAX_SIZE;\r
	180	} \r
	181	CopyMem (Record->ExtendData, Data + 1, Record->Data.Size);\r
	182	}\r
	183	}\r
	184	\r
	185	gBS->SignalEvent (mLogDataHubEvent);\r
	186	\r
	187	return EFI_SUCCESS;\r
	188	}\r
	189	\r
	190	\r
	191	/**\r
	192	The Event handler which will be notified to log data in Data Hub.\r
	193	\r
	194	@param Event Instance of the EFI_EVENT to signal whenever data is\r
	195	available to be logged in the system.\r
	196	@param Context Context of the event.\r
	197	\r
	198	**/\r
	199	VOID\r
	200	EFIAPI\r
	201	LogDataHubEventCallBack (\r
	202	IN EFI_EVENT Event,\r
	203	IN VOID *Context\r
	204	)\r
205	{\r
206	DATAHUB_STATUSCODE_RECORD *Record;\r
53408952	207	UINT32 Size;\r
56836fe9	208	UINT64 DataRecordClass;\r
	209	LIST_ENTRY *Node;\r
	210	\r
	211	//\r
	212	// Log DataRecord in Data Hub.\r
	213	// Journal records fifo to find all record entry.\r
	214	//\r
	215	//\r
	216	for (Node = mRecordsFifo.ForwardLink; Node != &mRecordsFifo;) {\r
	217	Record = CR (Node, DATAHUB_STATUSCODE_RECORD, Node, DATAHUB_STATUS_CODE_SIGNATURE);\r
	218	Node = Node->ForwardLink;\r
	219	\r
	220	//\r
	221	// Add in the size of the header we added.\r
	222	//\r
53408952	223	Size = sizeof (DATAHUB_STATUSCODE_RECORD) + (UINT32) Record->Data.Size;\r
56836fe9	224	\r
	225	if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {\r
	226	DataRecordClass = EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
	227	} else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {\r
	228	DataRecordClass = EFI_DATA_RECORD_CLASS_ERROR;\r
	229	} else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {\r
	230	DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG;\r
	231	} else {\r
	232	//\r
	233	// Should never get here.\r
	234	//\r
	235	DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG \|\r
	236	EFI_DATA_RECORD_CLASS_ERROR \|\r
	237	EFI_DATA_RECORD_CLASS_DATA \|\r
	238	EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
	239	}\r
	240	\r
	241	//\r
	242	// Log DataRecord in Data Hub\r
	243	//\r
	244	\r
	245	mDataHubProtocol->LogData (\r
	246	mDataHubProtocol,\r
	247	&gEfiStatusCodeGuid,\r
	248	&gEfiStatusCodeRuntimeProtocolGuid,\r
	249	DataRecordClass,\r
	250	Record,\r
53408952	251	Size\r
56836fe9	252	);\r
	253	\r
	254	FreeRecordBuffer (Record);\r
	255	}\r
	256	}\r
	257	\r
	258	\r
	259	/**\r
	260	Initialize data hubstatus code.\r
	261	Create a data hub listener.\r
	262	\r
	263	@return The function always return EFI_SUCCESS\r
	264	\r
	265	**/\r
	266	EFI_STATUS\r
	267	DataHubStatusCodeInitializeWorker (\r
	268	VOID\r
	269	)\r
	270	{\r
	271	EFI_STATUS Status;\r
	272	\r
	273	Status = gBS->LocateProtocol (\r
	274	&gEfiDataHubProtocolGuid, \r
	275	NULL, \r
	276	(VOID **) &mDataHubProtocol\r
	277	);\r
	278	ASSERT_EFI_ERROR (Status);\r
	279	\r
	280	//\r
	281	// Create a Notify Event to log data in Data Hub\r
	282	//\r
	283	Status = gBS->CreateEvent (\r
	284	EFI_EVENT_NOTIFY_SIGNAL,\r
	285	EFI_TPL_CALLBACK,\r
	286	LogDataHubEventCallBack,\r
	287	NULL,\r
	288	&mLogDataHubEvent\r
	289	);\r
	290	\r
	291	ASSERT_EFI_ERROR (Status);\r
	292	\r
	293	return EFI_SUCCESS;\r
	294	}\r
	295	\r
	296	\r