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