[edk2-devel] [PATCH v1 1/4] MdePkg: DelayedDispatch: Correct PPI descriptions

[Kun Qin]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4496

PI spec defined the `Register` function input argument `Delay` as output.
However, this parameter should be used to define the minmal time delay
the callback should fire. Thus it should be an input parameter.

This change fixed the argument type.

Cc: Michael D Kinney <michael.d.kinney at intel.com>
Cc: Liming Gao <gaoliming at byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu at intel.com>

Co-authored-by: Mike Turner <mikeyt at pobox.com>
Signed-off-by: Kun Qin <kuqin12 at gmail.com>
---
 MdePkg/Include/Ppi/DelayedDispatch.h | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/MdePkg/Include/Ppi/DelayedDispatch.h b/MdePkg/Include/Ppi/DelayedDispatch.h
index f9b4fed30fb0..098d57758551 100644
--- a/MdePkg/Include/Ppi/DelayedDispatch.h
+++ b/MdePkg/Include/Ppi/DelayedDispatch.h
@@ -4,6 +4,7 @@
     Provide timed event service in PEI
 
     Copyright (c) 2020, American Megatrends International LLC. All rights reserved.
+    Copyright (c) Microsoft Corporation.
     SPDX-License-Identifier: BSD-2-Clause-Patent
 **/
 
@@ -15,7 +16,7 @@
 ///
 #define EFI_DELAYED_DISPATCH_PPI_GUID \
   { \
-    0x869c711d, 0x649c, 0x44fe, { 0x8b, 0x9e, 0x2c, 0xbb, 0x29, 0x11, 0xc3, 0xe6} } \
+    0x869c711d, 0x649c, 0x44fe, { 0x8b, 0x9e, 0x2c, 0xbb, 0x29, 0x11, 0xc3, 0xe6} \
   }
 
 /**
@@ -46,10 +47,10 @@ 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
 
-  @param This           Pointer to the EFI_DELAYED_DISPATCH_PPI instance
-  @param Function       Function to call back
-  @param Context        Context data
-  @param Delay          Delay interval
+  @param[in] This           Pointer to the EFI_DELAYED_DISPATCH_PPI instance
+  @param[in] Function       Function to call back
+  @param[in] Context        Context data
+  @param[in] Delay          Delay interval
 
   @retval EFI_SUCCESS               Function successfully loaded
   @retval EFI_INVALID_PARAMETER     One of the Arguments is not supported
@@ -61,8 +62,8 @@ 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
+  IN  UINT64                         Context,
+  IN  UINT32                         Delay
   );
 
 ///
-- 
2.41.0.windows.2



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#107112): https://edk2.groups.io/g/devel/message/107112
Mute This Topic: https://groups.io/mt/100264776/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-