github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-04-27 19:30:48 +00:00
Code Issues Projects Releases Wiki Activity

doc: update doc for vUART to hypervisor console switch key

Browse Source 
Things changed since following commit
(c623e1112 debug: vuart: add guest break key support).

Tracked-On: #8583
Signed-off-by: Qiang Zhang <qiang4.zhang@intel.com>
This commit is contained in:
Qiang Zhang 2024-06-11 13:12:35 +08:00 committed by wenlingz
parent cc0364f1f7
commit 29137b9e9c
3 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/developer-guides/hld/hv-console.rst
View File

@ -70,10 +70,24 @@ Specifically:
the hypervisor shell. Inputs to the physical UART will be the hypervisor shell. Inputs to the physical UART will be
redirected to the vUART starting from the next timer event. redirected to the vUART starting from the next timer event.
- The vUART is deactivated after a :kbd:`Ctrl` + :kbd:`Space` hotkey is received - The vUART enters escaping mode after a BREAK character is received from
from the physical UART. Inputs to the physical UART will be the physical UART. When in escaping mode, next received character will
handled by the hypervisor shell starting from the next timer be a command. After processing this command, the vUART exits the escaping
event. mode. So far, following escaping commands are supported:
- BREAK charater. If user sends break charater again in escaping mode,
one break charater will be sent to vUART.
- Character "e". This will deactive vUART. Inputs to the physical UART will
be handled by the hypervisor shell starting from the next timer event.
Other characters are not supported. The physical UART will prompt out an
"Unknown escaping key" message and the active vUART exits escaping mode.
Note that the BREAK character is a control character and different serial
terminals have different ways to send it, for example, `<Ctrl-A> + F`
in minicom, `<Ctrl-a> + <Ctrl-\>` in picocom, right click -> special
command -> break in putty serial terminal.
The workflows are described as follows: The workflows are described as follows:

4
doc/user-guides/acrn-shell.rst
View File

@ -167,7 +167,9 @@ vm_console
The ``vm_console <vm_id>`` command switches the ACRN's console to become the The ``vm_console <vm_id>`` command switches the ACRN's console to become the
VM's console. VM's console.
Press :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`Space` to return to the ACRN shell console. Send a BREAK character to enter escaping mode and a character e to return to
the ACRN shell console. For details on how the hypervisor console works,
refer to :ref:`hv-console`.
vioapic vioapic
======= =======

2
hypervisor/debug/shell_priv.h
View File

@ -73,7 +73,7 @@ struct shell {
#define SHELL_CMD_VM_CONSOLE "vm_console" #define SHELL_CMD_VM_CONSOLE "vm_console"
#define SHELL_CMD_VM_CONSOLE_PARAM "<vm id>" #define SHELL_CMD_VM_CONSOLE_PARAM "<vm id>"
#define SHELL_CMD_VM_CONSOLE_HELP "Switch to the VM's console. Use [Ctrl+Spacebar] to return to the ACRN shell "\ #define SHELL_CMD_VM_CONSOLE_HELP "Switch to the VM's console. Use 'BREAK + e' to return to the ACRN shell "\
"console" "console"
#define SHELL_CMD_INTERRUPT "int" #define SHELL_CMD_INTERRUPT "int"