Commit Graph

1265 Commits

Author SHA1 Message Date
Zide Chen
e4c69546a0 doc: add VPID allocation to nested virtualization tutorial
Tracked-On: #6289
Signed-off-by: Zide Chen <zide.chen@intel.com>
2021-09-16 09:26:10 +08:00
David B. Kinder
d1f139a51e doc: add documentation updates to release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-14 17:16:46 -07:00
David B. Kinder
bdf2ba29d6 doc: update enable PTM instructions
Fix an error in the documentation where the output from dmesg was
incorrect for the Service VM.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-14 15:47:07 -07:00
David B. Kinder
a35f4b9e05 doc: starting draft for v2.6 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-14 11:39:17 -07:00
Amy Reyes
c9495a827b doc: Remove empty section marked "TBD"
Removed the Porting and Adaptation to Different Platforms section in hv-ioc-virt.rst, because it was blank.

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-09-13 10:20:40 -07:00
David B. Kinder
1f1ca8f253 doc: tweak GSG DX issues
Fix some issues found during DX studies of the new GSG that are trivial
changes but are impacting users in the study.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-08 12:51:49 -07:00
Geoffroy Van Cutsem
f45344b6bc doc: fix broken links to network scripts in HLD
Fix broken links in the Virtio-Net HLD that point at the network
scripts in the source code repository.

Tracked-On: #6542
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-09-03 10:27:04 -07:00
Victor Sun
23af93c0e1 doc: update usage of zephyr as pre-launched VM kernel
Now ACRN support booting pre-launched Zephyr VM kernel in ELF format
instead of previous raw image format, so update usage in related doc.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2021-09-02 08:57:02 -07:00
fuzhongl
37237757c6 Doc: ACRN on QEMU changed to CPU Named Model
Qemu HOST-passthrough has hardware dependency CPU feature;
which may block ACRN to boot up on QEMU;So change QEMU HOST-passthrough to CPU Named Model since v2.6.

Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
2021-09-02 08:55:39 -07:00
amyreye
904f9e11b2 doc: use "ACRN configurator" name in Overview, GSG
Replaced "ACRN configuration editor" name with "ACRN configurator" in text and image to match the recently renamed acrn_configurator.py.

Note:

* The gsg_overview_image_sources.pptx file is the editable source file for overview_flow.png.

* I changed the name "configuration editor" to "ACRN configurator" in gsg_overview_image_sources.pptx and then saved as overview_flow.png.

* Although GitHub will say that I added gsg_overview_image_sources.pptx, this file already exists in master. I just edited it.

* GitHub may say that I removed overview_flow.png. In the PR, try clicking "Display the rich diff" icon. It will show that the existing image was replaced with the edited image.

Signed-off-by: amyreye <amy.reyes@intel.com>
2021-08-30 09:33:22 -07:00
amyreye
f46f712f31 doc: remove hld-vsbl.rst Virtual Slim-Bootloader HLD
Per Nanlin, we don't need this document.

It is blank and never contained content.

Signed-off-by: amyreye <amy.reyes@intel.com>
2021-08-25 17:01:53 -07:00
Musa Ünal
da01f679b4 Add bc to build dependencies 2021-08-24 14:22:55 -07:00
David B. Kinder
8894081379 doc: update GSG checkout commits
Need to "freeze" the acrn-hypervisor for DX reviews since the
release_2.6 branch is still changing with fixes.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 18:56:27 -07:00
amyreye
5a8b9ff8f2 Fix step numbers 2021-08-23 16:23:03 -07:00
David B. Kinder
530baaafc6 doc: more GSG DX tweaks
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 14:04:55 -07:00
Kunhui-Li
96aa38763b doc: update UI tool instructions
1. Update the images to match with the latest UI.
2. Update the path of the saved XML file when clicking Export XML to
save customized file.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 12:12:05 -07:00
David B. Kinder
ce84751274 doc: additional DX edits to the new GSG
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 11:01:57 -07:00
David B. Kinder
bbe76d6b2a doc: GSG tweaks for DX
- mention usefulness of a fast computer for improving build time
- move Ubuntu boot USB drive earlier in the list of prereqs
- move some sentences around for clarity
- improve appearance with some more spacing after images

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-22 21:43:21 -07:00
David B. Kinder
50094fb88b doc: DX update for GSG
- Update the Getting Started material with a DX-inspired rewrite and
  simplification.
- Remove duplicate and out-of-date "Building from Source"
  document, deferring to the new GSG.
- Add a development overview document.
- Move other GSGs to the advanced guides section.
- Update links in other documents to aim at the new GSG.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-08-20 07:53:18 -07:00
David B. Kinder
331c66bde8 doc: update configuration tool names
PR #6418 renames the board inspector tool cli.py to board_inspector.py
and the configuration tool app.py to acrn_configurator.py

Update the documentation to use these new names.  Note that the ROScube
GSG is validated with ACRN v2.1 and instructs the user to checkout that
branch where the tool is still called app.py

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-19 16:34:08 -07:00
Liu, Hang1
3964167774 doc:resolve the mismatch between doc and code
Default e820 mem map in hld-devicemodel.rst is
mismatched with sw_load_common.c,update the doc
to align with code.

Signed-off-by: Liu, Hang1 <hang1.liu@intel.com>
2021-08-18 09:15:38 -07:00
Yang,Yu-chu
668ae81048 config-tools: replace xml.etree.ElementTree with defusedxml.ElementTree
Using xml.etree.ElementTree to parse the untrusted data is known to
raise security issue. Replaced it using defusedxml.

Tracked-On: #6342
Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2021-08-13 16:11:42 +08:00
Liu, Hang1
1f5a7e8b8d doc:add more explanation on parameter --windows
acrn-dm --windows parameter is used for specify
the Windows ORACLE virtio device driver,which is
used when enable secure boot in Windows, otherwise
the default REDHAT virtio device driver will be
used which is not certified by Microsoft

Signed-off-by: Liu, Hang1 <hang1.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-12 09:39:00 -07:00
Kunhui-Li
e0f4a05df2 doc: update Kconfig related doc
Replace Kconfig related scheduler configuration with scenario XML
file configuration in tutorials because the Kconfig related files
have been removed in the other PR 6358.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-08-09 20:36:01 -07:00
David B. Kinder
3f276e7ddd doc: add v2.5.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-09 19:10:29 -07:00
David B. Kinder
09e5df01b1 doc: remove obsolete kconfig references in Makefile
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-06 09:34:45 -07:00
David B. Kinder
5817cf8256 doc: fix acrn shell command
Update keys to return to ACRN shell console

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-19 20:10:34 -07:00
David B. Kinder
1129fe1736 doc: update nested virtualization tutorial notation
Add notation description for VMCSxx introducted in the nested
virtualization tutorial.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-19 18:51:41 -07:00
David B. Kinder
86f9cda177 doc: add enable PTM tutorial
Restore PTM tutorial removed for the 2.5 release (it's tested as
working now)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-16 12:20:26 -07:00
Shuo A Liu
7947b4dae8 doc: Adapt documents to new HSM driver
Tracked-On: #6282
Signed-off-by: Shuo A Liu <shuo.a.liu@intel.com>
2021-07-15 11:53:54 +08:00
Shuo A Liu
4c9e9b9e4a doc: Change VHM to HSM in documentations
Mainly do the renaming(VHM->HSM) in the Doc.

Tracked-On: #6282
Signed-off-by: Shuo A Liu <shuo.a.liu@intel.com>
2021-07-15 11:53:54 +08:00
Shuo A Liu
107cae316a hv: dm: Use new ioctl ACRN_IOCTL_SET_VCPU_REGS
struct acrn_set_vcpu_regs	->	struct acrn_vcpu_regs
struct acrn_vcpu_regs		->	struct acrn_regs
IC_SET_VCPU_REGS		->	ACRN_IOCTL_SET_VCPU_REGS

Tracked-On: #6282
Signed-off-by: Shuo A Liu <shuo.a.liu@intel.com>
2021-07-15 11:53:54 +08:00
Shuo A Liu
82fa2d6355 dm: Rename vhm_ioctl_defs.h to hsm_ioctl_defs.h
Tracked-On: #6282
Signed-off-by: Shuo A Liu <shuo.a.liu@intel.com>
2021-07-15 11:53:54 +08:00
David B. Kinder
24b555c75d doc: remove doc dependency on kerneldoc and acrn-kernel repo
We no longer need to generate API documentation for the upstreamed
gvt-g kernel additions so we can remove the doc generation dependency on
the acrn-kernel repo (and all use of the kerneldoc extension). We also
remove GVT-g API documentation and porting guide that are obsolete with
ACRN v2.6 and referenced this API documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-07-14 18:56:07 -07:00
David B. Kinder
4f0b86adf9 doc: fix doc reference using symbolic link
enable_s5.rst has a couple of literalinclude directives referencing
sample scripts that were moved and now go through a symbolic link to the
new folder.  Symbolic links don't work on Windows, so change the
references in enable_s5.rst to not go through the symbolic link.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-29 19:15:33 -07:00
David B. Kinder
0c52b9601a doc: update known issues list in v2.5 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-28 18:16:05 -07:00
David B. Kinder
62bad63afa doc: add 2.5 to version menu choice
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 21:22:23 -07:00
fuzhongl
e8bd5acc8a Doc: release notes update
Adding known issue in release note.

Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
2021-06-24 19:51:39 -07:00
David B. Kinder
b82b8073a9 doc: remove PTM tutorial for now
PTM feature postponed to v2.6 so remove documentation about enabling
this feature.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 18:53:22 -07:00
David Kinder
8d2f158d26 release notes edits (#6255)
- fix titles for fixed issues list
- edit what's new section to improve readability

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 16:39:32 -07:00
David B. Kinder
55644741fb doc: fix link in hardware doc
Links to UP2 Shop were incorrect

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 12:23:37 -07:00
David B. Kinder
e60454f7b7 doc: remove obsolete tar.gz file
Delete a two-year old tar.gz file found in the tutorial folder that's no
longer needed.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-24 12:23:06 -07:00
David B. Kinder
fd7f0e2c45 doc: update v2.5 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-23 20:23:28 -07:00
Kunhui-Li
25c677dc39 doc: fix documentation's issue
1. Update the necessary libraries to consistent with the "Build ACRN From Source"
document in the "Getting Started Guide" document.
2. Delete the related introduction with acrngt.conf and launch_uos_id1.sh files in
"Getting Started Guide" document.
3. Update WHL-IPC-I7 board's processor in Supported HW document.
4. Add cpu_affinity element's description in ACRN Configuration Data.
5. Update the description for shm_region in Launch XML format.
6. Update configurable/readonly attributes values.
7. Update the description for hv.CAPACITIES.MAX_MSIX_TABLE_NUM in schema/config.xsd.

Tracked-On: #5692
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-06-23 19:25:22 -07:00
David B. Kinder
00fbe949df doc: update v2.5 release notes highlights
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-23 19:23:46 -07:00
Zide Chen
9dc43de733 doc: update nested virtualization user guide
Tracked-On: #5923
Signed-off-by: Zide Chen <zide.chen@intel.com>
2021-06-23 13:43:15 -07:00
David B. Kinder
6cd8bcafdc doc: edit efi-stub tutorial
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-23 09:06:02 -07:00
Nishioka, Toshiki
5fffcdcbd9 doc: add acrn efi-stub user guide
Add user guide for ACRN EFI application for Secure Boot.

Tracked-On: #6078
Signed-off-by: Toshiki Nishioka <toshiki.nishioka@intel.com>
2021-06-23 09:00:32 -07:00
David B. Kinder
8e7f1dbac8 doc: release notes edits
Fix some minor formatting/layout issues and wording

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-22 18:49:33 -07:00
Junjie Mao
a9af948993 doc: update release notes for v2.5 on configuration upgrades
This patch updates recommendations to upgrade from a prior ACRN version for
v2.5.

v2:
 * Apply suggestions from review.
 * Remove descriptions on the scenario XML upgrade tool.

Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2021-06-22 18:39:25 -07:00