From patchwork Mon Sep 16 12:18:51 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ayan Kumar Halder X-Patchwork-Id: 13805361 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 44843C3ABB2 for ; Mon, 16 Sep 2024 12:19:42 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.799460.1209446 (Exim 4.92) (envelope-from ) id 1sqAhK-0005ko-JC; Mon, 16 Sep 2024 12:19:18 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 799460.1209446; Mon, 16 Sep 2024 12:19:18 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1sqAhK-0005kh-G1; Mon, 16 Sep 2024 12:19:18 +0000 Received: by outflank-mailman (input) for mailman id 799460; Mon, 16 Sep 2024 12:19:17 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1sqAhJ-0005ka-9C for xen-devel@lists.xenproject.org; Mon, 16 Sep 2024 12:19:17 +0000 Received: from NAM10-BN7-obe.outbound.protection.outlook.com (mail-bn7nam10on20625.outbound.protection.outlook.com [2a01:111:f403:2009::625]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id e32c1f43-7425-11ef-99a2-01e77a169b0f; Mon, 16 Sep 2024 14:19:14 +0200 (CEST) Received: from BN9PR03CA0522.namprd03.prod.outlook.com (2603:10b6:408:131::17) by LV2PR12MB6015.namprd12.prod.outlook.com (2603:10b6:408:14f::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7962.24; Mon, 16 Sep 2024 12:19:10 +0000 Received: from BN1PEPF00005FFF.namprd05.prod.outlook.com (2603:10b6:408:131:cafe::55) by BN9PR03CA0522.outlook.office365.com (2603:10b6:408:131::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7939.26 via Frontend Transport; Mon, 16 Sep 2024 12:19:10 +0000 Received: from SATLEXMB03.amd.com (165.204.84.17) by BN1PEPF00005FFF.mail.protection.outlook.com (10.167.243.231) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.7918.13 via Frontend Transport; Mon, 16 Sep 2024 12:19:09 +0000 Received: from SATLEXMB05.amd.com (10.181.40.146) by SATLEXMB03.amd.com (10.181.40.144) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39; Mon, 16 Sep 2024 07:19:09 -0500 Received: from SATLEXMB03.amd.com (10.181.40.144) by SATLEXMB05.amd.com (10.181.40.146) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39; Mon, 16 Sep 2024 07:19:09 -0500 Received: from xcbayankuma40.xilinx.com (10.180.168.240) by SATLEXMB03.amd.com (10.181.40.144) with Microsoft SMTP Server id 15.1.2507.39 via Frontend Transport; Mon, 16 Sep 2024 07:19:08 -0500 X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: e32c1f43-7425-11ef-99a2-01e77a169b0f ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=isdBnKKjbiKtKGdAlD4xpI6eQzHzhCmb/wibgeoUTY7uBEnVYDTs/x+u5DWcxBdd/NvbjyN6zjmOketzQdQxpk3v7Jzm2nU31H6ilZAG1gt9YyeKur0OQ2CSNgDyNqiRzfglEt7AtjNjbym1ML8U5P4ai3wWXeFk64GRa6t5wdfY3WSQIPPxNZ3JTTTT1Dsh48TrTTjsuQsXfahdCkHxIbuJa+06Bm83fCwgcnPKJyUkoRVPKPhTnP3axF8lH9bXPHNTKIRlptkeZ4D8qyEGI9wHIJhEfCfMZL6gMnJmwV2bt4C5F0OMJYRgvgsr8TJ5+VbC6pf6+COm1HXbYjPt2A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; 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=DerKJB4DpMjB60pSbx3jJXl2oQobnHY2AaURhP3AS9E=; b=n2YeERWj8HWLONj4S2xsrkAx7iwsoj4v6IuNRtmOjvGyQUzXF/q0wBBh+zTtNhN2DLV2K9SWsWcalLTD0heDaOr3Eg4kclav3V0qg99ap/gPtzQ4H9IvFP4RFK8DIb3HJ9m8h+uk7DN+KT2mh232ZQ4b3c74j00qsLoSzVjeb2uWyT8gVyHu1Z60E5dI0z9TLY3GN7tMuuJcD0j6X0teGa1i0dQv0RN330BB/lZI26wzsX+p1JCAuRq0WeoGNM80k33WhD2Ix4a6plxC2lpJCNlLFYix0TNQKO/7NgYhPKPfCejig1mGBHttxr6Dgu3zNvAYOSD67xY2gV96yNkh6Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=lists.xenproject.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=DerKJB4DpMjB60pSbx3jJXl2oQobnHY2AaURhP3AS9E=; b=QbjisRRPG0y6NWRCniuJG4PSnIfuCDLSpOGNB6QY16lJb+Kq3VR2ChTQQrqM+zfavnf8H1W9dYi+6Dwnfu02jrIvai7Xf7oHKBSfAldPpq82njO7wGERIKm+uK8JOjwMbjeYWm9Src2xiDFLilodXJAa47NYVGCoDiEnV7rMJwU= X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB03.amd.com; pr=C From: Ayan Kumar Halder To: CC: Michal Orzel , Stefano Stabellini , Bertrand Marquis , "Ayan Kumar Halder" , Artem Mygaiev , Hisao Munakata , Julien Grall , Julien Grall Subject: [PATCH v3] docs: fusa: Add Assumption of Use (AoU) Date: Mon, 16 Sep 2024 13:18:51 +0100 Message-ID: <20240916121851.3587139-1-ayan.kumar.halder@amd.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Received-SPF: None (SATLEXMB05.amd.com: ayan.kumar.halder@amd.com does not designate permitted sender hosts) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: BN1PEPF00005FFF:EE_|LV2PR12MB6015:EE_ X-MS-Office365-Filtering-Correlation-Id: 05b34096-26d1-478f-2b3b-08dcd649c4ab X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|1800799024|376014|82310400026|36860700013; X-Microsoft-Antispam-Message-Info: +LZEgWA9lw3qkr7Dta3HtcPLMHtv8Ug4RZlL5DlrJEE6vv38KK6SLVXmTivskt0MH8uZhME/JvhFry6kH/Qqn2BwVBvsvoHewn+l04bpZ0yDuxYqIHjW3Rbu6NZlQGjQuTWGQ1CuXRaSDAAfesS1NEfT2Coqb91dBTcgYF0IMpd+U34zSAP7hE1rljni8oaCMWK9LU4LxXyTjDUvrA31d5hRK1wFXWNPf2BrAWd0MQoFYtrKesAXhjfZVFspqkyaSiHokVvcXaYYBjbtQMSRRb/8Ltx50E8WohlVT+RAv3BeTnk8IlD050SZbd11DXXbIx0LDzGWHVAP5wtt3TOVR8VA2ubqoWoRnX/IrhvTsTVX1Dqan4vwCV+jDAKgXzuGDfrxcyX/nL8/SqZ4BO5SSOj23LpUwAkmA9oE0aKEeUaEzuMsc5MC2t9IktKtFXYschS0vNSSE1WH2JeB2sSDiQshl4zzRNssoT8XjEqCewp/kjG0Vjg8krYXTsH7YpHqxhB8/6JHnnw7nMWTT6fvp8hNhecYrDF7uKCyXItfOTeNILEDnJ0Y1ScVCDzjNCrnchOCosNqB8EZu1BU+ue9ThO6IuHPRAg/QcTQuP+n9wELCl6hzoT2c5B716saYP6RInd5UmotC9zGUDJ9XOy62MDzX+JqsQT1Y2pZ/OzVGBrqxzbZADp3NsKk3HaLnQ7qK/fSx0mTITaBexTA4dRx2Xxp+B847MlkDXuRKhRg7UmDZl3o8BKYVbb5tzhwdC210HQwcnYLFxmagYNLINuR2wFgRskGuSYpHXaSRLdZqDqF+lXUm01dC9ON5K5EXMNlkewOrt7srKkO77U5LJYG4MLxz4MhtyEnlAIeWIIuc8JvI4g8mfU8TSbH35YmsUFF2B2Kdp2Jal9a3GOvalaxWdqSehzcDrtr792dHXEkFlNz1bXA3cJFw/uJIAdnUhxqidKf8JwcDfPydyMVepSpBth8D9xatNcdh+kcL+zsf+1KG8WBu04V26PVz0l8HvEmVNLSi1FGv6tw0Tiw2A73SUCMkXfzX8ym+mr2+pJeNGxDFUIWDmn3XIX0WPH/7ZecYNl8AE9XAVouz4ZlFbgYEgFQUUH982G03EgYGuqud+3AYgLE+f3epU3zRSji5mwEsG5EW+GnNIQmmxHh0xOUlkqOo2j8HrDMX8b93AFRwNmo3O5fb2IEF6HCLv02SLAhTU8g4AnsqNH+dJWP5UAONFpz5VactGnUPS0g7VWSElmO0CIHVJvvj0Z1m1w6eaMuHH8Bbf4e0jabUZRmJpAyqXYak1N6r4Ev8hKxlYKjBIfTTPCpxZh0yIdNf3ZSBSWADpcfi4jSvma7MEQ4q4ZMHGQDIlzTmSH+fzyfu+IC0ScSGow56nrVjk8MBBm8uSp4bU5VN5drHi+Uhh7+w8up4xss2WnECzaUuwxNKIFqXbynXV4YKNur4hkFGoRwkKc3 X-Forefront-Antispam-Report: CIP:165.204.84.17;CTRY:US;LANG:en;SCL:1;SRV:;IPV:CAL;SFV:NSPM;H:SATLEXMB03.amd.com;PTR:InfoDomainNonexistent;CAT:NONE;SFS:(13230040)(1800799024)(376014)(82310400026)(36860700013);DIR:OUT;SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Sep 2024 12:19:09.9495 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 05b34096-26d1-478f-2b3b-08dcd649c4ab X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d;Ip=[165.204.84.17];Helo=[SATLEXMB03.amd.com] X-MS-Exchange-CrossTenant-AuthSource: BN1PEPF00005FFF.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV2PR12MB6015 From: Michal Orzel AoU are the assumptions that Xen relies on other components (eg platform platform, domains) to fulfill its requirements. In our case, platform means a combination of hardware, firmware and bootloader. We have defined AoU in the intro.rst and added AoU for the generic timer. Also, fixed a requirement to denote that Xen shall **not** expose the system counter frequency via the "clock-frequency" device tree property. The reason being the device tree documentation strongly discourages the use of this peoperty. Further if the "clock-frequency" is exposed, then it overrides the value programmed in the CNTFRQ_EL0 register. So, the frequency shall be exposed via the CNTFRQ_EL0 register only and consequently there is an assumption on the platform to program the register correctly. Signed-off-by: Michal Orzel Signed-off-by: Ayan Kumar Halder Reviewed-by: Julien Grall --- Changes from :- v1 - 1. Removed the part of requirement which states that Xen exposes the frequency of the system timer by reading the "clock-frequency" property. 2. Added a rationale for AoU. 3. Reworded the AoU. v2 - 1. Reworded the commit message. Added R-b. .../reqs/design-reqs/arm64/generic-timer.rst | 24 ++++++++++++++++++- docs/fusa/reqs/intro.rst | 10 ++++++++ 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst b/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst index f2a0cd7fb8..86d84a3c40 100644 --- a/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst +++ b/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst @@ -30,7 +30,7 @@ Read system counter frequency Description: Xen shall expose the frequency of the system counter to the domains in -CNTFRQ_EL0 register and/or domain device tree's "clock-frequency" property. +CNTFRQ_EL0 register. Rationale: @@ -116,6 +116,28 @@ Rationale: Comments: +Covers: + - `XenProd~emulated_timer~1` + +Assumption of Use on the Platform +================================= + +Expose system timer frequency via register +------------------------------------------ + +`XenSwdgn~arm64_generic_timer_pf_program_cntfrq_el0~1` + +Description: +Underlying platform shall program CNTFRQ_EL0 register with the value of system +timer frequency. + +Rationale: +Xen reads the CNTFRQ_EL0 register to get the value of system timer frequency. +While there is a provision to get this value by reading the "clock-frequency" +dt property [2], the use of this property is strongly discouraged. + +Comments: + Covers: - `XenProd~emulated_timer~1` diff --git a/docs/fusa/reqs/intro.rst b/docs/fusa/reqs/intro.rst index 245a219ff2..aa85ff821c 100644 --- a/docs/fusa/reqs/intro.rst +++ b/docs/fusa/reqs/intro.rst @@ -38,6 +38,16 @@ The requirements are linked using OpenFastTrace OpenFastTrace parses through the requirements and generates a traceability report. +Assumption of Use +================= + +To fulfill one or more design requirements, there may be underlying assumptions +on one or more components that Xen interacts with directly or indirectly. For +eg, there may be assumptions on the underlying platform (hardware + firmware + +bootloader) to set certain registers, etc. The important thing here is that +anyone who validates these requirements, need to consider the assumption on the +other components. + The following is the skeleton for a requirement. Title of the requirement