xref: /linux/Documentation/hwmon/max15301.rst (revision 1e406332)
1*1e406332SErik Rosen.. SPDX-License-Identifier: GPL-2.0
2*1e406332SErik Rosen
3*1e406332SErik RosenKernel driver max15301
4*1e406332SErik Rosen======================
5*1e406332SErik Rosen
6*1e406332SErik RosenSupported chips:
7*1e406332SErik Rosen
8*1e406332SErik Rosen  * Maxim MAX15301
9*1e406332SErik Rosen
10*1e406332SErik Rosen    Prefix: 'max15301', 'bmr461'
11*1e406332SErik Rosen
12*1e406332SErik Rosen    Addresses scanned: -
13*1e406332SErik Rosen
14*1e406332SErik Rosen    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX15301.pdf
15*1e406332SErik Rosen
16*1e406332SErik RosenAuthor: Erik Rosen <erik.rosen@metormote.com>
17*1e406332SErik Rosen
18*1e406332SErik Rosen
19*1e406332SErik RosenDescription
20*1e406332SErik Rosen-----------
21*1e406332SErik Rosen
22*1e406332SErik RosenThis driver supports hardware monitoring for Maxim MAX15301 controller chip and
23*1e406332SErik Rosencompatible modules.
24*1e406332SErik Rosen
25*1e406332SErik RosenThe driver is a client driver to the core PMBus driver. Please see
26*1e406332SErik RosenDocumentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
27*1e406332SErik Rosenon PMBus client drivers.
28*1e406332SErik Rosen
29*1e406332SErik Rosen
30*1e406332SErik RosenUsage Notes
31*1e406332SErik Rosen-----------
32*1e406332SErik Rosen
33*1e406332SErik RosenThis driver does not auto-detect devices. You will have to instantiate the
34*1e406332SErik Rosendevices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
35*1e406332SErik Rosendetails.
36*1e406332SErik Rosen
37*1e406332SErik Rosen
38*1e406332SErik RosenPlatform data support
39*1e406332SErik Rosen---------------------
40*1e406332SErik Rosen
41*1e406332SErik RosenThe driver supports standard PMBus driver platform data.
42*1e406332SErik Rosen
43*1e406332SErik Rosen
44*1e406332SErik RosenModule parameters
45*1e406332SErik Rosen-----------------
46*1e406332SErik Rosen
47*1e406332SErik Rosendelay
48*1e406332SErik Rosen-----
49*1e406332SErik Rosen
50*1e406332SErik RosenThe controller requires a minimum interval between I2C bus accesses.
51*1e406332SErik RosenThe default interval is set to 100 us. For manual override, the driver
52*1e406332SErik Rosenprovides a writeable module parameter, 'delay', which can be used to
53*1e406332SErik Rosenset the interval to a value between 0 and 65,535 microseconds.
54*1e406332SErik Rosen
55*1e406332SErik Rosen
56*1e406332SErik RosenSysfs entries
57*1e406332SErik Rosen-------------
58*1e406332SErik Rosen
59*1e406332SErik RosenThe following attributes are supported. Limits are read-write; all other
60*1e406332SErik Rosenattributes are read-only.
61*1e406332SErik Rosen
62*1e406332SErik Rosen======================= ========================================================
63*1e406332SErik Rosenin1_label		"vin"
64*1e406332SErik Rosenin1_input		Measured input voltage.
65*1e406332SErik Rosenin1_lcrit		Critical minimum input voltage.
66*1e406332SErik Rosenin1_crit		Critical maximum input voltage.
67*1e406332SErik Rosenin1_lcrit_alarm		Input voltage critical low alarm.
68*1e406332SErik Rosenin1_crit_alarm		Input voltage critical high alarm.
69*1e406332SErik Rosen
70*1e406332SErik Rosenin2_label		"vout1"
71*1e406332SErik Rosenin2_input		Measured output voltage.
72*1e406332SErik Rosenin2_lcrit		Critical minimum output Voltage.
73*1e406332SErik Rosenin2_crit		Critical maximum output voltage.
74*1e406332SErik Rosenin2_lcrit_alarm		Critical output voltage critical low alarm.
75*1e406332SErik Rosenin2_crit_alarm		Critical output voltage critical high alarm.
76*1e406332SErik Rosen
77*1e406332SErik Rosencurr1_label		"iout1"
78*1e406332SErik Rosencurr1_input		Measured output current.
79*1e406332SErik Rosencurr1_crit		Critical maximum output current.
80*1e406332SErik Rosencurr1_crit_alarm	Output current critical high alarm.
81*1e406332SErik Rosen
82*1e406332SErik Rosentemp1_input		Measured maximum temperature of all phases.
83*1e406332SErik Rosentemp1_max		Maximum temperature limit.
84*1e406332SErik Rosentemp1_max_alarm		High temperature alarm.
85*1e406332SErik Rosentemp1_crit		Critical maximum temperature limit.
86*1e406332SErik Rosentemp1_crit_alarm	Critical maximum temperature alarm.
87*1e406332SErik Rosen======================= ========================================================
88