Commit Graph

1443 Commits

Author SHA1 Message Date
Reyes, Amy 0d280ced2f doc: Style cleanup in guides
- Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:34:32 -08:00
Reyes, Amy 72a9b7bae3 doc: Style cleanup in usercrash, trusty, vuart docs
- Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:33:21 -08:00
Reyes, Amy 85fe6d7d1a doc: Style cleanup in dm, gpio, interrupt hld
Minor style changes per Acrolinx recommendations and for consistency

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-27 13:29:48 -08:00
jackwhich dad8834e23 doc: remove obsolete content in document
remove obsolete content in Document

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-02-22 21:06:43 -08:00
David B. Kinder d1b2b58b19 doc: limit search engines scan on older content
Update robots.txt to exclude older documentation versions: 0.? 1.? and 2.0 through 2.4

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-22 11:30:14 -08:00
Reyes, Amy 7c304539b4 doc: Update terms in vUART tutorial
- Update scenario names

Tracked-On: #6701
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-22 09:50:39 -08:00
jackwhich bd02de15b0 doc: Remove modprobe msr in gsg
modprobe msr has been added to board_parse.py in PR #6692.

Remove modprobe msr in gsg and board_inspector docs

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-02-22 09:45:29 -08:00
Chenli Wei b41ff11a9c doc: add UID parameter for acpidev_pt
Now the acpidev_pt module only use the hid to check the device,it can't
work well if there are more then one instance.

So this patch add UID to identify same type device to fix these issue.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
2022-02-22 09:44:02 -08:00
Reyes, Amy dc207b3fa3 doc: Style cleanup in doc guides
- Minor style changes per Acrolinx recommendations

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-18 20:58:10 -08:00
David B. Kinder 97855c54c2 doc: quick doc fix to remove build error from IVSHMEM changes
PR #7115 removed ``IVSHMEM_ENABLED`` and ``IVSHMEM_REGION`` from
``types.xsd``.  We'll need to update the documentation to reflect this
change, but for now we need to remove the doc build error.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-18 17:04:33 -08:00
Xiangyang Wu 53dd2954d2 doc: add libcjson-dev installation in GSG
Libcjson package is needed to build command monitor of DM,
so this should be installed in the user's development machine.

Tracked-On: #5921

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2022-02-18 18:33:52 +08:00
Reyes, Amy c952c00324 doc: Update terms in qemu tutorial
- Remove "sdc"
- Replace "sos" with "Service VM"
- Replace "uos" with "User VM"

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-16 16:51:36 -08:00
Reyes, Amy 8b21a85e1f doc: Remove FAQ from TOC
Per issue #5265, removing the FAQ from the table of contents until we create more content

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-16 15:37:00 -08:00
David B. Kinder b5fc55090c doc: update cpu-checker instructions in qemu doc
Clarify that ``cpu-checker`` is the package that you install to get the
``kvm-ok`` tool used in these instructions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-14 16:22:08 -08:00
fuzhongl c3f66210cf Doc: qemu cmdline update for acrn on qemu
For platforms which have apicv post-interrupt capability;
ACRN would use posted-interrupt to notify another vCPU which in non-root mode;
or sync interrupt for itself when it in root-mode.However,QEMU could not handle this properly.
So, remove the post-interrupt capability in qemu cmdline.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-By: Li, Fei <fei1.Li@intel.com>
2022-02-14 15:33:59 -08:00
Reyes, Amy e09968e5e4 doc: Update Debian packaging readme
- Update doc for v2.8 release

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-10 12:43:59 -08:00
David B. Kinder b62160255b doc: show source file link on html pages
A shortcut to find the :ref:`labelname` value to link to an HTML page is
to view the source .rst file for that page.  This patch tweaks the
conf.py to do just that.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-10 09:24:07 -08:00
David B. Kinder b32c56c540 doc: add community support and resources to introduction
Include the project's GitHub README that contains community support and
resource information into the ACRN Introduction documentation.  Also fix
the ACRN misspelling.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-01-26 17:20:08 -08:00
Kunhui-Li 159cb66167 doc: remove "pm_notify_channel" and "pm_by_vuart"
Since PR #7035 has removed "pm_notify_channel" and "pm_by_vuart"
in the launch script generation logic, this patch also removes
the related elements("poweroff_channel" and "allow_trigger_s5")
in the documentation.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-01-26 09:37:23 -08:00
Yuanyuan Zhao 8c046616c8 doc: dm cpu affinity dynamic param refine
Cpu affinty was set by pCPU ID which can't be obtained
explictly by user. Use lapic ID instead which can be easily
read from `/proc/cpuinfo` as `apicid`.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-26 09:37:23 -08:00
Geoffroy Van Cutsem 21d7b242c9 doc: update the method to run the acrn_configurator.py
Update the instructions on how to start the ACRN Configurator tool
('acrn_configurator.py'). It is no longer require to use 'python3 ...'
since we've added a shebang header to the file and made it executable.

Tracked-On: #7057
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-01-26 14:20:43 +08:00
Yuanyuan Zhao f731904638 doc: remove short version of dm dynamic param `-W`
Rename '--virtio_msix' to '--virtio_msi' for this param
means 'force virtio to use singel-vector MSI'.

Remove the `-W` which is the short version of `--virtio_msi`.

Tracked-On: #6690
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-24 09:07:39 -08:00
Yuanyuan Zhao 75884af9ac doc: remove dm dynamic param '-A'
Update document to remove 'acrn-dm' dynamic param '-A'.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-21 16:07:37 -08:00
Reyes, Amy a62e468aab doc: Update images
- Update images to align better with ACRN branding

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-21 16:04:45 -08:00
Reyes, Amy 19831b0a9b doc: Update debug tools path
- Update file path to acrn_trace files

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-20 14:00:35 -08:00
Chenli Wei fa8837b5ff doc: remove some dynamic parameters from acrn-dm usage
The following parameters have not used by new design:

1.  --vsbl <vsbl_file_path>
2.  --part_info <part_info_name>
3.  -G, --gvtargs <GVT_args>
4.  -s <slot>,pci-gvt
5.  -Y, --mptgen
6.  -s <slot>,virtio-hdcp
7.  -s <slot>,npk
8.  -s <slot>,virtio-coreu
9.  -i, --ioc_node <ioc_mediator_parameters>
10. --pm_by_vuart [pty|tty],<node_path>
11. --pm_notify_channel <channel>

This patch remove these parameters from doc.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
2022-01-14 10:53:26 -08:00
Reyes, Amy ad7ccc28a9 doc: editorial cleanup in enable s5 guide
- Address grammar and formatting comments from PR #6814
- General grammar cleanup

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-12 17:19:32 -08:00
Geoffroy Van Cutsem 31a5a907ba doc: remove obsolete TARGET_DIR Makefile parameter from tutorial
Remove the TARGET_DIR parameter from the "Enable Inter-VM Communication
Based on Ivshmem" tutorial as this is now an obsolete parameter that
will print out a warning.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-01-12 10:03:47 -08:00
Hu Fenglin 3545af5f8a doc: ACRN Inter-VM Communication
I. Add three kinds of Inter-VM communication advantage and shortage:
    1. Inter-VM vUART
    2. Inter-VM network communication
    3. Inter-VM shared memory device (ivshmem)
II.Add how to implement an Ivshmem application on ACRN.

Signed-off-by: Hu Fenglin <fenglin.hu@intel.com>
2022-01-12 09:53:15 -08:00
David B. Kinder 27f0d2969a doc: clarify 2.7 release notes
Update description of passthrough device usecase additions, and improved
description of Issue #6631 (Kata broken)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-21 18:13:16 -08:00
David B. Kinder 7f6f27be00 doc: add v2.7 docs to version menu
Also cleaned out older versions from list, keeping v1.0,
v1.6.1, v2.0, v2.5, and v2.6.

The documentation for previous releases is still available (by editing
the URL to mention that release (e.g., /2.1/ ).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-16 10:12:59 -08:00
David B. Kinder 88f8ab0a45 doc: finalize 2.7 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-15 20:36:34 -08:00
fuzhongl edbef20c02 Doc: release notes update
Adding the fixed and known issues in release notes.

Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
2021-12-15 20:25:07 -08:00
fuzhongl 32e853ccf0 Doc: Launch script update for acrn on qemu
To launch User VM, cpu_affinity parameter is needed for v2.7.

Signed-off-by: fuzhongl <fuzhong.liu@eintel.com>
Reviewed-by:   gvancuts <geoffroy.vancutsem@intel.com>
2021-12-15 18:58:04 -08:00
Reyes, Amy 9b30aa84a8 doc: Add formatting to Supported HW
- Format the HW table to improve look and feel / readability

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2021-12-15 17:39:53 -08:00
jackwhich ad5cf0ea3e doc: update GSG and partitioned documentation
1. Update launch script and replace the apt-get command with apt in GSG documentation.
2. Update the tag to v2.7 in partitioned documentation.

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-15 13:37:42 -08:00
Reyes, Amy a8ea36318d doc: Supported HW
- Remove outdated information.
- Add new HW table.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2021-12-15 13:25:31 -08:00
David B. Kinder ae0820760a doc: add CSS color styles
Add some color styles we can use (via .. rst-class:: style directive) to
add color to rst tables.  Also introduce a centered class instead of
using the deprecated .. centered:: directive.  Update documentation
guidelines to describe these new styles (background colors).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-14 16:58:16 -08:00
David B. Kinder 7c8004ab0d doc: fix $disk usage in GSG
The commands in the Getting Started Guide for copying files to and from
the USB stick will fail if the USB stick volume name has a space in it.
Fix this by quoting uses of $disk.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-14 10:42:42 -08:00
David B. Kinder 60097affd3 doc: update 2.7 release notes
Fix errors in description of changes.
Add mention of SOS -> Service_VM change in config options/values.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-13 21:27:13 -08:00
Yonghua Huang a778a0da00 doc: update 'asa.rst' for 2.7 release
Update security advisory 2.7 release.

Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-13 09:55:27 -08:00
Xiangyang Wu 097afee832 doc: add note about SRIOV disable
Currently, Service VM may fail to shut down due to some enabled
VFs. ACRN doesn't disable VFs automatically.

In this patch, add a note for user to disable VFs before Service
VM shuts down.

Tracked-On: #5921

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2021-12-13 09:38:23 -08:00
Shiqing Gao 90c987b600 doc: simplify the command to build Zephyr for ACRN
Simplify the build command using the west tool.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2021-12-08 18:23:42 -08:00
Xiangyang Wu 0b3fedee86 doc: update s5 document
For WaaG VM, the User VM name is hard coded in the
lifecycle manager, this User VM ("windows") is needed
for guest shutdown.
Note: libvirt will be used to do guest shutdown and
the WaaG VM name will be configurable in furture.

The lifecycle manager starup picture in WaaG VM is out
of data, update it in this patch.

Tracked-on: #6652
Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2021-12-08 16:56:58 -08:00
David B. Kinder 38d9227f79 doc: update release notes with cpu_affinity notice
The acrn-dm ``--cpu_affinity`` parameter is now mandatory.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-07 20:44:32 -08:00
Kunhui-Li 9a299effcb doc: update release notes for v2.7 on configuration upgrades
This patch updates recommendations to upgrade from a prior ACRN version
for v2.7, and updates the what's new summary.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-06 12:13:03 -08:00
Amy Reyes 48063c840b doc: Remove placeholder text from acrntrace
Removed placeholders for images. Will create an issue for tracking.

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-06 10:05:51 -08:00
Amy Reyes 22f4041d48 doc: terminology cleanup in hld/tutorial images
- 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-12-06 10:05:07 -08:00
Amy Reyes 28560c1db7 doc: terminology cleanup in RTVM tutorial
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-02 10:37:07 -08:00
Amy Reyes 30875208a6 doc: terminology cleanup in openstack and hld images
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-12-01 11:25:11 -08:00