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