X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FProtocol%2FDpc.h;h=99293e29876b52f500db44c037ba2670aa697243;hp=e095f84e813a195f3a2a721efecbc4b0cfba74d7;hb=9bd22b08d1a9b0b4c2fd325a928b58acd176d9d1;hpb=c93ce6481e695a0e1d8181a66953788a7d8c0885

diff --git a/MdeModulePkg/Include/Protocol/Dpc.h b/MdeModulePkg/Include/Protocol/Dpc.h
index e095f84e81..99293e2987 100644
--- a/MdeModulePkg/Include/Protocol/Dpc.h
+++ b/MdeModulePkg/Include/Protocol/Dpc.h
@@ -1,25 +1,17 @@
-/*++
+/** @file
 
-Copyright (c) 2007, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+  EFI Deferred Procedure Call Protocol.
 
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-Module Name:
-
-  Dpc.h
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials are licensed and made available under 
+the terms and conditions of the BSD License that accompanies this distribution.  
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.                                            
 
-Abstract:
-
-  EFI Deferred Procedure Call Protocol
-
-Revision History
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
---*/
+**/
 
 
 #ifndef __DPC_H__
@@ -42,23 +34,23 @@ typedef struct _EFI_DPC_PROTOCOL  EFI_DPC_PROTOCOL;
 /**
   Invoke a Deferred Procedure Call.
 
-  @param  DpcContext           Pointer to the Deferred Procedure Call's context,
+  @param  DpcContext           The pointer to the Deferred Procedure Call's context,
                                which is implementation dependent.
 
 **/
 typedef
 VOID
-(EFIAPI *EFI_DPC_PROCEDURE) (
+(EFIAPI *EFI_DPC_PROCEDURE)(
   IN VOID  *DpcContext
   );
 
 /**
   Add a Deferred Procedure Call to the end of the DPC queue.
 
-  @param  This          Protocol instance pointer.
-  @param  DpcTpl        The EFI_TPL that the DPC should be invoked.
-  @param  DpcProcedure  Pointer to the DPC's function.
-  @param  DpcContext    Pointer to the DPC's context.  Passed to DpcProcedure
+  @param  This          The protocol instance pointer.
+  @param  DpcTpl        The EFI_TPL that the DPC should invoke.
+  @param  DpcProcedure  The pointer to the DPC's function.
+  @param  DpcContext    The pointer to the DPC's context.  Passed to DpcProcedure
                         when DpcProcedure is invoked.
 
   @retval EFI_SUCCESS            The DPC was queued.
@@ -70,7 +62,7 @@ VOID
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_DPC_QUEUE_DPC) (
+(EFIAPI *EFI_DPC_QUEUE_DPC)(
   IN EFI_DPC_PROTOCOL   *This,
   IN EFI_TPL            DpcTpl,
   IN EFI_DPC_PROCEDURE  DpcProcedure,
@@ -78,10 +70,11 @@ EFI_STATUS
   );
 
 /**
-  Dispatch the queue of DPCs.  ALL DPCs that have been queued with a DpcTpl
-  value greater than or equal to the current TPL are invoked in the order that
-  they were queued.  DPCs with higher DpcTpl values are invoked before DPCs with
-  lower DpcTpl values.
+  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). 
 
   @param  This  Protocol instance pointer.
 
@@ -91,21 +84,21 @@ EFI_STATUS
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_DPC_DISPATCH_DPC) (
+(EFIAPI *EFI_DPC_DISPATCH_DPC)(
   IN EFI_DPC_PROTOCOL  *This
   );
 
-//
-// DPC Protocol structure
-//
+///
+/// DPC Protocol structure.
+///
 struct _EFI_DPC_PROTOCOL {
   EFI_DPC_QUEUE_DPC     QueueDpc;
   EFI_DPC_DISPATCH_DPC  DispatchDpc;
 };
 
-//
-// DPC Protocol GUID variable
-//
+///
+/// DPC Protocol GUID variable.
+///
 extern EFI_GUID gEfiDpcProtocolGuid;
 
 #endif