2 Status code driver for IA32/X64/EBC 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: DxeStatusCodeCommon.c
17 // Include common header file for this module.
19 #include "CommonHeader.h"
21 #include "DxeStatusCode.h"
25 Report status code to all supported device.
26 Calls into the workers which dispatches the platform specific
29 @param Type Indicates the type of status code being reported.
30 The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
31 @param Value Describes the current status of a hardware or software entity.
32 This includes information about the class and subclass that is used to classify the entity
33 as well as an operation. For progress codes, the operation is the current activity.
34 For error codes, it is the exception. For debug codes, it is not defined at this time.
35 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
36 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
37 @param Instance The enumeration of a hardware or software entity within the system.
38 A system may contain multiple entities that match a class/subclass pairing.
39 The instance differentiates between them. An instance of 0 indicates that instance
40 information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.
41 @param CallerId This optional parameter may be used to identify the caller.
42 This parameter allows the status code driver to apply different rules to different callers.
43 @param Data This optional parameter may be used to pass additional data.
44 Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.
45 The contents of this data type may have additional GUID-specific data. The standard GUIDs and
46 their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.
48 @return Always return EFI_SUCCESS.
54 IN EFI_STATUS_CODE_TYPE Type
,
55 IN EFI_STATUS_CODE_VALUE Value
,
57 IN EFI_GUID
*CallerId OPTIONAL
,
58 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
62 // Declaration of status code protocol.
65 EFI_STATUS_CODE_PROTOCOL mEfiStatusCodeProtocol
= {
70 // Delaration of DXE status code controller
72 DXE_STATUS_CODE_CONTROLLER gDxeStatusCode
= {
74 // Initialize nest status as non nested.
82 Install the ReportStatusCode runtime service.
84 @param ImageHandle Image handle of the loaded driver
85 @param SystemTable Pointer to the System Table
87 @return The function always returns success.
91 DxeStatusCodeDriverEntry (
92 IN EFI_HANDLE ImageHandle
,
93 IN EFI_SYSTEM_TABLE
*SystemTable
96 EFI_HANDLE Handle
= NULL
;
100 // Dispatch initialization request to supported devices
102 InitializationDispatcherWorker ();
105 // Install Status Code Architectural Protocol implementation as defined in Tiano
106 // Architecture Specification.
108 Status
= gBS
->InstallMultipleProtocolInterfaces (
110 &gEfiStatusCodeRuntimeProtocolGuid
,
111 &mEfiStatusCodeProtocol
,
114 ASSERT_EFI_ERROR (Status
);
120 Report status code to all supported device.
121 Calls into the workers which dispatches the platform specific
124 @param CodeType Indicates the type of status code being reported.
125 The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
126 @param Value Describes the current status of a hardware or software entity.
127 This includes information about the class and subclass that is used to classify the entity
128 as well as an operation. For progress codes, the operation is the current activity.
129 For error codes, it is the exception. For debug codes, it is not defined at this time.
130 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
131 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
132 @param Instance The enumeration of a hardware or software entity within the system.
133 A system may contain multiple entities that match a class/subclass pairing.
134 The instance differentiates between them. An instance of 0 indicates that instance
135 information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1.
136 @param CallerId This optional parameter may be used to identify the caller.
137 This parameter allows the status code driver to apply different rules to different callers.
138 @param Data This optional parameter may be used to pass additional data.
139 Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.
140 The contents of this data type may have additional GUID-specific data. The standard GUIDs and
141 their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.
143 @return Always return EFI_SUCCESS.
149 IN EFI_STATUS_CODE_TYPE CodeType
,
150 IN EFI_STATUS_CODE_VALUE Value
,
152 IN EFI_GUID
*CallerId OPTIONAL
,
153 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
157 // Use atom operation to avoid the reentant of report.
158 // If current status is not zero, then the function is reentrancy.
160 if (1 == InterlockedCompareExchange32 (&gDxeStatusCode
.StatusCodeNestStatus
, 0, 1)) {
161 return EFI_DEVICE_ERROR
;
164 if (FeaturePcdGet (PcdStatusCodeUseEfiSerial
) || FeaturePcdGet (PcdStatusCodeUseHardSerial
)) {
165 SerialStatusCodeReportWorker (
173 if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory
)) {
174 RtMemoryStatusCodeReportWorker (
175 gDxeStatusCode
.RtMemoryStatusCodeTable
[PHYSICAL_MODE
],
181 if (FeaturePcdGet (PcdStatusCodeUseDataHub
)) {
182 DataHubStatusCodeReportWorker (
190 if (FeaturePcdGet (PcdStatusCodeUseOEM
)) {
191 OemHookStatusCodeReport (
201 // Restore the nest status of report
203 InterlockedCompareExchange32 (&gDxeStatusCode
.StatusCodeNestStatus
, 1, 0);
210 Virtual address change notification call back. It converts global pointer
213 @param Event Event whose notification function is being invoked.
214 @param Context Pointer to the notification function's context, which is
215 always zero in current implementation.
220 VirtualAddressChangeCallBack (
226 // Convert memory status code table to virtual address;
230 (VOID
**) &gDxeStatusCode
.RtMemoryStatusCodeTable
[PHYSICAL_MODE
]