[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 19/55] ipmi: Add documentation
From: |
Michael S. Tsirkin |
Subject: |
[Qemu-devel] [PULL 19/55] ipmi: Add documentation |
Date: |
Tue, 22 Dec 2015 18:53:35 +0200 |
From: Corey Minyard <address@hidden>
Add some basic documentation for the IPMI device.
Signed-off-by: Corey Minyard <address@hidden>
Reviewed-by: Michael S. Tsirkin <address@hidden>
Signed-off-by: Michael S. Tsirkin <address@hidden>
---
qemu-options.hx | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
diff --git a/qemu-options.hx b/qemu-options.hx
index 49afe6c..94ab880 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -382,6 +382,58 @@ Add device @var{driver}. @address@hidden 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:
address@hidden -device ipmi-bmc-sim,address@hidden,address@hidden
+
+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.
+
address@hidden -device
ipmi-bmc-extern,address@hidden,address@hidden,address@hidden
+
+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.
+
address@hidden -device isa-ipmi-kcs,address@hidden,address@hidden,address@hidden
+
+Add a KCS IPMI interafce on the ISA bus. This also adds a
+corresponding ACPI and SMBIOS entries, if appropriate.
+
address@hidden @option
address@hidden address@hidden
+The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above.
address@hidden address@hidden
+Define the I/O address of the interface. The default is 0xca0 for KCS.
address@hidden address@hidden
+Define the interrupt to use. The default is 5. To disable interrupts,
+set this to 0.
address@hidden table
+
address@hidden -device isa-ipmi-bt,address@hidden,address@hidden,address@hidden
+
+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,
--
MST
- [Qemu-devel] [PULL 09/55] hw/pxb: introduce pxb-pcie expander for PCIe machines, (continued)
- [Qemu-devel] [PULL 09/55] hw/pxb: introduce pxb-pcie expander for PCIe machines, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 11/55] q35: Remove MCHPCIState.guest_info field, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 12/55] pc: Group and document related PCMachineState/PCMachineclass fields, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 13/55] Add a base IPMI interface, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 15/55] ipmi: Add an external connection simulation interface, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 14/55] ipmi: Add a local BMC simulation, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 17/55] ipmi: Add a BT low-level interface, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 16/55] ipmi: Add an ISA KCS low-level interface, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 18/55] ipmi: Add tests, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 20/55] ipmi: Add migration capability to the IPMI devices., Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 19/55] ipmi: Add documentation,
Michael S. Tsirkin <=
- [Qemu-devel] [PULL 23/55] ipmi: Add a force off function, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 22/55] ipmi: Add firmware registration to the ISA interface, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 21/55] ipmi: Add a firmware configuration repository, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 24/55] q35: skip q35-acpi-dsdt.aml load if not needed, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 25/55] pc: Remove redundant code from pc-*-2.3 machine classes, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 26/55] pc: Add pc-*-2.6 machine classes, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 27/55] pc: Change indentation of PC_COMPAT_* to 4 spaces, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 28/55] hw/compat.h: Change indentation of HW_COMPAT_* to 4 spaces, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 30/55] nvdimm: implement NVDIMM device abstract, Michael S. Tsirkin, 2015/12/22
- [Qemu-devel] [PULL 29/55] docs/pci_expander_bridge: fix typo, Michael S. Tsirkin, 2015/12/22