[edk2-devel] [PATCH v5 1/7] Silicon/ARM/NeoverseN1Soc: Fix missing function documentation
Sami Mujawar
sami.mujawar at arm.com
Mon Nov 8 10:15:16 UTC 2021
Hi Khasim,
Thank you for this patch.
Reviewed-by: Sami Mujawar <sami.mujawar at arm.com>
Regards,
Sami Mujawar
On 05/11/2021 02:21 PM, Khasim Mohammed via groups.io wrote:
> This patch adds missing documentation for few of the functions
> and fixes few formatting changes.
>
> Signed-off-by: Khasim Syed Mohammed <khasim.mohammed at arm.com>
> ---
> .../Library/PlatformLib/PlatformLib.c | 46 +++++++++++++++++--
> 1 file changed, 41 insertions(+), 5 deletions(-)
>
> diff --git a/Silicon/ARM/NeoverseN1Soc/Library/PlatformLib/PlatformLib.c b/Silicon/ARM/NeoverseN1Soc/Library/PlatformLib/PlatformLib.c
> index f722080e56..c0effd37f3 100644
> --- a/Silicon/ARM/NeoverseN1Soc/Library/PlatformLib/PlatformLib.c
> +++ b/Silicon/ARM/NeoverseN1Soc/Library/PlatformLib/PlatformLib.c
> @@ -1,9 +1,9 @@
> /** @file
> -*
> -* Copyright (c) 2018-2020, ARM Limited. All rights reserved.
> -*
> -* SPDX-License-Identifier: BSD-2-Clause-Patent
> -*
> +
> + Copyright (c) 2018-2021, ARM Limited. All rights reserved.<BR>
> +
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> **/
>
> #include <Library/ArmPlatformLib.h>
> @@ -17,6 +17,12 @@ STATIC ARM_CORE_INFO mCoreInfoTable[] = {
> { 0x1, 0x1 } // Cluster 1, Core 1
> };
>
> +/**
> + Return the current Boot Mode.
> +
> + @return The boot reason on the platform.
> +
> +**/
> EFI_BOOT_MODE
> ArmPlatformGetBootMode (
> VOID
> @@ -25,6 +31,16 @@ ArmPlatformGetBootMode (
> return BOOT_WITH_FULL_CONFIGURATION;
> }
>
> +/**
> + Initialize controllers that must be setup in the normal world.
> +
> + This function is called by the ArmPlatformPkg/Pei or
> + ArmPlatformPkg/Pei/PlatformPeim in the PEI phase.
> +
> + @param[in] MpId Processor ID
> + @retval RETURN_SUCCESS
> +
> +**/
> RETURN_STATUS
> ArmPlatformInitialize (
> IN UINTN MpId
> @@ -33,6 +49,17 @@ ArmPlatformInitialize (
> return RETURN_SUCCESS;
> }
>
> +/**
> + Populate the Platform core information.
> +
> + This function populates the ARM_MP_CORE_INFO_PPI with information
> + about the cores.
> +
> + @param[out] CoreCount Number of cores
> + @param[out] ArmCoreTable Table containing information about the cores
> + @retval EFI_SUCCESS
> +
> +**/
> EFI_STATUS
> PrePeiCoreGetMpCoreInfo (
> OUT UINTN *CoreCount,
> @@ -56,6 +83,15 @@ EFI_PEI_PPI_DESCRIPTOR gPlatformPpiTable[] = {
> }
> };
>
> +/**
> + Return the Platform specific PPIs
> +
> + This function exposes the N1Sdp Specific PPIs.
> +
> + @param[out] PpiListSize Size in Bytes of the Platform PPI List
> + @param[out] PpiList Platform PPI List
> +
> +**/
> VOID
> ArmPlatformGetPlatformPpiList (
> OUT UINTN *PpiListSize,
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#83439): https://edk2.groups.io/g/devel/message/83439
Mute This Topic: https://groups.io/mt/86841472/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list