You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/getting-started/rt_industry.rst
+30-52Lines changed: 30 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,10 +20,8 @@ for the RTVM.
20
20
- Intel Kaby Lake (aka KBL) NUC platform with two disks inside
21
21
(refer to :ref:`the tables <hardware_setup>` for detailed information).
22
22
- If you need to enable the serial port on KBL NUC, navigate to the
23
-
:ref:`troubleshooting <connect_serial_port>` to prepare the cable.
24
-
- Follow below steps to install Clear Linux OS (Ver: 31670) onto the SATA disk
25
-
of the KBL NUC(Here we install Clear linux with version 31670 and then the
26
-
subsequent ACRN quick setup script will upgrade Clear linux to version 32030):
23
+
:ref:`troubleshooting section <connect_serial_port>` that discusses how to prepare the cable.
24
+
- Follow the below steps to install Clear Linux OS (version 31670) onto the SATA disk of the KBL NUC. In the example below, we will install Clear Linux with version 31670 and then follow the subsequent ACRN quick setup script which will upgrade Clear Linux to version 32030:
.. [1] The maximum supported memory size for ACRN is 16GB. If you are using
102
-
32GB memory, follow the :ref:`config_32GB_memory` instruction to make
99
+
32GB memory, follow the :ref:`config_32GB_memory` instructions to make
103
100
a customized ACRN hypervisor that can support 32GB memory. For more
104
101
detailed information about how to build ACRN
105
102
from the source code, refer to this :ref:`guide <getting-started-building>`.
@@ -135,9 +132,7 @@ Use the pre-installed industry ACRN hypervisor
135
132
136
133
# ./acrn_quick_setup.sh -s 32030 -d -i
137
134
138
-
.. note:: ``-i`` option means the industry scenario efi image will be used, e.g.
139
-
``acrn.nuc7i7dnb.industry.efi``. For the detailed usage of the ``acrn_quick_setup.sh`` script,
140
-
move to this :ref:`quick setup ACRN guide <quick-setup-guide>` or just type ``./acrn_quick_setup.sh -h``.
135
+
.. note:: ``-i`` option means the industry scenario efi image will be used, e.g. ``acrn.nuc7i7dnb.industry.efi``. For the detailed usage of the ``acrn_quick_setup.sh`` script, refer to the :ref:`quick setup ACRN guide <quick-setup-guide>` or simply type ``./acrn_quick_setup.sh -h``.
141
136
142
137
#. Use ``efibootmgr -v`` command to check the ACRN boot order:
143
138
@@ -159,16 +154,14 @@ Use the pre-installed industry ACRN hypervisor
159
154
Boot000D* INTEL SSDPEKKW256G8 : PART 0 : Boot Drive BBS(HD,,0x0)..BO
160
155
Boot000E* UEFI : INTEL SSDPEKKW256G8 : PART 0 : OS Bootloader PciRoot(0x0)/Pci(0x1d,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-00)/HD(1,GPT,8aa992f8-8149-4f6b-8b64-503998c776c1,0x800,0x47000)..BO
161
156
162
-
.. note:: Ensure the ACRN is first in the boot order, or you may use ``efibootmgr -o 1`` command to move it
163
-
to the first position.
164
-
165
-
.. note:: If you need to enable the serial port, run the following command before reboot:
157
+
.. note:: Ensure that ACRN is first in the boot order, or you may use ``efibootmgr -o 1`` command to move it
158
+
to the first position. If you need to enable the serial port, run the following command before rebooting:
The cyclictest is most commonly used for benchmarking RT systems. It is one of the
298
-
most frequently used tools for evaluating the relative performance of real-time
299
-
systems. Cyclictest accurately and repeatedly measures the difference between a
300
-
thread's intended wake-up time and the time at which it actually wakes up in order
301
-
to provide statistics about the system's latencies. It can measure latencies in
302
-
real-time systems that are caused by hardware, firmware, and the operating system.
303
-
The cyclictest is currently maintained by Linux Foundation and is part of the test
304
-
suite rt-tests.
290
+
The cyclictest is most commonly used for benchmarking RT systems. It is one of the most frequently used tools for evaluating the relative performance of real-time systems. Cyclictest accurately and repeatedly measures the difference between a thread's intended wake-up time and the time at which it actually wakes up in order to provide statistics about the system's latencies. It can measure latencies in real-time systems that are caused by hardware, firmware, and the operating system. The cyclictest is currently maintained by Linux Foundation and is part of the test suite rt-tests.
305
291
306
292
Pre-Configurations
307
293
==================
@@ -341,20 +327,17 @@ Recommended BIOS settings
341
327
"ACPI S3 Support", "Intel Advanced Menu -> ACPI Settings", "Disabled"
342
328
"Native ASPM", "Intel Advanced Menu -> ACPI Settings", "Disabled"
343
329
344
-
.. note:: The BIOS settings depend on the platform and BIOS version; some may not be applicable.
330
+
.. note:: BIOS settings depend on the platform and BIOS version; some may not be applicable.
.. note:: CAT configuration is only supported on `Apollo Lake NUC`_.
338
+
.. note:: CAT configuration is only supported on the `Apollo Lake NUC`_.
353
339
354
-
With the ACRN Hypervisor shell, we can use ``cpuid`` and ``wrmsr``/``rdmsr`` debug
355
-
commands to enumerate the CAT capability and set the CAT configuration without rebuilding binaries.
356
-
Because ``lapic`` is a pass-through to the RTVM, the CAT configuration must be
357
-
set before launching the RTVM.
340
+
With the ACRN Hypervisor shell, we can use ``cpuid`` and ``wrmsr``/``rdmsr`` debug commands to enumerate the CAT capability and set the CAT configuration without rebuilding binaries. Because ``lapic`` is a pass-through to the RTVM, the CAT configuration must be set before launching the RTVM.
358
341
359
342
Check CAT ability with cupid
360
343
````````````````````````````
@@ -385,8 +368,7 @@ The PQR_ASSOC MSR is per CPU core; each core has its own PQR_ASSOC::
385
368
MSR_IA32_PQR_ASSOC 0x00000C8F
386
369
387
370
To set the CAT, first set the CLOS MSRs. Next, set the PQR_ASSOC of each CPU
388
-
so that the CPU of the RTVM uses dedicated cache and other CPUs use other cache.
389
-
Taking a Quad Core Apollo Lake platform for example, CPU0 and CPU1 share L2 cache while CPU2 and CPU3 share the other L2 cache.
371
+
so that the CPU of the RTVM uses dedicated cache and other CPUs use other cache. Taking a Quad Core Apollo Lake platform for example, CPU0 and CPU1 share L2 cache while CPU2 and CPU3 share the other L2 cache.
390
372
391
373
- If we allocate CPU2 and CPU3, no extra action is required.
392
374
- If we allocate only CPU1 to the RTVM, we need to set the CAT as follows.
@@ -398,15 +380,12 @@ a. Set CLOS with ``wrmsr <reg_num> <value>``, we want VM1 to use the lower 6 way
398
380
ACRN:\>wrmsr -p1 0xd10 0xf0
399
381
ACRN:\>wrmsr -p1 0xd11 0x0f
400
382
401
-
#. Attach COS1 to PCPU1. Because MSR is IA32_PQR_ASSOC [bit 63:32], we’ll write
402
-
0x100000000 to it to use CLOS1::
383
+
#. Attach COS1 to PCPU1. Because MSR is IA32_PQR_ASSOC [bit 63:32], we’ll write 0x100000000 to it to use CLOS1::
403
384
404
385
ACRN:\>wrmsr -p0 0xc8f 0x000000000
405
386
ACRN:\>wrmsr -p1 0xc8f 0x100000000
406
387
407
-
In addition to setting the CAT configuration via HV commands, we allow developers to add
408
-
the CAT configurations to the VM config and do the configure automatically at the
409
-
time of RTVM creation. Refer to the :ref:`configure_cat_vm` for details.
388
+
In addition to setting the CAT configuration via HV commands, we allow developers to add the CAT configurations to the VM config and do the configure automatically at the time of RTVM creation. Refer to :ref:`configure_cat_vm` for details.
410
389
411
390
Set up the core allocation for the RTVM
412
391
---------------------------------------
@@ -419,10 +398,10 @@ this, follow the below steps to allocate all housekeeping tasks to core 0:
0 commit comments