[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen master] cmdline: Document console=dtuart option



commit 422484e55cc2856a2f46e3e025115c678c388414
Author:     Michal Orzel <michal.orzel@xxxxxxx>
AuthorDate: Wed Sep 2 09:36:04 2026 +0200
Commit:     Michal Orzel <michal.orzel@xxxxxxx>
CommitDate: Tue Sep 15 17:13:02 2026 +0200

    cmdline: Document console=dtuart option
    
    Document the default console= option on Arm and RISC-V that is
    "dtuart" indicating a generic UART parsed from a device tree or
    ACPI SPCR table. This serial utilizes SERHND_DTUART handle.
    
    Take the opportunity to:
     - fix documented x86 default to vga to match OPT_CONSOLE_STR,
     - mark dtuart option as available on RISC-V,
     - document fall back to /chosen/stdout-path.
    
    Signed-off-by: Michal Orzel <michal.orzel@xxxxxxx>
    Acked-by: Jan Beulich <jbeulich@xxxxxxxx>
---
 docs/misc/xen-command-line.pandoc | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/docs/misc/xen-command-line.pandoc 
b/docs/misc/xen-command-line.pandoc
index 95cc3312f1..b2c94ae56d 100644
--- a/docs/misc/xen-command-line.pandoc
+++ b/docs/misc/xen-command-line.pandoc
@@ -438,9 +438,10 @@ The following are examples of correct specifications:
 Specify the size of the console ring buffer.
 
 ### console
-> `= List of [ vga | com1[H,L] | com2[H,L] | pv | dbgp | ehci | xhci | none ]`
+> `= List of [ vga | com1[H,L] | com2[H,L] | pv | dbgp | ehci | xhci | dtuart 
| none ]`
 
-> Default: `console=com1,vga`
+> Default (x86): `console=vga`
+> Default (Arm, RISC-V): `console=dtuart`
 
 Specify which console(s) Xen should use.
 
@@ -462,6 +463,10 @@ compiled with `CONFIG_XEN_GUEST` enabled.
 
 `xhci` indicates that Xen should use a USB3 debug port.
 
+`dtuart` indicates that Xen should use a generic UART (parsed from a device
+tree or ACPI SPCR table). Only available if Xen was compiled with
+`CONFIG_GENERIC_UART_INIT` enabled.
+
 `none` indicates that Xen should not use a console.  This option only
 makes sense on its own.
 
@@ -1077,13 +1082,15 @@ affinities to prefer but be not limited to the 
specified node(s).
 
 Pin dom0 vcpus to their respective pcpus
 
-### dtuart (ARM)
+### dtuart (ARM, RISC-V)
 > `= path [:options]`
 
 > Default: `""`
 
 Specify the full path in the device tree for the UART.  If the path doesn't
 start with `/`, it is assumed to be an alias.  The options are device specific.
+If the option is left empty, Xen will try to probe the device from the DT
+property /chosen/stdout-path if present.
 
 ### e820-mtrr-clip (x86)
 > `= <boolean>`
--
generated by git-patchbot for /home/xen/git/xen.git#master



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.