From patchwork Tue Sep 18 20:00:42 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Corey Minyard X-Patchwork-Id: 184836 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id A04882C0094 for ; Wed, 19 Sep 2012 06:09:03 +1000 (EST) Received: from localhost ([::1]:53632 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TE46P-0004Gu-HL for incoming@patchwork.ozlabs.org; Tue, 18 Sep 2012 16:09:01 -0400 Received: from eggs.gnu.org ([208.118.235.92]:43356) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TE46J-0004GO-Bi for qemu-devel@nongnu.org; Tue, 18 Sep 2012 16:08:56 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TE46I-0006us-69 for qemu-devel@nongnu.org; Tue, 18 Sep 2012 16:08:55 -0400 Received: from vms173013pub.verizon.net ([206.46.173.13]:57482) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TE46I-0006uk-1D for qemu-devel@nongnu.org; Tue, 18 Sep 2012 16:08:54 -0400 Received: from wf-rch.minyard.home ([unknown] [173.57.151.210]) by vms173013.mailsrvcs.net (Sun Java(tm) System Messaging Server 7u2-7.02 32bit (built Apr 16 2009)) with ESMTPA id <0MAK00CR7AM8VUH2@vms173013.mailsrvcs.net> for qemu-devel@nongnu.org; Tue, 18 Sep 2012 15:08:36 -0500 (CDT) Received: from i.minyard.home (i2.minyard.home [192.168.27.116]) by wf-rch.minyard.home (Postfix) with ESMTP id 546C31F95F; Tue, 18 Sep 2012 15:00:53 -0500 (CDT) Received: by i.minyard.home (Postfix, from userid 1000) id DE1C483FD1; Tue, 18 Sep 2012 15:00:50 -0500 (CDT) From: minyard@acm.org To: qemu-devel@nongnu.org Date: Tue, 18 Sep 2012 15:00:42 -0500 Message-id: <1347998443-20599-16-git-send-email-minyard@acm.org> X-Mailer: git-send-email 1.7.4.1 In-reply-to: <1347998443-20599-1-git-send-email-minyard@acm.org> References: <1347998443-20599-1-git-send-email-minyard@acm.org> X-detected-operating-system: by eggs.gnu.org: Solaris 10 (1203?) X-Received-From: 206.46.173.13 Cc: Corey Minyard Subject: [Qemu-devel] [PATCH 15/16] IPMI: Add documentation. X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org From: Corey Minyard Add some basic documentation for the IPMI device. Signed-off-by: Corey Minyard --- qemu-options.hx | 35 +++++++++++++++++++++++++++++++++++ 1 files changed, 35 insertions(+), 0 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index d60af6a..748758b 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -565,6 +565,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 ?} and @code{-device @var{driver},?}. + +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 DEFHEADING()