From patchwork Tue Jun 9 01:12:02 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Corey Minyard X-Patchwork-Id: 482065 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)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4B54214031F for ; Tue, 9 Jun 2015 11:14:20 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b=N+2jmGms; dkim-atps=neutral Received: from localhost ([::1]:60771 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z287O-0005rJ-Dc for incoming@patchwork.ozlabs.org; Mon, 08 Jun 2015 21:14:18 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:50935) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z285b-0002Q7-Nx for qemu-devel@nongnu.org; Mon, 08 Jun 2015 21:12:30 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Z285Y-0000mv-Dr for qemu-devel@nongnu.org; Mon, 08 Jun 2015 21:12:27 -0400 Received: from mail-yh0-x22a.google.com ([2607:f8b0:4002:c01::22a]:33085) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Z285Y-0000mr-A0 for qemu-devel@nongnu.org; Mon, 08 Jun 2015 21:12:24 -0400 Received: by yhpn97 with SMTP id n97so1802087yhp.0 for ; Mon, 08 Jun 2015 18:12:24 -0700 (PDT) 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=wJiVX3ZYSAmDoGDRmt4lUDd5eS4dLyM+8zoWnFAUD8E=; b=N+2jmGms8198hYjrwNBij2o6IzwVe2hTX6AEq+bu1Z/0CLxhF1KiFw8vOsmSlNO6I0 AwKrUO5OpsBapx+qdMkvXStRZI0aCR7XbW3wQsEkOCQhhpkD/hOhPeBmWKgTFuiIYE62 1W8elNr2kib+LIiwzidCzxSBXIV1PoZlF/E1pQL6z3ijGFapyXqKn0SwO0YPcgZst1u6 hO6rz9hGrVH1GCYTdU707UgqMuYcIZ+EuRK/wm6cP4N2eRvhfgEhFIZ0DsCxqBz1QrRb My/sty5IOBwTony1HIeKwVLq4/GeLZd3US7GnBAkMfWObB3wCPH8KC2bJhOVJGcXxudv CcTg== X-Received: by 10.170.135.205 with SMTP id b196mr21683092ykc.27.1433812344098; Mon, 08 Jun 2015 18:12:24 -0700 (PDT) Received: from t430.minyard.home ([12.218.212.2]) by mx.google.com with ESMTPSA id d15sm3031843ywe.34.2015.06.08.18.12.21 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 08 Jun 2015 18:12:23 -0700 (PDT) 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 t591CKWx019561; Mon, 8 Jun 2015 20:12:20 -0500 Received: (from cminyard@localhost) by t430.minyard.home (8.14.7/8.14.7/Submit) id t591CKnw019560; Mon, 8 Jun 2015 20:12:20 -0500 From: minyard@acm.org To: qemu-devel@nongnu.org Date: Mon, 8 Jun 2015 20:12:02 -0500 Message-Id: <1433812331-18993-8-git-send-email-minyard@acm.org> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1433812331-18993-1-git-send-email-minyard@acm.org> References: <1433812331-18993-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:4002:c01::22a Cc: Corey Minyard Subject: [Qemu-devel] [PATCH v3 07/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 | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/qemu-options.hx b/qemu-options.hx index 319d971..f2bc344 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -373,6 +373,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,