xref: /linux/Documentation/hwmon/max15301.rst (revision e814f3fd16acfb7f9966773953de8f740a1e3202)
1.. SPDX-License-Identifier: GPL-2.0
2
3Kernel driver max15301
4======================
5
6Supported chips:
7
8  * Maxim MAX15301
9
10    Prefix: 'max15301', 'bmr461'
11
12    Addresses scanned: -
13
14    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX15301.pdf
15
16  * Maxim MAX15303
17
18    Prefix: 'max15303'
19
20    Addresses scanned: -
21
22    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max15303.pdf
23
24Author: Erik Rosen <erik.rosen@metormote.com>
25
26
27Description
28-----------
29
30This driver supports hardware monitoring for Maxim MAX15301 controller chip and
31compatible modules.
32
33The driver is a client driver to the core PMBus driver. Please see
34Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
35on PMBus client drivers.
36
37
38Usage Notes
39-----------
40
41This driver does not auto-detect devices. You will have to instantiate the
42devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
43details.
44
45
46Platform data support
47---------------------
48
49The driver supports standard PMBus driver platform data.
50
51
52Module parameters
53-----------------
54
55delay
56-----
57
58The controller requires a minimum interval between I2C bus accesses.
59The default interval is set to 100 us. For manual override, the driver
60provides a writeable module parameter, 'delay', which can be used to
61set the interval to a value between 0 and 65,535 microseconds.
62
63
64Sysfs entries
65-------------
66
67The following attributes are supported. Limits are read-write; all other
68attributes are read-only.
69
70======================= ========================================================
71in1_label		"vin"
72in1_input		Measured input voltage.
73in1_lcrit		Critical minimum input voltage.
74in1_crit		Critical maximum input voltage.
75in1_lcrit_alarm		Input voltage critical low alarm.
76in1_crit_alarm		Input voltage critical high alarm.
77
78in2_label		"vout1"
79in2_input		Measured output voltage.
80in2_lcrit		Critical minimum output Voltage.
81in2_crit		Critical maximum output voltage.
82in2_lcrit_alarm		Critical output voltage critical low alarm.
83in2_crit_alarm		Critical output voltage critical high alarm.
84
85curr1_label		"iout1"
86curr1_input		Measured output current.
87curr1_crit		Critical maximum output current.
88curr1_crit_alarm	Output current critical high alarm.
89
90temp1_input		Measured maximum temperature of all phases.
91temp1_max		Maximum temperature limit.
92temp1_max_alarm		High temperature alarm.
93temp1_crit		Critical maximum temperature limit.
94temp1_crit_alarm	Critical maximum temperature alarm.
95======================= ========================================================
96