modify coding style to pass ecc tool and provide comments that complied with Doxgen.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / Dpc.h

/*++\r
\r
Copyright (c) 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  Dpc.h\r
\r
Abstract:\r
\r
  EFI Deferred Procedure Call Protocol\r
\r
Revision History\r
\r
--*/\r
\r
\r
#ifndef __DPC_H__\r
#define __DPC_H__\r
\r
//\r
// DPC Protocol GUID value\r
//\r
#define EFI_DPC_PROTOCOL_GUID \\r
    { \\r
      0x480f8ae9, 0xc46, 0x4aa9, { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 } \\r
    }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
typedef struct _EFI_DPC_PROTOCOL  EFI_DPC_PROTOCOL;\r
\r
\r
/**\r
  Invoke a Deferred Procedure Call.\r
\r
  @param  DpcContext           Pointer to the Deferred Procedure Call's context,\r
                               which is implementation dependent.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_DPC_PROCEDURE) (\r
  IN VOID  *DpcContext\r
  );\r
\r
/**\r
  Add a Deferred Procedure Call to the end of the DPC queue.\r
\r
  @param  This          Protocol instance pointer.\r
  @param  DpcTpl        The EFI_TPL that the DPC should be invoked.\r
  @param  DpcProcedure  Pointer to the DPC's function.\r
  @param  DpcContext    Pointer to the DPC's context.  Passed to DpcProcedure\r
                        when DpcProcedure is invoked.\r
\r
  @retval EFI_SUCCESS            The DPC was queued.\r
  @retval EFI_INVALID_PARAMETER  DpcTpl is not a valid EFI_TPL.\r
  @retval EFI_INVALID_PARAMETER  DpcProcedure is NULL.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources available to\r
                                 add the DPC to the queue.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DPC_QUEUE_DPC) (\r
  IN EFI_DPC_PROTOCOL   *This,\r
  IN EFI_TPL            DpcTpl,\r
  IN EFI_DPC_PROCEDURE  DpcProcedure,\r
  IN VOID               *DpcContext    OPTIONAL\r
  );\r
\r
/**\r
  Dispatch the queue of DPCs.  ALL DPCs that have been queued with a DpcTpl\r
  value greater than or equal to the current TPL are invoked in the order that\r
  they were queued.  DPCs with higher DpcTpl values are invoked before DPCs with\r
  lower DpcTpl values.\r
\r
  @param  This  Protocol instance pointer.\r
\r
  @retval EFI_SUCCESS    One or more DPCs were invoked.\r
  @retval EFI_NOT_FOUND  No DPCs were invoked.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DPC_DISPATCH_DPC) (\r
  IN EFI_DPC_PROTOCOL  *This\r
  );\r
\r
//\r
// DPC Protocol structure\r
//\r
struct _EFI_DPC_PROTOCOL {\r
  EFI_DPC_QUEUE_DPC     QueueDpc;\r
  EFI_DPC_DISPATCH_DPC  DispatchDpc;\r
};\r
\r
//\r
// DPC Protocol GUID variable\r
//\r
extern EFI_GUID gEfiDpcProtocolGuid;\r
\r
#endif\r