From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from EUR03-DB5-obe.outbound.protection.outlook.com (EUR03-DB5-obe.outbound.protection.outlook.com [40.107.4.55]) by mx.groups.io with SMTP id smtpd.web10.495.1635270038011412654 for ; Tue, 26 Oct 2021 10:40:38 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@armh.onmicrosoft.com header.s=selector2-armh-onmicrosoft-com header.b=1tSocu1M; spf=pass (domain: arm.com, ip: 40.107.4.55, mailfrom: khasim.mohammed@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=dKBKsnz63k/Dwki1RTuk6ZbD6wgnEqhVp4jT6/Oqd7w=; b=1tSocu1MhgwsIETS79nk0Q4KwxSsdpJVwhg0TO+W+UvHS8a6hc+QI9GV+kEJfBZM1hPF/VFNO94WQVS+zooYYWySvWTlmBjcufs1HnG2ON7NB8eCOFrTx+ewX1otTRTf4ilUeIMm+ippjnjPf7ucqrw/Fj72pmI1WXuOLEuW2JM= Received: from AM6PR08CA0021.eurprd08.prod.outlook.com (2603:10a6:20b:b2::33) by DB9PR08MB7039.eurprd08.prod.outlook.com (2603:10a6:10:2cf::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4628.16; Tue, 26 Oct 2021 17:40:34 +0000 Received: from AM5EUR03FT062.eop-EUR03.prod.protection.outlook.com (2603:10a6:20b:b2:cafe::42) by AM6PR08CA0021.outlook.office365.com (2603:10a6:20b:b2::33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4628.18 via Frontend Transport; Tue, 26 Oct 2021 17:40:34 +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 AM5EUR03FT062.mail.protection.outlook.com (10.152.17.120) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4628.18 via Frontend Transport; Tue, 26 Oct 2021 17:40:33 +0000 Received: ("Tessian outbound a8bfe25d7364:v103"); Tue, 26 Oct 2021 17:40:33 +0000 X-CheckRecipientChecked: true X-CR-MTA-CID: baed547b58540d1d X-CR-MTA-TID: 64aa7808 Received: from 6e8cf6226dae.3 by 64aa7808-outbound-1.mta.getcheckrecipient.com id 34D58638-25D7-4F8B-9B5C-D0CCADA1FEE8.1; Tue, 26 Oct 2021 17:40:27 +0000 Received: from EUR05-AM6-obe.outbound.protection.outlook.com by 64aa7808-outbound-1.mta.getcheckrecipient.com with ESMTPS id 6e8cf6226dae.3 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384); Tue, 26 Oct 2021 17:40:27 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=gOMTFAex5gP3e6NBNM9nExTLre5BeFztzpjYZsSEdtuu1pJEI6tphLJB2AebCZg9ogXL6A432qhEWcgoimOAol9UqXOZwMS5+EOqoQV2xLaBZNoE3dKw1tURIdx36rHgsFWD7l8LQNlzbi4swQdWCIlQmx3Iu10I8Hqo7Aw4Cs8xOHVWYVwwp4m0/FCOmzIxKNmEU9M8qMgrbP2i3jNwWRr+Nul8fXyJT/pfy4Qn2VXfASzULpszm1W5HtdbiRBBKC1Qfa7D8gYXWKxeIehdYFIOaQrMCpwa0g+adncwJwk1pyxjKi6opkt77TBqbEWxsuKjX51d6QqmcSrk5oY6ag== 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=dKBKsnz63k/Dwki1RTuk6ZbD6wgnEqhVp4jT6/Oqd7w=; b=hkZ0B1Ke7EzMVYpilbvVISO4Yc+t8weUPyQG80OYSjqJk13iihqo4YiWfPeQc0SLcL6cQ8LYeCSBoCyjXFx9c2o5EUAIidQ604xlvQsKRUE1qKaCPZoWKCD7PAUtuzbXi5jypQrZkX//TukN+EuEwSPAlBeOef6kbOt9eUhQRfmZeLbsY/1CWtgckwKoh//6Uox0pKCMyob7UwpFld9oodosOVM2TvjwENwYZi7MCkUO4nA6dNJfdC+PNwfvWX+6s0eTr915X0JIcGEo3tnY0OEQ1Yyu/IUQDlGTsLfzYXfwDhSufZ7tKI2VGXEkto097wuSu0nGwVvp4fNOVHzA7w== 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=dKBKsnz63k/Dwki1RTuk6ZbD6wgnEqhVp4jT6/Oqd7w=; b=1tSocu1MhgwsIETS79nk0Q4KwxSsdpJVwhg0TO+W+UvHS8a6hc+QI9GV+kEJfBZM1hPF/VFNO94WQVS+zooYYWySvWTlmBjcufs1HnG2ON7NB8eCOFrTx+ewX1otTRTf4ilUeIMm+ippjnjPf7ucqrw/Fj72pmI1WXuOLEuW2JM= Authentication-Results-Original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com; Received: from PA4PR08MB5902.eurprd08.prod.outlook.com (2603:10a6:102:e0::10) by PAXPR08MB6864.eurprd08.prod.outlook.com (2603:10a6:102:132::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4628.18; Tue, 26 Oct 2021 17:40:16 +0000 Received: from PA4PR08MB5902.eurprd08.prod.outlook.com ([fe80::e5a7:9474:4463:d258]) by PA4PR08MB5902.eurprd08.prod.outlook.com ([fe80::e5a7:9474:4463:d258%2]) with mapi id 15.20.4628.020; Tue, 26 Oct 2021 17:40:16 +0000 From: "Khasim Mohammed" To: devel@edk2.groups.io Cc: nd@arm.com, Khasim Syed Mohammed Subject: [PATCH v4 1/7] Silicon/ARM/NeoverseN1Soc: Fix missing function documentation Date: Tue, 26 Oct 2021 23:09:53 +0530 Message-Id: <20211026173959.15742-1-khasim.mohammed@arm.com> X-Mailer: git-send-email 2.17.1 X-ClientProxiedBy: LNXP265CA0004.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:5e::16) To PA4PR08MB5902.eurprd08.prod.outlook.com (2603:10a6:102:e0::10) MIME-Version: 1.0 Received: from e116623.arm.com (217.140.99.251) by LNXP265CA0004.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:5e::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4628.22 via Frontend Transport; Tue, 26 Oct 2021 17:40:15 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: f33d4e8a-67e5-47d3-6641-08d998a7b663 X-MS-TrafficTypeDiagnostic: PAXPR08MB6864:|DB9PR08MB7039: X-Microsoft-Antispam-PRVS: x-checkrecipientrouted: true NoDisclaimer: true X-MS-Oob-TLC-OOBClassifiers: OLM:8882;OLM:8882; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam-Untrusted: BCL:0; X-Microsoft-Antispam-Message-Info-Original: voZ9/VR1HIuN2zugQNoxqlevxEcun8OePQi7X6w7eNF1irZKk+Eykh14qq7ZbQ31V4IY6GulZtEeh9AtMZIW9no48Tj05b0kUYzp1OcHKkoixeSFABdPMLHXu3y+mIavUUg22WyAb2THlU92G8aBtl7V8Pf6RPCr+FhCn+U4BJJwvJyMglMNs7SsipOineTsM9DSUYDI83mh+iTzy+ReVi5g6WurB1KPHsC2mso9dPuLGWFY0/HKE/Hz/bvmbhgJcPiSmmkS8eRlBl7DiMEBtx4aY482GgA7cv0UgG9bK/xddeeChoFMmuQEsuBH551UAvKmySmWPCWRZTIrKH9PvPEXRfRJf8IJu+rGVfZ/k/lCNFBIymaAxsrl0i3sD/Ht9ppjBsX6crgivGPU3MdeFturCsqYTanbEQZ5q19C/D3jBC4OpJBBopgW7I7FsNkqx2p1cPGHZwjStnrhVEUma9m9Wc1lwnZuQ0Y5h5MV0KOD04A5lcGkBUYmbayeQiN/9vbISHIaQsTGLZzXx8++yneUJ2iJNHcvtqsMS2UEDpOXOZKJL/wRJ3Qk9KWUal5zDbMk3SymxCfsvi/uDIBRQqOkAOb49e75cIXEv3DoqbQG0lcqDF55rHGbU4aAzp/3D029Zw7ika0YQqwSuvlMQgUgVUNAV5/nTorPv5/qj6rM+A+jK0fvwtxEzYbef63seoJelkb0n9wfnpezVbwbyg== X-Forefront-Antispam-Report-Untrusted: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:PA4PR08MB5902.eurprd08.prod.outlook.com;PTR:;CAT:NONE;SFS:(4636009)(366004)(508600001)(4326008)(956004)(26005)(2906002)(186003)(6486002)(5660300002)(8936002)(6916009)(83380400001)(1076003)(7696005)(52116002)(316002)(36756003)(6666004)(2616005)(8676002)(86362001)(66556008)(66476007)(66946007)(38100700002)(38350700002);DIR:OUT;SFP:1101; X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR08MB6864 Original-Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com; Return-Path: Khasim.Mohammed@arm.com X-EOPAttributedMessage: 0 X-MS-Exchange-Transport-CrossTenantHeadersStripped: AM5EUR03FT062.eop-EUR03.prod.protection.outlook.com X-MS-Office365-Filtering-Correlation-Id-Prvs: 5720123a-7e40-461a-2025-08d998a7abe2 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: fnxn3FIIrxDGcjwcOi6+6KZEFwHOKCN2ikCc1vx8cDZt3LGs/E8kpZmzpUuxPQQ45fGLElQ5a9TJ/6+d0w7CF4nvpwuKif3xEd7TO27U+iGOZXjwMMfzNAU39JJq4VKdKRwZfNX/WsoYvlznJkSfsHhmuUqMqtiNv7H7XJ094u2V6EnFdWGiVqBuN8xZ3Lb3m+gY1HcLW/TAgSRoJN87j52Lc0NnL5OEHdoPpn1MAOPd2qVMGvE7jDHMSXMc9HYEOMyc3HeeRXsvxzi9QlxdU3Uh0xjBnYFD42fS8udFZ4kh5mEKia35gouQQl0Y3z2N8/Q6UR1xxFBz3mZ1aqC7TraiQNDc44doFOfauEeOqjJaaj5c4dkTV3mgg14DWa0XZ9TvNzNlzrqk8o3fOayxi/eVC25JyyTDD3ehKcvrM6KjtYbQRzWJ2bcDHTvx0eeYd1dH7hOD3aecD8aCYla61cnisDZ365OHZoZrBCXSaLd5ga/tPikmw97UK25Yjnt+HcaB+6IcRt8P86xd1PhwL4LdpCP7SLavoE/mmNCRtrSd76AVqNJ2A13CEt0liW7alsUCyzIIqbkcRxKzF8FgFHS2bchCnAtEH9porUJwJfGbOPPWaWz+ITnSRewaim6fG9f9k+vN10PQSZxdjwvGSNUMDD6A1C83jVWEhWcoE7JDWQOHE0dm6vQR6hgVUR/uA0uo58ALE0PEvkoRz+M+OA== 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)(36860700001)(7696005)(5660300002)(8936002)(508600001)(6486002)(82310400003)(956004)(2616005)(36756003)(1076003)(86362001)(6666004)(26005)(336012)(4326008)(186003)(83380400001)(6916009)(47076005)(70206006)(316002)(70586007)(2906002)(356005)(81166007)(8676002);DIR:OUT;SFP:1101; X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 Oct 2021 17:40:33.5984 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: f33d4e8a-67e5-47d3-6641-08d998a7b663 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: AM5EUR03FT062.eop-EUR03.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB9PR08MB7039 Content-Type: text/plain 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, -- 2.17.1