From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from EUR04-DB3-obe.outbound.protection.outlook.com (EUR04-DB3-obe.outbound.protection.outlook.com [40.107.6.84]) by mx.groups.io with SMTP id smtpd.web11.43096.1636366528968866998 for ; Mon, 08 Nov 2021 02:15:30 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@armh.onmicrosoft.com header.s=selector2-armh-onmicrosoft-com header.b=kUGmOv+b; spf=pass (domain: arm.com, ip: 40.107.6.84, mailfrom: sami.mujawar@arm.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; s=selector2-armh-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=wYV8ZlC+jglzU2vSWbu6jnkFLB7IEqRnrHTsUAgyywk=; b=kUGmOv+bZzfUcHDep6u1Jk9j+HNbtbuSoABIa1pZGDpXLjGkYGTfI4unSMp/P5DtUtw/GvA9nEpkuBK05q2DCW1gG68iHNAqjUMvYIK8DNc+7JpcYke79pn0715QxJyOe/2h4Aqu8G1QBOK5RHadH4EW8c0SANPK1UmDDoF+dMw= Received: from AM6P194CA0066.EURP194.PROD.OUTLOOK.COM (2603:10a6:209:84::43) by HE1PR0801MB2058.eurprd08.prod.outlook.com (2603:10a6:3:50::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4669.13; Mon, 8 Nov 2021 10:15:26 +0000 Received: from AM5EUR03FT048.eop-EUR03.prod.protection.outlook.com (2603:10a6:209:84:cafe::7f) by AM6P194CA0066.outlook.office365.com (2603:10a6:209:84::43) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4669.10 via Frontend Transport; Mon, 8 Nov 2021 10:15:26 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 63.35.35.123) smtp.mailfrom=arm.com; dkim=pass (signature was verified) header.d=armh.onmicrosoft.com;dmarc=pass action=none header.from=arm.com; Received-SPF: Pass (protection.outlook.com: domain of arm.com designates 63.35.35.123 as permitted sender) receiver=protection.outlook.com; client-ip=63.35.35.123; helo=64aa7808-outbound-1.mta.getcheckrecipient.com; Received: from 64aa7808-outbound-1.mta.getcheckrecipient.com (63.35.35.123) by AM5EUR03FT048.mail.protection.outlook.com (10.152.17.177) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4649.14 via Frontend Transport; Mon, 8 Nov 2021 10:15:25 +0000 Received: ("Tessian outbound d49ee2bec50d:v108"); Mon, 08 Nov 2021 10:15:24 +0000 X-CheckRecipientChecked: true X-CR-MTA-CID: 8d9c4e5126723070 X-CR-MTA-TID: 64aa7808 Received: from 953e59dfc860.1 by 64aa7808-outbound-1.mta.getcheckrecipient.com id BA3A2384-4BE1-438C-94BA-5331DB6C7DBD.1; Mon, 08 Nov 2021 10:15:14 +0000 Received: from EUR03-AM5-obe.outbound.protection.outlook.com by 64aa7808-outbound-1.mta.getcheckrecipient.com with ESMTPS id 953e59dfc860.1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384); Mon, 08 Nov 2021 10:15:14 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=VONtGWLfQNyRJ+SKwFK+kDMgpjyFdjg1LShV0By1eKlvBs/CW+VhbhjlpYVRVXE0qww6lxt3RcYbwpMWVjRlh5YP9EKirDgVoUzMvi+SlcYVrl2ATk+dt7/H28vdrledzoKvGC26eaaEMNs3cTPcpNjL1+BiuefyoYnEA3oxL2OngAsoAF3seLTaMtf78xEdz3H7TgASqSxMb5LBnCVfx0DCyay3OZOTRq3Ea6l2jTdVMtIBkx9Jr+gWlc29LtfEq4mi0a9qq0z7w8o6CeGIqqduI3qkYhs/vi62w34gMOfSqI9Bi3tPh1vs81100ZWGyDrsHjwc69H+NmCObjoryw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=wYV8ZlC+jglzU2vSWbu6jnkFLB7IEqRnrHTsUAgyywk=; b=i818jZF3MZQlTapC8daQbW0aClMBOGgrsrD9Oao8XEx80hBgOClMOExLpTvcPQr0fqNJTGYsMABfG8xBU9kk7mWgb/2LfcRoHGfJCqvi2lbjA0k258m0plTc9HnRrSIVaSOdjlfBp191LtbwbvTYZ3klt5CBh/UyVEVBKZR48f0CO+bHvi+ukPebhLmZPKzTMjSPtoDtphiZYY2R/9VTkdeHgeXvWYrdmrChEsMW7kMHKLxLqHRBQ5MI+yWFsks256n6ME5fIaZ//ZSGYJIReQ+q/U4CltOsSF4io/69Wy4lFMXAuEWMOy/XdUBYKxv44mjLx5CZWsT+S0sdMt7FAA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; s=selector2-armh-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=wYV8ZlC+jglzU2vSWbu6jnkFLB7IEqRnrHTsUAgyywk=; b=kUGmOv+bZzfUcHDep6u1Jk9j+HNbtbuSoABIa1pZGDpXLjGkYGTfI4unSMp/P5DtUtw/GvA9nEpkuBK05q2DCW1gG68iHNAqjUMvYIK8DNc+7JpcYke79pn0715QxJyOe/2h4Aqu8G1QBOK5RHadH4EW8c0SANPK1UmDDoF+dMw= Authentication-Results-Original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com; Received: from AS8PR08MB6806.eurprd08.prod.outlook.com (2603:10a6:20b:39b::12) by AM6PR08MB3720.eurprd08.prod.outlook.com (2603:10a6:20b:8f::29) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4669.13; Mon, 8 Nov 2021 10:15:11 +0000 Received: from AS8PR08MB6806.eurprd08.prod.outlook.com ([fe80::54b5:239d:9896:ee65]) by AS8PR08MB6806.eurprd08.prod.outlook.com ([fe80::54b5:239d:9896:ee65%4]) with mapi id 15.20.4669.010; Mon, 8 Nov 2021 10:15:10 +0000 Subject: Re: [edk2-devel] [PATCH v5 1/7] Silicon/ARM/NeoverseN1Soc: Fix missing function documentation To: devel@edk2.groups.io, khasim.mohammed@arm.com Cc: nd@arm.com References: <20211105142127.21616-1-khasim.mohammed@arm.com> From: "Sami Mujawar" Message-ID: <9ea26d35-198d-f933-f87d-7d87b4477fa3@arm.com> Date: Mon, 8 Nov 2021 10:15:16 +0000 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.0.1 In-Reply-To: <20211105142127.21616-1-khasim.mohammed@arm.com> X-ClientProxiedBy: LO2P265CA0261.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:8a::33) To AS8PR08MB6806.eurprd08.prod.outlook.com (2603:10a6:20b:39b::12) MIME-Version: 1.0 Received: from [10.1.196.43] (217.140.106.52) by LO2P265CA0261.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:8a::33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4669.10 via Frontend Transport; Mon, 8 Nov 2021 10:15:10 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: c1846bf0-e869-4203-ffe9-08d9a2a0ae75 X-MS-TrafficTypeDiagnostic: AM6PR08MB3720:|HE1PR0801MB2058: X-Microsoft-Antispam-PRVS: x-checkrecipientrouted: true NoDisclaimer: true X-MS-Oob-TLC-OOBClassifiers: OLM:9508;OLM:9508; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam-Untrusted: BCL:0; X-Microsoft-Antispam-Message-Info-Original: jWnuoQv87LB+J+gNPRBMxDkpwQGZUqShiCUAIJHX6KejT6Y6ukohQEDo2RGTAXjsjWyvpulrnUkb0PxematRK9Jcx/xsevhziCf8Yd/y2S5MFF8VUd0UBsOhGoXa3L3Mg7otavL1/6TG5An/YMET20leXCX/FdspZ2M9S+XWGgXi4QnZKbMRzIsWfgT9+cyG1YdHLq5vSSbmUe0vw9zDIKGtUwqhXHd9iAtV8sElTwp4E3bkTIg3svnUg2o9GPxZBWI6lm09KMuF+SOQ9PrY/fJBHqpZvZguuvdoVpkyM4g7E0R2nCe1ykxRsBc+5z8bH1I/Q6/aDzI0HzQbnn98qPlRxzAv67Uf1EvbmI1vng2P7WlBakhJfO5nVegGw6dpb/HAbvq5dxw8jfJtYQWHdJ9eJNcu7DITArQ77eke34aafRN/0Lx+/k4z4fv5+NoWkMZkJymwi/FqQIWkCzzNKpPowBQvPQ2TPEmNzfPVsNIZf6JbUprlIYpkOKwkvA2Jcu29oiPNZ7paUqPfQ2uXs5KNJNDZ0S2j9ArWpneTRLJfiAwGAxjBFQo3z4hUjqnGtnn+gIm5xybbMIKJrczBg3kYfe+eTT9JvrFOd7wVcw4nnJapS3Tk3oszHaCaXqeXgB48UGNyvIqJlMBF7SQLoy2tfqFAwK8/BmsR9E2JuQYv7VEFHUPCOoovWRLnylsnlC98WAr0gMP08AYa/xcSvoUxkuPvCk4eDq5KsTT0TmfmofC2J1QCj8yPMDxR1lpkX7SACmBaOJymfgIf9KZhFg== X-Forefront-Antispam-Report-Untrusted: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:AS8PR08MB6806.eurprd08.prod.outlook.com;PTR:;CAT:NONE;SFS:(4636009)(366004)(6636002)(53546011)(8676002)(66476007)(2906002)(508600001)(2616005)(956004)(31696002)(6486002)(5660300002)(8936002)(66946007)(36756003)(52116002)(83380400001)(4326008)(66556008)(38350700002)(86362001)(31686004)(16576012)(316002)(186003)(38100700002)(44832011)(26005)(45980500001)(43740500002);DIR:OUT;SFP:1101; X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM6PR08MB3720 Original-Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com; Return-Path: Sami.Mujawar@arm.com X-EOPAttributedMessage: 0 X-MS-Exchange-Transport-CrossTenantHeadersStripped: AM5EUR03FT048.eop-EUR03.prod.protection.outlook.com X-MS-Office365-Filtering-Correlation-Id-Prvs: d2c1b663-d724-40ec-0322-08d9a2a0a554 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: Ay73eptbuJK1RLKVKszPyF6kTVMJbrB0LqNASSd8ZDrfhpoG5vMDZ+rj0liajcoz+dZEJzMgeWjUOO3tDJ+KrfNnDYd4eQIB+O5SzXx2lnDtCbb0HZ0sw8Rl8THQSOHChR65PG3qgP4XxyIs2TLO+qfbYGBR8yIx3KJnJKfORfSOxrr/SyY5nxt2+fVUzNIPwPsRu1y/oTkhQi5qQ9YVY/w4xKkR+4aRK4suXAZiEHKWF3nkQYjH/OcMxzcg8+SAm6BtI4IwG9DwUqUKTTAlmk5Nc/RlmdqicM9XCn9c+Xtti142NI5ADUqOpZPjprFGdtzAFncsIxoTXtWvkR7cpSALW/IvtkoSnixF4tON9Un/RE6zzb2O9ZzZVp5JQvaLPhSmBw88D+91ZXZLKhIz6I+UagFzjPg3Rprccjh3LDvTVu16enX1Kg/rcLwClPzh41oJmGo7XuP8L5EcL02hvIqC/8rjZB9K44C0OUXoiezMFtFAARVfG/8y3ZwWKh4gAEInE2OFG6bq0PcRQ5x5bcOh8/1PoizaHPNgT2rZPhp5kAfXLFDEWEQbUT1ZK1p4gCMcIWl+XicCyesHokGGcyhJHxdEMpzPObPL2vY/48+NtcCvszdgTscW81yDdGmqJtnv0lp3F3+XHt8A1Er9IQLKlKlFTej0anhj6blOAf0dNIYjVgTEO1+hBYcG1MtuKzqWe2tD0WXEZfqNOIputH7fWRqvsak8a3nlOo9MDec= X-Forefront-Antispam-Report: CIP:63.35.35.123;CTRY:IE;LANG:en;SCL:1;SRV:;IPV:CAL;SFV:NSPM;H:64aa7808-outbound-1.mta.getcheckrecipient.com;PTR:ec2-63-35-35-123.eu-west-1.compute.amazonaws.com;CAT:NONE;SFS:(4636009)(36840700001)(46966006)(2616005)(53546011)(26005)(956004)(70206006)(336012)(82310400003)(2906002)(31696002)(70586007)(8936002)(86362001)(36756003)(316002)(81166007)(44832011)(186003)(83380400001)(6636002)(5660300002)(47076005)(8676002)(31686004)(16576012)(4326008)(356005)(6486002)(36860700001)(508600001)(43740500002);DIR:OUT;SFP:1101; X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Nov 2021 10:15:25.4422 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: c1846bf0-e869-4203-ffe9-08d9a2a0ae75 X-MS-Exchange-CrossTenant-Id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=f34e5979-57d9-4aaa-ad4d-b122a662184d;Ip=[63.35.35.123];Helo=[64aa7808-outbound-1.mta.getcheckrecipient.com] X-MS-Exchange-CrossTenant-AuthSource: AM5EUR03FT048.eop-EUR03.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0801MB2058 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-GB Hi Khasim, Thank you for this patch. Reviewed-by: Sami Mujawar 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 > --- > .../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,