diff mbox

[v2] docs/arm64: clarify the documention for loading XSM support

Message ID 1461602337-29568-1-git-send-email-ian.jackson@eu.citrix.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ian Jackson April 25, 2016, 4:38 p.m. UTC
From: Fu Wei <fu.wei@linaro.org>

Improve the clarity of the wording introduced in 67831c4c
"docs/arm64: update the documentation for loading XSM support"

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
CC: Fu Wei <fu.wei@linaro.org>
CC: Julien Grall <julien.grall@arm.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
---
v2: Tabify (to conform to the rest of the file)
---
 docs/misc/arm/device-tree/booting.txt |   29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

Comments

Julien Grall April 25, 2016, 4:45 p.m. UTC | #1
Hi Ian,

On 25/04/16 17:38, Ian Jackson wrote:
> From: Fu Wei <fu.wei@linaro.org>
>
> Improve the clarity of the wording introduced in 67831c4c
> "docs/arm64: update the documentation for loading XSM support"
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> CC: Fu Wei <fu.wei@linaro.org>
> CC: Julien Grall <julien.grall@arm.com>

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

Regards,

> CC: Stefano Stabellini <sstabellini@kernel.org>
> ---
> v2: Tabify (to conform to the rest of the file)
> ---
>   docs/misc/arm/device-tree/booting.txt |   29 +++++++++++++++++------------
>   1 file changed, 17 insertions(+), 12 deletions(-)
>
> diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
> index cae46eda..ce2d0dc 100644
> --- a/docs/misc/arm/device-tree/booting.txt
> +++ b/docs/misc/arm/device-tree/booting.txt
> @@ -26,19 +26,24 @@ Each node contains the following properties:
>   	Xen will assume that the first module which lacks a more
>   	specific compatible string is a "multiboot,kernel".
>
> -	Xen will check all the modules for the XSM Magic from the second
> -	module that lacks a specific compatible string. According to the
> -	result of the detection:
> -	- if it's an XSM, Xen will assume its compatible string is
> +	Xen will examine each module, starting from the second
> +	module that lacks a specific compatible string.  Xen will
> +	check each such module for the XSM Magic number:
> +
> +	- For a module which has the XSM Magic number: it will be
> +	  treated by Xen as if its compatible string was
>   	  "xen,xsm-policy";
> -	- if it's not an XSM, for the second module that lacks a specific
> -	  compatible string, Xen will assume its compatible string is
> -	  "multiboot,ramdisk"; the third and subsequent modules that
> -	  lack a specific compatible string will not receive any special
> -	  treatment.
> -	This means that if the ramdisk module is present and does not have
> -	the compatible string "multiboot,ramdisk", then it must always be
> -	the second module.
> +
> +	- For a module which does not have the XSM Magic: the second
> +	  module lacking a compatible string will be treated by Xen as
> +	  if its compatible string was "multiboot,ramdisk"; for the
> +	  third and subsequent modules which lack a specific
> +	  compatible string, Xen will not apply any special treatment.
> +
> +	This means if the ramdisk module is present and does not have the
> +	compatible string "multiboot,ramdisk", then it must always be the
> +	second module.
> +
>   	Note: This XSM Magic detection behavior was introduced by Xen 4.7.
>   	Xen 4.6 (and downwards) still requires the XSM module to have the
>   	compatible string "xen,xsm-policy".
>
Wei Liu April 25, 2016, 4:49 p.m. UTC | #2
On Mon, Apr 25, 2016 at 05:45:58PM +0100, Julien Grall wrote:
> Hi Ian,
> 
> On 25/04/16 17:38, Ian Jackson wrote:
> >From: Fu Wei <fu.wei@linaro.org>
> >
> >Improve the clarity of the wording introduced in 67831c4c
> >"docs/arm64: update the documentation for loading XSM support"
> >
> >Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> >CC: Fu Wei <fu.wei@linaro.org>
> >CC: Julien Grall <julien.grall@arm.com>
> 
> Reviewed-by: Julien Grall <julien.grall@arm.com>
> 

Queued. Thanks.
diff mbox

Patch

diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
index cae46eda..ce2d0dc 100644
--- a/docs/misc/arm/device-tree/booting.txt
+++ b/docs/misc/arm/device-tree/booting.txt
@@ -26,19 +26,24 @@  Each node contains the following properties:
 	Xen will assume that the first module which lacks a more
 	specific compatible string is a "multiboot,kernel".
 
-	Xen will check all the modules for the XSM Magic from the second
-	module that lacks a specific compatible string. According to the
-	result of the detection:
-	- if it's an XSM, Xen will assume its compatible string is
+	Xen will examine each module, starting from the second
+	module that lacks a specific compatible string.  Xen will
+	check each such module for the XSM Magic number:
+
+	- For a module which has the XSM Magic number: it will be
+	  treated by Xen as if its compatible string was
 	  "xen,xsm-policy";
-	- if it's not an XSM, for the second module that lacks a specific
-	  compatible string, Xen will assume its compatible string is
-	  "multiboot,ramdisk"; the third and subsequent modules that
-	  lack a specific compatible string will not receive any special
-	  treatment.
-	This means that if the ramdisk module is present and does not have
-	the compatible string "multiboot,ramdisk", then it must always be
-	the second module.
+
+	- For a module which does not have the XSM Magic: the second
+	  module lacking a compatible string will be treated by Xen as
+	  if its compatible string was "multiboot,ramdisk"; for the
+	  third and subsequent modules which lack a specific
+	  compatible string, Xen will not apply any special treatment.
+
+	This means if the ramdisk module is present and does not have the
+	compatible string "multiboot,ramdisk", then it must always be the
+	second module.
+
 	Note: This XSM Magic detection behavior was introduced by Xen 4.7.
 	Xen 4.6 (and downwards) still requires the XSM module to have the
 	compatible string "xen,xsm-policy".