2 Internal include file for Status Code Handler Driver.
4 Copyright (c) 2009 - 2010, 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.
15 #ifndef __STATUS_CODE_HANDLER_SMM_H__
16 #define __STATUS_CODE_HANDLER_SMM_H__
18 #include <Protocol/SmmReportStatusCodeHandler.h>
20 #include <Guid/MemoryStatusCodeRecord.h>
21 #include <Guid/StatusCodeDataTypeId.h>
22 #include <Guid/StatusCodeDataTypeDebug.h>
24 #include <Library/SynchronizationLib.h>
25 #include <Library/DebugLib.h>
26 #include <Library/ReportStatusCodeLib.h>
27 #include <Library/PrintLib.h>
28 #include <Library/PcdLib.h>
29 #include <Library/UefiDriverEntryPoint.h>
30 #include <Library/SmmServicesTableLib.h>
31 #include <Library/SerialPortLib.h>
32 #include <Library/MemoryAllocationLib.h>
35 // Runtime memory status code worker definition
39 UINT32 NumberOfRecords
;
40 UINT32 MaxRecordsNumber
;
41 } RUNTIME_MEMORY_STATUSCODE_HEADER
;
43 extern RUNTIME_MEMORY_STATUSCODE_HEADER
*mSmmMemoryStatusCodeTable
;
46 Locates Serial I/O Protocol as initialization for serial status code worker.
48 @retval EFI_SUCCESS Serial I/O Protocol is successfully located.
52 EfiSerialStatusCodeInitializeWorker (
58 Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
60 @param CodeType Indicates the type of status code being reported.
61 @param Value Describes the current status of a hardware or software entity.
62 This included information about the class and subclass that is used to
63 classify the entity as well as an operation.
64 @param Instance The enumeration of a hardware or software entity within
65 the system. Valid instance numbers start with 1.
66 @param CallerId This optional parameter may be used to identify the caller.
67 This parameter allows the status code driver to apply different rules to
69 @param Data This optional parameter may be used to pass additional data.
71 @retval EFI_SUCCESS Status code reported to serial I/O successfully.
72 @retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.
73 @retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.
78 SerialStatusCodeReportWorker (
79 IN EFI_STATUS_CODE_TYPE CodeType
,
80 IN EFI_STATUS_CODE_VALUE Value
,
82 IN EFI_GUID
*CallerId
,
83 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
87 Initialize runtime memory status code table as initialization for runtime memory status code worker
89 @retval EFI_SUCCESS Runtime memory status code table successfully initialized.
93 MemoryStatusCodeInitializeWorker (
98 Report status code into runtime memory. If the runtime pool is full, roll back to the
99 first record and overwrite it.
101 @param CodeType Indicates the type of status code being reported.
102 @param Value Describes the current status of a hardware or software entity.
103 This included information about the class and subclass that is used to
104 classify the entity as well as an operation.
105 @param Instance The enumeration of a hardware or software entity within
106 the system. 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
110 @param Data This optional parameter may be used to pass additional data.
112 @retval EFI_SUCCESS Status code successfully recorded in runtime memory status code table.
117 MemoryStatusCodeReportWorker (
118 IN EFI_STATUS_CODE_TYPE CodeType
,
119 IN EFI_STATUS_CODE_VALUE Value
,
121 IN EFI_GUID
*CallerId
,
122 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL