[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[RFC PATCH v3 5/5] docs/system: improve doc about preconfig
From: |
Damien Hedde |
Subject: |
[RFC PATCH v3 5/5] docs/system: improve doc about preconfig |
Date: |
Wed, 17 Nov 2021 15:47:03 +0100 |
Separate -S / -preconfig sections and improve a bit the preconfig part.
Signed-off-by: Damien Hedde <damien.hedde@greensocs.com>
Signed-off-by: Mirela Grujic <mirela.grujic@greensocs.com>
---
docs/system/managed-startup.rst | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/docs/system/managed-startup.rst b/docs/system/managed-startup.rst
index 9bcf98ea79..e1cdbb79b1 100644
--- a/docs/system/managed-startup.rst
+++ b/docs/system/managed-startup.rst
@@ -1,6 +1,9 @@
Managed start up options
========================
+CPU Frezee start
+----------------
+
In system mode emulation, it's possible to create a VM in a paused
state using the ``-S`` command line option. In this state the machine
is completely initialized according to command line options and ready
@@ -20,7 +23,12 @@ allowing VM code to run.
However, at the ``-S`` pause point, it's impossible to configure options
that affect initial VM creation (like: ``-smp``/``-m``/``-numa`` ...) or
-cold plug devices. The experimental ``--preconfig`` command line option
+cold plug devices.
+
+Preconfig (experimental)
+------------------------
+
+The experimental ``--preconfig`` command line option
allows pausing QEMU before the initial VM creation, in a "preconfig" state,
where additional queries and configuration can be performed via QMP
before moving on to the resulting configuration startup. In the
@@ -32,4 +40,14 @@ machine, including but not limited to:
- ``query-qmp-schema``
- ``query-commands``
- ``query-status``
+- ``query-machine-phase``
+- ``x-machine-init``
- ``x-exit-preconfig``
+
+Some commands make QEMU to progress along the VM creation procedure:
+
+- ``x-machine-init`` initializes the machine. Devices can be added only after
+ this command has been issued.
+
+- ``x-exit-preconfig`` leaves the preconfig state. It can be issued at any time
+ during preconfig and it will finish the VM creation.
--
2.33.0
- [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Damien Hedde, 2021/11/17
- [RFC PATCH v3 1/5] rename MachineInitPhase enum constants for QAPI compatibility, Damien Hedde, 2021/11/17
- [RFC PATCH v3 2/5] qapi: Implement query-machine-phase QMP command, Damien Hedde, 2021/11/17
- [RFC PATCH v3 3/5] qapi: Implement x-machine-init QMP command, Damien Hedde, 2021/11/17
- [RFC PATCH v3 4/5] qapi: Allow device_add to execute in machine initialized phase, Damien Hedde, 2021/11/17
- [RFC PATCH v3 5/5] docs/system: improve doc about preconfig,
Damien Hedde <=
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Markus Armbruster, 2021/11/20
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Damien Hedde, 2021/11/23
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Markus Armbruster, 2021/11/24
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Daniel P . Berrangé, 2021/11/24
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Markus Armbruster, 2021/11/24
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Damien Hedde, 2021/11/25
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Daniel P . Berrangé, 2021/11/25
- Re: [RFC PATCH v3 0/5] QMP support for cold-plugging devices, Dr. David Alan Gilbert, 2021/11/29