docs/specs/pvpanic: Convert to rST

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>
This commit is contained in:
Peter Maydell 2023-09-27 16:12:01 +01:00
parent bb1cff6ee0
commit 945f3fd4e4
2 changed files with 28 additions and 14 deletions

View File

@ -27,3 +27,4 @@ guest hardware that is specific to QEMU.
vmw_pvscsi-spec vmw_pvscsi-spec
edu edu
ivshmem-spec ivshmem-spec
pvpanic

View File

@ -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. Software should set only bits both itself and the device recognize.
Bit Definition 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; bit 0
the host should record it or report it, but should not affect a guest panic has happened and should be processed by the host
the execution of the guest. 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 PCI Interface
------------- -------------
The PCI interface is similar to the ISA interface except that it uses an MMIO 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 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. line.
ACPI Interface ACPI Interface
@ -40,15 +43,25 @@ ACPI Interface
pvpanic device is defined with ACPI ID "QEMU0001". Custom methods: pvpanic device is defined with ACPI ID "QEMU0001". Custom methods:
RDPT: To determine whether guest panic notification is supported. RDPT
Arguments: None ~~~~
Return: Returns a byte, with the same semantics as the I/O port
interface.
WRPT: To send a guest panic event To determine whether guest panic notification is supported.
Arguments: Arg0 is a byte to be written, with the same semantics as
the I/O interface. Arguments
Return: None None
Return
Returns a byte, with the same semantics as the I/O port interface.
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
The ACPI device will automatically refer to the right port in case it The ACPI device will automatically refer to the right port in case it
is modified. is modified.