Re: [Qemu-devel] [PATCH v15.1 4/6] pvpanic: add document of pvpanic

[Eric Blake]

On 03/25/2013 09:03 PM, Hu Tao wrote:
> Signed-off-by: Hu Tao <address@hidden>
> ---
>  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.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature