github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-02 16:30:12 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix doc error in ivshmem mmio registers

Browse Source 
ACRN IVSHMEM follows QEMU IVSHMEM spec. IVSHMEM supports MSIx interrupt
for doorbell mode. The document of ivshmem high level design is
out-of-date. This patch update the mmio register definition of doorbell
mode support.

Tracked-On: #5407

Signed-off-by: Jiayuan Yang <jiayuan.yang@intel.com>
This commit is contained in:
Jiayuan Yang 2024-10-28 21:50:34 -04:00
parent 95859dea34
commit 3a4946ad08
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/developer-guides/hld/ivshmem-hld.rst
View File

@ -107,22 +107,23 @@ MMIO Registers Definition
- 0x0 - 0x0
- R/W - R/W
- Interrupt Mask register is used for legacy interrupt. - Interrupt Mask register is used for legacy interrupt.
ivshmem doesn't support interrupts, so this register is reserved. IVSHMEM doesn't support legacy INTx interrupts, so this register
is reserved.
* - IVSHMEM\_IRQ\_STA\_REG * - IVSHMEM\_IRQ\_STA\_REG
- 0x4 - 0x4
- R/W - R/W
- Interrupt Status register is used for legacy interrupt. - Interrupt Status register is used for legacy interrupt.
ivshmem doesn't support interrupts, so this register is reserved. IVSHMEM doesn't support legacy INTx interrupts, so this register
is reserved.
* - IVSHMEM\_IV\_POS\_REG * - IVSHMEM\_IV\_POS\_REG
- 0x8 - 0x8
- RO - RO
- Inter-VM Position register is used to identify the VM ID. - Inter-VM Position register is used to identify the VM ID.
Its value is zero. Its value is equal to device ID.
* - IVSHMEM\_DOORBELL\_REG * - IVSHMEM\_DOORBELL\_REG
- 0xC - 0xC
- WO - WO
- Doorbell register is used to trigger an interrupt to the peer VM. - Doorbell register is used to trigger an interrupt to the peer VM.
ivshmem doesn't support interrupts.
Usage Usage
***** *****