From patchwork Thu Nov 12 19:02:24 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Corey Minyard X-Patchwork-Id: 56472 Delivered-To: patch@linaro.org Received: by 10.112.155.196 with SMTP id vy4csp600105lbb; Thu, 12 Nov 2015 11:13:56 -0800 (PST) X-Received: by 10.129.10.214 with SMTP id 205mr16513313ywk.7.1447355636344; Thu, 12 Nov 2015 11:13:56 -0800 (PST) Return-Path: Received: from lists.gnu.org (lists.gnu.org. [2001:4830:134:3::11]) by mx.google.com with ESMTPS id z133si10472477ywb.9.2015.11.12.11.13.56 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 12 Nov 2015 11:13:56 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 2001:4830:134:3::11 as permitted sender) client-ip=2001:4830:134:3::11; Authentication-Results: mx.google.com; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 2001:4830:134:3::11 as permitted sender) smtp.mailfrom=qemu-devel-bounces+patch=linaro.org@nongnu.org; dkim=fail header.i=@gmail.com Received: from localhost ([::1]:49317 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZwxJj-0005U0-U0 for patch@linaro.org; Thu, 12 Nov 2015 14:13:55 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58675) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zwx8y-0001QU-Cf for qemu-devel@nongnu.org; Thu, 12 Nov 2015 14:02:52 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Zwx8x-00051B-4H for qemu-devel@nongnu.org; Thu, 12 Nov 2015 14:02:48 -0500 Received: from mail-pa0-x231.google.com ([2607:f8b0:400e:c03::231]:35481) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zwx8w-000511-Vb for qemu-devel@nongnu.org; Thu, 12 Nov 2015 14:02:47 -0500 Received: by pasz6 with SMTP id z6so75685372pas.2 for ; Thu, 12 Nov 2015 11:02:46 -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=SCwJkbGyvRpLCMV97/2UTygXH1aZE3rc8Chw/vdRj00=; b=XTxW7W1hgpvIzBJyPrZSPAL0lpE93reGm18pW78s72rUev/YR0HDuymeHVuacMLqYF d731yaZNKDUO8o0HptOeEdVEAGHe9maCdLteqGNteRdo5GKUbjh+Dmxlx4KaXQm9Xr1U n9nTMLi114P3AYgLIaQbgimWh2SiRzvR9I6Y8AJVGvjI1XBB2qYtU5NOAa7jCwAhThrg ncloZW66Mc7NjlOHKBfcI0uj+OOcla4hP9J6gubYZc2MQNHManc7/vUpCXCRtU+3vzjS q6ByUHXCOYY8xeGNyAo7JMT5rPF2KV6tjYjSdwU3wdCvd7QTlrdEr+IyssSPuNbkvt5d fzrg== X-Received: by 10.66.140.39 with SMTP id rd7mr25875802pab.86.1447354966461; Thu, 12 Nov 2015 11:02:46 -0800 (PST) Received: from t430.minyard.home (pool-173-57-176-17.dllstx.fios.verizon.net. [173.57.176.17]) by smtp.gmail.com with ESMTPSA id fx3sm16078514pbb.60.2015.11.12.11.02.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 12 Nov 2015 11:02:45 -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 tACJ2gee019731; Thu, 12 Nov 2015 13:02:42 -0600 Received: (from cminyard@localhost) by t430.minyard.home (8.14.7/8.14.7/Submit) id tACJ2gcp019730; Thu, 12 Nov 2015 13:02:42 -0600 From: minyard@acm.org To: qemu-devel@nongnu.org, Paolo Bonzini , "Michael S. Tsirkin" , Igor Mammedov Date: Thu, 12 Nov 2015 13:02:24 -0600 Message-Id: <1447354953-18893-9-git-send-email-minyard@acm.org> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1447354953-18893-1-git-send-email-minyard@acm.org> References: <1447354953-18893-1-git-send-email-minyard@acm.org> X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2607:f8b0:400e:c03::231 Cc: Corey Minyard Subject: [Qemu-devel] [PATCH v4 08/17] 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+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Corey Minyard Add some basic documentation for the IPMI device. Signed-off-by: Corey Minyard --- qemu-options.hx | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) -- 1.8.3.1 diff --git a/qemu-options.hx b/qemu-options.hx index 0eea4ee..985d2ab 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -381,6 +381,58 @@ 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 ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}] + +Add an IPMI BMC. This is a simulation of a hardware management +interface processor that normally sits on a system. It provides +a watchdog and the ability to reset and power control the system. +You need to connect this to an IPMI interface to make it useful + +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 -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}] + +Add a connection to an external IPMI BMC simulator. Instead of +locally emulating the BMC like the above item, instead connect +to an external entity that provides the IPMI services. + +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. + +@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] + +Add a KCS IPMI interafce on the ISA bus. This also adds a +corresponding ACPI and SMBIOS entries, if appropriate. + +@table @option +@item bmc=@var{id} +The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. +@item ioport=@var{val} +Define the I/O address of the interface. The default is 0xca0 for KCS. +@item irq=@var{val} +Define the interrupt to use. The default is 5. To disable interrupts, +set this to 0. +@end table + +@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] + +Like the KCS interface, but defines a BT interface. The default port is +0xe4 and the default interrupt is 5. + ETEXI DEF("name", HAS_ARG, QEMU_OPTION_name,