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 <FrameworkPei.h>
21 #include <WinNtPeim.h>
23 // The protocols, PPI and GUID defintions for this module
25 #include <Guid/StatusCodeDataTypeId.h>
26 #include <Ppi/NtThunk.h>
28 // The Library classes this module consumes
30 #include <Library/OemHookStatusCodeLib.h>
31 #include <Library/DebugLib.h>
32 #include <Library/PrintLib.h>
33 #include <Library/BaseMemoryLib.h>
34 #include <Library/ReportStatusCodeLib.h>
35 #include <Library/PeiServicesLib.h>
38 // Cache of WinNtThunk protocol
41 EFI_WIN_NT_THUNK_PROTOCOL
*mWinNt
;
44 // Cache of standard output handle .
51 Initialize OEM status code device .
53 @return Always return EFI_SUCCESS.
58 OemHookStatusCodeInitialize (
62 PEI_NT_THUNK_PPI
*NtThunkPpi
;
67 // Locate NtThunkPpi for retrieving standard output handle
69 Status
= PeiServicesLocatePpi (
76 ASSERT_EFI_ERROR (Status
);
78 mWinNt
= (EFI_WIN_NT_THUNK_PROTOCOL
*) NtThunkPpi
->NtThunk ();
82 // Cache standard output handle.
84 mStdOut
= mWinNt
->GetStdHandle (STD_OUTPUT_HANDLE
);
90 Report status code to OEM device.
92 @param CodeType Indicates the type of status code being reported. Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.
94 @param Value Describes the current status of a hardware or software entity.
95 This included information about the class and subclass that is used to classify the entity
96 as well as an operation. For progress codes, the operation is the current activity.
97 For error codes, it is the exception. For debug codes, it is not defined at this time.
98 Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.
99 Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.
101 @param Instance The enumeration of a hardware or software entity within the system.
102 A system may contain multiple entities that match a class/subclass pairing.
103 The instance differentiates between them. An instance of 0 indicates that instance information is unavailable,
104 not meaningful, or not relevant. Valid instance numbers start with 1.
107 @param CallerId This optional parameter may be used to identify the caller.
108 This parameter allows the status code driver to apply different rules to different callers.
109 Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.
112 @param Data This optional parameter may be used to pass additional data
114 @return The function always return EFI_SUCCESS.
119 OemHookStatusCodeReport (
120 IN EFI_STATUS_CODE_TYPE CodeType
,
121 IN EFI_STATUS_CODE_VALUE Value
,
123 IN EFI_GUID
*CallerId
, OPTIONAL
124 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
130 CHAR8 Buffer
[EFI_STATUS_CODE_DATA_MAX_SIZE
];
135 EFI_DEBUG_INFO
*DebugInfo
;
140 ReportStatusCodeExtractAssertInfo (CodeType
, Value
, Data
, &Filename
, &Description
, &LineNumber
)) {
142 // Print ASSERT() information into output buffer.
144 CharCount
= AsciiSPrint (
146 EFI_STATUS_CODE_DATA_MAX_SIZE
,
147 "\n\rASSERT!: %a (%d): %a\n\r",
154 // Callout to standard output.
166 } else if (Data
!= NULL
&&
167 ReportStatusCodeExtractDebugInfo (Data
, &ErrorLevel
, &Marker
, &Format
)) {
169 // Print DEBUG() information into output buffer.
171 CharCount
= AsciiVSPrint (
173 EFI_STATUS_CODE_DATA_MAX_SIZE
,
177 } else if (Data
!= NULL
&&
178 CompareGuid (&Data
->Type
, &gEfiStatusCodeSpecificDataGuid
) &&
179 (CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_DEBUG_CODE
) {
181 // Print specific data into output buffer.
183 DebugInfo
= (EFI_DEBUG_INFO
*) (Data
+ 1);
184 Marker
= (VA_LIST
) (DebugInfo
+ 1);
185 Format
= (CHAR8
*) (((UINT64
*) Marker
) + 12);
187 CharCount
= AsciiVSPrint (Buffer
, EFI_STATUS_CODE_DATA_MAX_SIZE
, Format
, Marker
);
188 } else if ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) {
190 // Print ERROR information into output buffer.
192 CharCount
= AsciiSPrint (
194 EFI_STATUS_CODE_DATA_MAX_SIZE
,
195 "ERROR: C%x:V%x I%x",
202 // Make sure we don't try to print values that weren't intended to be printed, especially NULL GUID pointers.
205 if (CallerId
!= NULL
) {
206 CharCount
+= AsciiSPrint (
207 &Buffer
[CharCount
- 1],
208 (EFI_STATUS_CODE_DATA_MAX_SIZE
- (sizeof (Buffer
[0]) * CharCount
)),
215 CharCount
+= AsciiSPrint (
216 &Buffer
[CharCount
- 1],
217 (EFI_STATUS_CODE_DATA_MAX_SIZE
- (sizeof (Buffer
[0]) * CharCount
)),
223 CharCount
+= AsciiSPrint (
224 &Buffer
[CharCount
- 1],
225 (EFI_STATUS_CODE_DATA_MAX_SIZE
- (sizeof (Buffer
[0]) * CharCount
)),
228 } else if ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) {
229 CharCount
= AsciiSPrint (
231 EFI_STATUS_CODE_DATA_MAX_SIZE
,
232 "PROGRESS CODE: V%x I%x\n\r",
237 CharCount
= AsciiSPrint (
239 EFI_STATUS_CODE_DATA_MAX_SIZE
,
240 "Undefined: C%x:V%x I%x\n\r",
248 // Callout to standard output.