]> git.proxmox.com Git - mirror_edk2.git/blame - EdkModulePkg/Universal/StatusCode/Dxe/DataHubStatusCodeWorker.c
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2231 6f19259b...
[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / Dxe / DataHubStatusCodeWorker.c
CommitLineData
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 21STATIC\r
35d4cd92 22LIST_ENTRY mRecordsFifo = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsFifo);\r
a93763b7 23STATIC\r
35d4cd92 24LIST_ENTRY mRecordsBuffer = INITIALIZE_LIST_HEAD_VARIABLE (mRecordsBuffer);\r
a93763b7 25STATIC\r
56836fe9 26EFI_EVENT mLogDataHubEvent;\r
27//\r
28// Cache data hub protocol.\r
29//\r
a93763b7 30STATIC\r
56836fe9 31EFI_DATA_HUB_PROTOCOL *mDataHubProtocol;\r
32\r
33\r
34/**\r
35d4cd92 35 Return one DATAHUB_STATUSCODE_RECORD space.\r
36 The size of free record pool would be extend, if the pool is empty. \r
37\r
56836fe9 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
43DATAHUB_STATUSCODE_RECORD *\r
44AcquireRecordBuffer (\r
45 VOID\r
46 )\r
47{\r
48 DATAHUB_STATUSCODE_RECORD *Record;\r
35d4cd92 49 EFI_TPL CurrentTpl;\r
50 LIST_ENTRY *Node;\r
51 UINT32 Index;\r
52\r
53 CurrentTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
54\r
55 if (!IsListEmpty (&mRecordsBuffer)) {\r
56 Node = GetFirstNode (&mRecordsBuffer);\r
57 RemoveEntryList (Node);\r
56836fe9 58\r
69a99cc6 59 Record = _CR (Node, DATAHUB_STATUSCODE_RECORD, Node);\r
35d4cd92 60 } else {\r
61 if (CurrentTpl > EFI_TPL_NOTIFY) {\r
62 gBS->RestoreTPL (CurrentTpl);\r
63 return NULL;\r
64 }\r
65\r
66 gBS->RestoreTPL (CurrentTpl);\r
67 Record = (DATAHUB_STATUSCODE_RECORD *) AllocateZeroPool (sizeof (DATAHUB_STATUSCODE_RECORD) * 16);\r
68 if (NULL == Record) {\r
69 return NULL;\r
70 }\r
71\r
72 CurrentTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
73 for (Index = 1; Index < 16; Index++) {\r
74 InsertTailList (&mRecordsBuffer, &Record[Index].Node);\r
75 }\r
56836fe9 76 }\r
56836fe9 77\r
35d4cd92 78 Record->Signature = DATAHUB_STATUS_CODE_SIGNATURE;\r
56836fe9 79 InsertTailList (&mRecordsFifo, &Record->Node);\r
35d4cd92 80\r
81 gBS->RestoreTPL (CurrentTpl);\r
56836fe9 82\r
83 return Record;\r
84}\r
85\r
86\r
87/**\r
69a99cc6 88 Retrieve one record from Records FIFO. The record would be removed from FIFO and \r
89 release to free record buffer.\r
56836fe9 90\r
69a99cc6 91 @return !NULL Point to record, which is ready to be logged.\r
92 @return NULL the FIFO of record is empty.\r
56836fe9 93 \r
56836fe9 94**/\r
69a99cc6 95DATAHUB_STATUSCODE_RECORD *\r
96RetrieveRecord (\r
97 VOID\r
56836fe9 98 )\r
56836fe9 99{\r
69a99cc6 100 DATAHUB_STATUSCODE_RECORD *Record = NULL;\r
101 LIST_ENTRY *Node;\r
102 EFI_TPL CurrentTpl;\r
56836fe9 103\r
35d4cd92 104 CurrentTpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);\r
105\r
69a99cc6 106 if (!IsListEmpty (&mRecordsFifo)) {\r
107 Node = GetFirstNode (&mRecordsFifo);\r
108 Record = CR (Node, DATAHUB_STATUSCODE_RECORD, Node, DATAHUB_STATUS_CODE_SIGNATURE);\r
109\r
110 RemoveEntryList (&Record->Node);\r
111 InsertTailList (&mRecordsBuffer, &Record->Node);\r
112 Record->Signature = 0;\r
113 }\r
56836fe9 114\r
35d4cd92 115 gBS->RestoreTPL (CurrentTpl);\r
69a99cc6 116\r
117 return Record;\r
56836fe9 118}\r
119\r
120\r
121/**\r
122 Report status code into DataHub.\r
123 \r
511710d6 124 @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
56836fe9 125 \r
126 @param Value Describes the current status of a hardware or software entity. \r
127 This included information about the class and subclass that is used to classify the entity \r
128 as well as an operation. For progress codes, the operation is the current activity. \r
129 For error codes, it is the exception. For debug codes, it is not defined at this time. \r
511710d6 130 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. \r
56836fe9 131 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
132 \r
133 @param Instance The enumeration of a hardware or software entity within the system. \r
134 A system may contain multiple entities that match a class/subclass pairing. \r
135 The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, \r
136 not meaningful, or not relevant. Valid instance numbers start with 1.\r
137\r
138\r
139 @param CallerId This optional parameter may be used to identify the caller. \r
140 This parameter allows the status code driver to apply different rules to different callers. \r
141 Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
142\r
143\r
144 @param Data This optional parameter may be used to pass additional data\r
145 \r
146 @retval EFI_OUT_OF_RESOURCES Can not acquire record buffer.\r
afaa1b87 147 @retval EFI_DEVICE_ERROR EFI serial device can not work after ExitBootService() is called .\r
56836fe9 148 @retval EFI_SUCCESS Success to cache status code and signal log data event.\r
149\r
150**/\r
151EFI_STATUS\r
152DataHubStatusCodeReportWorker (\r
153 IN EFI_STATUS_CODE_TYPE CodeType,\r
154 IN EFI_STATUS_CODE_VALUE Value,\r
155 IN UINT32 Instance,\r
156 IN EFI_GUID *CallerId,\r
157 IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r
158 )\r
159{\r
160 DATAHUB_STATUSCODE_RECORD *Record;\r
161 UINT32 ErrorLevel;\r
162 VA_LIST Marker;\r
163 CHAR8 *Format;\r
164 UINTN CharCount;\r
165\r
166 //\r
167 // See whether in runtime phase or not.\r
168 //\r
169 if (EfiAtRuntime ()) {\r
afaa1b87 170 return EFI_DEVICE_ERROR;\r
56836fe9 171 }\r
172\r
afaa1b87 173 Record = AcquireRecordBuffer ();\r
56836fe9 174 if (Record == NULL) {\r
175 //\r
176 // There are no empty record buffer in private buffers\r
177 //\r
178 return EFI_OUT_OF_RESOURCES;\r
179 }\r
180 //\r
181 // Construct Data Hub Extended Data\r
182 //\r
183 Record->CodeType = CodeType;\r
184 Record->Value = Value;\r
185 Record->Instance = Instance;\r
186\r
187 if (CallerId != NULL) {\r
188 CopyMem (&Record->CallerId, CallerId, sizeof (EFI_GUID));\r
189 }\r
190\r
191 if (Data != NULL) {\r
192 if (ReportStatusCodeExtractDebugInfo (Data, &ErrorLevel, &Marker, &Format)) {\r
193 CharCount = UnicodeVSPrintAsciiFormat (\r
194 (CHAR16 *) Record->ExtendData,\r
195 EFI_STATUS_CODE_DATA_MAX_SIZE,\r
196 Format,\r
197 Marker\r
198 );\r
199 //\r
200 // Change record data type from DebugType to String Type.\r
201 //\r
202 CopyGuid (&Record->Data.Type, &gEfiStatusCodeDataTypeStringGuid);\r
203 Record->Data.HeaderSize = Data->HeaderSize;\r
204 Record->Data.Size = (UINT16) ((CharCount + 1) * sizeof (CHAR16));\r
205 } else {\r
206 //\r
207 // Copy status code data header\r
208 //\r
209 CopyMem (&Record->Data, Data, sizeof (EFI_STATUS_CODE_DATA));\r
210\r
211 if (Data->Size > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
212 Record->Data.Size = EFI_STATUS_CODE_DATA_MAX_SIZE;\r
213 } \r
214 CopyMem (Record->ExtendData, Data + 1, Record->Data.Size);\r
215 }\r
216 }\r
217\r
218 gBS->SignalEvent (mLogDataHubEvent);\r
219\r
220 return EFI_SUCCESS;\r
221}\r
222\r
223\r
224/**\r
225 The Event handler which will be notified to log data in Data Hub.\r
226\r
227 @param Event Instance of the EFI_EVENT to signal whenever data is\r
228 available to be logged in the system.\r
229 @param Context Context of the event.\r
230\r
231**/\r
232VOID\r
233EFIAPI\r
234LogDataHubEventCallBack (\r
235 IN EFI_EVENT Event,\r
236 IN VOID *Context\r
237 )\r
238{\r
239 DATAHUB_STATUSCODE_RECORD *Record;\r
53408952 240 UINT32 Size;\r
56836fe9 241 UINT64 DataRecordClass;\r
56836fe9 242\r
243 //\r
244 // Log DataRecord in Data Hub.\r
245 // Journal records fifo to find all record entry.\r
246 //\r
69a99cc6 247 while (1) {\r
248 Record = RetrieveRecord ();\r
249 if (Record == NULL) {\r
250 break;\r
251 }\r
56836fe9 252 //\r
253 // Add in the size of the header we added.\r
254 //\r
53408952 255 Size = sizeof (DATAHUB_STATUSCODE_RECORD) + (UINT32) Record->Data.Size;\r
56836fe9 256\r
257 if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) {\r
258 DataRecordClass = EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
259 } else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) {\r
260 DataRecordClass = EFI_DATA_RECORD_CLASS_ERROR;\r
261 } else if ((Record->CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE) {\r
262 DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG;\r
263 } else {\r
264 //\r
265 // Should never get here.\r
266 //\r
267 DataRecordClass = EFI_DATA_RECORD_CLASS_DEBUG |\r
268 EFI_DATA_RECORD_CLASS_ERROR |\r
269 EFI_DATA_RECORD_CLASS_DATA |\r
270 EFI_DATA_RECORD_CLASS_PROGRESS_CODE;\r
271 }\r
272\r
273 //\r
274 // Log DataRecord in Data Hub\r
275 //\r
276 \r
277 mDataHubProtocol->LogData (\r
278 mDataHubProtocol,\r
279 &gEfiStatusCodeGuid,\r
280 &gEfiStatusCodeRuntimeProtocolGuid,\r
281 DataRecordClass,\r
282 Record,\r
53408952 283 Size\r
56836fe9 284 );\r
285\r
56836fe9 286 }\r
287}\r
288\r
289\r
290/**\r
291 Initialize data hubstatus code.\r
292 Create a data hub listener.\r
293 \r
294 @return The function always return EFI_SUCCESS\r
295\r
296**/\r
297EFI_STATUS\r
298DataHubStatusCodeInitializeWorker (\r
299 VOID\r
300 )\r
301{\r
302 EFI_STATUS Status;\r
303\r
304 Status = gBS->LocateProtocol (\r
305 &gEfiDataHubProtocolGuid, \r
306 NULL, \r
307 (VOID **) &mDataHubProtocol\r
308 );\r
309 ASSERT_EFI_ERROR (Status);\r
310\r
311 //\r
312 // Create a Notify Event to log data in Data Hub\r
313 //\r
314 Status = gBS->CreateEvent (\r
315 EFI_EVENT_NOTIFY_SIGNAL,\r
316 EFI_TPL_CALLBACK,\r
317 LogDataHubEventCallBack,\r
318 NULL,\r
319 &mLogDataHubEvent\r
320 );\r
321\r
322 ASSERT_EFI_ERROR (Status);\r
323\r
324 return EFI_SUCCESS;\r
325}\r
326\r
327\r