From 4779bc6c0bc6709f404d964e81812c784c3f5fa1 Mon Sep 17 00:00:00 2001 From: Sami Mujawar Date: Mon, 7 Dec 2020 12:10:43 +0000 Subject: StandaloneMmPkg: Fix ECC error 9002 in StandaloneMmCoreEntryPoint 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 Acked-by: Jiewen Yao Acked-by: Ard Biesheuvel Reviewed-by: Liming Gao --- .../Include/Library/AArch64/StandaloneMmCoreEntryPoint.h | 13 ++++++++----- .../StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c | 6 ++++-- .../AArch64/StandaloneMmCoreEntryPoint.c | 7 ++++--- 3 files changed, 16 insertions(+), 10 deletions(-) (limited to 'StandaloneMmPkg') diff --git a/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h b/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h index 8e39ea16d7..c44f7066c6 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 08b12c45bc..e8fb96bd6e 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.
+Copyright (c) 2017 - 2021, Arm Ltd. All rights reserved.
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 903e32d711..a4d0dd0321 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 -- cgit v1.2.3