public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
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 12/26] StandaloneMmPkg: Fix ECC error 4002 and 9002 in StandaloneMmCore
Date: Thu, 17 Dec 2020 13:04:55 +0000	[thread overview]
Message-ID: <20201217130509.12568-13-sami.mujawar@arm.com> (raw)
In-Reply-To: <20201217130509.12568-1-sami.mujawar@arm.com>

Add doxygen style function documentation headers to fix the ECC
reported errors:
 - [4002] Function header doesn't exist.
 - [9002] The function headers should follow Doxygen special
   documentation blocks in section 2.3.5.

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/Core/StandaloneMmCore.c | 23 +++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/StandaloneMmPkg/Core/StandaloneMmCore.c b/StandaloneMmPkg/Core/StandaloneMmCore.c
index 803d7605ece7f6a3400866a04e39acf74cda8144..b04a9f985c6ecc601a6d7caf8fd433a1d4cf73c4 100644
--- a/StandaloneMmPkg/Core/StandaloneMmCore.c
+++ b/StandaloneMmPkg/Core/StandaloneMmCore.c
@@ -414,6 +414,15 @@ MmEntryPoint (
   DEBUG ((DEBUG_INFO, "MmEntryPoint Done\n"));
 }
 
+/** Register the MM Entry Point provided by the MM Core with the
+    MM Configuration protocol.
+
+  @param [in]  Protocol   Pointer to the protocol.
+  @param [in]  Interface  Pointer to the MM Configuration protocol.
+  @param [in]  Handle     Handle.
+
+  @retval EFI_SUCCESS             Success.
+**/
 EFI_STATUS
 EFIAPI
 MmConfigurationMmNotify (
@@ -448,6 +457,12 @@ MmConfigurationMmNotify (
   return EFI_SUCCESS;
 }
 
+/** Returns the HOB list size.
+
+  @param [in]  HobStart   Pointer to the start of the HOB list.
+
+  @retval Size of the HOB list.
+**/
 UINTN
 GetHobListSize (
   IN VOID *HobStart
@@ -475,12 +490,10 @@ GetHobListSize (
 
   Note: This function is called for both DXE invocation and MMRAM invocation.
 
-  @param  ImageHandle    The firmware allocated handle for the EFI image.
-  @param  SystemTable    A pointer to the EFI System Table.
-
-  @retval EFI_SUCCESS    The entry point is executed successfully.
-  @retval Other          Some error occurred when executing this entry point.
+  @param  HobStart       Pointer to the start of the HOB list.
 
+  @retval EFI_SUCCESS             Success.
+  @retval EFI_UNSUPPORTED         Unsupported operation.
 **/
 EFI_STATUS
 EFIAPI
-- 
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'


  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 ` Sami Mujawar [this message]
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 ` [PATCH v2 15/26] StandaloneMmPkg: Fix ECC error 9002 in StandaloneMmCoreEntryPoint Sami Mujawar
2020-12-17 13:04 ` [PATCH v2 16/26] StandaloneMmPkg: Fix ECC error 9003 " 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-13-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