2 OEM hook status code library functions with no library constructor/destructor
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: Nt32OemHookStatusCodeLib.c
18 // The package level header files this module uses
20 #include <FrameworkDxe.h>
21 #include <FrameworkModuleDxe.h>
23 #include <DebugInfo.h>
26 // The protocols, PPI and GUID defintions for this module
28 #include <Protocol/WinNtThunk.h>
29 #include <Guid/StatusCodeDataTypeId.h>
31 // The Library classes this module consumes
33 #include <Library/OemHookStatusCodeLib.h>
34 #include <Library/DebugLib.h>
35 #include <Library/HobLib.h>
36 #include <Library/PrintLib.h>
37 #include <Library/BaseMemoryLib.h>
38 #include <Library/ReportStatusCodeLib.h>
41 // Cache of WinNtThunk protocol
44 EFI_WIN_NT_THUNK_PROTOCOL
*mWinNt
;
47 // Cache of standard output handle .
54 Initialize OEM status code device .
56 @return Always return EFI_SUCCESS.
61 OemHookStatusCodeInitialize (
65 EFI_HOB_GUID_TYPE
*GuidHob
;
68 // Retrieve WinNtThunkProtocol from GUID'ed HOB
70 GuidHob
= GetFirstGuidHob (&gEfiWinNtThunkProtocolGuid
);
71 ASSERT (GuidHob
!= NULL
);
72 mWinNt
= (EFI_WIN_NT_THUNK_PROTOCOL
*)(*(UINTN
*)(GET_GUID_HOB_DATA (GuidHob
)));
73 ASSERT (mWinNt
!= NULL
);
76 // Cache standard output handle.
78 mStdOut
= mWinNt
->GetStdHandle (STD_OUTPUT_HANDLE
);
84 Report status code to OEM device.
86 @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
88 @param Value Describes the current status of a hardware or software entity.
89 This included information about the class and subclass that is used to classify the entity
90 as well as an operation. For progress codes, the operation is the current activity.
91 For error codes, it is the exception. For debug codes, it is not defined at this time.
92 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
93 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
95 @param Instance The enumeration of a hardware or software entity within the system.
96 A system may contain multiple entities that match a class/subclass pairing.
97 The instance differentiates between them. An instance of 0 indicates that instance information is unavailable,
98 not meaningful, or not relevant. Valid instance numbers start with 1.
101 @param CallerId This optional parameter may be used to identify the caller.
102 This parameter allows the status code driver to apply different rules to different callers.
103 Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
106 @param Data This optional parameter may be used to pass additional data
108 @return The function always return EFI_SUCCESS.
113 OemHookStatusCodeReport (
114 IN EFI_STATUS_CODE_TYPE CodeType
,
115 IN EFI_STATUS_CODE_VALUE Value
,
117 IN EFI_GUID
*CallerId
, OPTIONAL
118 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
124 CHAR8 Buffer
[EFI_STATUS_CODE_DATA_MAX_SIZE
];
129 EFI_DEBUG_INFO
*DebugInfo
;
134 ReportStatusCodeExtractAssertInfo (CodeType
, Value
, Data
, &Filename
, &Description
, &LineNumber
)) {
136 // Print ASSERT() information into output buffer.
138 CharCount
= AsciiSPrint (
140 EFI_STATUS_CODE_DATA_MAX_SIZE
,
141 "\n\rASSERT!: %a (%d): %a\n\r",
148 // Callout to standard output.
160 } else if (Data
!= NULL
&&
161 ReportStatusCodeExtractDebugInfo (Data
, &ErrorLevel
, &Marker
, &Format
)) {
163 // Print DEBUG() information into output buffer.
165 CharCount
= AsciiVSPrint (
167 EFI_STATUS_CODE_DATA_MAX_SIZE
,
171 } else if (Data
!= NULL
&&
172 CompareGuid (&Data
->Type
, &gEfiStatusCodeSpecificDataGuid
) &&
173 (CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_DEBUG_CODE
) {
175 // Print specific data into output buffer.
177 DebugInfo
= (EFI_DEBUG_INFO
*) (Data
+ 1);
178 Marker
= (VA_LIST
) (DebugInfo
+ 1);
179 Format
= (CHAR8
*) (((UINT64
*) Marker
) + 12);
181 CharCount
= AsciiVSPrint (Buffer
, EFI_STATUS_CODE_DATA_MAX_SIZE
, Format
, Marker
);
182 } else if ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) {
184 // Print ERROR information into output buffer.
186 CharCount
= AsciiSPrint (
188 EFI_STATUS_CODE_DATA_MAX_SIZE
,
189 "ERROR: C%x:V%x I%x",
196 // Make sure we don't try to print values that weren't intended to be printed, especially NULL GUID pointers.
199 if (CallerId
!= NULL
) {
200 CharCount
+= AsciiSPrint (
201 &Buffer
[CharCount
- 1],
202 (EFI_STATUS_CODE_DATA_MAX_SIZE
- (sizeof (Buffer
[0]) * CharCount
)),
209 CharCount
+= AsciiSPrint (
210 &Buffer
[CharCount
- 1],
211 (EFI_STATUS_CODE_DATA_MAX_SIZE
- (sizeof (Buffer
[0]) * CharCount
)),
217 CharCount
+= AsciiSPrint (
218 &Buffer
[CharCount
- 1],
219 (EFI_STATUS_CODE_DATA_MAX_SIZE
- (sizeof (Buffer
[0]) * CharCount
)),
222 } else if ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) {
223 CharCount
= AsciiSPrint (
225 EFI_STATUS_CODE_DATA_MAX_SIZE
,
226 "PROGRESS CODE: V%x I%x\n\r",
231 CharCount
= AsciiSPrint (
233 EFI_STATUS_CODE_DATA_MAX_SIZE
,
234 "Undefined: C%x:V%x I%x\n\r",
242 // Callout to standard output.