[Xen-devel] xen/docs: arm: Update dom0less binding and example

Message ID 20190813213237.4819-1-julien.grall@arm.com
State New
Headers show
Series
  • [Xen-devel] xen/docs: arm: Update dom0less binding and example
Related show

Commit Message

Julien Grall Aug. 13, 2019, 9:32 p.m.
The binding for the dom0less module does not match Xen implementation.
Any module should contain the compatible "multiboot,module" to be
recognized.

This was clearly an oversight as other examples with Xen code base
provide the compatible "multiboot,module".

So fix the binding and the example associated to it.

Signed-off-by: Julien Grall <julien.grall@arm.com>

---

Cc: viktor_mitin@epam.com

    We probably want to consolidate all the dom0less documentation in
    one place rather than having to fix documation issues in a multiple
    places one by one.
---
 docs/misc/arm/device-tree/booting.txt | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Julien Grall Oct. 2, 2019, 5:46 p.m. | #1
Gentle ping.

On 8/13/19 10:32 PM, Julien Grall wrote:
> The binding for the dom0less module does not match Xen implementation.
> Any module should contain the compatible "multiboot,module" to be
> recognized.
> 
> This was clearly an oversight as other examples with Xen code base
> provide the compatible "multiboot,module".
> 
> So fix the binding and the example associated to it.
> 
> Signed-off-by: Julien Grall <julien.grall@arm.com>
> 
> ---
> 
> Cc: viktor_mitin@epam.com
> 
>      We probably want to consolidate all the dom0less documentation in
>      one place rather than having to fix documation issues in a multiple
>      places one by one.
> ---
>   docs/misc/arm/device-tree/booting.txt | 12 ++++++------
>   1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
> index 317a9e962a..0fafa01b5d 100644
> --- a/docs/misc/arm/device-tree/booting.txt
> +++ b/docs/misc/arm/device-tree/booting.txt
> @@ -160,7 +160,7 @@ The kernel sub-node has the following properties:
>   
>   - compatible
>   
> -    "multiboot,kernel"
> +    "multiboot,kernel", "multiboot,module"
>   
>   - reg
>   
> @@ -175,7 +175,7 @@ The ramdisk sub-node has the following properties:
>   
>   - compatible
>   
> -    "multiboot,ramdisk"
> +    "multiboot,ramdisk", "multiboot,module"
>   
>   - reg
>   
> @@ -196,13 +196,13 @@ chosen {
>           vpl011;
>   
>           module@0x4a000000 {
> -            compatible = "multiboot,kernel";
> +            compatible = "multiboot,kernel", "multiboot,module";
>               reg = <0x0 0x4a000000 0xffffff>;
>               bootargs = "console=ttyAMA0 init=/bin/sh";
>           };
>   
>           module@0x4b000000 {
> -            compatible = "multiboot,ramdisk";
> +            compatible = "multiboot,ramdisk", "multiboot,module";
>               reg = <0x0 0x4b000000 0xffffff>;
>           };
>       };
> @@ -215,13 +215,13 @@ chosen {
>           cpus = <1>;
>   
>           module@0x4c000000 {
> -            compatible = "multiboot,kernel";
> +            compatible = "multiboot,kernel", "multiboot,module";
>               reg = <0x0 0x4c000000 0xffffff>;
>               bootargs = "console=ttyAMA0 init=/bin/sh";
>           };
>   
>           module@0x4d000000 {
> -            compatible = "multiboot,ramdisk";
> +            compatible = "multiboot,ramdisk", "multiboot,module";
>               reg = <0x0 0x4d000000 0xffffff>;
>           };
>       };
>
Stefano Stabellini Oct. 2, 2019, 10:27 p.m. | #2
On Tue, 13 Aug 2019, Julien Grall wrote:
> The binding for the dom0less module does not match Xen implementation.
> Any module should contain the compatible "multiboot,module" to be
> recognized.
> 
> This was clearly an oversight as other examples with Xen code base
> provide the compatible "multiboot,module".
> 
> So fix the binding and the example associated to it.
> 
> Signed-off-by: Julien Grall <julien.grall@arm.com>

Yes!

Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>

> ---
> 
> Cc: viktor_mitin@epam.com
> 
>     We probably want to consolidate all the dom0less documentation in
>     one place rather than having to fix documation issues in a multiple
>     places one by one.
> ---
>  docs/misc/arm/device-tree/booting.txt | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
> index 317a9e962a..0fafa01b5d 100644
> --- a/docs/misc/arm/device-tree/booting.txt
> +++ b/docs/misc/arm/device-tree/booting.txt
> @@ -160,7 +160,7 @@ The kernel sub-node has the following properties:
>  
>  - compatible
>  
> -    "multiboot,kernel"
> +    "multiboot,kernel", "multiboot,module"
>  
>  - reg
>  
> @@ -175,7 +175,7 @@ The ramdisk sub-node has the following properties:
>  
>  - compatible
>  
> -    "multiboot,ramdisk"
> +    "multiboot,ramdisk", "multiboot,module"
>  
>  - reg
>  
> @@ -196,13 +196,13 @@ chosen {
>          vpl011;
>  
>          module@0x4a000000 {
> -            compatible = "multiboot,kernel";
> +            compatible = "multiboot,kernel", "multiboot,module";
>              reg = <0x0 0x4a000000 0xffffff>;
>              bootargs = "console=ttyAMA0 init=/bin/sh";
>          };
>  
>          module@0x4b000000 {
> -            compatible = "multiboot,ramdisk";
> +            compatible = "multiboot,ramdisk", "multiboot,module";
>              reg = <0x0 0x4b000000 0xffffff>;
>          };
>      };
> @@ -215,13 +215,13 @@ chosen {
>          cpus = <1>;
>  
>          module@0x4c000000 {
> -            compatible = "multiboot,kernel";
> +            compatible = "multiboot,kernel", "multiboot,module";
>              reg = <0x0 0x4c000000 0xffffff>;
>              bootargs = "console=ttyAMA0 init=/bin/sh";
>          };
>  
>          module@0x4d000000 {
> -            compatible = "multiboot,ramdisk";
> +            compatible = "multiboot,ramdisk", "multiboot,module";
>              reg = <0x0 0x4d000000 0xffffff>;
>          };
>      };
> -- 
> 2.11.0
>
Julien Grall Oct. 10, 2019, 2:45 p.m. | #3
Hi,

Juergen, would you be happy if this patch is committed for Xen 4.13?

Cheers,

On 02/10/2019 23:27, Stefano Stabellini wrote:
> On Tue, 13 Aug 2019, Julien Grall wrote:
>> The binding for the dom0less module does not match Xen implementation.
>> Any module should contain the compatible "multiboot,module" to be
>> recognized.
>>
>> This was clearly an oversight as other examples with Xen code base
>> provide the compatible "multiboot,module".
>>
>> So fix the binding and the example associated to it.
>>
>> Signed-off-by: Julien Grall <julien.grall@arm.com>
> 
> Yes!
> 
> Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
> 
>> ---
>>
>> Cc: viktor_mitin@epam.com
>>
>>      We probably want to consolidate all the dom0less documentation in
>>      one place rather than having to fix documation issues in a multiple
>>      places one by one.
>> ---
>>   docs/misc/arm/device-tree/booting.txt | 12 ++++++------
>>   1 file changed, 6 insertions(+), 6 deletions(-)
>>
>> diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
>> index 317a9e962a..0fafa01b5d 100644
>> --- a/docs/misc/arm/device-tree/booting.txt
>> +++ b/docs/misc/arm/device-tree/booting.txt
>> @@ -160,7 +160,7 @@ The kernel sub-node has the following properties:
>>   
>>   - compatible
>>   
>> -    "multiboot,kernel"
>> +    "multiboot,kernel", "multiboot,module"
>>   
>>   - reg
>>   
>> @@ -175,7 +175,7 @@ The ramdisk sub-node has the following properties:
>>   
>>   - compatible
>>   
>> -    "multiboot,ramdisk"
>> +    "multiboot,ramdisk", "multiboot,module"
>>   
>>   - reg
>>   
>> @@ -196,13 +196,13 @@ chosen {
>>           vpl011;
>>   
>>           module@0x4a000000 {
>> -            compatible = "multiboot,kernel";
>> +            compatible = "multiboot,kernel", "multiboot,module";
>>               reg = <0x0 0x4a000000 0xffffff>;
>>               bootargs = "console=ttyAMA0 init=/bin/sh";
>>           };
>>   
>>           module@0x4b000000 {
>> -            compatible = "multiboot,ramdisk";
>> +            compatible = "multiboot,ramdisk", "multiboot,module";
>>               reg = <0x0 0x4b000000 0xffffff>;
>>           };
>>       };
>> @@ -215,13 +215,13 @@ chosen {
>>           cpus = <1>;
>>   
>>           module@0x4c000000 {
>> -            compatible = "multiboot,kernel";
>> +            compatible = "multiboot,kernel", "multiboot,module";
>>               reg = <0x0 0x4c000000 0xffffff>;
>>               bootargs = "console=ttyAMA0 init=/bin/sh";
>>           };
>>   
>>           module@0x4d000000 {
>> -            compatible = "multiboot,ramdisk";
>> +            compatible = "multiboot,ramdisk", "multiboot,module";
>>               reg = <0x0 0x4d000000 0xffffff>;
>>           };
>>       };
>> -- 
>> 2.11.0
>>
Juergen Gross Oct. 10, 2019, 2:47 p.m. | #4
On 10.10.19 16:45, Julien Grall wrote:
> Hi,
> 
> Juergen, would you be happy if this patch is committed for Xen 4.13?

Yes, you can add my:

Release-acked-by: Juergen Gross <jgross@suse.com>


Juergen

> 
> Cheers,
> 
> On 02/10/2019 23:27, Stefano Stabellini wrote:
>> On Tue, 13 Aug 2019, Julien Grall wrote:
>>> The binding for the dom0less module does not match Xen implementation.
>>> Any module should contain the compatible "multiboot,module" to be
>>> recognized.
>>>
>>> This was clearly an oversight as other examples with Xen code base
>>> provide the compatible "multiboot,module".
>>>
>>> So fix the binding and the example associated to it.
>>>
>>> Signed-off-by: Julien Grall <julien.grall@arm.com>
>>
>> Yes!
>>
>> Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
>>
>>> ---
>>>
>>> Cc: viktor_mitin@epam.com
>>>
>>>      We probably want to consolidate all the dom0less documentation in
>>>      one place rather than having to fix documation issues in a multiple
>>>      places one by one.
>>> ---
>>>   docs/misc/arm/device-tree/booting.txt | 12 ++++++------
>>>   1 file changed, 6 insertions(+), 6 deletions(-)
>>>
>>> diff --git a/docs/misc/arm/device-tree/booting.txt 
>>> b/docs/misc/arm/device-tree/booting.txt
>>> index 317a9e962a..0fafa01b5d 100644
>>> --- a/docs/misc/arm/device-tree/booting.txt
>>> +++ b/docs/misc/arm/device-tree/booting.txt
>>> @@ -160,7 +160,7 @@ The kernel sub-node has the following properties:
>>>   - compatible
>>> -    "multiboot,kernel"
>>> +    "multiboot,kernel", "multiboot,module"
>>>   - reg
>>> @@ -175,7 +175,7 @@ The ramdisk sub-node has the following properties:
>>>   - compatible
>>> -    "multiboot,ramdisk"
>>> +    "multiboot,ramdisk", "multiboot,module"
>>>   - reg
>>> @@ -196,13 +196,13 @@ chosen {
>>>           vpl011;
>>>           module@0x4a000000 {
>>> -            compatible = "multiboot,kernel";
>>> +            compatible = "multiboot,kernel", "multiboot,module";
>>>               reg = <0x0 0x4a000000 0xffffff>;
>>>               bootargs = "console=ttyAMA0 init=/bin/sh";
>>>           };
>>>           module@0x4b000000 {
>>> -            compatible = "multiboot,ramdisk";
>>> +            compatible = "multiboot,ramdisk", "multiboot,module";
>>>               reg = <0x0 0x4b000000 0xffffff>;
>>>           };
>>>       };
>>> @@ -215,13 +215,13 @@ chosen {
>>>           cpus = <1>;
>>>           module@0x4c000000 {
>>> -            compatible = "multiboot,kernel";
>>> +            compatible = "multiboot,kernel", "multiboot,module";
>>>               reg = <0x0 0x4c000000 0xffffff>;
>>>               bootargs = "console=ttyAMA0 init=/bin/sh";
>>>           };
>>>           module@0x4d000000 {
>>> -            compatible = "multiboot,ramdisk";
>>> +            compatible = "multiboot,ramdisk", "multiboot,module";
>>>               reg = <0x0 0x4d000000 0xffffff>;
>>>           };
>>>       };
>>> -- 
>>> 2.11.0
>>>
>

Patch

diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
index 317a9e962a..0fafa01b5d 100644
--- a/docs/misc/arm/device-tree/booting.txt
+++ b/docs/misc/arm/device-tree/booting.txt
@@ -160,7 +160,7 @@  The kernel sub-node has the following properties:
 
 - compatible
 
-    "multiboot,kernel"
+    "multiboot,kernel", "multiboot,module"
 
 - reg
 
@@ -175,7 +175,7 @@  The ramdisk sub-node has the following properties:
 
 - compatible
 
-    "multiboot,ramdisk"
+    "multiboot,ramdisk", "multiboot,module"
 
 - reg
 
@@ -196,13 +196,13 @@  chosen {
         vpl011;
 
         module@0x4a000000 {
-            compatible = "multiboot,kernel";
+            compatible = "multiboot,kernel", "multiboot,module";
             reg = <0x0 0x4a000000 0xffffff>;
             bootargs = "console=ttyAMA0 init=/bin/sh";
         };
 
         module@0x4b000000 {
-            compatible = "multiboot,ramdisk";
+            compatible = "multiboot,ramdisk", "multiboot,module";
             reg = <0x0 0x4b000000 0xffffff>;
         };
     };
@@ -215,13 +215,13 @@  chosen {
         cpus = <1>;
 
         module@0x4c000000 {
-            compatible = "multiboot,kernel";
+            compatible = "multiboot,kernel", "multiboot,module";
             reg = <0x0 0x4c000000 0xffffff>;
             bootargs = "console=ttyAMA0 init=/bin/sh";
         };
 
         module@0x4d000000 {
-            compatible = "multiboot,ramdisk";
+            compatible = "multiboot,ramdisk", "multiboot,module";
             reg = <0x0 0x4d000000 0xffffff>;
         };
     };