Re: [PATCH 12/12 v3] xen/arm: vpl011: Update documentation for vuart console support

[Stefano Stabellini <sstabellini@kernel.org>]

On Wed, 10 May 2017, Bhupinder Thakur wrote:
> 1. Update documentation for a new vuart option added.
> 2. Update documentation about SPI irq reserved for vpl011.
> 
> Signed-off-by: Bhupinder Thakur <bhupinder.thakur@linaro.org>
> ---
> 
> Changes since v2:
> 
> - Incorporated the review comments on the documentation.
> 
>  docs/man/xl.cfg.pod.5.in |  9 +++++++++
>  docs/misc/console.txt    | 31 ++++++++++++++++++++++++++-----
>  2 files changed, 35 insertions(+), 5 deletions(-)
> 
> diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
> index 13167ff..3397cda 100644
> --- a/docs/man/xl.cfg.pod.5.in
> +++ b/docs/man/xl.cfg.pod.5.in
> @@ -1085,6 +1085,15 @@ Allow a guest to access specific physical IRQs.
>  It is recommended to use this option only for trusted VMs under
>  administrator control.
>  
> +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"
> +
> +Currently vuart console is available 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..9eccfa1 100644
> --- a/docs/misc/console.txt
> +++ b/docs/misc/console.txt
> @@ -19,7 +19,20 @@ The first PV console path in xenstore remains:
>  
>  /local/domain/$DOMID/console
>  
> -the other PV consoles follow the conventional xenstore device path and
> +The virtual UART console path in xenstore is defined as:
> +
> +/local/domain/$DOMID/vuart/0
> +
> +The vuart console provides access to a virtual pl011 UART on ARM64 systems. To
> +enable vuart the following line has to be added to the guest configuration
> +file:
> +
> +vuart = "pl011"
> +
> +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.
> @@ -61,6 +74,14 @@ output = pty
>  The backend will write the pty device name to the "tty" node in the
>  console frontend.
>  
> +For the PV console the tty node is added at
> +
> +/local/domain/$DOMID/console/tty
> +
> +For the virtual UART console the tty node is added at
> +
> +/local/domain/$DOMID/vuart/0/tty
> +
>  If the toolstack wants a listening Unix domain socket to be created at path
>  <path>, a connection accepted and data proxied to the console, it will write:
>  
> @@ -79,8 +100,8 @@ For example:
>  ioemu
>  
>  The supported values are only xenconsoled or ioemu; xenconsoled has
> -several limitations: it can only be used for the first PV console and it
> -can only connect to a pty.
> +several limitations: it can only be used for the first PV or virtual UART console
> +and it can only connect to a pty.
>  
>  Emulated serials are provided by qemu-dm only to hvm guests; the number
>  of emulated serials depends on how many "-serial" command line options
> @@ -90,8 +111,8 @@ xenstore in the following path:
>  
>  /local/domain/$DOMID/serial/$SERIAL_NUM/tty
>  
> -xenconsole is the tool to connect to a PV console or an emulated serial
> -that has a pty as output. Xenconsole takes a domid as parameter plus an
> +xenconsole is the tool to connect to a PV or virtual UART console or an
> +emulated serial that has a pty as output. Xenconsole takes a domid as parameter plus an

This line is too long. Aside from that:

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


>  optional console type (pv for PV consoles or serial for emulated
>  serials) and console number. Depending on the type and console
>  number, xenconsole will look for the tty node in different xenstore
> -- 
> 2.7.4
> 
> 
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xen.org
> https://lists.xen.org/xen-devel
> 

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel