[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 13/33] docs/specs/virt-ctlr: Convert to rST
|
From: |
Peter Maydell |
|
Subject: |
[PULL 13/33] docs/specs/virt-ctlr: Convert to rST |
|
Date: |
Thu, 2 Nov 2023 17:38:15 +0000 |
Convert docs/specs/virt-ctlr.txt to rST format.
I added the name of the device to give readers a bit more idea
of which device we're actually documenting here.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20230927151205.70930-7-peter.maydell@linaro.org
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
MAINTAINERS | 1 +
docs/specs/index.rst | 1 +
docs/specs/{virt-ctlr.txt => virt-ctlr.rst} | 12 +++++-------
3 files changed, 7 insertions(+), 7 deletions(-)
rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%)
diff --git a/MAINTAINERS b/MAINTAINERS
index b5e1765d7a6..11f3bdbfa78 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1283,6 +1283,7 @@ F: include/hw/char/goldfish_tty.h
F: include/hw/intc/goldfish_pic.h
F: include/hw/intc/m68k_irqc.h
F: include/hw/misc/virt_ctrl.h
+F: docs/specs/virt-ctlr.rst
MicroBlaze Machines
-------------------
diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index ee84b8109d6..8d30968650b 100644
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -29,3 +29,4 @@ guest hardware that is specific to QEMU.
ivshmem-spec
pvpanic
standard-vga
+ virt-ctlr
diff --git a/docs/specs/virt-ctlr.txt b/docs/specs/virt-ctlr.rst
similarity index 70%
rename from docs/specs/virt-ctlr.txt
rename to docs/specs/virt-ctlr.rst
index 24d38084f7f..ad3edde82d2 100644
--- a/docs/specs/virt-ctlr.txt
+++ b/docs/specs/virt-ctlr.rst
@@ -1,9 +1,9 @@
Virtual System Controller
=========================
-This device is a simple interface defined for the pure virtual machine with no
-hardware reference implementation to allow the guest kernel to send command
-to the host hypervisor.
+The ``virt-ctrl`` device is a simple interface defined for the pure
+virtual machine with no hardware reference implementation to allow the
+guest kernel to send command to the host hypervisor.
The specification can evolve, the current state is defined as below.
@@ -11,14 +11,12 @@ This is a MMIO mapped device using 256 bytes.
Two 32bit registers are defined:
-1- the features register (read-only, address 0x00)
-
+the features register (read-only, address 0x00)
This register allows the device to report features supported by the
controller.
The only feature supported for the moment is power control (0x01).
-2- the command register (write-only, address 0x04)
-
+the command register (write-only, address 0x04)
This register allows the kernel to send the commands to the hypervisor.
The implemented commands are part of the power control feature and
are reset (1), halt (2) and panic (3).
--
2.34.1
- [PULL 28/33] hw/char/stm32f2xx_usart: Update IRQ when DR is written, (continued)
- [PULL 28/33] hw/char/stm32f2xx_usart: Update IRQ when DR is written, Peter Maydell, 2023/11/02
- [PULL 31/33] hw/misc: Introduce AMD/Xilix Versal TRNG device, Peter Maydell, 2023/11/02
- [PULL 32/33] hw/arm: xlnx-versal-virt: Add AMD/Xilinx TRNG device, Peter Maydell, 2023/11/02
- [PULL 12/33] docs/specs/standard-vga: Convert to rST, Peter Maydell, 2023/11/02
- [PULL 20/33] hw/misc/imx7_snvs: Trace MMIO access, Peter Maydell, 2023/11/02
- [PULL 02/33] hw/input/stellaris_input: Rename to stellaris_gamepad, Peter Maydell, 2023/11/02
- [PULL 33/33] tests/qtest: Introduce tests for AMD/Xilinx Versal TRNG device, Peter Maydell, 2023/11/02
- [PULL 22/33] hw/i2c/pm_smbus: Convert DPRINTF to trace events, Peter Maydell, 2023/11/02
- [PULL 26/33] target/arm: Fix SVE STR increment, Peter Maydell, 2023/11/02
- [PULL 29/33] hw/char/stm32f2xx_usart: Add more definitions for CR1 register, Peter Maydell, 2023/11/02
- [PULL 13/33] docs/specs/virt-ctlr: Convert to rST,
Peter Maydell <=
- [PULL 25/33] target/arm: Make FEAT_MOPS SET* insns handle Xs == XZR correctly, Peter Maydell, 2023/11/02
- [PULL 16/33] MAINTAINERS: Make sure that gicv3_internal.h is covered, too, Peter Maydell, 2023/11/02
- [PULL 04/33] qdev: Add qdev_prop_set_array(), Peter Maydell, 2023/11/02
- [PULL 21/33] hw/misc/imx6_ccm: Convert DPRINTF to trace events, Peter Maydell, 2023/11/02
- [PULL 23/33] target/arm: Enable FEAT_MOPS insns in user-mode emulation, Peter Maydell, 2023/11/02
- [PULL 27/33] hw/char/stm32f2xx_usart: Extract common IRQ update code to update_irq(), Peter Maydell, 2023/11/02
- Re: [PULL 00/33] target-arm queue, Stefan Hajnoczi, 2023/11/02