From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58979) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YlQ75-0007PW-Jn for qemu-devel@nongnu.org; Thu, 23 Apr 2015 19:00:56 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YlQ73-0005Em-PW for qemu-devel@nongnu.org; Thu, 23 Apr 2015 19:00:55 -0400 Received: from mail-ie0-x22e.google.com ([2607:f8b0:4001:c03::22e]:33289) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YlQ73-0005Eg-IE for qemu-devel@nongnu.org; Thu, 23 Apr 2015 19:00:53 -0400 Received: by iecrt8 with SMTP id rt8so72194236iec.0 for ; Thu, 23 Apr 2015 16:00:53 -0700 (PDT) Sender: Corey Minyard From: minyard@acm.org Date: Thu, 23 Apr 2015 17:57:49 -0500 Message-Id: <1429829878-26862-9-git-send-email-minyard@acm.org> In-Reply-To: <1429829878-26862-1-git-send-email-minyard@acm.org> References: <1429829878-26862-1-git-send-email-minyard@acm.org> Subject: [Qemu-devel] [PATCH 08/17] ipmi: Add documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: Corey Minyard From: Corey Minyard Add some basic documentation for the IPMI device. Signed-off-by: Corey Minyard --- qemu-options.hx | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/qemu-options.hx b/qemu-options.hx index 319d971..598c631 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -373,6 +373,44 @@ 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 ACPI and SMBIOS entries, +if appropriate. 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. +This address is the BMC's address on the I2C network of management +controllers. If you don't know what this means, it is safe to ignore +it. +@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