michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: ivshmem: Simple syntax correction

Browse source 
Correct some trivial syntax issues in ivshmem.rst.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2023-08-28 14:21:20 +03:00 • committed by Anas Nashif
commit 8e0fc8095e
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/services/virtualization/ivshmem.rst
View file

@ -16,7 +16,7 @@ it might be necessary to make VMs aware of each other, or aware of the host.
This is made possible by exposing a shared memory among parties via a feature This is made possible by exposing a shared memory among parties via a feature
called ivshmem, which stands for inter-VM Shared Memory. called ivshmem, which stands for inter-VM Shared Memory.
The Two types are supported: a plain shared memory (ivshmem-plain) or a shared The two types are supported: a plain shared memory (ivshmem-plain) or a shared
memory with the ability for a VM to generate an interruption on another, and memory with the ability for a VM to generate an interruption on another, and
thus to be interrupted as well itself (ivshmem-doorbell). thus to be interrupted as well itself (ivshmem-doorbell).
@ -26,13 +26,13 @@ Please refer to the official `Qemu ivshmem documentation
Support Support
******* *******
Zephyr supports both version: plain and doorbell. Ivshmem driver can be build Zephyr supports both versions: plain and doorbell. Ivshmem driver can be built
by enabling :kconfig:option:`CONFIG_IVSHMEM`. By default, this will expose the plain by enabling :kconfig:option:`CONFIG_IVSHMEM`. By default, this will expose the plain
version. :kconfig:option:`CONFIG_IVSHMEM_DOORBELL` needs to be enabled to get the version. :kconfig:option:`CONFIG_IVSHMEM_DOORBELL` needs to be enabled to get the
doorbell version. doorbell version.
Because the doorbell version uses MSI-X vectors to support notification vectors, Because the doorbell version uses MSI-X vectors to support notification vectors,
the :kconfig:option:`CONFIG_IVSHMEM_MSI_X_VECTORS` has to be tweaked to the amount of the :kconfig:option:`CONFIG_IVSHMEM_MSI_X_VECTORS` has to be tweaked to the number of
vectors that will be needed. vectors that will be needed.
Note that a tiny shell module can be exposed to test the ivshmem feature by Note that a tiny shell module can be exposed to test the ivshmem feature by