Re: [PATCH v1 07/18] docs: update hyperlaunch device tree documentation

["Daniel P. Smith" <dpsmith@xxxxxxxxxxxxxxxxxxxx>]

On 7/18/22 09:57, Smith, Jackson wrote:
> Hi Daniel,
> 
>> -----Original Message-----
>> Subject: [PATCH v1 07/18] docs: update hyperlaunch device tree
>> documentation
> 
> 
>> diff --git a/docs/designs/launch/hyperlaunch-devicetree.rst
>> b/docs/designs/launch/hyperlaunch-devicetree.rst
>> index b49c98cfbd..ae1a786d0b 100644
>> --- a/docs/designs/launch/hyperlaunch-devicetree.rst
>> +++ b/docs/designs/launch/hyperlaunch-devicetree.rst
>> @@ -13,12 +13,268 @@ difference is the introduction of the ``hypervisor``
> 
>> +
>> +The Hypervisor node
>> +-------------------
>> +
>> +The ``hypervisor`` node is a top level container for the domains that
>> +will be
>> built
>> +by hypervisor on start up. The node will be named ``hypervisor``  with
>> +a
>> ``compatible``
>> +property to identify which hypervisors the configuration is intended.
> ^^^ Should there be a note here that hypervisor node also needs a compatible 
> "xen,<arch>"?

Ack.

>> +The
>> hypervisor
>> +node will consist of one or more config nodes and one or more domain
>> nodes.
>> +
>> +Properties
>> +""""""""""
>> +
>> +compatible
>> +  Identifies which hypervisors the configuration is compatible. Required.
>> +
>> +  Format: "hypervisor,<hypervisor name>", e.g "hypervisor,xen"
> ^^^ Same here: compatible "<hypervisor name>,<arch>"?

Ack.

>>  Example Configuration
>>  ---------------------
>> +
>> +Multiboot x86 Configuration Dom0-only:
>> +""""""""""""""""""""""""""""""""""""""
>> +The following dts file can be provided to the Device Tree compiler,
>> +``dtc``,
>> to
>> +produce a dtb file.
>> +::
>> +
>> +  /dts-v1/;
>> +
>> +  / {
>> +      chosen {
>> +          hypervisor {
>> +              compatible = "hypervisor,xen";
> ^^^^^^^^  compatible = "hypervisor,xen", "xen,x86";

Ack.

>> +
>> +              dom0 {
>> +                  compatible = "xen,domain";
>> +
>> +                  domid = <0>;
>> +
>> +                  permissions = <3>;
>> +                  functions = <0xC000000F>;
>> +                  mode = <5>;
>> +
>> +                  domain-uuid = [B3 FB 98 FB 8F 9F 67 A3 8A 6E 62 5A 09
>> + 13 F0
>> 8C];
>> +
>> +                  cpus = <1>;
>> +                  memory = <0x0 0x20000000>;
> ^^^^^^^^^^ memory = "2048M";
> Needs to be updated to new format for mem.

Ack.

>> +
>> +                  kernel {
>> +                      compatible = "module,kernel", "module,index";
>> +                      module-index = <1>;
>> +                  };
>> +              };
>> +
>> +          };
>> +      };
>> +  };
>> +
> 
> Similar adjustments are needed for the rest of the examples I believe.
> 
> Also, two typos:
> Line 287 is missing a line ending semi-colon.
> Line 82 has a double space between 'node' and 'may'.

Ack.

v/r,
dps