From 945f3fd4e46405ed37b035922eebe2bfad6bc11e Mon Sep 17 00:00:00 2001
From: Peter Maydell <peter.maydell@linaro.org>
Date: Wed, 27 Sep 2023 16:12:01 +0100
Subject: [PATCH] docs/specs/pvpanic: Convert to rST
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit
Convert docs/specs/pvpanic.txt to rST format.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20230927151205.70930-5-peter.maydell@linaro.org
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
docs/specs/index.rst | 1 +
docs/specs/{pvpanic.txt => pvpanic.rst} | 41 ++++++++++++++++---------
2 files changed, 28 insertions(+), 14 deletions(-)
rename docs/specs/{pvpanic.txt => pvpanic.rst} (64%)
diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index e60c837754..52bfab2f68 100644
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -27,3 +27,4 @@ guest hardware that is specific to QEMU.
vmw_pvscsi-spec
edu
ivshmem-spec
+ pvpanic
diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.rst
similarity index 64%
rename from docs/specs/pvpanic.txt
rename to docs/specs/pvpanic.rst
index 8afcde11cc..f894bc1955 100644
--- a/docs/specs/pvpanic.txt
+++ b/docs/specs/pvpanic.rst
@@ -21,18 +21,21 @@ recognize. On write, the bits not recognized by the device are ignored.
Software should set only bits both itself and the device recognize.
Bit Definition
---------------
-bit 0: a guest panic has happened and should be processed by the host
-bit 1: a guest panic has happened and will be handled by the guest;
- the host should record it or report it, but should not affect
- the execution of the guest.
+~~~~~~~~~~~~~~
+
+bit 0
+ a guest panic has happened and should be processed by the host
+bit 1
+ a guest panic has happened and will be handled by the guest;
+ the host should record it or report it, but should not affect
+ the execution of the guest.
PCI Interface
-------------
The PCI interface is similar to the ISA interface except that it uses an MMIO
address space provided by its BAR0, 1 byte long. Any machine with a PCI bus
-can enable a pvpanic device by adding '-device pvpanic-pci' to the command
+can enable a pvpanic device by adding ``-device pvpanic-pci`` to the command
line.
ACPI Interface
@@ -40,15 +43,25 @@ ACPI Interface
pvpanic device is defined with ACPI ID "QEMU0001". Custom methods:
-RDPT: To determine whether guest panic notification is supported.
-Arguments: None
-Return: Returns a byte, with the same semantics as the I/O port
- interface.
+RDPT
+~~~~
+
+To determine whether guest panic notification is supported.
+
+Arguments
+ None
+Return
+ Returns a byte, with the same semantics as the I/O port interface.
+
+WRPT
+~~~~
+
+To send a guest panic event.
-WRPT: To send a guest panic event
-Arguments: Arg0 is a byte to be written, with the same semantics as
- the I/O interface.
-Return: None
+Arguments
+ Arg0 is a byte to be written, with the same semantics as the I/O interface.
+Return
+ None
The ACPI device will automatically refer to the right port in case it
is modified.
--
2.30.2