4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol provide registering and unregistering services to status code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync consumers while in DXE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x86212936, 0xe76, 0x41c8, {0xa0, 0x3a, 0x2a, 0xf2, 0xfc, 0x1c, 0x39, 0xe2} \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Register the callback function for ReportStatusCode() notification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When this function is called the function pointer is added to an internal list and any future calls to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReportStatusCode() will be forwarded to the Callback function. During the bootservices,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is the callback for which this service can be invoked. The report status code router
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will create an event such that the callback function is only invoked at the TPL for which it was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered. The entity that registers for the callback should also register for an event upon
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync generation of exit boot services and invoke the unregister service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the handler does not have a TPL dependency, it should register for a callback at TPL high. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync router infrastructure will support making callbacks at runtime, but the caller for runtime invocation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must meet the following criteria:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1. must be a runtime driver type so that its memory is not reclaimed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2. not unregister at exit boot services so that the router will still have its callback address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3. the caller must be self-contained (eg. Not call out into any boot-service interfaces) and be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync runtime safe, in general.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is called when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a call to ReportStatusCode() occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Tpl TPL at which callback can be safely invoked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Function was successfully registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The callback function was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove a previously registered callback function from the notification list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A callback function must be unregistered before it is deallocated. It is important that any registered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync callbacks that are not runtime complaint be unregistered when ExitBootServices() is called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Callback A pointer to a function of type EFI_RSC_HANDLER_CALLBACK that is to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function was successfully unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The callback function was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The callback function was not found to be unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif // __REPORT_STATUS_CODE_HANDLER_H__