2 * Status code driver for IPF architecture.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: DxeStatusCodeIpf.c
17 #include "DxeStatusCode.h"
21 Report status code to all supported device.
22 Calls into the workers which dispatches the platform specific
25 @param Type Indicates the type of status code being reported.
26 The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
27 @param Value Describes the current status of a hardware or software entity.
28 This includes information about the class and subclass that is used to classify the entity
29 as well as an operation. For progress codes, the operation is the current activity.
30 For error codes, it is the exception. For debug codes, it is not defined at this time.
31 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
32 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
33 @param Instance The enumeration of a hardware or software entity within the system.
34 A system may contain multiple entities that match a class/subclass pairing.
35 The instance differentiates between them. An instance of 0 indicates that instance
36 information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.
37 @param CallerId This optional parameter may be used to identify the caller.
38 This parameter allows the status code driver to apply different rules to different callers.
39 @param Data This optional parameter may be used to pass additional data.
40 Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.
41 The contents of this data type may have additional GUID-specific data. The standard GUIDs and
42 their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.
44 @return Always return EFI_SUCCESS.
51 IN EFI_STATUS_CODE_TYPE Type
,
52 IN EFI_STATUS_CODE_VALUE Value
,
54 IN EFI_GUID
*CallerId OPTIONAL
,
55 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
59 // Declaration of status code protocol.
62 EFI_STATUS_CODE_PROTOCOL mEfiStatusCodeProtocol
= {
67 // Delaration of DXE status code controller
69 DXE_STATUS_CODE_CONTROLLER gDxeStatusCode
= {
71 // Initialize nest status as non nested.
78 Report status code to all supported device.
79 Calls into the workers which dispatches the platform specific
82 @param CodeType Indicates the type of status code being reported.
83 The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
84 @param Value Describes the current status of a hardware or software entity.
85 This includes information about the class and subclass that is used to classify the entity
86 as well as an operation. For progress codes, the operation is the current activity.
87 For error codes, it is the exception. For debug codes, it is not defined at this time.
88 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
89 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
90 @param Instance The enumeration of a hardware or software entity within the system.
91 A system may contain multiple entities that match a class/subclass pairing.
92 The instance differentiates between them. An instance of 0 indicates that instance
93 information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.
94 @param CallerId This optional parameter may be used to identify the caller.
95 This parameter allows the status code driver to apply different rules to different callers.
96 @param Data This optional parameter may be used to pass additional data.
97 Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.
98 The contents of this data type may have additional GUID-specific data. The standard GUIDs and
99 their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.
101 @return Always return EFI_SUCCESS.
108 IN EFI_STATUS_CODE_TYPE CodeType
,
109 IN EFI_STATUS_CODE_VALUE Value
,
111 IN EFI_GUID
*CallerId OPTIONAL
,
112 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
116 // Use atom operation to avoid the reentant of report.
117 // If current status is not zero, then the function is reentrancy.
119 if (1 == InterlockedCompareExchange32 (&gDxeStatusCode
.StatusCodeNestStatus
, 0, 1)) {
120 return EFI_DEVICE_ERROR
;
123 if (FeaturePcdGet (PcdStatusCodeUseEfiSerial
) || FeaturePcdGet (PcdStatusCodeUseHardSerial
)) {
124 SerialStatusCodeReportWorker (
132 if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory
)) {
133 RtMemoryStatusCodeReportWorker (
134 gDxeStatusCode
.RtMemoryStatusCodeTable
[PHYSICAL_MODE
],
140 if (FeaturePcdGet (PcdStatusCodeUseDataHub
)) {
141 DataHubStatusCodeReportWorker (
149 if (FeaturePcdGet (PcdStatusCodeUseOEM
)) {
150 OemHookStatusCodeReport (
160 // Restore the nest status of report
162 InterlockedCompareExchange32 (&gDxeStatusCode
.StatusCodeNestStatus
, 1, 0);
170 Main entry for Extended SAL ReportStatusCode Services
172 @param FunctionId Function Id which needed to be called
173 @param Arg2 Efi status code type
174 @param Arg3 Efi status code value
175 @param Arg4 Instance number
176 @param Arg5 Caller Id
177 @param Arg6 Efi status code data
180 @param ExtendedSalProc Esal Proc pointer
181 @param VirtualMode If this function is called in virtual mode
182 @param Global This module's global variable pointer
184 @return Value returned in SAL_RETURN_REGS
190 ReportEsalServiceEntry (
191 IN UINT64 FunctionId
,
199 IN SAL_EXTENDED_SAL_PROC ExtendedSalProc
,
200 IN BOOLEAN VirtualMode
,
204 SAL_RETURN_REGS ReturnVal
;
205 DXE_STATUS_CODE_CONTROLLER
*DxeStatusCode
;
207 switch (FunctionId
) {
209 case ReportStatusCodeService
:
211 DxeStatusCode
= (DXE_STATUS_CODE_CONTROLLER
*) Global
;
214 // Use atom operation to avoid the reentant of report.
215 // If current status is not zero, then the function is reentrancy.
217 if (1 == InterlockedCompareExchange32 (&DxeStatusCode
->StatusCodeNestStatus
, 0, 1)) {
218 ReturnVal
.Status
= EFI_DEVICE_ERROR
;
222 if (FeaturePcdGet (PcdStatusCodeUseEfiSerial
) || FeaturePcdGet (PcdStatusCodeUseHardSerial
)) {
223 SerialStatusCodeReportWorker (
224 (EFI_STATUS_CODE_TYPE
) Arg2
,
225 (EFI_STATUS_CODE_VALUE
) Arg3
,
228 (EFI_STATUS_CODE_DATA
*) Arg6
231 if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory
)) {
232 RtMemoryStatusCodeReportWorker (
233 DxeStatusCode
->RtMemoryStatusCodeTable
[VirtualMode
],
234 (EFI_STATUS_CODE_TYPE
) Arg2
,
235 (EFI_STATUS_CODE_VALUE
) Arg3
,
239 if (FeaturePcdGet (PcdStatusCodeUseDataHub
)) {
240 DataHubStatusCodeReportWorker (
241 (EFI_STATUS_CODE_TYPE
) Arg2
,
242 (EFI_STATUS_CODE_VALUE
) Arg3
,
245 (EFI_STATUS_CODE_DATA
*) Arg6
248 if (FeaturePcdGet (PcdStatusCodeUseOEM
)) {
249 OemHookStatusCodeReport (
250 (EFI_STATUS_CODE_TYPE
) Arg2
,
251 (EFI_STATUS_CODE_VALUE
) Arg3
,
254 (EFI_STATUS_CODE_DATA
*) Arg6
259 // Restore the nest status of report
261 InterlockedCompareExchange32 (&DxeStatusCode
->StatusCodeNestStatus
, 1, 0);
263 ReturnVal
.Status
= EFI_SUCCESS
;
268 ReturnVal
.Status
= EFI_SAL_INVALID_ARGUMENT
;
277 Install the ReportStatusCode runtime service.
279 @param ImageHandle Image handle of the loaded driver
280 @param SystemTable Pointer to the System Table
282 @return The function always returns success.
286 DxeStatusCodeDriverEntry (
287 IN EFI_HANDLE ImageHandle
,
288 IN EFI_SYSTEM_TABLE
*SystemTable
292 EFI_HANDLE Handle
= NULL
;
295 // Dispatch initialization request to supported devices
297 InitializationDispatcherWorker ();
300 // Install Status Code Architectural Protocol implementation as defined in Tiano
301 // Architecture Specification.
303 Status
= gBS
->InstallMultipleProtocolInterfaces (
305 &gEfiStatusCodeRuntimeProtocolGuid
,
306 &mEfiStatusCodeProtocol
,
309 ASSERT_EFI_ERROR (Status
);
312 // Initialize ESAL capabilities.
314 Status
= RegisterEsalClass (
315 &gEfiExtendedSalStatusCodeServicesProtocolGuid
,
317 ReportEsalServiceEntry
,
321 ASSERT_EFI_ERROR (Status
);
328 Virtual address change notification call back. It converts physical mode global pointer to
331 @param Event Event whose notification function is being invoked.
332 @param Context Pointer to the notification function's context, which is
333 always zero in current implementation.
338 VirtualAddressChangeCallBack (
343 gDxeStatusCode
.RtMemoryStatusCodeTable
[VIRTUAL_MODE
] =
344 gDxeStatusCode
.RtMemoryStatusCodeTable
[PHYSICAL_MODE
];
347 // Convert the physical mode pointer to virtual mode point.
351 (VOID
**) &gDxeStatusCode
.RtMemoryStatusCodeTable
[VIRTUAL_MODE
]