/** @file | |
Include file for PI SMM Status Code Protocol on Framework SMM Status Code Protocol Thunk driver. | |
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR> | |
This program and the accompanying materials are licensed and made available under | |
the terms and conditions of the BSD License that accompanies this distribution. | |
The full text of the license may be found at | |
http://opensource.org/licenses/bsd-license.php. | |
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
**/ | |
#ifndef __PI_SMM_STATUS_CODE_ON_FRAMEWORK_SMM_STATUS_CODE_H__ | |
#define __PI_SMM_STATUS_CODE_ON_FRAMEWORK_SMM_STATUS_CODE_H__ | |
#include <Protocol/SmmReportStatusCodeHandler.h> | |
#include <Protocol/SmmStatusCode.h> | |
#include <Library/BaseLib.h> | |
#include <Library/DebugLib.h> | |
#include <Library/SynchronizationLib.h> | |
#include <Library/UefiDriverEntryPoint.h> | |
#include <Library/SmmServicesTableLib.h> | |
#include <Library/MemoryAllocationLib.h> | |
#define SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE SIGNATURE_32 ('s', 'h', 'c', 'e') | |
typedef struct { | |
UINTN Signature; | |
EFI_SMM_RSC_HANDLER_CALLBACK RscHandlerCallback; | |
LIST_ENTRY Node; | |
} SMM_RSC_HANDLER_CALLBACK_ENTRY; | |
/** | |
Register the callback function for ReportStatusCode() notification. | |
When this function is called the function pointer is added to an internal list and any future calls to | |
ReportStatusCode() will be forwarded to the Callback function. | |
@param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called | |
when a call to ReportStatusCode() occurs. | |
@retval EFI_SUCCESS Function was successfully registered. | |
@retval EFI_INVALID_PARAMETER The callback function was NULL. | |
@retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be | |
registered. | |
@retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
Register ( | |
IN EFI_SMM_RSC_HANDLER_CALLBACK Callback | |
); | |
/** | |
Remove a previously registered callback function from the notification list. | |
ReportStatusCode() messages will no longer be forwarded to the Callback function. | |
@param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be | |
unregistered. | |
@retval EFI_SUCCESS The function was successfully unregistered. | |
@retval EFI_INVALID_PARAMETER The callback function was NULL. | |
@retval EFI_NOT_FOUND The callback function was not found to be unregistered. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
Unregister ( | |
IN EFI_SMM_RSC_HANDLER_CALLBACK Callback | |
); | |
/** | |
Provides an interface that a software module can call to report a status code. | |
@param This EFI_SMM_STATUS_CODE_PROTOCOL instance. | |
@param Type 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 The function completed successfully | |
@retval EFI_DEVICE_ERROR The function should not be completed due to a device error. | |
**/ | |
EFI_STATUS | |
EFIAPI | |
ReportDispatcher ( | |
IN CONST EFI_SMM_STATUS_CODE_PROTOCOL *This, | |
IN EFI_STATUS_CODE_TYPE Type, | |
IN EFI_STATUS_CODE_VALUE Value, | |
IN UINT32 Instance, | |
IN CONST EFI_GUID *CallerId OPTIONAL, | |
IN EFI_STATUS_CODE_DATA *Data OPTIONAL | |
); | |
#endif |