Commit Graph

33 Commits

Author SHA1 Message Date
Amy Reyes 3207e7c3f1 doc: terminology cleanup in image (Modular Design)
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-22 07:42:52 -08:00
Amy Reyes 33a205c913 doc: terminology cleanup in trusty doc
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-10 13:09:07 -08:00
David B. Kinder b81153145d doc: update images with VHM to use HSM
Change references to VHM to HSM (Hypervisor Service Module) in images.
While in these files, update SOS (to Service VM) and UOS (to User VM) as
well.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-30 08:45:46 -07:00
David B. Kinder 6d352ba4e6 doc: remove remaining GVT-g documentation
When GVT-g support was removed from ACRN some documentation changes were
missed. Delete the GVT-g HLD docs and the images it used.  Also fix
references in the old release notes so they don't depend on this deleted
document.  (The original release notes are still in the archived release
docs.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-22 16:08:14 -07:00
David B. Kinder 35aba4ff21 doc: remove stray x attrib on png and rst files
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-12-21 09:57:19 -08:00
Zide Chen 456dd43187 doc: remove the vboot module design example from sw_design_guidelines.rst
Since de-privilege boot mode is removed and vboot module is completely
rewritten.

Tracked-On: #5197
Signed-off-by: Zide Chen <zide.chen@intel.com>
2020-08-25 14:42:26 -07:00
David B. Kinder e2d3653976 doc: continue doc restructuring
Changing the folder structure will cause too many broken links for
external references (from other sites). So, let's put the content back
where it was before the reorg, and instead use the new persona-based
navigation to point to documents in the original locations.

Also, introduce redirects for some documents that no longer exits.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 14:07:22 -07:00
David B. Kinder 11d4f4159f doc: Reorganize documentation site content
Take the existing ACRN technical documentation and reorganize its
presentation to be persona and use-case based, in preparation for adding
new scenario/use-case based architecture introduction and getting
started documents.

Introduce a more graphical home page and theme color tweaks.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-31 18:29:22 -07:00
David B. Kinder cf6d6f1678 doc: remove (outdated) primer documents
The ACRN primer has be replaced by an updated set of ACRN High-Level Design
documents.  Remove the primer (and images), and replace a link to the
graphics mediation section (from API documentation) to the corresponding
section in the APL GVT-g document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-06-13 12:34:11 -07:00
Geoffroy Van Cutsem 4cfd952413 doc: re-organize and consolidate ACRN kernel parameters documentation
A few changes to the documents that describe kernel command-line parameters
relevant to ACRN (SOS and UOS):
- Merge two documents into one (with sections)
- Move to the "User Guides" (from the "Developer Guides")
- Update order in the list to make it consistent across sections
- Add missing parameters to the overview list

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-04-04 13:38:30 -07:00
Shiqing Gao 79582b996f doc: update software design guidelines
This patch adds the guidelines for 'Module Level
Configuration Design'.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-30 12:54:55 -04:00
Shiqing Gao 18b619da4d doc: add the doc for 'Error Detection and Handling'
This patch adds the doc for 'Error Detection and Handling'.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-07 22:12:10 -08:00
David B. Kinder 8c3cfe62aa doc: add VBSK overhead analysis doc
Add a new developer guide describing VBSK overhead analysis.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-02-28 20:25:19 -08:00
David B. Kinder a6cef1095f doc: add GVT-g kernel options doc
Update developer docs with a new GVT-g kernel options document. Update
existing docs with referenced labels.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-13 22:56:58 -08:00
Junjie Mao e2a8989ff4 doc: add a document on considerations and current status of hypervisor modularization
To kick off the efforts on modularization, this patch introduces a document
describing the goals and general principles of modular design as well as a brief
introduction on the current status of component/module decomposition.

A detailed assignment of source files to components will be added in the future.

v2 -> v3:

* Expand mailing list address in the doc

v1 -> v2:

* Add more description on complexity measures, cyclic dependency avoidance, and
  the reverse dependency of boot on hypervisor initialzation.
* Fix typos.

Tracked-On: #1842
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2018-12-03 20:49:28 -08: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 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
Geoffroy Van Cutsem 047f4e90a2 Documentation: update to AcrnGT official name
Update the ACRN documentation to use the official name of GVT-g
in ACRN to "AcrnGT" (ACRN-GT was previously widely used).

Also update the few occurences of "GVT-G" to "GVT-g" to be
consistent across our documentation. This includes a couple of
file name updates.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-06 21:51:23 -07:00
Fei Jiang e49c42d698 Documentation: update GVT-G-porting-image1.png for AcrnGT official name
Signed-off-by: Fei Jiang <fei.jiang@intel.com>
2018-08-30 14:03:43 -07:00
David B. Kinder 4753da4374 doc: add interrupt high-level design doc
Transcode, review, and publish interrupt high-level design document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-08-08 20:23:12 -07:00
David B. Kinder 014bef6fec doc: add virtio-console HLD document
transcode, review, and publish virtio-console developer-guides doc

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-31 09:47:27 -07:00
David B. Kinder 53a5941b99 doc: add GVT-G porting guide
Transcode, review, and publish GVT-G porting guide documentation. Merged
glossary entries, added anchor links in GVT-g_api for referencing from
this document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:08:57 -07:00
David B. Kinder 746cbab979 doc: add UART virtualization documentation
transcode, review, and publish UART virtualization design and
documentation

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:01:35 -07:00
David B. Kinder b25caad29e doc: add API-GVT-g high level design doc
Transcode and publish HLD document.  Moved glossary terms to the
project-wide glossary.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-10 16:42:22 -07:00
David B. Kinder 2c706b21a1 doc: add ACPI virtualization HLD
Transcribe and publish the reviewed ACPI virtualization HLD as another
developer guide.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-10 14:18:07 -07:00
David B. Kinder 1707fc370a doc: add memory management HLD
Transcribe and publish the reviewed memory managment HLD into the ACRN
doc set as a developer guide

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-10 10:29:43 -07:00
David B. Kinder f96c2b867c doc: add virtio HLD document
High level design document for Virtio

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-08 20:51:10 -07:00
David B. Kinder 1bf511cf08 doc: small tweaks to new trusty doc
Adjusted the picture sizes a bit smaller, fixed some spelling errors,
and moved the boot-flow.dot image used by trusty into the common images
folder (and renamed the image to trusty-boot-flow.dot)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-05 06:56:20 -07:00
Geoffroy Van Cutsem f7d78289ee Documentation: add pictures to Trusty documentation
A couple of diagram were written using text characters. This
commit changes that to use pictures instead.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-07-05 00:06:51 -07:00
David B. Kinder 05d2558f9f doc: move graphviz material to developer-guides
Rather than a "tutorial", it was suggested to move the graphviz
information to the devleoper-guides, along with the documentation
guidelines.  Makes sense.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-03 09:48:19 -07:00
David B. Kinder 3965593df6 doc: reorganize documentation
We've been expanding documentation, and now need to organize things a bit
cleaner and separate content into new major folders: Introduction, Getting
Started, User Guides, Developer Guides, Tutorials, and Release notes..

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:36:13 -07:00