Skip to content

Commit 809338a

Browse files
committed
Doc: Clarify Post-Launch VM data flow discussion for vuart conf
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
1 parent fd4775d commit 809338a

File tree

2 files changed

+8
-47
lines changed

2 files changed

+8
-47
lines changed
93.6 KB
Loading

doc/tutorials/vuart_configuration.rst

Lines changed: 8 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -178,60 +178,21 @@ For a post-launched VM, the ``acrn-dm`` cmdline also provides a COM port configu
178178

179179
This adds ``com1 (0x3f8)`` and ``com2 (0x2f8)`` modules in the Guest VM, including the ACPI info for these two ports.
180180

181-
**Data Flow 1:**
181+
**Data Flows**
182182

183-
When the post-launched VM is started with the vUART enabled in the hypervisor configuration file only, the data flow is shown as below:
183+
Three different data flows exist based on how the post-launched VM is started, as shown in the diagram below.
184184

185-
.. figure:: images/vuart-config-3.png
186-
:align: center
187-
:name: PLVM1-vuart
188-
189-
**acrn-dm cmdline:** N/A
190-
191-
.. code-block:: none
192-
193-
vm_configuration.c: .vuart[0] = {
194-
.type = VUART_LEGACY_PIO,
195-
.addr.port_base = COM1_BASE,
196-
.irq = COM1_IRQ,
197-
},
185+
Figure 1 data flow: The post-launched VM is started with the vUART enabled in the hypervisor configuration file only.
198186

199-
**Data Flow 2:**
187+
Figure 2 data flow: The post-launched VM is started with the ``acrn-dm`` cmdline of ``-s 1:0,lpc -l com1,stdio`` only.
200188

201-
When the post-launched VM is started with the ``acrn-dm`` cmdline of ``-s 1:0,lpc -l com1,stdio`` only, the data flow is shown as below:
189+
Figure 3 data flow: The post-launched VM is started with both vUART enabled and the ``acrn-dm`` cmdline of ``-s 1:0,lpc -l com1,stdio``.
202190

203-
.. figure:: images/vuart-config-4.png
191+
.. figure:: images/vuart-config-post-launch.png
204192
:align: center
205-
:name: PLVM2-vuart
206-
207-
**acrn-dm cmdline:** ``-s 1:0,lpc -l com1,stdio``
208-
209-
.. code-block:: none
210-
211-
vm_configuration.c: .vuart[0] = {
212-
.type = VUART_LEGACY_PIO,
213-
.addr.port_base = INVALID_COM_BASE,
214-
},
215-
216-
**Date Flow 3:**
217-
218-
When the post-launched VM is started with both vUART enabled and the ``acrn-dm`` cmdline of ``-s 1:0,lpc -l com1,stdio``, the data flow is show as below:
219-
220-
.. figure:: images/vuart-config-5.png
221-
:align: center
222-
:name: PLVM3-vuart
223-
224-
**acrn-dm cmdline:** ``-s 1:0,lpc -l com1,stdio``
225-
226-
.. code-block:: none
227-
228-
vm_configuration.c: .vuart[0] = {
229-
.type = VUART_LEGACY_PIO,
230-
.addr.port_base = COM1_BASE,
231-
.irq = COM1_IRQ,
232-
},
193+
:name: Post-Launched VMs
233194

234195
.. note::
235-
For operating systems such as VxWorks and Windows that depend on the ACPI table to probe the uart driver, adding the vuart configuration in the hypervisor is not sufficient. Currently, we recommend that you use the configuration in Data Flow 3. This may be refined in the future.
196+
For operating systems such as VxWorks and Windows that depend on the ACPI table to probe the uart driver, adding the vuart configuration in the hypervisor is not sufficient. Currently, we recommend that you use the configuration in the figure 3 data flow. This may be refined in the future.
236197

237198

0 commit comments

Comments
 (0)