[Xen-devel,10/10,v2] xen/arm: vpl011: Update documentation for vuart console support

Message ID 1493395284-18430-11-git-send-email-bhupinder.thakur@linaro.org
State New
Headers show
Series
  • pl011 emulation support in Xen
Related show

Commit Message

Bhupinder Thakur April 28, 2017, 4:01 p.m.
1. Update documentation for vuart = "pl011" option added.
2. Update documentation about SPI irq reserved for vpl011.

Signed-off-by: Bhupinder Thakur <bhupinder.thakur@linaro.org>
---
 docs/man/xl.cfg.pod.5.in |  8 ++++++++
 docs/misc/console.txt    | 14 +++++++++++++-
 2 files changed, 21 insertions(+), 1 deletion(-)

Comments

Stefano Stabellini April 28, 2017, 10:06 p.m. | #1
On Fri, 28 Apr 2017, Bhupinder Thakur wrote:
> 1. Update documentation for vuart = "pl011" option added.
> 2. Update documentation about SPI irq reserved for vpl011.
> 
> Signed-off-by: Bhupinder Thakur <bhupinder.thakur@linaro.org>
> ---
>  docs/man/xl.cfg.pod.5.in |  8 ++++++++
>  docs/misc/console.txt    | 14 +++++++++++++-
>  2 files changed, 21 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
> index 13167ff..44118a8 100644
> --- a/docs/man/xl.cfg.pod.5.in
> +++ b/docs/man/xl.cfg.pod.5.in
> @@ -1085,6 +1085,14 @@ Allow a guest to access specific physical IRQs.
>  It is recommended to use this option only for trusted VMs under
>  administrator control.
>  
> +If vuart console is enabled then irq 32 is reserved for vuart. By default
> +vuart console is disabled. If user specifies the following option in
> +the guest config file then vuart console is enabled.

Please rewrite this as:

  If the virtual uart is enabled then irq 32 is reserved for it. By
  default, it is disabled. If the user specifies the following option in
  the VM config file then the vuart gets enabled. Today, only the
  "pl011" model is supported.


> +vuart = "pl011"
> +
> +vuart console is currently enabled only for ARM64.
                              ^ available


>  =item B<max_event_channels=N>
>  
>  Limit the guest to using at most N event channels (PV interrupts).
> diff --git a/docs/misc/console.txt b/docs/misc/console.txt
> index 16da805..2455fc7 100644
> --- a/docs/misc/console.txt
> +++ b/docs/misc/console.txt
> @@ -19,7 +19,19 @@ The first PV console path in xenstore remains:
>  
>  /local/domain/$DOMID/console
>  
> -the other PV consoles follow the conventional xenstore device path and
> +The vuart console path in xenstore is defined as:
> +
> +/local/domain/$DOMID/console/vuart/0
> +
> +The vuart console provides access to pl011 UART on ARM64 systems. To
                                     ^ to a virtual pl011 UUART

> +enable vuart the following line has to be added the guest configuration
> +file:
> +
> +vuart = "pl011"
> +
> +Also the console should be set to "ttyAMA0" instead of "hvc0".

ttyAMA0 and hvc0 are Linuxims. Please rewrite as follow:

  In Linux you can select the virtual pl011 uart by using the "ttyAMA0"
  console instead of "hvc0".


> +The other PV consoles follow the conventional xenstore device path and
>  live in:
>  
>  /local/domain/$DOMID/device/console/$DEVID.
> -- 
> 2.7.4
>

Patch hide | download patch | download mbox

diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index 13167ff..44118a8 100644
--- a/docs/man/xl.cfg.pod.5.in
+++ b/docs/man/xl.cfg.pod.5.in
@@ -1085,6 +1085,14 @@  Allow a guest to access specific physical IRQs.
 It is recommended to use this option only for trusted VMs under
 administrator control.
 
+If vuart console is enabled then irq 32 is reserved for vuart. By default
+vuart console is disabled. If user specifies the following option in
+the guest config file then vuart console is enabled.
+
+vuart = "pl011"
+
+vuart console is currently enabled only for ARM64.
+
 =item B<max_event_channels=N>
 
 Limit the guest to using at most N event channels (PV interrupts).
diff --git a/docs/misc/console.txt b/docs/misc/console.txt
index 16da805..2455fc7 100644
--- a/docs/misc/console.txt
+++ b/docs/misc/console.txt
@@ -19,7 +19,19 @@  The first PV console path in xenstore remains:
 
 /local/domain/$DOMID/console
 
-the other PV consoles follow the conventional xenstore device path and
+The vuart console path in xenstore is defined as:
+
+/local/domain/$DOMID/console/vuart/0
+
+The vuart console provides access to pl011 UART on ARM64 systems. To
+enable vuart the following line has to be added the guest configuration
+file:
+
+vuart = "pl011"
+
+Also the console should be set to "ttyAMA0" instead of "hvc0".
+
+The other PV consoles follow the conventional xenstore device path and
 live in:
 
 /local/domain/$DOMID/device/console/$DEVID.