Commit Graph

201 Commits

Author SHA1 Message Date
David B. Kinder ac5b46eba5 doc: update rest of hypervisor HLD sections
Transcode, edit, and upload HLD 0.7 section 3.10 (PM in hypervisor),
3.11 (Console, shell, vUART), 3.12 (Hypercall/VHM upcall), and
3.13 (Compile-time config)

Also scan/replace UTF-8 punctuation missed in previous PRs.

Add anchor targets in referenced docs.

Tracked-on: #1648

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 11:20:09 -07:00
David B. Kinder 97c8c16f6a doc: fix misspellings in hld docs
can and fix misspellings missed during normal review

Tracked-on: #1648

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 08:58:01 -07:00
Junjie Mao b9d54f4ab3 kconfig: support board-specific defconfig
The current defconfigs are BIOS-specific which makes it difficult to maintain
multiple defconfigs for boards running the same BIOS.

This patch re-organizes the defconfigs to be board-specific. A command line
option BOARD is introduced to specify a board on which the current build targets
at. The original PLATFORM is kept for backward compatibility which redirects to
apl-mrb and nuc6cayh for sbl and uefi, respectively.

The getting started guide is also updated accordingly.

v1 -> v2:

* Rewrite 'up2' to 'UP2'.

Tracked-On: #1588
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Reviewed-by: Anthony Xu <anthony.xu@intel.com>
2018-10-30 10:49:12 +08:00
David B. Kinder bf7b1cf744 doc: update HLD Device passthrough
transcode, edit, and upload HLD 0.7 section 3.9 (Device passthrough)

Tracked-on: #1645

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-29 16:32:32 -07:00
David B. Kinder 7c192db1ba doc: update HLD VT-d
transcode, edit, and upload HLD 0.7 section 3.8 (VT-d)

Tracked-on: #1643

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-29 13:34:01 -07:00
Xinyun Liu e141150e4c doc: Fix AcrnGT broken API doc due to kernel upgrade
* interface name changed
* missing kernel doc comment in kernel source code

Tracked-On: #1511

Signed-off-by: Xinyun Liu <xinyun.liu@intel.com>
2018-10-29 09:20:43 -07:00
David B. Kinder dc7df1cd0f doc: update HLD Virtual Interrupt
transcode, edit, and upload HLD 0.7 section 3.7 (Virtual Interrupt)
Add target references in other docs as needed.

Tracked-on: #1623

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-26 16:46:49 -07:00
David B. Kinder 1c54734f8b doc: update HLD Timer section
transcode, edit, and upload HLD 0.7 section 3.6 (Timer)
Also, fix the hv sections file names to be consistent.

Tracked-on: #1623

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-26 15:12:45 -07:00
Geoffroy Van Cutsem d6523964ee Documentation: tweak 'partition mode' tutorial
Tweak the 'Using partition mode on UP2' tutorial by removing
a couple of Grub menu entries that are not present by default
(nor introduced as part of the tutorial).

Also make it more obvious that there is still a default entry
called 'Ubuntu' which is the one by default.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-26 15:06:20 -07:00
David B. Kinder 70e13bf8f4 doc: update interrupt hld section
Transcode, edit, and upload HLD 0.7 sections 3.5 (Physical Interrupts)

Tracked-on: #1610

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 16:44:41 -07:00
David B. Kinder f84547cad2 doc: move docs to match HLD 0.7 org
I/O emulation section was in a different place than in the HLD 0.7 doc

Tracked-on: #1592
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 14:09:30 -07:00
David B. Kinder 9871b343fa doc: update I/O emulation section
Transcode, edit, and upload HLD 0.7 sections 3.4 (I/O emulation)
Add anchor targets to other docs reference in this section.
Update .known-issues filter for "known" doxygen/breathe errors

Tracked-on: #1592

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 13:39:33 -07:00
David B. Kinder 6dffef12d9 doc: filter error exit status incorrect
When the doc log is scanned for potential "new" errors, if any are found
it wasn't returning a non-zero error code.

Tracked-on: #1514

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 13:38:11 -07:00
David B. Kinder d764edbf83 doc: update GRUB menu image in partition mode doc
Replace the askew photo of a GRUB screen with a ``code-block:: console``
directive.

Tracked-On: #1160

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 10:43:20 -07:00
Kaige Fu 61a9ca2053 Documentation: Add tutorial about how to use partition mode on UP2
This patch adds tutorial about all the steps you need to take in order to use
partition mode with ACRN hypervisor on UP2.

Tracked-On: #1160
Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2018-10-25 10:14:36 -07:00
David B. Kinder bc7b06ae2f doc: update Memory management HLD
Update HLD documentation with HLD 0.7 section 3.3 (Memory Management).
Add a referenced target link to hv-cpu-virt.rst

Tracked-on: #1590

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 10:04:10 -07:00
Junjie Mao 7b06be9e2c HV: checkpatch: add configurations to customize checkpatch.pl
ACRN hypervisor follows MISRA-C which has some inconsistencies with the Linux
kernel coding style. Namely,

    * Braces are required even for single-statement blocks.
    * Zero-initialisers to global variables are allowed.
    * Line limit is 120 instead of 80.

This patch adds a .checkpatch.conf so that checkpatch.pl stops warning on the
exceptions above when invoked under the root directory of the acrn-hypervisor
repository.

The coding style documentation is updated accordingly.

Tracked-On: #1557
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2018-10-24 18:20:36 +08:00
David B. Kinder acc51877f1 doc: merge static core with cpu virt
Update the converted HLD 0.7 section 3.2 with a previously converted
static partitioning document (instead of a separate doc for this topic).

Tracked-on: #1533

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 16:09:19 -07:00
David B. Kinder e01f47778a doc: HV startup and CPU virtualization sections
transcode, edit, and upload HLD 0.7 sections 3.1 and 3.2

Tracked-on: #1533

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 15:46:38 -07:00
David B. Kinder 8893a8c2c7 doc: update HLD overview chapter
Transcode, edit, and publish update HLD chapter 2

Tracked-on: #1512

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 15:46:14 -07:00
David B. Kinder 813e3abccc doc: Update contrib doc with Tracked-On
For traceability, all changes must include a Tracked-On: line indicating
the issue driving this change.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Tracked-On: #1420
2018-10-18 15:04:34 -07:00
Geoffroy Van Cutsem 30c2901546 Documentation: typo in Ubuntu tutorial and additional note
Fix one typo (in a command) in the tutorial entitled "Using
Ubuntu as the Service OS".

Add a note explaining that a script may have to be adjusted
based on the HW set-up (network interface name).

Tracked-On: #1502

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-18 14:56:47 -07:00
Geoffroy Van Cutsem 4ed87f90e9 Documentation: add note and instructions for Ubuntu 16.04
There is a compilation error when using the stock gcc compiler
from Ubuntu 16.04. This adds a note to our Getting Started
Guide to indicate what the error is and how to work around it.

Tracked-On: #1482

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-17 05:56:43 -07:00
Geoffroy Van Cutsem 2b449680ff Documentation: minor update to the tutorial about Ubuntu as SOS
Minor update to the tutorial on how to use Ubuntu as the Service OS
with ACRN. Specifically, the instructions for making the Grub menu
visible at boot time now involved modify the /etc/default/grub file
and not the /boot/grub/grub.cfg as before.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-17 05:54:49 -07:00
David B. Kinder e7b63aec9d doc: add static core partitioning doc
Update HLD with the static core partitioning doc

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-15 12:45:16 -07:00
David B. Kinder d800baf553 doc: tweak hld intro
Add another level to the HLD toc, and start conversion of the HLD intro

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 16:38:13 -07:00
David B. Kinder 1e38544112 doc: reorganize HLD docs
Reorganize the high-level design docs to align with a work-in-progress
HLD document.  Migrate previous web content (and images) into the new
organization.

From here we'll continue inclusion of new design chapters as they're
reviewed and edited.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 16:08:15 -07:00
David B. Kinder 8e21d5ee99 doc: update genrest script for latest kconfiglib
The genrest.py script (used to generate config documentation from the
Kconfig files) broke when upgrading to the latest kconfiglib (10.9.1).
Copied the latest genrest.py script from the Zephyr project (where this
script and processing was developed) and things work again.

Update Makefile's call to genrest.py (toplevel Kconfig path is now found
relative to the srctree.

Update requirements.txt to match the kconfiglib version family
verified to work.

fixes: #1387

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

Documentation scripts: enhance 'show-versions.py'

Modify the doc/scripts/show-versions.py script by making it
gather the list of Python modules to check the version for from
the "requirements.txt" file. It should help keep this in sync
if/when our requirements evolve.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-04 14:25:00 -07:00
David B. Kinder 1c0a05705f doc: update genrest script for latest kconfiglib
The genrest.py script (used to generate config documentation from the
Kconfig files) broke when upgrading to the latest kconfiglib (10.9.1).
Copied the latest genrest.py script from the Zephyr project (where this
script and processing was developed) and things work again.

Also update requirements.txt to match the kconfiglib version verified to
work.

tracked-on: #1387

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-04 14:25:00 -07:00
Geoffroy Van Cutsem 373e79bb52 Getting Started Guide: add instructions to disable cbc_* services
Add instructions on how to disable ('mask') the 'cbc_*' services
installed by the 'ioc-cbc-tools'. These services are not functional
on standard off-the-shelf platforms such as NUCs or UP2.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-01 14:37:25 -07:00
Geoffroy Van Cutsem 769871496d Getting Started Guide: minor clean-up
Fix the delimiting character used when adding an extra row
to a table so as to make it consistent with the other rows.

Remove an extra set of "<>"

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-01 14:37:25 -07:00
Geoffroy Van Cutsem be0651adf4 Getting Started Guide: fix highlighting in launch_uos.sh
The "launch_uos.sh" script has evolved and the lines that we
highlight have moved. Update the syntax to highlight the correct
lines.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-27 07:07:05 -07:00
Geoffroy Van Cutsem 37014caa13 Documentation: add pointer to the documentation generation in GSG
Add a pointer to the documentation generation tutorial from the
Getting Started Guide (in the "Building ACRN") section.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-27 07:07:05 -07:00
Geoffroy Van Cutsem 7b26b3484a Documentation: update list of bundles to be installed in GSG
Update the list of bundles to be installed in the Service OS. The
"desktop" bundle is no longer require as "software-defined-cockpit"
includes all media and graphics components.

Add "sudo" to the list (it was installed as part of the "desktop"
bundle previously).

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-27 07:07:05 -07:00
Geoffroy Van Cutsem f45c3bd279 Documentation: add instruction to use a specific version of Clear
Add a note (and instruction) on how to use a specific version of
Clear Linux on a system. Picking up the image of a specific release
is not sufficient as Clear Linux always grabs the very latest image
when installing.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-27 07:04:19 -07:00
David B. Kinder 68ce114b43 doc: add tool for verifying installed doc tools
Added a python script that displays versions of doc building tools
(e.g., doxygen, breathe, sphinx) to help verify doc building environment
is properly set up (can help doc building problem diagnostic, as shown
in issue #1333

Update doc build documentation to reference this script.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-26 13:34:25 -07:00
ailin,yang ac9ebc5e0f update to support v0.2 release
updated Clear Linux version to 25130 as getting started
updated pk kernel version to 4.14.68-99
added one bundle installation
2018-09-24 21:05:44 -07:00
David B. Kinder d08256dfa9 doc: code-block text not readable
The .. code-block:: console directive (used for white text on a black
background) didn't handle some CSS cases properly resulting in
unreadable grey text on a black background.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 15:31:37 -07:00
David B. Kinder 23cf8079e7 doc: update tagged release doc build instructions
Update the doc build instructions to include how to update the version
navigation selector (bottom of the left nav panel), and make commands
for building and publishing specific tagged releases (e.g., 0.2)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 13:43:03 -07:00
David B. Kinder b5bf00b6e0 doc: update doc version menu for v0.2 release
Update conf.py selector list to include version 0.2 documentation (and
fix an URL typo in the release notes).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 11:01:15 -07:00
David B. Kinder c7d87795f0 doc: release notes update for v0.2 release
Remove "DRAFT" indicator, and a few tweaks to repo description and
download instructions noticed in PR #1316

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 10:44:19 -07:00
Xie, nanlin 8dba99f8c1 doc: Add new known issue in v0.2 release note.
Add new known issue in v0.2 release note.

Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-09-24 08:50:34 -07:00
David B. Kinder f20ca31145 doc: add tags and checkout info to release notes
Add instructions for accessing source for the v0.2 tagged
release.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 23:19:26 -07:00
Xie, nanlin 6709a08580 doc: Add change log in v0.2 release note.
Add change log in v0.2 release note.

Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-09-20 21:30:57 -07:00
David B. Kinder 7dd3207a6a doc: fix typo in network virt hld
punctuation fix

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 10:23:48 -07:00
David B. Kinder 01ce3b6aee doc: sort title in developer HLD section
We've got enough docs now that it would be better to put them in sorted
order by title.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 10:11:12 -07:00
David B. Kinder dae98a0409 doc: add network virtualization hld
Review, edit, and transcode network virtualization doc

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 10:02:43 -07:00
David B. Kinder 55a71e402d doc: add watchdog high-level design
Review, transcode, and publish watchdog high-level design doc.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 09:57:55 -07:00
David B. Kinder 31285a9fdd doc: add security hld document
review and publish ACRN security hld document, also added the oplus
replacement symbol

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-20 09:45:36 -07:00
David B. Kinder 40dfd3fc24 doc: edit 0.2 release notes
Followup #1281 update with some spelling and formatting fixes

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-18 09:19:48 -07:00