diff options
| author | Sami Mujawar <sami.mujawar@arm.com> | 2020-12-07 11:04:26 +0000 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2021-01-07 11:13:39 +0000 |
| commit | 84096dccd6b6e801be78ba7819eeb87885e0ef4e (patch) | |
| tree | 580a3c2917621124875d62b7c45bfcc8c9a10368 /StandaloneMmPkg | |
| parent | 3efc2919d09e62cbda763fe92efb52aea6f70b8a (diff) | |
| download | edk2-84096dccd6b6e801be78ba7819eeb87885e0ef4e.tar.gz edk2-84096dccd6b6e801be78ba7819eeb87885e0ef4e.tar.bz2 edk2-84096dccd6b6e801be78ba7819eeb87885e0ef4e.zip | |
StandaloneMmPkg: Fix ECC error 4002 and 9002 in StandaloneMmCore
Bugzilla: 3150 (https://bugzilla.tianocore.org/show_bug.cgi?id=3150)
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>
Acked-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Diffstat (limited to 'StandaloneMmPkg')
| -rw-r--r-- | StandaloneMmPkg/Core/StandaloneMmCore.c | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/StandaloneMmPkg/Core/StandaloneMmCore.c b/StandaloneMmPkg/Core/StandaloneMmCore.c index 7c3aca9877..8388ec289c 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
|