Dpc.h File Reference

Go to the source code of this file.

Data Structures
struct	_EFI_DPC_PROTOCOL

Macros
#define	EFI_DPC_PROTOCOL_GUID

Typedefs
typedef struct _EFI_DPC_PROTOCOL	EFI_DPC_PROTOCOL
typedef VOID(EFIAPI *	EFI_DPC_PROCEDURE) (IN VOID *DpcContext)
typedef EFI_STATUS(EFIAPI *	EFI_DPC_QUEUE_DPC) (IN EFI_DPC_PROTOCOL *This, IN EFI_TPL DpcTpl, IN EFI_DPC_PROCEDURE DpcProcedure, IN VOID *DpcContext OPTIONAL)
typedef EFI_STATUS(EFIAPI *	EFI_DPC_DISPATCH_DPC) (IN EFI_DPC_PROTOCOL *This)

Variables
EFI_GUID	gEfiDpcProtocolGuid

Detailed Description

EFI Deferred Procedure Call Protocol.

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Dpc.h.

Macro Definition Documentation

EFI_DPC_PROTOCOL_GUID

#define EFI_DPC_PROTOCOL_GUID

Value:

    { \
      0x480f8ae9, 0xc46, 0x4aa9, { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 } \
    }

Definition at line 16 of file Dpc.h.

Typedef Documentation

EFI_DPC_DISPATCH_DPC

typedef EFI_STATUS(EFIAPI * EFI_DPC_DISPATCH_DPC) (IN EFI_DPC_PROTOCOL *This)

Dispatch the queue of DPCs.

DPCs with DpcTpl value greater than the current TPL value are queued, and then DPCs with DpcTpl value lower than the current TPL value are queued. All DPCs in the first group (higher DpcTpl values) are invoked before DPCs in the second group (lower DpcTpl values).

Parameters

This	Protocol instance pointer.

Return values

EFI_SUCCESS	One or more DPCs were invoked.
EFI_NOT_FOUND	No DPCs were invoked.

Definition at line 78 of file Dpc.h.

EFI_DPC_PROCEDURE

typedef VOID(EFIAPI * EFI_DPC_PROCEDURE) (IN VOID *DpcContext)

Invoke a Deferred Procedure Call.

Parameters

DpcContext

The pointer to the Deferred Procedure Call's context, which is implementation dependent.

Definition at line 34 of file Dpc.h.

EFI_DPC_PROTOCOL

typedef struct _EFI_DPC_PROTOCOL EFI_DPC_PROTOCOL

Definition at line 24 of file Dpc.h.

EFI_DPC_QUEUE_DPC

typedef EFI_STATUS(EFIAPI * EFI_DPC_QUEUE_DPC) (IN EFI_DPC_PROTOCOL *This, IN EFI_TPL DpcTpl, IN EFI_DPC_PROCEDURE DpcProcedure, IN VOID *DpcContext OPTIONAL)

Add a Deferred Procedure Call to the end of the DPC queue.

Parameters

This	The protocol instance pointer.
DpcTpl	The EFI_TPL that the DPC should invoke.
DpcProcedure	The pointer to the DPC's function.
DpcContext	The pointer to the DPC's context. Passed to DpcProcedure when DpcProcedure is invoked.

Return values

EFI_SUCCESS	The DPC was queued.
EFI_INVALID_PARAMETER	DpcTpl is not a valid EFI_TPL.
EFI_INVALID_PARAMETER	DpcProcedure is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources available to add the DPC to the queue.

Definition at line 56 of file Dpc.h.

Variable Documentation

gEfiDpcProtocolGuid

EFI_GUID gEfiDpcProtocolGuid

extern

DPC Protocol GUID variable.