MdeModulePkg: Add match2 opcode support in SetupBrowserDxe and sample code in DriverS...

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

diff --git a/MdeModulePkg/Include/Protocol/Dpc.h b/MdeModulePkg/Include/Protocol/Dpc.h
index a93ac249e271e9c6aa851bb9b646a7d60b0fed30..99293e29876b52f500db44c037ba2670aa697243 100644 (file)
--- a/MdeModulePkg/Include/Protocol/Dpc.h
+++ b/MdeModulePkg/Include/Protocol/Dpc.h
@@ -1,14 +1,14 @@
 /** @file\r
 \r
-  EFI Deferred Procedure Call Protocol\r
+  EFI Deferred Procedure Call Protocol.\r
 \r
-Copyright (c) 2007 - 2008, 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
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
+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
 **/\r
@@ -34,23 +34,23 @@ typedef struct _EFI_DPC_PROTOCOL  EFI_DPC_PROTOCOL;
 /**\r
   Invoke a Deferred Procedure Call.\r
 \r
-  @param  DpcContext           Pointer to the Deferred Procedure Call's context,\r
+  @param  DpcContext           The 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
+(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
+  @param  This          The protocol instance pointer.\r
+  @param  DpcTpl        The EFI_TPL that the DPC should invoke.\r
+  @param  DpcProcedure  The pointer to the DPC's function.\r
+  @param  DpcContext    The pointer to the DPC's context.  Passed to DpcProcedure\r
                         when DpcProcedure is invoked.\r
 \r
   @retval EFI_SUCCESS            The DPC was queued.\r
@@ -62,7 +62,7 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DPC_QUEUE_DPC) (\r
+(EFIAPI *EFI_DPC_QUEUE_DPC)(\r
   IN EFI_DPC_PROTOCOL   *This,\r
   IN EFI_TPL            DpcTpl,\r
   IN EFI_DPC_PROCEDURE  DpcProcedure,\r
@@ -70,10 +70,11 @@ EFI_STATUS
   );\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
+  Dispatch the queue of DPCs.  \r
+  \r
+  DPCs with DpcTpl value greater than the current TPL value are queued, and then DPCs\r
+  with DpcTpl value lower than the current TPL value are queued. All DPCs in the first \r
+  group (higher DpcTpl values) are invoked before DPCs in the second group (lower DpcTpl values). \r
 \r
   @param  This  Protocol instance pointer.\r
 \r
@@ -83,21 +84,21 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DPC_DISPATCH_DPC) (\r
+(EFIAPI *EFI_DPC_DISPATCH_DPC)(\r
   IN EFI_DPC_PROTOCOL  *This\r
   );\r
 \r
-//\r
-// DPC Protocol structure\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
+///\r
+/// DPC Protocol GUID variable.\r
+///\r
 extern EFI_GUID gEfiDpcProtocolGuid;\r
 \r
 #endif\r