From 8c8dfdca9af2c146e51065161ba5080ccbe9ae57 Mon Sep 17 00:00:00 2001 From: Jiayuan Yang Date: Mon, 28 Oct 2024 21:50:34 -0400 Subject: [PATCH] doc: fix doc error in ivshmem mmio registers 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 Signed-off-by: Shiqing Gao --- doc/developer-guides/hld/ivshmem-hld.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/developer-guides/hld/ivshmem-hld.rst b/doc/developer-guides/hld/ivshmem-hld.rst index 5401c4796..69bea473e 100644 --- a/doc/developer-guides/hld/ivshmem-hld.rst +++ b/doc/developer-guides/hld/ivshmem-hld.rst @@ -107,22 +107,23 @@ MMIO Registers Definition - 0x0 - R/W - 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 - 0x4 - R/W - 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 - 0x8 - RO - - Inter-VM Position register is used to identify the VM ID. - Its value is zero. + - Inter-VM Position register is used to identify the device. + Its value is equal to the ID of the VM (to which the device belongs), in the context of ACRN. * - IVSHMEM\_DOORBELL\_REG - 0xC - WO - Doorbell register is used to trigger an interrupt to the peer VM. - ivshmem doesn't support interrupts. Usage *****