[edk2-devel] [PATCH v3 15/26] StandaloneMmPkg: Fix ECC error 9002 in StandaloneMmCoreEntryPoint

[Sami Mujawar]

Bugzilla: 3150 (https://bugzilla.tianocore.org/show_bug.cgi?id=3150)

Fix the ECC reported error "[9002] The function headers should follow
Doxygen special documentation blocks in section 2.3.5 in Comment".

Signed-off-by: Sami Mujawar <sami.mujawar at arm.com>
Acked-by: Jiewen Yao <Jiewen.yao at intel.com>
---

Notes:
    v3:
     - No code change. Added bugzilla ID and resending patch     [SAMI]
       with v3 series.
    
    v2:
     - No code change. Resending patch with v2 series.           [SAMI]

 StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h                    | 13 ++++++++-----
 StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c              |  6 ++++--
 StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c |  7 ++++---
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h b/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h
index 34c43897dded9aebe1470f2dbfe96b93590a9e45..b176e56e789b0bc766e48a6083512a9d0ae3ebc3 100644
--- a/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h
+++ b/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h
@@ -140,8 +140,9 @@ LocateStandaloneMmCorePeCoffData (
   Use the boot information passed by privileged firmware to populate a HOB list
   suitable for consumption by the MM Core and drivers.
 
-  @param  CpuDriverEntryPoint    Address of MM CPU driver entrypoint
-  @param  PayloadBootInfo        Boot information passed by privileged firmware
+  @param  [in, out] CpuDriverEntryPoint   Address of MM CPU driver entrypoint
+  @param  [in]      PayloadBootInfo       Boot information passed by privileged
+                                          firmware
 
 **/
 VOID *
@@ -155,9 +156,11 @@ CreateHobListFromBootInfo (
 /**
   The entry point of Standalone MM Foundation.
 
-  @param  SharedBufAddress  Pointer to the Buffer between SPM and SP.
-  @param  cookie1.
-  @param  cookie2.
+  @param  [in]  SharedBufAddress  Pointer to the Buffer between SPM and SP.
+  @param  [in]  SharedBufSize     Size of the shared buffer.
+  @param  [in]  cookie1           Cookie 1
+  @param  [in]  cookie2           Cookie 2
+
 **/
 VOID
 EFIAPI
diff --git a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c
index 08b12c45bc2937942a85ee66cf1a6d80bfa41e69..887f2559dfd05bedb66bb86cd17021efa6a4aea0 100644
--- a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c
+++ b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c
@@ -2,7 +2,7 @@
   Creates HOB during Standalone MM Foundation entry point
   on ARM platforms.
 
-Copyright (c) 2017 - 2018, ARM Ltd. All rights reserved.<BR>
+Copyright (c) 2017 - 2020, Arm Ltd. All rights reserved.<BR>
 SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
@@ -46,7 +46,9 @@ extern EFI_GUID gEfiArmTfCpuDriverEpDescriptorGuid;
   Use the boot information passed by privileged firmware to populate a HOB list
   suitable for consumption by the MM Core and drivers.
 
-  @param  PayloadBootInfo    Boot information passed by privileged firmware
+  @param  [in, out] CpuDriverEntryPoint   Address of MM CPU driver entrypoint
+  @param  [in]      PayloadBootInfo       Boot information passed by privileged
+                                          firmware
 
 **/
 VOID *
diff --git a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c
index 3d3c772019df9afe9b8ec77019c776ea7c3b55fb..19472fa659a20d84eebd9e31e20eabab6596f799 100644
--- a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c
+++ b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c
@@ -214,9 +214,10 @@ GetSpmVersion (VOID)
 /**
   The entry point of Standalone MM Foundation.
 
-  @param  SharedBufAddress  Pointer to the Buffer between SPM and SP.
-  @param  cookie1.
-  @param  cookie2.
+  @param  [in]  SharedBufAddress  Pointer to the Buffer between SPM and SP.
+  @param  [in]  SharedBufSize     Size of the shared buffer.
+  @param  [in]  cookie1           Cookie 1
+  @param  [in]  cookie2           Cookie 2
 
 **/
 VOID
-- 
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'



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