xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/intel-m10-bmc-hwmon.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunKernel driver intel-m10-bmc-hwmon
4*4882a593Smuzhiyun=================================
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunSupported chips:
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun * Intel MAX 10 BMC for Intel PAC N3000
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun   Prefix: 'n3000bmc-hwmon'
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunAuthor: Xu Yilun <yilun.xu@intel.com>
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunDescription
16*4882a593Smuzhiyun-----------
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunThis driver adds the temperature, voltage, current and power reading
19*4882a593Smuzhiyunsupport for the Intel MAX 10 Board Management Controller (BMC) chip.
20*4882a593SmuzhiyunThe BMC chip is integrated in some Intel Programmable Acceleration
21*4882a593SmuzhiyunCards (PAC). It connects to a set of sensor chips to monitor the
22*4882a593Smuzhiyunsensor data of different components on the board. The BMC firmware is
23*4882a593Smuzhiyunresponsible for sensor data sampling and recording in shared
24*4882a593Smuzhiyunregisters. The host driver reads the sensor data from these shared
25*4882a593Smuzhiyunregisters and exposes them to users as hwmon interfaces.
26*4882a593Smuzhiyun
27*4882a593SmuzhiyunThe BMC chip is implemented using the Intel MAX 10 CPLD. It could be
28*4882a593Smuzhiyunreprogramed to some variants in order to support different Intel
29*4882a593SmuzhiyunPACs. The driver is designed to be able to distinguish between the
30*4882a593Smuzhiyunvariants, but now it only supports the BMC for Intel PAC N3000.
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunSysfs attributes
34*4882a593Smuzhiyun----------------
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunThe following attributes are supported:
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun- Intel MAX 10 BMC for Intel PAC N3000:
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun======================= =======================================================
41*4882a593SmuzhiyuntempX_input             Temperature of the component (specified by tempX_label)
42*4882a593SmuzhiyuntempX_max               Temperature maximum setpoint of the component
43*4882a593SmuzhiyuntempX_crit              Temperature critical setpoint of the component
44*4882a593SmuzhiyuntempX_max_hyst          Hysteresis for temperature maximum of the component
45*4882a593SmuzhiyuntempX_crit_hyst         Hysteresis for temperature critical of the component
46*4882a593Smuzhiyuntemp1_label             "Board Temperature"
47*4882a593Smuzhiyuntemp2_label             "FPGA Die Temperature"
48*4882a593Smuzhiyuntemp3_label             "QSFP0 Temperature"
49*4882a593Smuzhiyuntemp4_label             "QSFP1 Temperature"
50*4882a593Smuzhiyuntemp5_label             "Retimer A Temperature"
51*4882a593Smuzhiyuntemp6_label             "Retimer A SerDes Temperature"
52*4882a593Smuzhiyuntemp7_label             "Retimer B Temperature"
53*4882a593Smuzhiyuntemp8_label             "Retimer B SerDes Temperature"
54*4882a593Smuzhiyun
55*4882a593SmuzhiyuninX_input               Measured voltage of the component (specified by
56*4882a593Smuzhiyun                        inX_label)
57*4882a593Smuzhiyunin0_label               "QSFP0 Supply Voltage"
58*4882a593Smuzhiyunin1_label               "QSFP1 Supply Voltage"
59*4882a593Smuzhiyunin2_label               "FPGA Core Voltage"
60*4882a593Smuzhiyunin3_label               "12V Backplane Voltage"
61*4882a593Smuzhiyunin4_label               "1.2V Voltage"
62*4882a593Smuzhiyunin5_label               "12V AUX Voltage"
63*4882a593Smuzhiyunin6_label               "1.8V Voltage"
64*4882a593Smuzhiyunin7_label               "3.3V Voltage"
65*4882a593Smuzhiyun
66*4882a593SmuzhiyuncurrX_input             Measured current of the component (specified by
67*4882a593Smuzhiyun                        currX_label)
68*4882a593Smuzhiyuncurr1_label             "FPGA Core Current"
69*4882a593Smuzhiyuncurr2_label             "12V Backplane Current"
70*4882a593Smuzhiyuncurr3_label             "12V AUX Current"
71*4882a593Smuzhiyun
72*4882a593SmuzhiyunpowerX_input            Measured power of the component (specified by
73*4882a593Smuzhiyun                        powerX_label)
74*4882a593Smuzhiyunpower1_label            "Board Power"
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun======================= =======================================================
77*4882a593Smuzhiyun
78*4882a593SmuzhiyunAll the attributes are read-only.
79