2 EFI Delayed Dispatch PPI as defined in the PI 1.7 Specification
4 Provide timed event service in PEI
6 Copyright (c) 2020, American Megatrends International LLC. All rights reserved.
7 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef __DELAYED_DISPATCH_PPI_H__
11 #define __DELAYED_DISPATCH_PPI_H__
14 /// Global ID for EFI_DELAYED_DISPATCH_PPI_GUID
16 #define EFI_DELAYED_DISPATCH_PPI_GUID \
18 0x869c711d, 0x649c, 0x44fe, { 0x8b, 0x9e, 0x2c, 0xbb, 0x29, 0x11, 0xc3, 0xe6} } \
23 Delayed Dispatch function. This routine is called sometime after the required
24 delay. Upon return, if NewDelay is 0, the function is unregistered. If NewDelay
25 is not zero, this routine will be called again after the new delay period.
27 @param[in,out] Context Pointer to Context. Can be updated by routine.
28 @param[out] NewDelay The new delay in us. Leave at 0 to unregister callback.
34 (EFIAPI
*EFI_DELAYED_DISPATCH_FUNCTION
) (
35 IN OUT UINT64
*Context
,
41 /// The forward declaration for EFI_DELAYED_DISPATCH_PPI
44 typedef struct _EFI_DELAYED_DISPATCH_PPI EFI_DELAYED_DISPATCH_PPI
;
48 Register a callback to be called after a minimum delay has occurred.
50 This service is the single member function of the EFI_DELAYED_DISPATCH_PPI
52 @param This Pointer to the EFI_DELAYED_DISPATCH_PPI instance
53 @param Function Function to call back
54 @param Context Context data
55 @param Delay Delay interval
57 @retval EFI_SUCCESS Function successfully loaded
58 @retval EFI_INVALID_PARAMETER One of the Arguments is not supported
59 @retval EFI_OUT_OF_RESOURCES No more entries
64 (EFIAPI
*EFI_DELAYED_DISPATCH_REGISTER
)(
65 IN EFI_DELAYED_DISPATCH_PPI
*This
,
66 IN EFI_DELAYED_DISPATCH_FUNCTION Function
,
73 /// This PPI is a pointer to the Delayed Dispatch Service.
74 /// This service will be published by the Pei Foundation. The PEI Foundation
75 /// will use this service to relaunch a known function that requests a delayed
78 struct _EFI_DELAYED_DISPATCH_PPI
{
79 EFI_DELAYED_DISPATCH_REGISTER Register
;
83 extern EFI_GUID gEfiPeiDelayedDispatchPpiGuid
;