From: "Sami Mujawar" <sami.mujawar@arm.com>
To: <devel@edk2.groups.io>
Cc: Sami Mujawar <sami.mujawar@arm.com>, <ard.biesheuvel@arm.com>,
<jiewen.yao@intel.com>, <thomas.abraham@arm.com>,
<Sughosh.Ganu@arm.com>, <Matteo.Carlini@arm.com>,
<Ben.Adderson@arm.com>, <nd@arm.com>
Subject: [PATCH v2 15/26] StandaloneMmPkg: Fix ECC error 9002 in StandaloneMmCoreEntryPoint
Date: Thu, 17 Dec 2020 13:04:58 +0000 [thread overview]
Message-ID: <20201217130509.12568-16-sami.mujawar@arm.com> (raw)
In-Reply-To: <20201217130509.12568-1-sami.mujawar@arm.com>
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@arm.com>
Acked-by: Jiewen Yao <Jiewen.yao@intel.com>
---
Notes:
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)'
next prev parent reply other threads:[~2020-12-17 13:05 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-17 13:04 [PATCH v2 00/26] Enable Core CI support for StandaloneMmPkg Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 01/26] StandaloneMmPkg: Add library header files to DEC Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 02/26] StandaloneMmPkg: Add library files to DSC Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 03/26] StandaloneMmPkg: Fix spell check reported errors Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 04/26] StandaloneMmPkg: Fix ECC error 9002 in Core dispatcher Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 05/26] StandaloneMmPkg: Fix ECC error 1001 in SMM Memory pool management Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 06/26] StandaloneMmPkg: Fix ECC error 3002 in StandaloneMmCpu Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 07/26] StandaloneMmPkg: Fix ECC error 4002 in FwVol helper Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 08/26] StandaloneMmPkg: Fix ECC error 5007 in StandaloneMmCoreEntryPoint Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 09/26] StandaloneMmPkg: Fix ECC error 5007 in StandaloneMmCpu Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 10/26] StandaloneMmPkg: Fix ECC error 5007 in StandaloneMmCore Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 11/26] StandaloneMmPkg: Fix ECC error 10014 in StandaloneMmCpu Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 12/26] StandaloneMmPkg: Fix ECC error 4002 and 9002 in StandaloneMmCore Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 13/26] StandaloneMmPkg: Fix ECC error 4002 in StandaloneMmCoreEntryPoint Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 14/26] StandaloneMmPkg: Fix ECC error 9002 in StandaloneMmMemLib Sami Mujawar
2020-12-17 13:04 ` Sami Mujawar [this message]
2020-12-17 13:04 ` [PATCH v2 16/26] StandaloneMmPkg: Fix ECC error 9003 in StandaloneMmCoreEntryPoint Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 17/26] StandaloneMmPkg: Fix ECC error 4002 in StandaloneMmCpu Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 18/26] StandaloneMmPkg: Fix ECC error 9001 " Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 19/26] StandaloneMmPkg: Fix ECC error 9001 in Standalone MM Core Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 20/26] StandaloneMmPkg: Fix ECC error 9002 in CoreMemoryAllocationLib Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 21/26] StandaloneMmPkg: Fix ECC error 4002 in StandaloneMmCpu Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 22/26] StandaloneMmPkg: Fix ECC error 8005 in StandaloneMmCoreEntryPoint Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 23/26] StandaloneMmPkg: Remove dependency on ArmPlatformPkg.dec Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 24/26] StandaloneMmPkg: Add EDK2 Core CI support Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 25/26] .azurepipelines: Add StandaloneMmPkg to CI matrix Sami Mujawar
2020-12-17 13:05 ` [PATCH v2 26/26] .pytool: CI Settings to support StandaloneMmPkg Sami Mujawar
2020-12-24 1:34 ` 回复: [edk2-devel] [PATCH v2 00/26] Enable Core CI support for StandaloneMmPkg gaoliming
2021-01-04 12:50 ` [edk2-devel] " Sami Mujawar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201217130509.12568-16-sami.mujawar@arm.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox