ibmaem: update the documentation to reflect the current name

Minor documentation update to reflect the current full name of the power
management hardware interface and reflows the text a bit.

Signed-off-by: Darrick J. Wong <djwong@us.ibm.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Darrick J. Wong 2008-08-15 00:40:40 -07:00 committed by Linus Torvalds
parent 4ef664b5bc
commit eb93b7df7e
2 changed files with 20 additions and 19 deletions

View File

@ -1,8 +1,11 @@
Kernel driver ibmaem Kernel driver ibmaem
====================== ======================
This driver talks to the IBM Systems Director Active Energy Manager, known
henceforth as AEM.
Supported systems: Supported systems:
* Any recent IBM System X server with Active Energy Manager support. * Any recent IBM System X server with AEM support.
This includes the x3350, x3550, x3650, x3655, x3755, x3850 M2, This includes the x3350, x3550, x3650, x3655, x3755, x3850 M2,
x3950 M2, and certain HS2x/LS2x/QS2x blades. The IPMI host interface x3950 M2, and certain HS2x/LS2x/QS2x blades. The IPMI host interface
driver ("ipmi-si") needs to be loaded for this driver to do anything. driver ("ipmi-si") needs to be loaded for this driver to do anything.
@ -14,24 +17,22 @@ Author: Darrick J. Wong
Description Description
----------- -----------
This driver implements sensor reading support for the energy and power This driver implements sensor reading support for the energy and power meters
meters available on various IBM System X hardware through the BMC. All available on various IBM System X hardware through the BMC. All sensor banks
sensor banks will be exported as platform devices; this driver can talk will be exported as platform devices; this driver can talk to both v1 and v2
to both v1 and v2 interfaces. This driver is completely separate from the interfaces. This driver is completely separate from the older ibmpex driver.
older ibmpex driver.
The v1 AEM interface has a simple set of features to monitor energy use. The v1 AEM interface has a simple set of features to monitor energy use. There
There is a register that displays an estimate of raw energy consumption is a register that displays an estimate of raw energy consumption since the
since the last BMC reset, and a power sensor that returns average power last BMC reset, and a power sensor that returns average power use over a
use over a configurable interval. configurable interval.
The v2 AEM interface is a bit more sophisticated, being able to present The v2 AEM interface is a bit more sophisticated, being able to present a wider
a wider range of energy and power use registers, the power cap as range of energy and power use registers, the power cap as set by the AEM
set by the AEM software, and temperature sensors. software, and temperature sensors.
Special Features Special Features
---------------- ----------------
The "power_cap" value displays the current system power cap, as set by The "power_cap" value displays the current system power cap, as set by the AEM
the Active Energy Manager software. Setting the power cap from the host software. Setting the power cap from the host is not currently supported.
is not currently supported.

View File

@ -1,6 +1,6 @@
/* /*
* A hwmon driver for the IBM Active Energy Manager temperature/power sensors * A hwmon driver for the IBM System Director Active Energy Manager (AEM)
* and capping functionality. * temperature/power/energy sensors and capping functionality.
* Copyright (C) 2008 IBM * Copyright (C) 2008 IBM
* *
* Author: Darrick J. Wong <djwong@us.ibm.com> * Author: Darrick J. Wong <djwong@us.ibm.com>
@ -1104,7 +1104,7 @@ static void __exit aem_exit(void)
} }
MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>"); MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>");
MODULE_DESCRIPTION("IBM Active Energy Manager power/temp sensor driver"); MODULE_DESCRIPTION("IBM AEM power/temp/energy sensor driver");
MODULE_LICENSE("GPL"); MODULE_LICENSE("GPL");
module_init(aem_init); module_init(aem_init);