diff mbox

[12/16] ipmi: Add documentation

Message ID 1384273995-16486-13-git-send-email-cminyard@mvista.com
State New
Headers show

Commit Message

Corey Minyard Nov. 12, 2013, 4:33 p.m. UTC
Add some basic documentation for the IPMI device.

Signed-off-by: Corey Minyard <cminyard@mvista.com>
---
 qemu-options.hx | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

Comments

Bret Ketchum Nov. 13, 2013, 4:08 p.m. UTC | #1
The actual default I/O address for KCS is 0xca2.


On Tue, Nov 12, 2013 at 10:33 AM, Corey Minyard <minyard@acm.org> wrote:

> Add some basic documentation for the IPMI device.
>
> Signed-off-by: Corey Minyard <cminyard@mvista.com>
> ---
>  qemu-options.hx | 35 +++++++++++++++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 5bcfaa0..500d7c8 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -327,6 +327,41 @@ Add device @var{driver}.  @var{prop}=@var{value} sets
> driver
>  properties.  Valid properties depend on the driver.  To get help on
>  possible drivers and properties, use @code{-device help} and
>  @code{-device @var{driver},help}.
> +
> +Some drivers are:
> +@item -device
> isa-ipmi[,interface=kcs|bt][,iobase=@var{val}][,irq=@var{val}][,slave_addr=@var{val}][,chardev=name]
> +
> +Add an IPMI device.  This also adds a corresponding SMBIOS entry to the
> +SMBIOS tables for x86.  The following options are handled:
> +@table @option
> +@item interface=kcs|bt
> +Define the interface type to use.  Currently the IPMI-defined KCS and
> +BT interfaces are handled.  The default is KCS.
> +@item iobase=@var{val}
> +Define the I/O address of the interface.  The default is 0xca0 for KCS
> +and 0xe4 for BT.
> +@item irq=@var{val}
> +Define the interrupt to use.  The default is 5.  To disable interrupts,
> +set this to 0.
> +@item slave_addr=@var{val}
> +The IPMI slave address to use for the BMC.  The default is 0x20.
> +@item chardev=name
> +If a chardev is not specified, the IPMI driver uses a built-in baseboard
> +management controller (BMC) simulator.  It provides a basic BMC with a
> +watchdog timer and associated sensor.
> +
> +If a chardev is specified, A connection is made to an external BMC
> +simulator.  If you do this, it is strongly recommended that you use
> +the "reconnect=" chardev option to reconnect to the simulator if the
> +connection is lost.  Note that if this is not used carefully, it can
> +be a security issue, as the interface has the ability to send resets,
> +NMIs, and power off the VM.  It's best if QEMU makes a connection to
> +an external simulator running on a secure port on localhost, so
> +neither the simulator nor QEMU is exposed to any outside network.
> +
> +See the "lanserv/README.vm" file in the OpenIPMI library for more
> +details on the external interface.
> +@end table
>  ETEXI
>
>  DEF("name", HAS_ARG, QEMU_OPTION_name,
> --
> 1.8.3.1
>
>
diff mbox

Patch

diff --git a/qemu-options.hx b/qemu-options.hx
index 5bcfaa0..500d7c8 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -327,6 +327,41 @@  Add device @var{driver}.  @var{prop}=@var{value} sets driver
 properties.  Valid properties depend on the driver.  To get help on
 possible drivers and properties, use @code{-device help} and
 @code{-device @var{driver},help}.
+
+Some drivers are:
+@item -device isa-ipmi[,interface=kcs|bt][,iobase=@var{val}][,irq=@var{val}][,slave_addr=@var{val}][,chardev=name]
+
+Add an IPMI device.  This also adds a corresponding SMBIOS entry to the
+SMBIOS tables for x86.  The following options are handled:
+@table @option
+@item interface=kcs|bt
+Define the interface type to use.  Currently the IPMI-defined KCS and
+BT interfaces are handled.  The default is KCS.
+@item iobase=@var{val}
+Define the I/O address of the interface.  The default is 0xca0 for KCS
+and 0xe4 for BT.
+@item irq=@var{val}
+Define the interrupt to use.  The default is 5.  To disable interrupts,
+set this to 0.
+@item slave_addr=@var{val}
+The IPMI slave address to use for the BMC.  The default is 0x20.
+@item chardev=name
+If a chardev is not specified, the IPMI driver uses a built-in baseboard
+management controller (BMC) simulator.  It provides a basic BMC with a
+watchdog timer and associated sensor.
+
+If a chardev is specified, A connection is made to an external BMC
+simulator.  If you do this, it is strongly recommended that you use
+the "reconnect=" chardev option to reconnect to the simulator if the
+connection is lost.  Note that if this is not used carefully, it can
+be a security issue, as the interface has the ability to send resets,
+NMIs, and power off the VM.  It's best if QEMU makes a connection to
+an external simulator running on a secure port on localhost, so
+neither the simulator nor QEMU is exposed to any outside network.
+
+See the "lanserv/README.vm" file in the OpenIPMI library for more
+details on the external interface.
+@end table
 ETEXI
 
 DEF("name", HAS_ARG, QEMU_OPTION_name,