Patchwork [v15.1,4/6] pvpanic: add document of pvpanic

login
register
mail settings
Submitter Hu Tao
Date March 26, 2013, 3:03 a.m.
Message ID <1364267011-31975-1-git-send-email-hutao@cn.fujitsu.com>
Download mbox | patch
Permalink /patch/231053/
State New
Headers show

Comments

Hu Tao - March 26, 2013, 3:03 a.m.
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
---
 docs/specs/pvpanic.txt | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/specs/pvpanic.txt
Paolo Bonzini - March 26, 2013, 9:21 a.m.
Il 26/03/2013 04:03, Hu Tao ha scritto:
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  docs/specs/pvpanic.txt | 35 +++++++++++++++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 docs/specs/pvpanic.txt
> 
> diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
> new file mode 100644
> index 0000000..1f14063
> --- /dev/null
> +++ b/docs/specs/pvpanic.txt
> @@ -0,0 +1,35 @@
> +PVPANIC DEVICE
> +==============
> +
> +pvpanic device is a simulated ISA device, through which a guest panic
> +event is sent to qemu, and a QMP event is generated. This allows
> +management apps (e.g. libvirt) to be notified and respond to the event.
> +
> +The management app has the option of waiting for GUEST_PANICKED events,
> +and/or polling for guest-panicked RunState, to learn when the pvpanic
> +device has fired a panic event.
> +
> +ISA Interface
> +-------------
> +
> +pvpanic uses port 0x505 to receive a panic event from the guest. On
> +written, bit 0 is set to indicate guest panic has happened. On read, bit
> +0 is set to indicate guest panic notification is supported.
> +
> +ACPI Interface
> +--------------
> +
> +pvpanic device is defined with ACPI ID "QEMU0001". Custom methods:
> +
> +RDPT:       To determine whether guest panic notification is supported.
> +Rrguments:  None
> +Return:     Returns a byte, bit 0 set to indicate guest panic
> +            notification is supported.
> +
> +WRPT:       To send a guest panic event
> +Arguments:  Arg0 is a byte, with bit 0 set to indicate guest panic has
> +            happened.
> +Return:     None
> +
> +The ACPI device will automatically refer to the right port in case it
> +is modified.
> 

Looks good.

Paolo
Eric Blake - March 26, 2013, 3:07 p.m.
On 03/25/2013 09:03 PM, Hu Tao wrote:
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  docs/specs/pvpanic.txt | 35 +++++++++++++++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 docs/specs/pvpanic.txt

> +ISA Interface
> +-------------
> +
> +pvpanic uses port 0x505 to receive a panic event from the guest. On
> +written, bit 0 is set to indicate guest panic has happened. On read, bit

s/written/write/

Also, mention that the remaining bits are reserved, and should be
written as 0, and ignored on read (that way, the spec can be updated
when we define a later bit, and older hosts won't be trying to set or
act on bits they don't understand).


> +ACPI Interface
> +--------------
> +
> +pvpanic device is defined with ACPI ID "QEMU0001". Custom methods:
> +
> +RDPT:       To determine whether guest panic notification is supported.
> +Rrguments:  None
> +Return:     Returns a byte, bit 0 set to indicate guest panic
> +            notification is supported.
> +
> +WRPT:       To send a guest panic event
> +Arguments:  Arg0 is a byte, with bit 0 set to indicate guest panic has
> +            happened.

Again, documenting that the remaining bits are reserved (write 0, ignore
on read) is a wise addition.

Patch

diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
new file mode 100644
index 0000000..1f14063
--- /dev/null
+++ b/docs/specs/pvpanic.txt
@@ -0,0 +1,35 @@ 
+PVPANIC DEVICE
+==============
+
+pvpanic device is a simulated ISA device, through which a guest panic
+event is sent to qemu, and a QMP event is generated. This allows
+management apps (e.g. libvirt) to be notified and respond to the event.
+
+The management app has the option of waiting for GUEST_PANICKED events,
+and/or polling for guest-panicked RunState, to learn when the pvpanic
+device has fired a panic event.
+
+ISA Interface
+-------------
+
+pvpanic uses port 0x505 to receive a panic event from the guest. On
+written, bit 0 is set to indicate guest panic has happened. On read, bit
+0 is set to indicate guest panic notification is supported.
+
+ACPI Interface
+--------------
+
+pvpanic device is defined with ACPI ID "QEMU0001". Custom methods:
+
+RDPT:       To determine whether guest panic notification is supported.
+Rrguments:  None
+Return:     Returns a byte, bit 0 set to indicate guest panic
+            notification is supported.
+
+WRPT:       To send a guest panic event
+Arguments:  Arg0 is a byte, with bit 0 set to indicate guest panic has
+            happened.
+Return:     None
+
+The ACPI device will automatically refer to the right port in case it
+is modified.