[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] docs: fusa: Add Assumption of Use (AOU)


  • To: <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
  • Date: Fri, 6 Sep 2024 11:13:18 +0100
  • 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)
  • 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=oG5vCAN2wpzafd+FPmGk4LRhs9L3qL3e+Xxkqwi64tY=; b=t2bqmsl1qm+BMuBhHgViiT3GZkOLd+SBCh4FDOmtNKYzifOVlHUsQ/lbic7yDcaPVax4d7f3Bh/0VwCNNoB8/aAIk3+VgeVeix5tRxdRM1xRUKZc/uCdkar3j7lmrxX/9HAKCf70/2kY39PmDwNEjtt+Mpe8K5y9K1PrZ0vF9ZkuCN96/iRHG4LXLAGN+dV4t/lIdZ6LGhGUkY4WRmBHtz8ZYj7EHIOmFnAYlTsClYISSOvG7Cb+1LJwzsuGeHhv96BXX8K08LPQeUGbxYG1WLQ5b6/Ps5u3LTrBr9DKmHq1dhavKvliWv6obkRjtOhstODOriwifKR2r3G4dY4Ijw==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=YHxh0GGtj89BWTC01FkrTzvK7bSo4l4wJiESfJgpTtsTt/gg/Cx1BB5HAQR8IEWfFl4AIcOxJQZCrTP87HlZLj3CG0Sfzl473bfZq2YfPpcsES2IUPT26vOkT2N8/mwX064rsaa3ZL6XIjjPy0CyfeqvpI+vgP2vSTLBCsgZu4emY6Yx+WHvNMCK66bjuHeBi8tPMrdKiTor9/M9dGld0TyYtOGSo4uZ9BGnSY8Xl8t0J5vVho5lUj0kQgp6ZRdM/OjRTJtdDFYbs1PcObOGJ/Bu60IzFJCXQlMhMjisp5MEEazZ2t+uMQxLubsmXuSzjR45fNk4ryLqE5kqq62+aQ==
  • Cc: Michal Orzel <michal.orzel@xxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Bertrand Marquis <bertrand.marquis@xxxxxxx>, "Ayan Kumar Halder" <ayan.kumar.halder@xxxxxxx>, Artem Mygaiev <artem_mygaiev@xxxxxxxx>
  • Delivery-date: Fri, 06 Sep 2024 10:13:51 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

From: Michal Orzel <michal.orzel@xxxxxxx>

AOU are the assumptions Xen relies on other components (eg 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.

Signed-off-by: Michal Orzel <michal.orzel@xxxxxxx>
Signed-off-by: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
---
 .../reqs/design-reqs/arm64/generic-timer.rst  | 19 +++++++++++++++++++
 docs/fusa/reqs/intro.rst                      | 10 ++++++++++
 2 files changed, 29 insertions(+)

diff --git a/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst 
b/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst
index f2a0cd7fb8..9df87cf4e0 100644
--- a/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst
+++ b/docs/fusa/reqs/design-reqs/arm64/generic-timer.rst
@@ -116,6 +116,25 @@ 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 ensure that CNTFRQ_EL0 register contains the system
+timer frequency.
+
+Rationale:
+
+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
-- 
2.25.1




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.