Skip to content

Commit f34f87f

Browse files
lkanxwenlingz
authored andcommitted
doc:update acrn_configuration_tool
Signed-off-by: lkanx <lix.kan@intel.com>
1 parent 0e65254 commit f34f87f

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

doc/tutorials/acrn_configuration_tool.rst

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ setting up the log and the serial port.
2424
The hypervisor configuration uses the ``Kconfig`` ``make
2525
menuconfig`` mechanism. The configuration file is located at::
2626

27-
acrn-hypervisor/hypervisor/arch/x86/configs/Kconfig
27+
acrn-hypervisor/hypervisor/arch/x86/configs/
2828

2929
A board-specific ``defconfig`` file, located at::
3030

31-
acrn-hypervisor/hypervisor/arch/x86/configs/$(BOARD)/$(BOARD).config
31+
acrn-hypervisor/hypervisor/arch/x86/configs/$(BOARD).config
3232

3333
is loaded first; it is the default ``Kconfig`` for the specified board.
3434

@@ -42,7 +42,7 @@ board settings, root device selection, and the kernel cmdline. It also includes
4242
and BDF information. The board configuration is organized as
4343
``*.c/*.h`` files located at::
4444

45-
acrn-hypervisor/hypervisor/arch/x86/$(BOARD)/
45+
acrn-hypervisor/hypervisor/arch/x86/configs/$(BOARD)/
4646

4747
VM configuration
4848
=================
@@ -80,6 +80,8 @@ configurations by exporting XMLs.
8080
Board XML format
8181
================
8282

83+
The board XML located at:
84+
acrn-hypervisor/misc/acrn-config/xmls/board-xmls
8385
The board XML has an ``acrn-config`` root element and a ``board`` attribute:
8486

8587
.. code-block:: xml
@@ -90,7 +92,8 @@ As an input for the ``acrn-config`` tool, end users do not need to care about th
9092

9193
Scenario XML format
9294
===================
93-
95+
The scenario XML located at:
96+
acrn-hypervisor/misc/acrn-config/xmls/config-xmls
9497
The scenario XML has an ``acrn-config`` root element as well as ``board`` and ``scenario`` attributes:
9598

9699
.. code-block:: xml
@@ -155,7 +158,8 @@ Additional scenario XML elements:
155158

156159
Launch XML format
157160
=================
158-
161+
The launch XML located at:
162+
acrn-hypervisor/misc/acrn-config/xmls/config-xmls
159163
The launch XML has an ``acrn-config`` root element as well as
160164
``board``, ``scenario`` and ``uos_launcher`` attributes:
161165

@@ -171,8 +175,6 @@ Attributes of the ``uos_launcher`` specify the number of User VMs that the curre
171175

172176
``rtos_type``: Specify the User VM Realtime capability: Soft RT, Hard RT, or none of them.
173177

174-
``cpu_num``: Specify the max cpu number for the VM.
175-
176178
``mem_size``: Specify the User VM memory size in Mbyte.
177179

178180
``gvt_args``: GVT argument for the VM.
@@ -265,24 +267,24 @@ Here is the offline configuration tool workflow:
265267

266268
a. Generate a patch for the board-related configuration::
267269

268-
cd misc/board_config
270+
cd misc/acrn-config/board_config
269271
python3 board_cfg_gen.py --board $(BOARD).xml --scenario $(SCENARIO).xml
270272

271273
Note that this can also be done by clicking **Generate Board SRC** in the acrn-config UI.
272274

273275

274276
#. Generate a patch for scenario-based VM configuration::
275277

276-
cd misc/scenario_config
278+
cd misc/acrn-config/scenario_config
277279
python3 scenario_cfg_gen.py --board $(BOARD).xml --scenario $(SCENARIO).xml
278280

279281
Note that this can also be done by clicking **Generate Scenario SRC** in the acrn-config UI.
280282

281283
#. Generate the launch script for the specified
282284
post-launch User VM::
283285

284-
cd misc/launch_config
285-
python3 launch_cfg_gen.py --board $(BOARD).xml --scenario $(SCENARIO).xml --launch $(LAUNCH).xml
286+
cd misc/acrn-config/launch_config
287+
python3 launch_cfg_gen.py --board $(BOARD).xml --scenario $(SCENARIO).xml --launch $(LAUNCH).xml --uosid xx
286288

287289
Note that this can also be done by clicking **Generate Launch Script** in the acrn-config UI.
288290

@@ -316,10 +318,11 @@ Prerequisites
316318
.. _get acrn repo guide:
317319
https://projectacrn.github.io/latest/getting-started/building-from-source.html#get-the-acrn-hypervisor-source-code
318320

319-
- Follow the :ref:`instruction <getting-started-building>` to install the
320-
ACRN hypervisor dependencies and tools on your development host.
321+
- Clone acrn-hypervisor :
321322

322-
- Follow the `get acrn repo guide`_ to download the ACRN hypervisor repo to your host.
323+
.. code-block:: none
324+
325+
$git clone https://github.com/username/acrn-hypervisor.git
323326
324327
- Install ACRN configuration app dependencies:
325328

@@ -328,6 +331,7 @@ Prerequisites
328331
$ cd ~/acrn-hypervisor/misc/acrn-config/config_app
329332
$ sudo pip3 install -r requirements
330333
334+
331335
Instructions
332336
============
333337

0 commit comments

Comments
 (0)