9df063a06a
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10403 6f19259b-4bc3-4df7-8a09-765794883524
82 lines
3.2 KiB
C
82 lines
3.2 KiB
C
/** @file
|
|
This protocol provides registering and unregistering services to status code consumers while in DXE SMM.
|
|
|
|
Copyright (c) 2007 - 2009, 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
|
|
which 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 __SMM_REPORT_STATUS_CODE_HANDLER_PROTOCOL_H__
|
|
#define __SMM_REPORT_STATUS_CODE_HANDLER_PROTOCOL_H__
|
|
|
|
#define EFI_SMM_RSC_HANDLER_PROTOCOL_GUID \
|
|
{ \
|
|
0x2ff29fa7, 0x5e80, 0x4ed9, {0xb3, 0x80, 0x1, 0x7d, 0x3c, 0x55, 0x4f, 0xf4} \
|
|
}
|
|
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SMM_RSC_HANDLER_CALLBACK)(
|
|
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
|
|
);
|
|
|
|
/**
|
|
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_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.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SMM_RSC_HANDLER_REGISTER)(
|
|
IN EFI_SMM_RSC_HANDLER_CALLBACK Callback
|
|
);
|
|
|
|
/**
|
|
Remove a previously registered callback function from the notification list.
|
|
|
|
A callback function must be unregistered before it is deallocated. It is important that any registered
|
|
callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.
|
|
|
|
@param[in] Callback A pointer to a function of type EFI_SMM_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.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_SMM_RSC_HANDLER_UNREGISTER)(
|
|
IN EFI_SMM_RSC_HANDLER_CALLBACK Callback
|
|
);
|
|
|
|
typedef struct _EFI_SMM_RSC_HANDLER_PROTOCOL {
|
|
EFI_SMM_RSC_HANDLER_REGISTER Register;
|
|
EFI_SMM_RSC_HANDLER_UNREGISTER Unregister;
|
|
} EFI_SMM_RSC_HANDLER_PROTOCOL;
|
|
|
|
extern EFI_GUID gEfiSmmRscHandlerProtocolGuid;
|
|
|
|
#endif // __SMM_REPORT_STATUS_CODE_HANDLER_PROTOCOL_H__
|