DelayedDispatch.h File Reference

Data Structures
struct	_EFI_DELAYED_DISPATCH_PPI

Macros
#define	EFI_DELAYED_DISPATCH_PPI_GUID

Typedefs
typedef OUT UINT32 *	NewDelay
typedef struct _EFI_DELAYED_DISPATCH_PPI	EFI_DELAYED_DISPATCH_PPI
typedef EFI_STATUS(EFIAPI *	EFI_DELAYED_DISPATCH_REGISTER )(IN EFI_DELAYED_DISPATCH_PPI *This, IN EFI_DELAYED_DISPATCH_FUNCTION Function, IN UINT64 Context, OUT UINT32 Delay)

Functions
typedef	VOID (EFIAPI *EFI_DELAYED_DISPATCH_FUNCTION)(IN OUT UINT64 *Context

Variables
EFI_GUID	gEfiPeiDelayedDispatchPpiGuid

Detailed Description

EFI Delayed Dispatch PPI as defined in the PI 1.7 Specification

Provide timed event service in PEI

Copyright (c) 2020, American Megatrends International LLC. All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_DELAYED_DISPATCH_PPI_GUID

Value:

{ \
    0x869c711d, 0x649c, 0x44fe, { 0x8b, 0x9e, 0x2c, 0xbb, 0x29, 0x11, 0xc3, 0xe6} } \
  }

Global ID for EFI_DELAYED_DISPATCH_PPI_GUID

Typedef Documentation

typedef struct _EFI_DELAYED_DISPATCH_PPI EFI_DELAYED_DISPATCH_PPI

The forward declaration for EFI_DELAYED_DISPATCH_PPI

typedef EFI_STATUS(EFIAPI * EFI_DELAYED_DISPATCH_REGISTER)(IN EFI_DELAYED_DISPATCH_PPI *This, IN EFI_DELAYED_DISPATCH_FUNCTION Function, IN UINT64 Context, OUT UINT32 Delay)

Register a callback to be called after a minimum delay has occurred.

This service is the single member function of the EFI_DELAYED_DISPATCH_PPI

Parameters

This	Pointer to the EFI_DELAYED_DISPATCH_PPI instance
Function	Function to call back
Context	Context data
Delay	Delay interval

Return values

EFI_SUCCESS	Function successfully loaded
EFI_INVALID_PARAMETER	One of the Arguments is not supported
EFI_OUT_OF_RESOURCES	No more entries

typedef OUT UINT32* NewDelay

Function Documentation

typedef VOID

(

EFIAPI *

EFI_DELAYED_DISPATCH_FUNCTION

)

Delayed Dispatch function. This routine is called sometime after the required delay. Upon return, if NewDelay is 0, the function is unregistered. If NewDelay is not zero, this routine will be called again after the new delay period.

Parameters

[in,out]	Context	Pointer to Context. Can be updated by routine.
[out]	NewDelay	The new delay in us. Leave at 0 to unregister callback.

Variable Documentation

EFI_GUID gEfiPeiDelayedDispatchPpiGuid