xref: /linux/Documentation/hwmon/stpddc60.rst (revision 249ebf3f65f8530beb2cbfb91bff1d83ba88d23c)
1.. SPDX-License-Identifier: GPL-2.0
2
3Kernel driver stpddc60
4======================
5
6Supported chips:
7
8  * ST STPDDC60
9
10    Prefix: 'stpddc60', 'bmr481'
11
12    Addresses scanned: -
13
14    Datasheet: https://flexpowermodules.com/documents/fpm-techspec-bmr481
15
16Author: Erik Rosen <erik.rosen@metormote.com>
17
18
19Description
20-----------
21
22This driver supports hardware monitoring for ST STPDDC60 controller chip and
23compatible modules.
24
25The driver is a client driver to the core PMBus driver. Please see
26Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
27on PMBus client drivers.
28
29
30Usage Notes
31-----------
32
33This driver does not auto-detect devices. You will have to instantiate the
34devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
35details.
36
37The vout under- and over-voltage limits are set in relation to the commanded
38output voltage as a positive or negative offset in the interval 50mV to 400mV
39in 50mV steps. This means that the absolute values of the limits will change
40when the commanded output voltage changes. Also, care should be taken when
41writing to those limits since in the worst case the commanded output voltage
42could change at the same time as the limit is written to, which will lead to
43unpredictable results.
44
45
46Platform data support
47---------------------
48
49The driver supports standard PMBus driver platform data.
50
51
52Sysfs entries
53-------------
54
55The following attributes are supported. Vin, iout, pout and temp limits
56are read-write; all other attributes are read-only.
57
58======================= ========================================================
59in1_label		"vin"
60in1_input		Measured input voltage.
61in1_lcrit		Critical minimum input voltage.
62in1_crit		Critical maximum input voltage.
63in1_lcrit_alarm		Input voltage critical low alarm.
64in1_crit_alarm		Input voltage critical high alarm.
65
66in2_label		"vout1"
67in2_input		Measured output voltage.
68in2_lcrit		Critical minimum output voltage.
69in2_crit		Critical maximum output voltage.
70in2_lcrit_alarm		Critical output voltage critical low alarm.
71in2_crit_alarm		Critical output voltage critical high alarm.
72
73curr1_label		"iout1"
74curr1_input		Measured output current.
75curr1_max		Maximum output current.
76curr1_max_alarm		Output current high alarm.
77curr1_crit		Critical maximum output current.
78curr1_crit_alarm	Output current critical high alarm.
79
80power1_label		"pout1"
81power1_input		Measured output power.
82power1_crit		Critical maximum output power.
83power1_crit_alarm	Output power critical high alarm.
84
85temp1_input		Measured maximum temperature of all phases.
86temp1_max		Maximum temperature limit.
87temp1_max_alarm		High temperature alarm.
88temp1_crit		Critical maximum temperature limit.
89temp1_crit_alarm	Critical maximum temperature alarm.
90======================= ========================================================
91