Add man for ipmi. jmc have a ball :-)

2 files changed, 128 insertions, 2 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 0f3e334a9bb..38dd92eac81 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.312 2005/09/28 18:31:48 martin Exp $
+#	$OpenBSD: Makefile,v 1.313 2005/10/06 20:58:09 marco Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \
 	aic.4 amdpm.4 ami.4 amphy.4 an.4 aps.4 aria.4 art.4 ast.4 atalk.4 \
@@ -15,7 +15,7 @@ MAN=	aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \
 	hifn.4 hil.4 hilid.4 hilkbd.4 hilms.4 hme.4 hotplug.4 hsq.4 \
 	ichwdt.4 icmp.4 icmp6.4 icsphy.4 idp.4 ifmedia.4 \
 	iha.4 iic.4 inet.4 inet6.4 inphy.4 iop.4 iophy.4 ioprbs.4 \
-	iopsp.4 ip.4 ip6.4 ipcomp.4 ipsec.4 ipw.4 isa.4 isapnp.4 \
+	iopsp.4 ip.4 ip6.4 ipcomp.4 ipmi.4 ipsec.4 ipw.4 isa.4 isapnp.4 \
 	ises.4 isp.4 it.4 iwi.4 ksyms.4 kue.4 lc.4 lge.4 lkm.4 lm.4 \
 	lmc.4 lmtemp.4 lo.4 lofn.4 lpt.4 lxtphy.4 luphy.4 maestro.4 midi.4 \
 	mii.4 mpt.4 mpu.4 mtd.4 mtdphy.4 multicast.4 mtio.4 ne.4 neo.4 \
diff --git a/share/man/man4/ipmi.4 b/share/man/man4/ipmi.4
new file mode 100644
index 00000000000..9fe23ecfdeb
--- /dev/null
+++ b/share/man/man4/ipmi.4
@@ -0,0 +1,126 @@
+.\"	$OpenBSD: ipmi.4,v 1.1 2005/10/06 20:58:09 marco Exp $
+.\"
+.\" Copyright (c) Marco Peereboom <marco@openbsd.org>
+.\" Text was heavily borrowed from the IPMI spec V1.5
+.\" 
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\" 
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" TORTIOUS ACTION, ARISING OUT OF
+.\" PERFORMANCE OF THIS SOFTWARE.
+.Dd October 5, 2005
+.Dt IPMI 4
+.Os
+.Sh NAME
+.Nm ipmi
+.Nd Intelligent Platform Management Interface driver
+.Sh SYNOPSIS
+.Cd "ipmi0 at mainbus0"
+.Sh DESCRIPTION
+The
+.Nm
+term Intelligent Platform Management refers to autonomous monitoring and
+recovery features implemented directly in platform management hardware and
+firmware.  The key characteristics of Intelligent Platform Management is that
+inventory, monitoring, logging and recovery control functions are available
+indepent of the main processor, BIOS and operating system.
+.Pp
+Platform status information can be obtiained and recovery actions initiated
+under situations where vendor "in-band" management mechanisms are unavailable.
+The independent monitoring, logging and access functions available through IPMI
+provide a level of manageability built-in to the platform hardware.  This can
+support systems where there is no systems management software available for a
+particular operating system.
+.Pp
+At the heart of the IPMI architecture is a microcontroller called the Baseboard Management Controller or BMC.  The BMC provides the intelligence behind Intelligent Platform Management.  The BMC manages the interface between system management software and the platform management hardware, provides autonomous monitoring, event logging and recovery control and serves as the gateway between systems management software and hardware.
+.Pp
+.Sh IPMI MESSAGING
+IPMI uses message-based interfaces for the different interfaces to the platform
+management subsystems.  All IPMI messages share the same fields in the message
+"payload"; regardless of the interface (transport) that they're transferred
+over.  IPMI messaging uses a request/response protocol.  IPMI request messages are commonly referred to as commands.  The use of request/response protocol facilitates the transfer of IPMI messages over different transports.  IPMI commands are grouped into functional command sets using a field called network function code.  There are command sets for sensor and even related commands, chassis commands etc.  This functional grouping makes it easier to organize and manage the assignment and allocation of command values.
+.Sh SENSOR MODEL
+Access to monitored information such as temperatures, voltages, fan status
+etc., is provided via the IPMI Sensor Model.  Instead of providing direct
+access to the monitoring hardware IPMI provides access by abstracted sensor
+commands such as the "Get Seonsor Reading" command, implemented via a
+management controller.  This approach isolates the software from changes in the
+platform management hardware implementation.
+.Pp
+Sensors are classified according to the type of readings they provide and/or the type of events they generate.  A sensor can return either an analog or discrete reading.  Sensor events can be discrete or threshold-based.
+.Sh SYSTEM EVENT LOG AND EVENT MESSAGES
+The BMC provides a centralized non-volatile System Event Log, or SEL.  Having
+the SEL and logging functions managed by the BMC helps ensure that post-mortem
+logging information is available should a failure occur that disables the
+systems processor(s).
+.Pp
+A set of IPMI commands alows the SEL to be read and cleared and for events to be added to the SEL.  The common request message (command) used for adding events to the SEL is referred to as Event Message.
+.Sh SENSOR DATA RECORDS & CAPABILITIES COMMANDS
+IPMI's extensibility and scalability mean that each platform implementation can
+have a differerent population of management controllers and sensors and
+different event generation capabilities.  The design of IPMI allows system
+management software to retrieve information from the platform and automatically
+configure itself to the platform's capabilities.
+.Pp
+Information that describes the platform management capabilities is provided via
+two mechanisms: Capabilities Commands and Sensor Data Records (SDRs).
+Capabilities commands are commands within the IPMI command sets that return
+fields that provide information on other commands and functions the controller
+can handle.
+.Sh SYSTEMS INTERFACES
+IPMI defines three standardized systems intefaces that systems software uses
+for transfering IPMI messages to the BMC.  In order to support a variety of
+microcontrollers, IPMI offers a choice of systems interfaces.  The system
+interfaces are similar enough so that a single driver can handle all IPMI
+system interfaces.
+.Pp
+.Bl -tag -width <10> -compact
+.It Keyboard Controller Style (KCS)
+The bit definitions, and operation of the registers follows that used in the
+Intel 8742 Universal Peripheral Interface microcontroller.  The term "Keyboard
+Controller Style" reflects the fact that the 8742 interface was used as the
+legacy keyboard controller interface in PC architecture computer systems.  This
+interface is available built-in to several commercially available
+microcontrollers.  Data is transferred accross the KCS interface using a per
+byte-byte handshake.
+.Pp
+.It System Management Interface Chip (SMIC)
+The SMIC interface provides an alternative when the implementer wishes to use a
+microcontroller for the BMC that does not have the built-in hardware for a KCS
+interface.  This interface is a three I/O port interface that can be
+implemented using a simple ASIC, FPGA or discrete logic devices.  It may also
+be built-in to a custom-designed management controller.  Like the KCS interface
+a per-byte handshake is also used for transferring data accross the SMIC
+interface.
+.Pp
+.It Block Transfer (BT)
+This interface provides a higher performance system interface option.  Unlike
+the KCS and SMIC interfaces a per-block handshake is used for transferring data
+accross the interface.  The BT interface also provides an alternative to using
+a controller with a built-in KCS interface.  The BT interface has three I/O
+mapped ports.  A typical implementation includes hardware buffers for holding
+upstream and downstream message blocks.  The BT interface can be implemented
+using an ASIC or FPGA or may be built-in to a custom-designed management
+controller.
+.El
+.Sh SEE ALSO
+.Xr sysctl 8 ,
+.Xr sensorsd 8
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 3.9
+and conforms to the IPMI 1.5 specification.
+.Sh AUTHORS
+The
+.Om
+.Nm
+driver was written by Jordan Hargrave <jordan@openbsd.org>
+