hwmon: Add driver for AMD family 15h processor power information
[linux-2.6.git] / Documentation / hwmon / fam15h_power
1 Kernel driver fam15h_power
2 ==========================
3
4 Supported chips:
5 * AMD Family 15h Processors
6
7   Prefix: 'fam15h_power'
8   Addresses scanned: PCI space
9   Datasheets:
10   BIOS and Kernel Developer's Guide (BKDG) For AMD Family 15h Processors
11     (not yet published)
12
13 Author: Andreas Herrmann <andreas.herrmann3@amd.com>
14
15 Description
16 -----------
17
18 This driver permits reading of registers providing power information
19 of AMD Family 15h processors.
20
21 For AMD Family 15h processors the following power values can be
22 calculated using different processor northbridge function registers:
23
24 * BasePwrWatts: Specifies in watts the maximum amount of power
25   consumed by the processor for NB and logic external to the core.
26 * ProcessorPwrWatts: Specifies in watts the maximum amount of power
27   the processor can support.
28 * CurrPwrWatts: Specifies in watts the current amount of power being
29   consumed by the processor.
30
31 This driver provides ProcessorPwrWatts and CurrPwrWatts:
32 * power1_crit (ProcessorPwrWatts)
33 * power1_input (CurrPwrWatts)
34
35 On multi-node processors the calculated value is for the entire
36 package and not for a single node. Thus the driver creates sysfs
37 attributes only for internal node0 of a multi-node processor.