doc: add IVSHMEM region ID support

Add guide to configure IVSHMEM Region ID. Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2024-08-26 20:24:16 +08:00 · 2024-08-26 20:24:16 +08:00 · 7d15cc5255
parent eae668268e
commit 7d15cc5255
2 changed files with 4 additions and 1 deletions
--- a/doc/tutorials/enable_ivshmem.rst
+++ b/doc/tutorials/enable_ivshmem.rst
@ -67,6 +67,9 @@ For the shared memory region:
 #. Enter a name for the shared memory region.
 #. Select the source of the emulation, either Hypervisor or Device Model.
 #. Select the size of the shared memory region.
+#. **Enter shared memory region ID, which can be in hexadecimal or decimal format**.
+    .. note::
+       Default value is 0 and IDs in 0x001 ~ 0xFFF  are reserved, 0x1000 ~ 0xFFFF are available.
 #. Select at least two VMs that can use the shared memory region.
 #. Enter a virtual Board:Device.Function (BDF) address for each VM or leave it
   blank. If the field is blank, the tool provides an address when the
--- a/doc/tutorials/images/configurator-ivshmem02.png
+++ b/doc/tutorials/images/configurator-ivshmem02.png