xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/bel-pfe.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunKernel driver bel-pfe
2*4882a593Smuzhiyun======================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunSupported chips:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun  * BEL PFE1100
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun    Prefixes: 'pfe1100'
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun    Addresses scanned: -
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun    Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe1100-12-054xa.pdf
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun  * BEL PFE3000
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun    Prefixes: 'pfe3000'
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun    Addresses scanned: -
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun    Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe3000-series.pdf
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunAuthor: Tao Ren <rentao.bupt@gmail.com>
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun
25*4882a593SmuzhiyunDescription
26*4882a593Smuzhiyun-----------
27*4882a593Smuzhiyun
28*4882a593SmuzhiyunThis driver supports hardware monitoring for below power supply devices
29*4882a593Smuzhiyunwhich support PMBus Protocol:
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun  * BEL PFE1100
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun    1100 Watt AC to DC power-factor-corrected (PFC) power supply.
34*4882a593Smuzhiyun    PMBus Communication Manual is not publicly available.
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun  * BEL PFE3000
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun    3000 Watt AC/DC power-factor-corrected (PFC) and DC-DC power supply.
39*4882a593Smuzhiyun    PMBus Communication Manual is not publicly available.
40*4882a593Smuzhiyun
41*4882a593SmuzhiyunThe driver is a client driver to the core PMBus driver. Please see
42*4882a593SmuzhiyunDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun
45*4882a593SmuzhiyunUsage Notes
46*4882a593Smuzhiyun-----------
47*4882a593Smuzhiyun
48*4882a593SmuzhiyunThis driver does not auto-detect devices. You will have to instantiate the
49*4882a593Smuzhiyundevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
50*4882a593Smuzhiyundetails.
51*4882a593Smuzhiyun
52*4882a593SmuzhiyunExample: the following will load the driver for an PFE3000 at address 0x20
53*4882a593Smuzhiyunon I2C bus #1::
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun	$ modprobe bel-pfe
56*4882a593Smuzhiyun	$ echo pfe3000 0x20 > /sys/bus/i2c/devices/i2c-1/new_device
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun
59*4882a593SmuzhiyunPlatform data support
60*4882a593Smuzhiyun---------------------
61*4882a593Smuzhiyun
62*4882a593SmuzhiyunThe driver supports standard PMBus driver platform data.
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun
65*4882a593SmuzhiyunSysfs entries
66*4882a593Smuzhiyun-------------
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun======================= =======================================================
69*4882a593Smuzhiyuncurr1_label		"iin"
70*4882a593Smuzhiyuncurr1_input		Measured input current
71*4882a593Smuzhiyuncurr1_max               Input current max value
72*4882a593Smuzhiyuncurr1_max_alarm         Input current max alarm
73*4882a593Smuzhiyun
74*4882a593Smuzhiyuncurr[2-3]_label		"iout[1-2]"
75*4882a593Smuzhiyuncurr[2-3]_input		Measured output current
76*4882a593Smuzhiyuncurr[2-3]_max           Output current max value
77*4882a593Smuzhiyuncurr[2-3]_max_alarm     Output current max alarm
78*4882a593Smuzhiyun
79*4882a593Smuzhiyunfan[1-2]_input          Fan 1 and 2 speed in RPM
80*4882a593Smuzhiyunfan1_target             Set fan speed reference for both fans
81*4882a593Smuzhiyun
82*4882a593Smuzhiyunin1_label		"vin"
83*4882a593Smuzhiyunin1_input		Measured input voltage
84*4882a593Smuzhiyunin1_crit		Input voltage critical max value
85*4882a593Smuzhiyunin1_crit_alarm		Input voltage critical max alarm
86*4882a593Smuzhiyunin1_lcrit               Input voltage critical min value
87*4882a593Smuzhiyunin1_lcrit_alarm         Input voltage critical min alarm
88*4882a593Smuzhiyunin1_max                 Input voltage max value
89*4882a593Smuzhiyunin1_max_alarm           Input voltage max alarm
90*4882a593Smuzhiyun
91*4882a593Smuzhiyunin2_label               "vcap"
92*4882a593Smuzhiyunin2_input               Hold up capacitor voltage
93*4882a593Smuzhiyun
94*4882a593Smuzhiyunin[3-8]_label		"vout[1-3,5-7]"
95*4882a593Smuzhiyunin[3-8]_input		Measured output voltage
96*4882a593Smuzhiyunin[3-4]_alarm           vout[1-2] output voltage alarm
97*4882a593Smuzhiyun
98*4882a593Smuzhiyunpower[1-2]_label	"pin[1-2]"
99*4882a593Smuzhiyunpower[1-2]_input        Measured input power
100*4882a593Smuzhiyunpower[1-2]_alarm	Input power high alarm
101*4882a593Smuzhiyun
102*4882a593Smuzhiyunpower[3-4]_label	"pout[1-2]"
103*4882a593Smuzhiyunpower[3-4]_input	Measured output power
104*4882a593Smuzhiyun
105*4882a593Smuzhiyuntemp[1-3]_input		Measured temperature
106*4882a593Smuzhiyuntemp[1-3]_alarm         Temperature alarm
107*4882a593Smuzhiyun======================= =======================================================
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun.. note::
110*4882a593Smuzhiyun
111*4882a593Smuzhiyun    - curr3, fan2, vout[2-7], vcap, pin2, pout2 and temp3 attributes only
112*4882a593Smuzhiyun      exist for PFE3000.
113