Author: Bhupinder Thakur <[hidden email]>
AuthorDate: Wed Sep 27 11:43:34 2017 +0530
Commit: Stefano Stabellini <[hidden email]>
CommitDate: Tue Oct 3 15:23:38 2017 -0700
xen/arm: vpl011: Update documentation for vuart console support
1. Update documentation for a new vuart option added.
2. Update documentation about SPI irq reserved for vuart.
Signed-off-by: Bhupinder Thakur <[hidden email]>
Reviewed-by: Stefano Stabellini <[hidden email]>
Acked-by: Wei Liu <[hidden email]>
docs/man/xl.cfg.pod.5.in | 12 ++++++++++++
docs/misc/console.txt | 44 +++++++++++++++++++++++++++++++++-----------
2 files changed, 45 insertions(+), 11 deletions(-)
diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index 6b4db7d..bac335e 100644
@@ -1205,6 +1205,9 @@ Allow a guest to access specific physical IRQs.
It is recommended to only use this option for trusted VMs under
+If vuart console is enabled then irq 32 is reserved for it. See
+L</vuart="uart"> to know how to enable vuart console.
Limit the guest to using at most N event channels (PV interrupts).
@@ -2425,6 +2428,15 @@ the domain was created.
This requires hardware compatibility with the requested version, either
natively or via hardware backwards compatibility support.
+To enable vuart console, user must specify the following option in the
+VM config file:
+vuart = "sbsa_uart"
+Currently, only the "sbsa_uart" model is supported for ARM.
diff --git a/docs/misc/console.txt b/docs/misc/console.txt
index 16da805..4e180f8 100644
@@ -19,7 +19,20 @@ The first PV console path in xenstore remains:
-the other PV consoles follow the conventional xenstore device path and
+The virtual UART console path in xenstore is defined as:
+The vuart console provides access to a virtual SBSA UART on ARM systems.
+To enable vuart the following line has to be added to the guest configuration
+vuart = "sbsa_uart"
+In Linux you can select the virtual SBSA UART by using the "ttyAMA0"
+console instead of "hvc0".
+The other PV consoles follow the conventional xenstore device path and
@@ -61,6 +74,14 @@ output = pty
The backend will write the pty device name to the "tty" node in the
+For the PV console the tty node is added at
+For the virtual UART console the tty node is added at
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:
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,14 +111,15 @@ xenstore in the following path:
-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
-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
-paths, as described above. If the user doesn't specify the console type
-xenconsole will try to guess: if the guest is a pv guest it defaults to
-PV console, if the guest is an hvm guest it defaults to emulated serial.
+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 optional console type (pv for PV consoles, vuart for
+virtual UART 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 paths, as described above. If the user doesn't
+specify the console type xenconsole will try to guess: if the guest is a pv
+guest it defaults to PV console, if the guest is an hvm guest it defaults to
By default xl creates a pv console for hvm guests, plus an emulated
serial if the user specified 'serial = "pty"' in the VM config file.
generated by git-patchbot for /home/xen/git/xen.git#master
Xen-changelog mailing list
|Free forum by Nabble||Edit this page|