Skip to contentSkip to conversation

docs: fusa: Add dom0less domain configuration requirements

PATCH In review Ayan Kumar Halder 3 participants 4 messages Jan 8, 2025 – Jan 9, 2025

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 docs: fusa: Add dom0less domain configuration requirements

From: Michal Orzel <[email protected]>

Add requirements for dom0less domain creation.

---
Changes from -

v1 - 1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.

2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.

3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.

4. The design requirements will be added later.

v2 - 1. Rephrased the requirements as suggested.

2. Split the product requirements into arm64 specific and common.

3. The arm64 specific requirements have arm64_ prefixed to their tag names.

4. Grant table requirements have been dropped for now.

5. Added a market requirement to denote that Xen can support multiple schedulers.

6. Updated index.rst as we have a new file ie product-reqs/reqs.rst.

V3 - 1. Removed duplicate mention for 'Rationale'.

2. Fixed some of the descriptions as per the review comments.

 docs/fusa/reqs/index.rst                   |   1 +
 docs/fusa/reqs/market-reqs/reqs.rst        |  31 ++++
 docs/fusa/reqs/product-reqs/arm64/reqs.rst | 128 ++++++++++++++++-
 docs/fusa/reqs/product-reqs/reqs.rst       | 160 +++++++++++++++++++++
 4 files changed, 318 insertions(+), 2 deletions(-)
 create mode 100644 docs/fusa/reqs/product-reqs/reqs.rst
docs/fusa/reqs/index.rst +1 -0
index 8a4dae6fb2..1088a51d52 100644
@@ -8,6 +8,7 @@ Requirements documentation
 
    intro
    market-reqs/reqs
+   product-reqs/reqs
    product-reqs/arm64/reqs
    design-reqs/arm64/generic-timer
    design-reqs/arm64/sbsa-uart
docs/fusa/reqs/market-reqs/reqs.rst +31 -0
index f456788d96..39b2714237 100644
@@ -47,3 +47,34 @@ Comments:
 
 Needs:
  - XenProd
+
+Static VM definition
+--------------------
+
+`XenMkt~static_vm_definition~1`
+
+Description:
+Xen shall support assigning peripherals to various domains.
+
+Rationale:
+
+Comments:
+Peripheral implies an iomem (input output memory) and/or interrupts.
+
+Needs:
+ - XenProd
+
+Multiple schedulers
+-------------------
+
+`XenMkt~multiple_schedulers~1`
+
+Description:
+Xen shall provide different ways of scheduling virtual cpus onto physical cpus.
+
+Rationale:
+
+Comments:
+
+Needs:
+ - XenProd
docs/fusa/reqs/product-reqs/arm64/reqs.rst +126 -2

143 lines not on this page · raw message

docs/fusa/reqs/product-reqs/reqs.rst new file +160 -0

160 lines not on this page · raw message

Signature · 1 line
2.25.1
#1 lore raw

Hi Ayan,

This is a lot better.
I just have some minor phrasing comments after.

Quoted 66 lines · Ayan Kumar Halder

From: Michal Orzel <[email protected]>

Add requirements for dom0less domain creation.

---
Changes from -

v1 - 1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.

2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.

3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.

4. The design requirements will be added later.

v2 - 1. Rephrased the requirements as suggested.

2. Split the product requirements into arm64 specific and common.

3. The arm64 specific requirements have arm64_ prefixed to their tag names.

4. Grant table requirements have been dropped for now.

5. Added a market requirement to denote that Xen can support multiple schedulers.

6. Updated index.rst as we have a new file ie product-reqs/reqs.rst.

V3 - 1. Removed duplicate mention for 'Rationale'.

2. Fixed some of the descriptions as per the review comments.

docs/fusa/reqs/index.rst                   |   1 +
docs/fusa/reqs/market-reqs/reqs.rst        |  31 ++++
docs/fusa/reqs/product-reqs/arm64/reqs.rst | 128 ++++++++++++++++-
docs/fusa/reqs/product-reqs/reqs.rst       | 160 +++++++++++++++++++++
4 files changed, 318 insertions(+), 2 deletions(-)

create mode 100644 docs/fusa/reqs/product-reqs/reqs.rst

docs/fusa/reqs/index.rst +1 -0
index 8a4dae6fb2..1088a51d52 100644
@@ -8,6 +8,7 @@ Requirements documentation
 
   intro
   market-reqs/reqs
+   product-reqs/reqs
   product-reqs/arm64/reqs
   design-reqs/arm64/generic-timer
   design-reqs/arm64/sbsa-uart
docs/fusa/reqs/market-reqs/reqs.rst +0 -0
index f456788d96..39b2714237 100644
@@ -47,3 +47,34 @@ Comments:
 

Needs:
- XenProd

docs/fusa/reqs/market-reqs/reqs.rst Comments: · line 57

Quoted 8 lines
docs/fusa/reqs/market-reqs/reqs.rst +8 -0
+
+Static VM definition
+--------------------
+
+`XenMkt~static_vm_definition~1`
+
+Description:
+Xen shall support assigning peripherals to various domains.

"various" here could be removed or replaced with "a domain" to be coherent with the phrasing after.

Quoted 6 lines
docs/fusa/reqs/market-reqs/reqs.rst +6 -0
+
+Rationale:
+
+Comments:
+Peripheral implies an iomem (input output memory) and/or interrupts.
+

docs/fusa/reqs/market-reqs/reqs.rst Comments: · line 73

Quoted 10 lines
docs/fusa/reqs/market-reqs/reqs.rst +10 -0
+Needs:
+ - XenProd
+
+Multiple schedulers
+-------------------
+
+`XenMkt~multiple_schedulers~1`
+
+Description:
+Xen shall provide different ways of scheduling virtual cpus onto physical cpus.

different here is a bit imprecise.
how about:
Xen shall have configurable scheduling strategies of virtual cpus onto physical cpus.

The rest looks good.

Cheers
Bertrand

#2 lore raw
Quoted 1 line · Bertrand Marquis

Hi Ayan,

Hi Bertrand,

Quoted 68 lines

This is a lot better.
I just have some minor phrasing comments after.

Quoted 64 lines · Ayan Kumar Halder

From: Michal Orzel <[email protected]>

Add requirements for dom0less domain creation.

---
Changes from -

v1 - 1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.

2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.

3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.

4. The design requirements will be added later.

v2 - 1. Rephrased the requirements as suggested.

2. Split the product requirements into arm64 specific and common.

3. The arm64 specific requirements have arm64_ prefixed to their tag names.

4. Grant table requirements have been dropped for now.

5. Added a market requirement to denote that Xen can support multiple schedulers.

6. Updated index.rst as we have a new file ie product-reqs/reqs.rst.

V3 - 1. Removed duplicate mention for 'Rationale'.

2. Fixed some of the descriptions as per the review comments.

docs/fusa/reqs/index.rst                   |   1 +
docs/fusa/reqs/market-reqs/reqs.rst        |  31 ++++
docs/fusa/reqs/product-reqs/arm64/reqs.rst | 128 ++++++++++++++++-
docs/fusa/reqs/product-reqs/reqs.rst       | 160 +++++++++++++++++++++
4 files changed, 318 insertions(+), 2 deletions(-)

create mode 100644 docs/fusa/reqs/product-reqs/reqs.rst

docs/fusa/reqs/index.rst +1 -0
index 8a4dae6fb2..1088a51d52 100644
@@ -8,6 +8,7 @@ Requirements documentation
 
    intro
    market-reqs/reqs
+   product-reqs/reqs
    product-reqs/arm64/reqs
    design-reqs/arm64/generic-timer
    design-reqs/arm64/sbsa-uart
docs/fusa/reqs/market-reqs/reqs.rst +0 -0
index f456788d96..39b2714237 100644
@@ -47,3 +47,34 @@ Comments:
 
Quoted 12 lines

docs/fusa/reqs/market-reqs/reqs.rst Comments: · line 57

Quoted 10 lines

Needs:
- XenProd

docs/fusa/reqs/market-reqs/reqs.rst +8 -0
+
+Static VM definition
+--------------------
+
+`XenMkt~static_vm_definition~1`
+
+Description:
+Xen shall support assigning peripherals to various domains.

"various" here could be removed or replaced with "a domain" to be coherent with the phrasing after.

I agree

Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/market-reqs/reqs.rst +11 -0
+
+Rationale:
+
+Comments:
+Peripheral implies an iomem (input output memory) and/or interrupts.
+
+Needs:
+ - XenProd
+
+Multiple schedulers
+-------------------
Quoted 8 lines

docs/fusa/reqs/market-reqs/reqs.rst Comments: · line 73

Quoted 5 lines
docs/fusa/reqs/market-reqs/reqs.rst +5 -0
+
+`XenMkt~multiple_schedulers~1`
+
+Description:
+Xen shall provide different ways of scheduling virtual cpus onto physical cpus.

different here is a bit imprecise.
how about:
Xen shall have configurable scheduling strategies of virtual cpus onto physical cpus.

looks fine to me.

Are you ok to give your R-b ? Then I can request Michal to fix them on commit.

- Ayan

Quoted 6 lines

The rest looks good.

Cheers
Bertrand

Reviewed-by
#3 lore raw

Hi Ayan,

Quoted 18 lines · Ayan Kumar Halder
Quoted 1 line · Bertrand Marquis

Hi Ayan,

Hi Bertrand,

Quoted 12 lines

This is a lot better.
I just have some minor phrasing comments after.

Quoted 8 lines · Ayan Kumar Halder

From: Michal Orzel <[email protected]>

Add requirements for dom0less domain creation.

With the fixes handled on commit:

Cheers
Bertrand

Quoted 101 lines
Quoted 56 lines
Quoted 56 lines

---
Changes from -

v1 - 1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.

2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.

3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.

4. The design requirements will be added later.

v2 - 1. Rephrased the requirements as suggested.

2. Split the product requirements into arm64 specific and common.

3. The arm64 specific requirements have arm64_ prefixed to their tag names.

4. Grant table requirements have been dropped for now.

5. Added a market requirement to denote that Xen can support multiple schedulers.

6. Updated index.rst as we have a new file ie product-reqs/reqs.rst.

V3 - 1. Removed duplicate mention for 'Rationale'.

2. Fixed some of the descriptions as per the review comments.

docs/fusa/reqs/index.rst                   |   1 +
docs/fusa/reqs/market-reqs/reqs.rst        |  31 ++++
docs/fusa/reqs/product-reqs/arm64/reqs.rst | 128 ++++++++++++++++-
docs/fusa/reqs/product-reqs/reqs.rst       | 160 +++++++++++++++++++++
4 files changed, 318 insertions(+), 2 deletions(-)

create mode 100644 docs/fusa/reqs/product-reqs/reqs.rst

docs/fusa/reqs/index.rst +1 -0
index 8a4dae6fb2..1088a51d52 100644
@@ -8,6 +8,7 @@ Requirements documentation
 
   intro
   market-reqs/reqs
+   product-reqs/reqs
   product-reqs/arm64/reqs
   design-reqs/arm64/generic-timer
   design-reqs/arm64/sbsa-uart
docs/fusa/reqs/market-reqs/reqs.rst +0 -0
index f456788d96..39b2714237 100644
@@ -47,3 +47,34 @@ Comments:
 
Quoted 12 lines

docs/fusa/reqs/market-reqs/reqs.rst Comments: · line 57

Quoted 10 lines

Needs:
- XenProd

docs/fusa/reqs/market-reqs/reqs.rst +8 -0
+
+Static VM definition
+--------------------
+
+`XenMkt~static_vm_definition~1`
+
+Description:
+Xen shall support assigning peripherals to various domains.

"various" here could be removed or replaced with "a domain" to be coherent with the phrasing after.

I agree

Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/market-reqs/reqs.rst +11 -0
+
+Rationale:
+
+Comments:
+Peripheral implies an iomem (input output memory) and/or interrupts.
+
+Needs:
+ - XenProd
+
+Multiple schedulers
+-------------------
Quoted 8 lines

docs/fusa/reqs/market-reqs/reqs.rst Comments: · line 73

Quoted 5 lines
docs/fusa/reqs/market-reqs/reqs.rst +5 -0
+
+`XenMkt~multiple_schedulers~1`
+
+Description:
+Xen shall provide different ways of scheduling virtual cpus onto physical cpus.

different here is a bit imprecise.
how about:
Xen shall have configurable scheduling strategies of virtual cpus onto physical cpus.

looks fine to me.

Are you ok to give your R-b ? Then I can request Michal to fix them on commit.

- Ayan

Quoted 5 lines

The rest looks good.

Cheers
Bertrand