1 Kernel driver occ-hwmon 1 Kernel driver occ-hwmon
2 ======================= 2 =======================
3 3
4 Supported chips: 4 Supported chips:
5 5
6 * POWER8 6 * POWER8
7 * POWER9 7 * POWER9
8 8
9 Author: Eddie James <eajames@linux.ibm.com> 9 Author: Eddie James <eajames@linux.ibm.com>
10 10
11 Description 11 Description
12 ----------- 12 -----------
13 13
14 This driver supports hardware monitoring for t 14 This driver supports hardware monitoring for the On-Chip Controller (OCC)
15 embedded on POWER processors. The OCC is a dev 15 embedded on POWER processors. The OCC is a device that collects and aggregates
16 sensor data from the processor and the system. 16 sensor data from the processor and the system. The OCC can provide the raw
17 sensor data as well as perform thermal and pow 17 sensor data as well as perform thermal and power management on the system.
18 18
19 The P8 version of this driver is a client driv 19 The P8 version of this driver is a client driver of I2C. It may be probed
20 manually if an "ibm,p8-occ-hwmon" compatible d 20 manually if an "ibm,p8-occ-hwmon" compatible device is found under the
21 appropriate I2C bus node in the device-tree. 21 appropriate I2C bus node in the device-tree.
22 22
23 The P9 version of this driver is a client driv 23 The P9 version of this driver is a client driver of the FSI-based OCC driver.
24 It will be probed automatically by the FSI-bas 24 It will be probed automatically by the FSI-based OCC driver.
25 25
26 Sysfs entries 26 Sysfs entries
27 ------------- 27 -------------
28 28
29 The following attributes are supported. All at 29 The following attributes are supported. All attributes are read-only unless
30 specified. 30 specified.
31 31
32 The OCC sensor ID is an integer that represent 32 The OCC sensor ID is an integer that represents the unique identifier of the
33 sensor with respect to the OCC. For example, a 33 sensor with respect to the OCC. For example, a temperature sensor for the third
34 DIMM slot in the system may have a sensor ID o 34 DIMM slot in the system may have a sensor ID of 7. This mapping is unavailable
35 to the device driver, which must therefore exp 35 to the device driver, which must therefore export the sensor ID as-is.
36 36
37 Some entries are only present with certain OCC 37 Some entries are only present with certain OCC sensor versions or only on
38 certain OCCs in the system. The version number 38 certain OCCs in the system. The version number is not exported to the user
39 but can be inferred. 39 but can be inferred.
40 40
41 temp[1-n]_label 41 temp[1-n]_label
42 OCC sensor ID. 42 OCC sensor ID.
43 43
44 [with temperature sensor version 1] 44 [with temperature sensor version 1]
45 45
46 temp[1-n]_input 46 temp[1-n]_input
47 Measured temperature o 47 Measured temperature of the component in millidegrees
48 Celsius. 48 Celsius.
49 49
50 [with temperature sensor version >= 2] 50 [with temperature sensor version >= 2]
51 51
52 temp[1-n]_type 52 temp[1-n]_type
53 The FRU (Field 53 The FRU (Field Replaceable Unit) type
54 (represented b 54 (represented by an integer) for the component
55 that this sens 55 that this sensor measures.
56 temp[1-n]_fault 56 temp[1-n]_fault
57 Temperature se 57 Temperature sensor fault boolean; 1 to indicate
58 that a fault i 58 that a fault is present or 0 to indicate that
59 no fault is pr 59 no fault is present.
60 60
61 [with type == 3 (FRU type is VRM)] 61 [with type == 3 (FRU type is VRM)]
62 62
63 temp[1-n]_alarm 63 temp[1-n]_alarm
64 VRM temperatur 64 VRM temperature alarm boolean; 1 to indicate
65 alarm, 0 to in 65 alarm, 0 to indicate no alarm
66 66
67 [else] 67 [else]
68 68
69 temp[1-n]_input 69 temp[1-n]_input
70 Measured tempe 70 Measured temperature of the component in
71 millidegrees C 71 millidegrees Celsius.
72 72
73 freq[1-n]_label 73 freq[1-n]_label
74 OCC sensor ID. 74 OCC sensor ID.
75 freq[1-n]_input 75 freq[1-n]_input
76 Measured frequency of 76 Measured frequency of the component in MHz.
77 power[1-n]_input 77 power[1-n]_input
78 Latest measured power 78 Latest measured power reading of the component in
79 microwatts. 79 microwatts.
80 power[1-n]_average 80 power[1-n]_average
81 Average power of the c 81 Average power of the component in microwatts.
82 power[1-n]_average_interval 82 power[1-n]_average_interval
83 The amount of 83 The amount of time over which the power average
84 was taken in m 84 was taken in microseconds.
85 85
86 [with power sensor version < 2] 86 [with power sensor version < 2]
87 87
88 power[1-n]_label 88 power[1-n]_label
89 OCC sensor ID. 89 OCC sensor ID.
90 90
91 [with power sensor version >= 2] 91 [with power sensor version >= 2]
92 92
93 power[1-n]_label 93 power[1-n]_label
94 OCC sensor ID + functi 94 OCC sensor ID + function ID + channel in the form
95 of a string, delimited 95 of a string, delimited by underscores, i.e. "0_15_1".
96 Both the function ID a 96 Both the function ID and channel are integers that
97 further identify the p 97 further identify the power sensor.
98 98
99 [with power sensor version 0xa0] 99 [with power sensor version 0xa0]
100 100
101 power[1-n]_label 101 power[1-n]_label
102 OCC sensor ID + sensor 102 OCC sensor ID + sensor type in the form of a string,
103 delimited by an unders 103 delimited by an underscore, i.e. "0_system". Sensor
104 type will be one of "s 104 type will be one of "system", "proc", "vdd" or "vdn".
105 For this sensor versio 105 For this sensor version, OCC sensor ID will be the same
106 for all power sensors. 106 for all power sensors.
107 107
108 [present only on "master" OCC; represents the 108 [present only on "master" OCC; represents the whole system power; only one of
109 this type of power sensor will be present] 109 this type of power sensor will be present]
110 110
111 power[1-n]_label 111 power[1-n]_label
112 "system" 112 "system"
113 power[1-n]_input 113 power[1-n]_input
114 Latest system 114 Latest system output power in microwatts.
115 power[1-n]_cap 115 power[1-n]_cap
116 Current system 116 Current system power cap in microwatts.
117 power[1-n]_cap_not_redundant 117 power[1-n]_cap_not_redundant
118 System power c 118 System power cap in microwatts when
119 there is not r 119 there is not redundant power.
120 power[1-n]_cap_max 120 power[1-n]_cap_max
121 Maximum power 121 Maximum power cap that the OCC can enforce in
122 microwatts. 122 microwatts.
123 power[1-n]_cap_min Minimum power 123 power[1-n]_cap_min Minimum power cap that the OCC can enforce in
124 microwatts. 124 microwatts.
125 power[1-n]_cap_user The power cap 125 power[1-n]_cap_user The power cap set by the user, in microwatts.
126 This attribute 126 This attribute will return 0 if no user power
127 cap has been s 127 cap has been set. This attribute is read-write,
128 but writing an 128 but writing any precision below watts will be
129 ignored, i.e. 129 ignored, i.e. requesting a power cap of
130 500900000 micr 130 500900000 microwatts will result in a power cap
131 request of 500 131 request of 500 watts.
132 132
133 [with caps sensor version > 1] 133 [with caps sensor version > 1]
134 134
135 power[1-n]_cap_user_source 135 power[1-n]_cap_user_source
136 Indica 136 Indicates how the user power cap was
137 set. T 137 set. This is an integer that maps to
138 system 138 system or firmware components that can
139 set th 139 set the user power cap.
140 140
141 The following "extn" sensors are exported as a 141 The following "extn" sensors are exported as a way for the OCC to provide data
142 that doesn't fit anywhere else. The meaning of 142 that doesn't fit anywhere else. The meaning of these sensors is entirely
143 dependent on their data, and cannot be statica 143 dependent on their data, and cannot be statically defined.
144 144
145 extn[1-n]_label 145 extn[1-n]_label
146 ASCII ID or OCC sensor 146 ASCII ID or OCC sensor ID.
147 extn[1-n]_flags 147 extn[1-n]_flags
148 This is one byte hexad 148 This is one byte hexadecimal value. Bit 7 indicates the
149 type of the label attr 149 type of the label attribute; 1 for sensor ID, 0 for
150 ASCII ID. Other bits a 150 ASCII ID. Other bits are reserved.
151 extn[1-n]_input 151 extn[1-n]_input
152 6 bytes of hexadecimal 152 6 bytes of hexadecimal data, with a meaning defined by
153 the sensor ID. 153 the sensor ID.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.