From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web11.13377.1635348488909207607 for ; Wed, 27 Oct 2021 08:28:09 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: pierre.gondois@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 76F72ED1; Wed, 27 Oct 2021 08:28:07 -0700 (PDT) Received: from [192.168.1.16] (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 6F6393F70D; Wed, 27 Oct 2021 08:28:06 -0700 (PDT) Message-ID: Date: Wed, 27 Oct 2021 16:27:56 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.2.1 Subject: Re: [edk2-devel] [PATCH v4 1/7] Silicon/ARM/NeoverseN1Soc: Fix missing function documentation To: devel@edk2.groups.io, khasim.mohammed@arm.com, Sami Mujawar Cc: nd@arm.com References: <20211026173959.15742-1-khasim.mohammed@arm.com> From: "PierreGondois" In-Reply-To: <20211026173959.15742-1-khasim.mohammed@arm.com> Content-Language: en-US Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Hi Khasim, + Sami Thanks for the new patch-set, everything looks good to me: Reviewed-by: Pierre Gondois Just a reminder for Sami about the _OSC method: https://edk2.groups.io/g/devel/message/82724 Regards, Pierre On 10/26/21 18:39, 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 > --- > .../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.
> + > + SPDX-License-Identifier: BSD-2-Clause-Patent > + > **/ > > #include > @@ -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,