Skip to content

Commit c43bca9

Browse files
committed
doc: add a FAQ doc
Start a new FAQ document with questions we're often being asked on support channels. We'll expand this list over time, and as the number of questions grow, we'll organize them as appropriate. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent bb8f539 commit c43bca9

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

doc/faq.rst

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
.. _faq:
2+
3+
FAQ
4+
###
5+
6+
Here are some frequently asked questions about the ACRN project.
7+
8+
.. contents::
9+
:local:
10+
:backlinks: entry
11+
12+
------
13+
14+
What hardware does ACRN support?
15+
********************************
16+
17+
ACRN runs on Intel Apollo Lake and Kaby Lake boards, as documented in
18+
our :ref:`hardware` documentation.
19+
20+
Clear Linux* fails to boot on my NUC
21+
************************************
22+
23+
If you're following the :ref:`getting_started` documentation and the NUC
24+
fails to boot, here are some options to try:
25+
26+
* Upgrade your platform to the latest BIOS
27+
* Verify Secure Boot is disabled in the BIOS settings:
28+
29+
- Depending on your platform, press for example, :kbd:`F2` while
30+
booting to enter the BIOS options menu, and verify "Secure Boot" is
31+
not checked in the "Boot Options"
32+
* Make sure you are using EFI (and not legacy BIOS)
33+
34+
How do I configure ACRN's memory use?
35+
*************************************
36+
37+
It's important that the ACRN Kconfig settings are aligned with the physical memory
38+
on your platform. Check the documentation for these option settings for
39+
details:
40+
41+
* :option:`CONFIG_PLATFORM_RAM_SIZE`
42+
* :option:`CONFIG_SOS_RAM_SIZE`
43+
* :option:`CONFIG_UOS_RAM_SIZE`
44+
* :option:`CONFIG_HV_RAM_SIZE`
45+
46+
For example, if memory is 32G, setup ``PLATFORM_RAM_SIZE`` = 32G
47+
48+
::
49+
50+
config PLATFORM_RAM_SIZE
51+
hex "Size of the physical platform RAM"
52+
default 0x200000000 if PLATFORM_SBL
53+
default 0x800000000 if PLATFORM_UEFI
54+
55+
Setup ``SOS_RAM_SIZE`` = 32G too (The SOS will have the whole resource)
56+
57+
::
58+
59+
config SOS_RAM_SIZE
60+
hex "Size of the vm0 (SOS) RAM"
61+
default 0x200000000 if PLATFORM_SBL
62+
default 0x800000000 if PLATFORM_UEFI
63+
64+
Setup ``UOS_RAM_SIZE`` to what you need, for example, 16G
65+
66+
::
67+
68+
config UOS_RAM_SIZE
69+
hex "Size of the User OS (UOS) RAM"
70+
default 0x100000000 if PLATFORM_SBL
71+
default 0x400000000 if PLATFORM_UEFI
72+
73+
Setup ``HV_RAM_SIZE`` (we will reserve memory for guest EPT paging
74+
table), if you setup 32G (default 16G), you must enlarge it with
75+
(32G-16G)/2M pages (where pages are 4K). The example below is after
76+
HV_RAM_SIZE is changed to 240M
77+
78+
::
79+
80+
config HV_RAM_SIZE
81+
hex "Size of the RAM region used by the hypervisor"
82+
default 0x07800000 if PLATFORM_SBL
83+
default 0x0f000000 if PLATFORM_UEFI

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Sections
3131
developer-guides/index.rst
3232
tutorials/index.rst
3333
release_notes.rst
34+
faq.rst
3435

3536
Indices and Tables
3637
******************

0 commit comments

Comments
 (0)