xref: /linux/Documentation/hwmon/intel-m10-bmc-hwmon.rst (revision 8e07e0e3964ca4e23ce7b68e2096fe660a888942)
1.. SPDX-License-Identifier: GPL-2.0
2
3Kernel driver intel-m10-bmc-hwmon
4=================================
5
6Supported chips:
7
8 * Intel MAX 10 BMC for Intel PAC N3000
9
10   Prefix: 'n3000bmc-hwmon'
11
12Author: Xu Yilun <yilun.xu@intel.com>
13
14
15Description
16-----------
17
18This driver adds the temperature, voltage, current and power reading
19support for the Intel MAX 10 Board Management Controller (BMC) chip.
20The BMC chip is integrated in some Intel Programmable Acceleration
21Cards (PAC). It connects to a set of sensor chips to monitor the
22sensor data of different components on the board. The BMC firmware is
23responsible for sensor data sampling and recording in shared
24registers. The host driver reads the sensor data from these shared
25registers and exposes them to users as hwmon interfaces.
26
27The BMC chip is implemented using the Intel MAX 10 CPLD. It could be
28reprogramed to some variants in order to support different Intel
29PACs. The driver is designed to be able to distinguish between the
30variants, but now it only supports the BMC for Intel PAC N3000.
31
32
33Sysfs attributes
34----------------
35
36The following attributes are supported:
37
38- Intel MAX 10 BMC for Intel PAC N3000:
39
40======================= =======================================================
41tempX_input             Temperature of the component (specified by tempX_label)
42tempX_max               Temperature maximum setpoint of the component
43tempX_crit              Temperature critical setpoint of the component
44tempX_max_hyst          Hysteresis for temperature maximum of the component
45tempX_crit_hyst         Hysteresis for temperature critical of the component
46temp1_label             "Board Temperature"
47temp2_label             "FPGA Die Temperature"
48temp3_label             "QSFP0 Temperature"
49temp4_label             "QSFP1 Temperature"
50temp5_label             "Retimer A Temperature"
51temp6_label             "Retimer A SerDes Temperature"
52temp7_label             "Retimer B Temperature"
53temp8_label             "Retimer B SerDes Temperature"
54
55inX_input               Measured voltage of the component (specified by
56                        inX_label)
57in0_label               "QSFP0 Supply Voltage"
58in1_label               "QSFP1 Supply Voltage"
59in2_label               "FPGA Core Voltage"
60in3_label               "12V Backplane Voltage"
61in4_label               "1.2V Voltage"
62in5_label               "12V AUX Voltage"
63in6_label               "1.8V Voltage"
64in7_label               "3.3V Voltage"
65
66currX_input             Measured current of the component (specified by
67                        currX_label)
68curr1_label             "FPGA Core Current"
69curr2_label             "12V Backplane Current"
70curr3_label             "12V AUX Current"
71
72powerX_input            Measured power of the component (specified by
73                        powerX_label)
74power1_label            "Board Power"
75
76======================= =======================================================
77
78All the attributes are read-only.
79