]> git.proxmox.com Git - mirror_edk2.git/commitdiff
ArmPkg: MmCommunicationDxe: MM communicate function argument attributes
authorKun Qin <kuqin12@gmail.com>
Tue, 25 Jan 2022 19:39:06 +0000 (03:39 +0800)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Thu, 27 Jan 2022 02:16:17 +0000 (02:16 +0000)
Current MM communicate2 function from ArmPkg described input arguments
`CommBufferPhysical`, `CommBufferVirtual` and `CommSize` as input only,
which mismatches with the "input and output type" as in PI specification.

This change updated function descriptions of MM communite2 to match input
argument types.

Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Kun Qin <kuqin12@gmail.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
ArmPkg/Drivers/MmCommunicationDxe/MmCommunication.c

index 7c8284104d87c5a1abba5d20e7b2a941582b7a2a..7f756a32d4e0be782f0585b79f16c7643076e325 100644 (file)
@@ -41,12 +41,13 @@ STATIC EFI_HANDLE  mMmCommunicateHandle;
 \r
   This function provides a service to send and receive messages from a registered UEFI service.\r
 \r
-  @param[in] This                The EFI_MM_COMMUNICATION_PROTOCOL instance.\r
-  @param[in] CommBufferPhysical  Physical address of the MM communication buffer\r
-  @param[in] CommBufferVirtual   Virtual address of the MM communication buffer\r
-  @param[in] CommSize            The size of the data buffer being passed in. On exit, the size of data\r
-                                 being returned. Zero if the handler does not wish to reply with any data.\r
-                                 This parameter is optional and may be NULL.\r
+  @param[in] This                     The EFI_MM_COMMUNICATION_PROTOCOL instance.\r
+  @param[in, out] CommBufferPhysical  Physical address of the MM communication buffer\r
+  @param[in, out] CommBufferVirtual   Virtual address of the MM communication buffer\r
+  @param[in, out] CommSize            The size of the data buffer being passed in. On exit, the\r
+                                      size of data being returned. Zero if the handler does not\r
+                                      wish to reply with any data. This parameter is optional\r
+                                      and may be NULL.\r
 \r
   @retval EFI_SUCCESS            The message was successfully posted.\r
   @retval EFI_INVALID_PARAMETER  CommBufferPhysical was NULL or CommBufferVirtual was NULL.\r