2 Internal include file for Status Code Handler Driver.
4 Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
5 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.
15 #ifndef __STATUS_CODE_HANDLER_RUNTIME_DXE_H__
16 #define __STATUS_CODE_HANDLER_RUNTIME_DXE_H__
18 #include <Protocol/ReportStatusCodeHandler.h>
20 #include <Guid/MemoryStatusCodeRecord.h>
21 #include <Guid/StatusCodeDataTypeId.h>
22 #include <Guid/StatusCodeDataTypeDebug.h>
23 #include <Guid/EventGroup.h>
25 #include <Library/SynchronizationLib.h>
26 #include <Library/DebugLib.h>
27 #include <Library/ReportStatusCodeLib.h>
28 #include <Library/PrintLib.h>
29 #include <Library/PcdLib.h>
30 #include <Library/HobLib.h>
31 #include <Library/UefiDriverEntryPoint.h>
32 #include <Library/UefiBootServicesTableLib.h>
33 #include <Library/MemoryAllocationLib.h>
34 #include <Library/UefiRuntimeLib.h>
35 #include <Library/SerialPortLib.h>
38 // Runtime memory status code worker definition
42 UINT32 NumberOfRecords
;
43 UINT32 MaxRecordsNumber
;
44 } RUNTIME_MEMORY_STATUSCODE_HEADER
;
46 extern RUNTIME_MEMORY_STATUSCODE_HEADER
*mRtMemoryStatusCodeTable
;
49 Locates Serial I/O Protocol as initialization for serial status code worker.
51 @retval EFI_SUCCESS Serial I/O Protocol is successfully located.
55 EfiSerialStatusCodeInitializeWorker (
61 Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
63 @param CodeType Indicates the type of status code being reported.
64 @param Value Describes the current status of a hardware or software entity.
65 This included information about the class and subclass that is used to
66 classify the entity as well as an operation.
67 @param Instance The enumeration of a hardware or software entity within
68 the system. Valid instance numbers start with 1.
69 @param CallerId This optional parameter may be used to identify the caller.
70 This parameter allows the status code driver to apply different rules to
72 @param Data This optional parameter may be used to pass additional data.
74 @retval EFI_SUCCESS Status code reported to serial I/O successfully.
75 @retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.
76 @retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.
81 SerialStatusCodeReportWorker (
82 IN EFI_STATUS_CODE_TYPE CodeType
,
83 IN EFI_STATUS_CODE_VALUE Value
,
85 IN EFI_GUID
*CallerId
,
86 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
90 Initialize runtime memory status code table as initialization for runtime memory status code worker
92 @retval EFI_SUCCESS Runtime memory status code table successfully initialized.
96 RtMemoryStatusCodeInitializeWorker (
101 Report status code into runtime memory. If the runtime pool is full, roll back to the
102 first record and overwrite it.
104 @param CodeType Indicates the type of status code being reported.
105 @param Value Describes the current status of a hardware or software entity.
106 This included information about the class and subclass that is used to
107 classify the entity as well as an operation.
108 @param Instance The enumeration of a hardware or software entity within
109 the system. Valid instance numbers start with 1.
110 @param CallerId This optional parameter may be used to identify the caller.
111 This parameter allows the status code driver to apply different rules to
113 @param Data This optional parameter may be used to pass additional data.
115 @retval EFI_SUCCESS Status code successfully recorded in runtime memory status code table.
120 RtMemoryStatusCodeReportWorker (
121 IN EFI_STATUS_CODE_TYPE CodeType
,
122 IN EFI_STATUS_CODE_VALUE Value
,
124 IN EFI_GUID
*CallerId
,
125 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL