mirror of https://github.com/acidanthera/audk.git
294 lines
11 KiB
C
294 lines
11 KiB
C
|
/** @file
|
||
|
|
PI SMM Status Code Protocol on Framework SMM Status Code Protocol Thunk.
|
||
|
|
|
||
|
|
This thunk driver produces PI SMM Status Code Protocol and SMM Report Status Code Handler Protocol.
|
||
|
|
And it registers a status code handler within itself to route status codes into Framework SMM Status
|
||
|
|
Code Protocol.
|
||
|
|
|
||
|
|
Note that Framework SMM Status Code Protocol and PI SMM Status Code Protocol have identical protocol
|
||
|
|
GUID and interface structure, but they are in different handle databases.
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#include "PiSmmStatusCodeOnFrameworkSmmStatusCodeThunk.h"
|
||
|
|
|
||
|
|
LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Report operation nest status.
|
||
|
|
// If it is set, then the report operation has nested.
|
||
|
|
//
|
||
|
|
UINT32 mStatusCodeNestStatus = 0;
|
||
|
|
|
||
|
|
EFI_SMM_STATUS_CODE_PROTOCOL mSmmStatusCodeProtocol = {
|
||
|
|
ReportDispatcher
|
||
|
|
};
|
||
|
|
|
||
|
|
EFI_SMM_RSC_HANDLER_PROTOCOL mSmmRscHandlerProtocol = {
|
||
|
|
Register,
|
||
|
|
Unregister
|
||
|
|
};
|
||
|
|
|
||
|
|
EFI_SMM_STATUS_CODE_PROTOCOL *mFrameworkSmmStatusCode;
|
||
|
|
|
||
|
|
/**
|
||
|
|
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
|
||
|
|
)
|
||
|
|
{
|
||
|
|
LIST_ENTRY *Link;
|
||
|
|
SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;
|
||
|
|
|
||
|
|
if (Callback == NULL) {
|
||
|
|
return EFI_INVALID_PARAMETER;
|
||
|
|
}
|
||
|
|
|
||
|
|
for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {
|
||
|
|
CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);
|
||
|
|
if (CallbackEntry->RscHandlerCallback == Callback) {
|
||
|
|
//
|
||
|
|
// If the function was already registered. It can't be registered again.
|
||
|
|
//
|
||
|
|
return EFI_ALREADY_STARTED;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
CallbackEntry = (SMM_RSC_HANDLER_CALLBACK_ENTRY *)AllocatePool (sizeof (SMM_RSC_HANDLER_CALLBACK_ENTRY));
|
||
|
|
ASSERT (CallbackEntry != NULL);
|
||
|
|
|
||
|
|
CallbackEntry->Signature = SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;
|
||
|
|
CallbackEntry->RscHandlerCallback = Callback;
|
||
|
|
|
||
|
|
InsertTailList (&mCallbackListHead, &CallbackEntry->Node);
|
||
|
|
|
||
|
|
return EFI_SUCCESS;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
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
|
||
|
|
)
|
||
|
|
{
|
||
|
|
LIST_ENTRY *Link;
|
||
|
|
SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;
|
||
|
|
|
||
|
|
if (Callback == NULL) {
|
||
|
|
return EFI_INVALID_PARAMETER;
|
||
|
|
}
|
||
|
|
|
||
|
|
for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {
|
||
|
|
CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);
|
||
|
|
if (CallbackEntry->RscHandlerCallback == Callback) {
|
||
|
|
//
|
||
|
|
// If the function is found in list, delete it and return.
|
||
|
|
//
|
||
|
|
RemoveEntryList (&CallbackEntry->Node);
|
||
|
|
FreePool (CallbackEntry);
|
||
|
|
return EFI_SUCCESS;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return EFI_NOT_FOUND;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
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
|
||
|
|
)
|
||
|
|
{
|
||
|
|
LIST_ENTRY *Link;
|
||
|
|
SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;
|
||
|
|
|
||
|
|
//
|
||
|
|
// Use atom operation to avoid the reentant of report.
|
||
|
|
// If current status is not zero, then the function is reentrancy.
|
||
|
|
//
|
||
|
|
if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {
|
||
|
|
return EFI_DEVICE_ERROR;
|
||
|
|
}
|
||
|
|
|
||
|
|
for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {
|
||
|
|
CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);
|
||
|
|
|
||
|
|
CallbackEntry->RscHandlerCallback (
|
||
|
|
Type,
|
||
|
|
Value,
|
||
|
|
Instance,
|
||
|
|
(EFI_GUID*)CallerId,
|
||
|
|
Data
|
||
|
|
);
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Restore the nest status of report
|
||
|
|
//
|
||
|
|
InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);
|
||
|
|
|
||
|
|
return EFI_SUCCESS;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
This SMM Status Code Handler routes status codes to Framework SMM Status Code Protocol.
|
||
|
|
|
||
|
|
@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 The function completed successfully.
|
||
|
|
@retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
SmmStatusCodeHandler (
|
||
|
|
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
|
||
|
|
)
|
||
|
|
{
|
||
|
|
return mFrameworkSmmStatusCode->ReportStatusCode (
|
||
|
|
mFrameworkSmmStatusCode,
|
||
|
|
CodeType,
|
||
|
|
Value,
|
||
|
|
Instance,
|
||
|
|
CallerId,
|
||
|
|
Data
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Entry point of PI SMM Status Code Protocol on Framework SMM Status Code Protocol thunk driver.
|
||
|
|
|
||
|
|
@param ImageHandle The firmware allocated handle for the EFI image.
|
||
|
|
@param SystemTable A pointer to the EFI System Table.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS The entry point is executed successfully.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
SmmStatusCodeThunkMain (
|
||
|
|
IN EFI_HANDLE ImageHandle,
|
||
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
||
|
|
)
|
||
|
|
{
|
||
|
|
EFI_STATUS Status;
|
||
|
|
EFI_HANDLE Handle;
|
||
|
|
|
||
|
|
//
|
||
|
|
// Locate Framework SMM Status Code Protocol in UEFI handle database.
|
||
|
|
//
|
||
|
|
Status = SystemTable->BootServices->LocateProtocol (
|
||
|
|
&gEfiSmmStatusCodeProtocolGuid,
|
||
|
|
NULL,
|
||
|
|
(VOID **)&mFrameworkSmmStatusCode
|
||
|
|
);
|
||
|
|
ASSERT_EFI_ERROR (Status);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Registers status code handler to route status codes into Framework SMM Status Code Protocol.
|
||
|
|
//
|
||
|
|
Register (SmmStatusCodeHandler);
|
||
|
|
|
||
|
|
Handle = NULL;
|
||
|
|
|
||
|
|
//
|
||
|
|
// Install SmmRscHandler Protocol
|
||
|
|
//
|
||
|
|
Status = gSmst->SmmInstallProtocolInterface (
|
||
|
|
&Handle,
|
||
|
|
&gEfiSmmRscHandlerProtocolGuid,
|
||
|
|
EFI_NATIVE_INTERFACE,
|
||
|
|
&mSmmRscHandlerProtocol
|
||
|
|
);
|
||
|
|
ASSERT_EFI_ERROR (Status);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Install SmmStatusCode Protocol
|
||
|
|
//
|
||
|
|
Status = gSmst->SmmInstallProtocolInterface (
|
||
|
|
&Handle,
|
||
|
|
&gEfiSmmStatusCodeProtocolGuid,
|
||
|
|
EFI_NATIVE_INTERFACE,
|
||
|
|
&mSmmStatusCodeProtocol
|
||
|
|
);
|
||
|
|
ASSERT_EFI_ERROR (Status);
|
||
|
|
|
||
|
|
return EFI_SUCCESS;
|
||
|
|
}
|