Commit eb93b7df authored by Darrick J. Wong's avatar Darrick J. Wong Committed by Linus Torvalds
Browse files

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: default avatarDarrick J. Wong <djwong@us.ibm.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 4ef664b5

Documentation/hwmon/ibmaem

+17 −16
Original line number Diff line number Diff line 
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 Active Energy Manager support.

  * Any recent IBM System X server with AEM support.

    This includes the x3350, x3550, x3650, x3655, x3755, x3850 M2,

    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.
@@ -14,24 +17,22 @@ 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.

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 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.

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 Active Energy Manager software.  Setting the power cap from the host

is not currently supported.
 
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.

drivers/hwmon/ibmaem.c

+3 −3
Original line number Diff line number Diff line 
/*

 * A hwmon driver for the IBM Active Energy Manager temperature/power sensors

 * and capping functionality.

 * A hwmon driver for the IBM System Director Active Energy Manager (AEM)

 * temperature/power/energy sensors and capping functionality.

 * Copyright (C) 2008 IBM

 *

 * 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_DESCRIPTION("IBM Active Energy Manager power/temp sensor driver");

MODULE_DESCRIPTION("IBM AEM power/temp/energy sensor driver");

MODULE_LICENSE("GPL");



module_init(aem_init);