mirror of https://github.com/acidanthera/audk.git
132 lines
4.7 KiB
C
132 lines
4.7 KiB
C
/** @file
|
|
Internal include file for Status Code Handler Driver.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __STATUS_CODE_HANDLER_RUNTIME_DXE_H__
|
|
#define __STATUS_CODE_HANDLER_RUNTIME_DXE_H__
|
|
|
|
#include <Protocol/ReportStatusCodeHandler.h>
|
|
|
|
#include <Guid/MemoryStatusCodeRecord.h>
|
|
#include <Guid/StatusCodeDataTypeId.h>
|
|
#include <Guid/StatusCodeDataTypeDebug.h>
|
|
#include <Guid/EventGroup.h>
|
|
|
|
#include <Library/SynchronizationLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/ReportStatusCodeLib.h>
|
|
#include <Library/PrintLib.h>
|
|
#include <Library/PcdLib.h>
|
|
#include <Library/HobLib.h>
|
|
#include <Library/UefiDriverEntryPoint.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiRuntimeLib.h>
|
|
#include <Library/SerialPortLib.h>
|
|
|
|
//
|
|
// Define the maximum message length
|
|
//
|
|
#define MAX_DEBUG_MESSAGE_LENGTH 0x100
|
|
|
|
extern RUNTIME_MEMORY_STATUSCODE_HEADER *mRtMemoryStatusCodeTable;
|
|
|
|
/**
|
|
Locates Serial I/O Protocol as initialization for serial status code worker.
|
|
|
|
@retval EFI_SUCCESS Serial I/O Protocol is successfully located.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EfiSerialStatusCodeInitializeWorker (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Convert status code value and extended data to readable ASCII string, send string to serial I/O device.
|
|
|
|
@param CodeType Indicates the type of status code being reported.
|
|
@param Value Describes the current status of a hardware or software entity.
|
|
This included information about the class and subclass that is used to
|
|
classify the entity as well as an operation.
|
|
@param Instance The enumeration of a hardware or software entity within
|
|
the system. Valid instance numbers start with 1.
|
|
@param CallerId This optional parameter may be used to identify the caller.
|
|
This parameter allows the status code driver to apply different rules to
|
|
different callers.
|
|
@param Data This optional parameter may be used to pass additional data.
|
|
|
|
@retval EFI_SUCCESS Status code reported to serial I/O successfully.
|
|
@retval EFI_DEVICE_ERROR EFI serial device cannot work after ExitBootService() is called.
|
|
@retval EFI_DEVICE_ERROR EFI serial device cannot work with TPL higher than TPL_CALLBACK.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialStatusCodeReportWorker (
|
|
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
IN EFI_STATUS_CODE_VALUE Value,
|
|
IN UINT32 Instance,
|
|
IN EFI_GUID *CallerId,
|
|
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Initialize runtime memory status code table as initialization for runtime memory status code worker
|
|
|
|
@retval EFI_SUCCESS Runtime memory status code table successfully initialized.
|
|
@retval others Errors from gBS->InstallConfigurationTable().
|
|
|
|
**/
|
|
EFI_STATUS
|
|
RtMemoryStatusCodeInitializeWorker (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Report status code into runtime memory. If the runtime pool is full, roll back to the
|
|
first record and overwrite it.
|
|
|
|
@param CodeType Indicates the type of status code being reported.
|
|
@param Value Describes the current status of a hardware or software entity.
|
|
This included information about the class and subclass that is used to
|
|
classify the entity as well as an operation.
|
|
@param Instance The enumeration of a hardware or software entity within
|
|
the system. Valid instance numbers start with 1.
|
|
@param CallerId This optional parameter may be used to identify the caller.
|
|
This parameter allows the status code driver to apply different rules to
|
|
different callers.
|
|
@param Data This optional parameter may be used to pass additional data.
|
|
|
|
@retval EFI_SUCCESS Status code successfully recorded in runtime memory status code table.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
RtMemoryStatusCodeReportWorker (
|
|
IN EFI_STATUS_CODE_TYPE CodeType,
|
|
IN EFI_STATUS_CODE_VALUE Value,
|
|
IN UINT32 Instance,
|
|
IN EFI_GUID *CallerId,
|
|
IN EFI_STATUS_CODE_DATA *Data OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Unregister status code callback functions only available at boot time from
|
|
report status code router when exiting boot services.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
UnregisterSerialBootTimeHandlers (
|
|
VOID
|
|
);
|
|
|
|
#endif
|