Documentation/hwmon/occ.rst

1 Kernel driver occ-hwmon
12 -----------
14 This driver supports hardware monitoring for the On-Chip Controller (OCC)
16 sensor data from the processor and the system. The OCC can provide the raw
17 sensor data as well as perform thermal and power management on the system.
20 manually if an "ibm,p8-occ-hwmon" compatible device is found under the
21 appropriate I2C bus node in the device-tree.
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-based OCC driver.
27 -------------
29 The following attributes are supported. All attributes are read-only unless
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 temperature sensor for the third
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 export the sensor ID as-is.
37 Some entries are only present with certain OCC sensor versions or only on
41 temp[1-n]_label
42 	OCC sensor ID.
44 [with temperature sensor version 1]
46     temp[1-n]_input
50 [with temperature sensor version >= 2]
52     temp[1-n]_type
55 				that this sensor measures.
56     temp[1-n]_fault
57 				Temperature sensor fault boolean; 1 to indicate
63 	temp[1-n]_alarm
69 	temp[1-n]_input
73 freq[1-n]_label
74 			OCC sensor ID.
75 freq[1-n]_input
77 power[1-n]_input
80 power[1-n]_average
82 power[1-n]_average_interval
86 [with power sensor version < 2]
88     power[1-n]_label
89 			OCC sensor ID.
91 [with power sensor version >= 2]
93     power[1-n]_label
94 			OCC sensor ID + function ID + channel in the form
97 			further identify the power sensor.
99 [with power sensor version 0xa0]
101     power[1-n]_label
102 			OCC sensor ID + sensor type in the form of a string,
103 			delimited by an underscore, i.e. "0_system". Sensor
105 			For this sensor version, OCC sensor ID will be the same
109 this type of power sensor will be present]
111     power[1-n]_label
113     power[1-n]_input
115     power[1-n]_cap
117     power[1-n]_cap_not_redundant
120     power[1-n]_cap_max
123     power[1-n]_cap_min		Minimum power cap that the OCC can enforce in
125     power[1-n]_cap_user		The power cap set by the user, in microwatts.
127 				cap has been set. This attribute is read-write,
133     [with caps sensor version > 1]
135 	power[1-n]_cap_user_source
145 extn[1-n]_label
146 			ASCII ID or OCC sensor ID.
147 extn[1-n]_flags
149 			type of the label attribute; 1 for sensor ID, 0 for
151 extn[1-n]_input
153 			the sensor ID.