From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from EUR04-HE1-obe.outbound.protection.outlook.com (EUR04-HE1-obe.outbound.protection.outlook.com [40.107.7.53]) by mx.groups.io with SMTP id smtpd.web09.390.1635269591081201957 for ; Tue, 26 Oct 2021 10:33:12 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@armh.onmicrosoft.com header.s=selector2-armh-onmicrosoft-com header.b=VvavLcse; spf=pass (domain: arm.com, ip: 40.107.7.53, 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=VvavLcsex/y5cr24OQwwKpuFR6Rgj6EOoSitnvQVYGBq53Cc6Inq8YAvRyh6Bygb8oxeFhRMxuQPDsj7LnROnW6IrN+5m3ulEbKIWifVXlF3hyFMkr+zo0Y1KTj7WYHsR54/w8SQ3SHI3qwI4yrfTXpak9eUjY83L+dKP0TXHxE= Received: from AM6P195CA0058.EURP195.PROD.OUTLOOK.COM (2603:10a6:209:87::35) by AM4PR0802MB2163.eurprd08.prod.outlook.com (2603:10a6:200:5d::13) 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:33:07 +0000 Received: from VE1EUR03FT049.eop-EUR03.prod.protection.outlook.com (2603:10a6:209:87:cafe::e7) by AM6P195CA0058.outlook.office365.com (2603:10a6:209:87::35) 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:33:07 +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 VE1EUR03FT049.mail.protection.outlook.com (10.152.19.216) 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:33:06 +0000 Received: ("Tessian outbound e27daf245730:v103"); Tue, 26 Oct 2021 17:33:06 +0000 X-CheckRecipientChecked: true X-CR-MTA-CID: 6a6823ca03e87453 X-CR-MTA-TID: 64aa7808 Received: from 924b78afff36.2 by 64aa7808-outbound-1.mta.getcheckrecipient.com id 2999F6C6-F893-4268-B88A-80E3D9D0E3FC.1; Tue, 26 Oct 2021 17:33:01 +0000 Received: from EUR05-AM6-obe.outbound.protection.outlook.com by 64aa7808-outbound-1.mta.getcheckrecipient.com with ESMTPS id 924b78afff36.2 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384); Tue, 26 Oct 2021 17:33:01 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=FI0D/LepUhjnis08tc0ImvDGOsfvvIztK2EabThui7h3xMamEtgnJ98dAcX0gWJg2y2m640RPpc+/bIuNh6Xo4kznerb4xkMxyhX1S/DTfi51EyvvwqDcYXN+KROnsi9ReSPgbMzXAf7Tb4gUixWP/WVLvKNhW6h0fUf5RNmvrONgy5TIh+HdTYrLlFmNXbG51hp6JGvjXGuKlqt6K8VuXyjJRyGS3HdOe0qwumKQZ06LMkfPmBksifJiLdU9mMzwd+MgT8HClOlLbQ6QhTq3IeGJpqZftuUEsuwSYSmZH9qZmNaZW9x6GDqdsxPtAfthhAovmm/RBX90UrMDuzpeg== 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=j7O15FC4j6bq7her/AwKJlgHMyZjuHPevA0Lnkx7R2qv083Raz6EpIZX4EMRFI9ohFdaQEgDcJll1O6qXGsLZEh4LouqBWI0PvJZbaU9TRNeyRVhPfyI47wXgxLpzElEkav8iN622PZInxudMh8FXMtNgWAP4UaoOMxLl1w/tVqkeC58egNnWMeIM/4rZK5K4mk8Ll50oN9SpCsQHKzyKBq0LKH5BR5mzBp8H8UiVg5nprONHDDN18tucNwzZvt6whYBByd64E4aS8tE9YfMeg1nu0PoWim7+niKaH3p9bKvEVPdLVT9tNCDtABx4NkYBwU0ZiYLMQeGpJ3PVVLrTQ== 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=VvavLcsex/y5cr24OQwwKpuFR6Rgj6EOoSitnvQVYGBq53Cc6Inq8YAvRyh6Bygb8oxeFhRMxuQPDsj7LnROnW6IrN+5m3ulEbKIWifVXlF3hyFMkr+zo0Y1KTj7WYHsR54/w8SQ3SHI3qwI4yrfTXpak9eUjY83L+dKP0TXHxE= 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 PR2PR08MB4698.eurprd08.prod.outlook.com (2603:10a6:101:19::11) 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:32:59 +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:32:58 +0000 From: "Khasim Mohammed" To: devel@edk2.groups.io Cc: nd@arm.com, Khasim Syed Mohammed Subject: [PATCH v3 1/7] Silicon/ARM/NeoverseN1Soc: Fix missing function documentation Date: Tue, 26 Oct 2021 23:02:28 +0530 Message-Id: <20211026173234.9053-2-khasim.mohammed@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20211026173234.9053-1-khasim.mohammed@arm.com> References: <20211026173234.9053-1-khasim.mohammed@arm.com> X-ClientProxiedBy: LO4P123CA0218.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:1a6::7) 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 LO4P123CA0218.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:1a6::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4628.16 via Frontend Transport; Tue, 26 Oct 2021 17:32:57 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 1a3f7c20-605f-476d-537c-08d998a6ac2b X-MS-TrafficTypeDiagnostic: PR2PR08MB4698:|AM4PR0802MB2163: 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: 3psrDVqo1wpoz8jTJ7DRPUGrf3v752lnJNVe6n8sWmEB6dKZkA5053wt38+sZoldvLd8gjfrTBWxgWLBDWc+QJVLiBSdf1xgs4YyzJKcaOXac6cewdxVaPENYG4Pqy34f6uXjxeffLznm8N4BYl10wasu/VNjNq8dJ9POlyiCN6eQngBu1/of3hjHD6EocK2+WorTsbkQHhbyh6T7GM7s3R35ELFbKo2+3hHp0mOqeiojHTOiqns6+2x7ql8aKBrIH2Ky+Yn9RIjttTjxlxpH3KNdEeDm+BNeV9LNCpQPneFSwOqKjXITRhCWx5rMQ8emlw/waS8U1KEUTs4T076+VH8akbt8POmZW4wPlCCUKPauZtathVDjsrIKeNVOW1MtvNp1SpJqKxIAiG5woq2wPpBkOfrSGtlw8/2U6ASaFLEMIuE+WVl+HyTSodUND4blV8qF0/+rdLVuz8WE3w8HlgkJUIwPfmcQewCKqEVZ+0gOqInB5Fzutgkc0maDVt8w0CpR3Q/vMwXwLaGfZh/4HWM5bUyoEcNx1FW29LSpVOS8pLMSQ62wPRCVuc6IQlFNZit7NLmALNDltoUOHJ8Xwq0gun6n0ev1kqv7Les7w95mNg1Yl5PaadHp1+/EiPtDWficCO8xwJv/avHbxHATm4ewdXznwwK/PJRYsnx0xq+X2rKt5X+ydbtcPrRRodGKxYsqk4WhY6uEWVoQWSwcg== 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)(6916009)(6666004)(316002)(6486002)(4326008)(66476007)(86362001)(36756003)(52116002)(83380400001)(5660300002)(26005)(2616005)(956004)(66946007)(7696005)(38350700002)(8676002)(186003)(508600001)(1076003)(38100700002)(66556008)(2906002)(8936002);DIR:OUT;SFP:1101; X-MS-Exchange-Transport-CrossTenantHeadersStamped: PR2PR08MB4698 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: VE1EUR03FT049.eop-EUR03.prod.protection.outlook.com X-MS-Office365-Filtering-Correlation-Id-Prvs: a6fe438a-4c25-4388-be56-08d998a6a721 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 0aNmOVlD7aNvMalwP+FCpbmNXRZ55cY4iWoJYCj86h2DJUNjtGFoX8kZP+nzB6k/Q4eTGij6TNm+zVp9V44rOdeOsdGTqgblb9srr+Gr572bchylL4yYRMnWcJ+R9xfGwGkXowSQaFTuFlkWSqmrSxZkU8zv5uLbfpgp1p4bQPhyA1TVALo0T8eUdZmo/XI0Jmf6JDtvVE9wWhjV8WW8zcmSLvlxmotk1wPC2huoxrWdKchvzQzjaRULq2MUYdQzkH6u9sKp9UrLzpC/ypjsrspkBeFge2n9BONYxAZLTW1vD5QGOpUQJgKRro2vYMnNTTdJO7FnEi7IENrdNrExYdOPr3tLZ7W6JAAu2g+tTo7B6PL5i7UasoHsi9Cx4tDI0kAaKKOWD5H0trGVek9C3ABdSIt5wpn8qoFm0eHqicM853hpY7OGjtaRO9JvfHNkIWGauUJVPR7wkyCcc1G0PvMRxaf50SLCMWfXYLYFraqVW93d8TLYcdwszjFgSA/bz3w+XLvzkBpC15pi4N9jN8FN4RI4eF9uVqEV+vIZukTYAaV2wvVGXTJsmTNkEd2SwBTllvAZSOXlp5zayyxfrw+6NhjbZD3yNiN/niHwR2tBg59W2NNC7QXPb92CwR6k0TCecPktwcZQ0kNLNIu1zO+0hnN6WOIGFmo8iQaLJwGNBn7udiJEX88Zck0LnUrCyEncSz0OM5klC4vxpkRdCw== 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)(46966006)(36840700001)(7696005)(6666004)(2616005)(81166007)(2906002)(6916009)(336012)(83380400001)(86362001)(36860700001)(508600001)(36756003)(956004)(5660300002)(8676002)(8936002)(82310400003)(186003)(4326008)(1076003)(70206006)(47076005)(356005)(70586007)(6486002)(26005)(316002);DIR:OUT;SFP:1101; X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 Oct 2021 17:33:06.9070 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 1a3f7c20-605f-476d-537c-08d998a6ac2b 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: VE1EUR03FT049.eop-EUR03.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM4PR0802MB2163 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