From patchwork Tue Nov 12 16:33:11 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Corey Minyard X-Patchwork-Id: 290717 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id BC7E72C00AB for ; Wed, 13 Nov 2013 03:42:59 +1100 (EST) Received: from localhost ([::1]:43909 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VgH3J-0000iO-UA for incoming@patchwork.ozlabs.org; Tue, 12 Nov 2013 11:42:57 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58589) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VgGuG-0004i5-Ki for qemu-devel@nongnu.org; Tue, 12 Nov 2013 11:33:47 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VgGu5-0007MD-3b for qemu-devel@nongnu.org; Tue, 12 Nov 2013 11:33:36 -0500 Received: from mail-oa0-x22d.google.com ([2607:f8b0:4003:c02::22d]:53325) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VgGu4-0007Li-UF for qemu-devel@nongnu.org; Tue, 12 Nov 2013 11:33:25 -0500 Received: by mail-oa0-f45.google.com with SMTP id m1so4168172oag.32 for ; Tue, 12 Nov 2013 08:33:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=Km4UUb2EM9vXfanpQscwjxZdGAaewMXPI4PKhrfoTGY=; b=CwpFQvnwzz67VSUkzaxdVXSCYjGVEw2tYCGC6/o4GIbI+1rErAJcKhTPZ4Xii6+U2A XSyfY21ILiXBcBM1s/hCsrE2/kKIC25mnclIiGIM7bnGX04L+67/SFoRpLM5oTqmEzp3 6mcFwm0ipw6BRagxWvP29pstp1u24Z7yKYCphOFybC2TS6N+KX3w/xRpYTGAjLyNspeA bETQYz/lIFpUgrPSdl1MXBAJCD8Tbavcko8/e77jGksLEc2t/06ktaonxLpZ+DfgImn0 xRr/HqPbU/yakDDbdHQRvP2syqTY+zlYJgfTI/Zug0ID7mYZYs8+3Slji2M/bjcy7Ur9 tDqw== X-Received: by 10.182.3.71 with SMTP id a7mr1720793oba.101.1384274004412; Tue, 12 Nov 2013 08:33:24 -0800 (PST) Received: from t430.minyard.home (pool-173-57-152-84.dllstx.fios.verizon.net. [173.57.152.84]) by mx.google.com with ESMTPSA id jz7sm37343032oeb.4.2013.11.12.08.33.22 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 12 Nov 2013 08:33:23 -0800 (PST) Received: from t430.minyard.home (t430.minyard.home [127.0.0.1]) by t430.minyard.home (8.14.7/8.14.7) with ESMTP id rACGXLwx016642; Tue, 12 Nov 2013 10:33:21 -0600 Received: (from cminyard@localhost) by t430.minyard.home (8.14.7/8.14.7/Submit) id rACGXLx7016641; Tue, 12 Nov 2013 10:33:21 -0600 From: Corey Minyard To: qemu-devel@nongnu.org Date: Tue, 12 Nov 2013 10:33:11 -0600 Message-Id: <1384273995-16486-13-git-send-email-cminyard@mvista.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1384273995-16486-1-git-send-email-cminyard@mvista.com> References: <1384273995-16486-1-git-send-email-cminyard@mvista.com> X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2607:f8b0:4003:c02::22d Cc: Bret Ketchum , Corey Minyard , =?UTF-8?q?Andreas=20F=C3=A4rber?= , "Michael S. Tsirkin" Subject: [Qemu-devel] [PATCH 12/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 Add some basic documentation for the IPMI device. Signed-off-by: Corey Minyard --- 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,