xref: /openbmc/linux/Documentation/hwmon/bel-pfe.rst (revision c95baf12f5077419db01313ab61c2aac007d40cd)
1*61412ef1STao RenKernel driver bel-pfe
2*61412ef1STao Ren======================
3*61412ef1STao Ren
4*61412ef1STao RenSupported chips:
5*61412ef1STao Ren
6*61412ef1STao Ren  * BEL PFE1100
7*61412ef1STao Ren
8*61412ef1STao Ren    Prefixes: 'pfe1100'
9*61412ef1STao Ren
10*61412ef1STao Ren    Addresses scanned: -
11*61412ef1STao Ren
12*61412ef1STao Ren    Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe1100-12-054xa.pdf
13*61412ef1STao Ren
14*61412ef1STao Ren  * BEL PFE3000
15*61412ef1STao Ren
16*61412ef1STao Ren    Prefixes: 'pfe3000'
17*61412ef1STao Ren
18*61412ef1STao Ren    Addresses scanned: -
19*61412ef1STao Ren
20*61412ef1STao Ren    Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe3000-series.pdf
21*61412ef1STao Ren
22*61412ef1STao RenAuthor: Tao Ren <rentao.bupt@gmail.com>
23*61412ef1STao Ren
24*61412ef1STao Ren
25*61412ef1STao RenDescription
26*61412ef1STao Ren-----------
27*61412ef1STao Ren
28*61412ef1STao RenThis driver supports hardware monitoring for below power supply devices
29*61412ef1STao Renwhich support PMBus Protocol:
30*61412ef1STao Ren
31*61412ef1STao Ren  * BEL PFE1100
32*61412ef1STao Ren
33*61412ef1STao Ren    1100 Watt AC to DC power-factor-corrected (PFC) power supply.
34*61412ef1STao Ren    PMBus Communication Manual is not publicly available.
35*61412ef1STao Ren
36*61412ef1STao Ren  * BEL PFE3000
37*61412ef1STao Ren
38*61412ef1STao Ren    3000 Watt AC/DC power-factor-corrected (PFC) and DC-DC power supply.
39*61412ef1STao Ren    PMBus Communication Manual is not publicly available.
40*61412ef1STao Ren
41*61412ef1STao RenThe driver is a client driver to the core PMBus driver. Please see
42*61412ef1STao RenDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
43*61412ef1STao Ren
44*61412ef1STao Ren
45*61412ef1STao RenUsage Notes
46*61412ef1STao Ren-----------
47*61412ef1STao Ren
48*61412ef1STao RenThis driver does not auto-detect devices. You will have to instantiate the
49*61412ef1STao Rendevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
50*61412ef1STao Rendetails.
51*61412ef1STao Ren
52*61412ef1STao RenExample: the following will load the driver for an PFE3000 at address 0x20
53*61412ef1STao Renon I2C bus #1::
54*61412ef1STao Ren
55*61412ef1STao Ren	$ modprobe bel-pfe
56*61412ef1STao Ren	$ echo pfe3000 0x20 > /sys/bus/i2c/devices/i2c-1/new_device
57*61412ef1STao Ren
58*61412ef1STao Ren
59*61412ef1STao RenPlatform data support
60*61412ef1STao Ren---------------------
61*61412ef1STao Ren
62*61412ef1STao RenThe driver supports standard PMBus driver platform data.
63*61412ef1STao Ren
64*61412ef1STao Ren
65*61412ef1STao RenSysfs entries
66*61412ef1STao Ren-------------
67*61412ef1STao Ren
68*61412ef1STao Ren======================= =======================================================
69*61412ef1STao Rencurr1_label		"iin"
70*61412ef1STao Rencurr1_input		Measured input current
71*61412ef1STao Rencurr1_max               Input current max value
72*61412ef1STao Rencurr1_max_alarm         Input current max alarm
73*61412ef1STao Ren
74*61412ef1STao Rencurr[2-3]_label		"iout[1-2]"
75*61412ef1STao Rencurr[2-3]_input		Measured output current
76*61412ef1STao Rencurr[2-3]_max           Output current max value
77*61412ef1STao Rencurr[2-3]_max_alarm     Output current max alarm
78*61412ef1STao Ren
79*61412ef1STao Renfan[1-2]_input          Fan 1 and 2 speed in RPM
80*61412ef1STao Renfan1_target             Set fan speed reference for both fans
81*61412ef1STao Ren
82*61412ef1STao Renin1_label		"vin"
83*61412ef1STao Renin1_input		Measured input voltage
84*61412ef1STao Renin1_crit		Input voltage critical max value
85*61412ef1STao Renin1_crit_alarm		Input voltage critical max alarm
86*61412ef1STao Renin1_lcrit               Input voltage critical min value
87*61412ef1STao Renin1_lcrit_alarm         Input voltage critical min alarm
88*61412ef1STao Renin1_max                 Input voltage max value
89*61412ef1STao Renin1_max_alarm           Input voltage max alarm
90*61412ef1STao Ren
91*61412ef1STao Renin2_label               "vcap"
92*61412ef1STao Renin2_input               Hold up capacitor voltage
93*61412ef1STao Ren
94*61412ef1STao Renin[3-8]_label		"vout[1-3,5-7]"
95*61412ef1STao Renin[3-8]_input		Measured output voltage
96*61412ef1STao Renin[3-4]_alarm           vout[1-2] output voltage alarm
97*61412ef1STao Ren
98*61412ef1STao Renpower[1-2]_label	"pin[1-2]"
99*61412ef1STao Renpower[1-2]_input        Measured input power
100*61412ef1STao Renpower[1-2]_alarm	Input power high alarm
101*61412ef1STao Ren
102*61412ef1STao Renpower[3-4]_label	"pout[1-2]"
103*61412ef1STao Renpower[3-4]_input	Measured output power
104*61412ef1STao Ren
105*61412ef1STao Rentemp[1-3]_input		Measured temperature
106*61412ef1STao Rentemp[1-3]_alarm         Temperature alarm
107*61412ef1STao Ren======================= =======================================================
108*61412ef1STao Ren
109*61412ef1STao Ren.. note::
110*61412ef1STao Ren
111*61412ef1STao Ren    - curr3, fan2, vout[2-7], vcap, pin2, pout2 and temp3 attributes only
112*61412ef1STao Ren      exist for PFE3000.
113