[net-next-2.6.git] / Documentation / hwmon / ibmaem

Kernel driver ibmaem
======================

This driver talks to the IBM Systems Director Active Energy Manager, known
henceforth as AEM.

Supported systems:
  * Any recent IBM System X server with AEM support.
    This includes the x3350, x3550, x3650, x3655, x3755, x3850 M2,
    x3950 M2, and certain HC10/HS2x/LS2x/QS2x blades.  The IPMI host interface
    driver ("ipmi-si") needs to be loaded for this driver to do anything.
    Prefix: 'ibmaem'
    Datasheet: Not available

Author: Darrick J. Wong

Description
-----------

This driver implements sensor reading support for the energy and power meters
available on various IBM System X hardware through the BMC.  All sensor banks
will be exported as platform devices; this driver can talk to both v1 and v2
interfaces.  This driver is completely separate from the older ibmpex driver.

The v1 AEM interface has a simple set of features to monitor energy use.  There
is a register that displays an estimate of raw energy consumption since the
last BMC reset, and a power sensor that returns average power use over a
configurable interval.

The v2 AEM interface is a bit more sophisticated, being able to present a wider
range of energy and power use registers, the power cap as set by the AEM
software, and temperature sensors.

Special Features
----------------

The "power_cap" value displays the current system power cap, as set by the AEM
software.  Setting the power cap from the host is not currently supported.
Commit	Line	Data
8808a793 DW	1	Kernel driver ibmaem
	2	======================
	3
eb93b7df DW	4	This driver talks to the IBM Systems Director Active Energy Manager, known
	5	henceforth as AEM.
	6
8808a793	7	Supported systems:
eb93b7df	8	* Any recent IBM System X server with AEM support.
8808a793	9	This includes the x3350, x3550, x3650, x3655, x3755, x3850 M2,
8070408b	10	x3950 M2, and certain HC10/HS2x/LS2x/QS2x blades. The IPMI host interface
8808a793 DW	11	driver ("ipmi-si") needs to be loaded for this driver to do anything.
	12	Prefix: 'ibmaem'
	13	Datasheet: Not available
	14
	15	Author: Darrick J. Wong
	16
	17	Description
	18	-----------
	19
eb93b7df DW	20	This driver implements sensor reading support for the energy and power meters
	21	available on various IBM System X hardware through the BMC. All sensor banks
	22	will be exported as platform devices; this driver can talk to both v1 and v2
	23	interfaces. This driver is completely separate from the older ibmpex driver.
8808a793	24
eb93b7df DW	25	The v1 AEM interface has a simple set of features to monitor energy use. There
	26	is a register that displays an estimate of raw energy consumption since the
	27	last BMC reset, and a power sensor that returns average power use over a
	28	configurable interval.
8808a793	29
eb93b7df DW	30	The v2 AEM interface is a bit more sophisticated, being able to present a wider
	31	range of energy and power use registers, the power cap as set by the AEM
	32	software, and temperature sensors.
8808a793 DW	33
	34	Special Features
	35	----------------
	36
eb93b7df DW	37	The "power_cap" value displays the current system power cap, as set by the AEM
eb93b7df DW	38	software. Setting the power cap from the host is not currently supported.