Kaynağa Gözat

docs/specs/virt-ctlr: Convert to rST

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>
Peter Maydell 1 yıl önce
ebeveyn
işleme
6e0c849275
3 değiştirilmiş dosya ile 7 ekleme ve 7 silme
  1. 1 0
      MAINTAINERS
  2. 1 0
      docs/specs/index.rst
  3. 5 7
      docs/specs/virt-ctlr.rst

+ 1 - 0
MAINTAINERS

@@ -1283,6 +1283,7 @@ F: include/hw/char/goldfish_tty.h
 F: include/hw/intc/goldfish_pic.h
 F: include/hw/intc/goldfish_pic.h
 F: include/hw/intc/m68k_irqc.h
 F: include/hw/intc/m68k_irqc.h
 F: include/hw/misc/virt_ctrl.h
 F: include/hw/misc/virt_ctrl.h
+F: docs/specs/virt-ctlr.rst
 
 
 MicroBlaze Machines
 MicroBlaze Machines
 -------------------
 -------------------

+ 1 - 0
docs/specs/index.rst

@@ -29,3 +29,4 @@ guest hardware that is specific to QEMU.
    ivshmem-spec
    ivshmem-spec
    pvpanic
    pvpanic
    standard-vga
    standard-vga
+   virt-ctlr

+ 5 - 7
docs/specs/virt-ctlr.txt → docs/specs/virt-ctlr.rst

@@ -1,9 +1,9 @@
 Virtual System Controller
 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.
 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:
 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
    This register allows the device to report features supported by the
    controller.
    controller.
    The only feature supported for the moment is power control (0x01).
    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.
    This register allows the kernel to send the commands to the hypervisor.
    The implemented commands are part of the power control feature and
    The implemented commands are part of the power control feature and
    are reset (1), halt (2) and panic (3).
    are reset (1), halt (2) and panic (3).